List Dedicated Circuit Links

 

The List Dedicated Circuit Links operation obtains the status of the links between VLANs and VNETs.

Request

The List Dedicated Circuit Links request may be specified as follows. Replace <subscription-id> with the subscription ID, <service-key> with the service key that was obtained when the circuit was created, and <vnet-name> with the name of the virtual network.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/dedicatedcircuits/<service-key>/vnets

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:

<?xml version="1.0" encoding="utf-8"?>
<DedicatedCircuitLink xmlns="https://schemas.microsoft.com/windowsazure">
  <Status>operation-id</Status>
  <VNetName>name-of-vnet</VNetName>
</DedicatedCircuitLink>

The following table describes the elements of the response body.

Element name

Description

Status

Specifies the status of the link between a VLAN and a VNET.

Possible values are:

  • NotProvisioned

  • Provisioning

  • Provisioned

  • DeProvisioning

  • ProvisioningError

VNetName

Specifies the name of the VNET that is linked to the VLAN.

See Also

Operations on ExpressRoute
ExpressRoute Technical Overview