List Dedicated Circuits

Article
08/13/2015

The List Dedicated Circuits operation returns a list of dedicated circuits that are associated with a subscription.

Request

The List Dedicated Circuits request may be specified as follows. Replace <subscription-id> with the subscription ID.

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

You must make sure that the request that is made to the management service is secure. For additional details, see Authenticating Service Management Requests.

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header	Description
x-ms-version	Required. Specifies the version of the operation to use for this request. This header should be set to 2014-01-01 or higher. For more information about versioning headers, see Service Management Versioning.

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 Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers comply with the HTTP/1.1 protocol specification.

Response Header	Description
x-ms-request-id	A value that uniquely identifies a request made against the management service.

Response Body

The following example shows the format of the response body:

<DedicatedCircuits xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DedicatedCircuit>
    <ServiceKey>service-key</ServiceKey>
    <Bandwidth>bandwidth-of-circuit</Bandwidth>
    <CircuitName>name-of-circuit</CircuitName>
    <Location>location-of-circuit</Location>
    <ServiceProviderName>name-of-provider</ServiceProviderName>
    <ServiceProviderProvisioningState>provisioning-state</ServiceProviderProvisioningState>
    <Status>status</Status>
  </DedicatedCircuit>
</DedicatedCircuits>

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. Disabled Disabling Enabling Enabled

Share via