Get Authorized Dedicated Circuit

Article
08/13/2015

The Get Authorized DedicatedCircuit operation provides details of a dedicated circuit authorized for use by the dedicated circuit owner. The dedicated circuit owner refers to the owner of the subscription in which a dedicated circuit is created. This API call is made by the user of the dedicated circuit. The user of the dedicated circuit will be a different subscription from the subscription in which the dedicated circuit is created.

Request

The Get Authorized DedicatedCircuit request may be specified as follows. Replace <subscription-id> with the subscription ID and <service-key> with the service key that was obtained when the circuit was created.

Method	Request URI
GET	https://management.core.windows.net/<subscription-id>/services/networking/authorizeddedicatedcircuits/<service-key>

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 200 (OK). For information about status codes, see Service Management Status and Error Codes.

Response Body

The following example shows the format of the response body:

<AuthorizedDedicatedCircuit xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
 <Bandwidth>bandwidth</Bandwidth> 
 <CircuitName>circuit-name</CircuitName> 
<Location>location</Location> 
 <MaximumAllowedLinks>maximum-allowed-links</ MaximumAllowedLinks > 
 <ServiceKey>service-key</ServiceKey> 
       <ServiceProviderName>provider</ServiceProviderName> 
       <ServiceProviderProvisioningState>provisioning-state</ServiceProviderProvisioningState>      <Status>status</Status> 
      <UsedLinks>used-links</ UsedLinks > 
</AuthorizedDedicatedCircuit>

The following table describes the elements of the response body:

Element name	Description
ServiceKey	A value that uniquely identifies the circuit
Bandwidth	Specifies the bandwidth that is assigned to the circuit
CircuitName	Specifies the name of the circuit
Location	Specifies the peering location of the circuit. For more information about finding the locations that are supported by service providers, see List Dedicated Circuit Service Providers.
ServiceProviderName	Specifies the name of the dedicated circuit service provider. For more information about finding service provider names, see List Dedicated Circuit Service Providers.
ServiceProviderProvisioningState	Specifies the provisioning state of the circuit. Possible values are: NotProvisioned Provisioning Provisioned Deprovisioning
Status	The current status of the circuit. Possible values are: Disabled Disabling Enabling Enabled
MaximumAllowedLinks	Maximum number of authorized links for the link authorization
UsedLinks	Number of links redeemed for the link authorization