Create Dedicated Circuit
The Create Dedicated Circuit operation registers the necessary customer information for the dedicated circuit connection and creates a unique service key that is used to establish a relationship between the customer and the Microsoft.
Request
The Create Dedicated Circuit request may be specified as follows. Replace <subscription-id> with the subscription ID.
Method |
Request URI |
|---|---|
POST |
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
The format of the request body is as follows:
<CreateDedicatedCircuit 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>
<ServiceProviderName>provider</ServiceProviderName>
</CreateDedicatedCircuit>
The following table describes the elements of the request body.
Element name |
Description |
|---|---|
Bandwidth |
Required. Specifies the expected bandwidth for the circuit in Mbps. For more information about finding the bandwidth of a circuit, see List Dedicated Circuit Service Providers. |
CircuitName |
Required. Specifies the name of the circuit. Spaces are not allowed in the name. |
Location |
Required. 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 |
Required. Specifies the name of the dedicated circuit service provider. For more information about finding service provider names, see List Dedicated Circuit Service Providers. |
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"?>
<GatewayOperationAsyncResponse xmlns="https://schemas.microsoft.com/windowsazure">
<ID>operation-id</ID>
</GatewayOperationAsyncResponse>
The following table describes the elements of the response body.
Element name |
Description |
|---|---|
ID |
Uniquely identifies the operation. This ID contains the same value as the request ID that is returned by the x-ms-request-id header. To get more information about the status of an operation, such as whether it is still executing or complete, you can call Get Virtual Network Gateway Operation Status with the request ID. |