Update Dedicated Circuit Link Authorization

Article
08/13/2015

The Update DedicatedCircuit Link Authorization API enables the dedicated circuit owner to update the description and number of authorizations. The dedicated circuit owner refers to the owner of the subscription in which a dedicated circuit is created.

Request

The Update DedicatedCircuit Link Authorization 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, and the <auth-id> is the authorization ID identifying the unique authorization request.

Method	Request URI
PATCH	https://management.core.windows.net/<subscription-id>/services/networking/dedicatedcircuits/<service-key>/authorizations/<auth-id>

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

Request Body

The following example shows the format of the request body:

<UpdateDedicatedCircuitLinkAuthorization xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Description>description</ Description >
<Limit>number of links authorized</ Limit >
</UpdateDedicatedCircuitLinkAuthorization >

The following table describes the elements of the request body.

Element name	Description
Description	User-friendly text describing the link.
Limit	Maximum number of links authorized for this authorization.

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:

<DedicatedCircuitLinkAuthorization xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Description>description</Description>
  <Limit> number of links authorized </Limit>
  <LinkAuthId>unique link authorization id for this link<s/LinkAuthId>
  <MicrosoftIds> comma-separated list of microsoft ids </MicrosoftIds>
  <Used>used links for this link authorization</Used>
</DedicatedCircuitLinkAuthorization>

The following table describes the elements of the response body.

Element name	Description
Description	User-friendly text describing the link.
Limit	Maximum number of links authorized for this authorization.
Link AuthID	GUID uniquely identifying the authorization.
MicrosoftIds	List of Microsoft IDs (typically IDs of account admins and co-admins.) who are authorized to claim the authorization.
Used	Number of links redeemed.

Share via