Express Route Circuit Authorizations - List

Gets all authorizations in an express route circuit.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations?api-version=2023-09-01

URI Parameters

Name In Required Type Description
circuitName
path True

string

The name of the circuit.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API version.

Responses

Name Type Description
200 OK

AuthorizationListResult

Request successful. The operation returns a list of ExpressRouteCircuitAuthorization resources.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List ExpressRouteCircuit Authorization

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations?api-version=2023-09-01

Sample response

{
  "value": [
    {
      "name": "MyAuthorization1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1",
      "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"",
      "properties": {
        "provisioningState": "Succeeded",
        "authorizationKey": "authKey",
        "authorizationUseStatus": "Available"
      }
    }
  ]
}

Definitions

Name Description
AuthorizationListResult

Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit.

AuthorizationUseStatus

The authorization use status.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ExpressRouteCircuitAuthorization

Authorization in an ExpressRouteCircuit resource.

ProvisioningState

The current provisioning state.

AuthorizationListResult

Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit.

Name Type Description
nextLink

string

The URL to get the next set of results.

value

ExpressRouteCircuitAuthorization[]

The authorizations in an ExpressRoute Circuit.

AuthorizationUseStatus

The authorization use status.

Name Type Description
Available

string

InUse

string

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

ExpressRouteCircuitAuthorization

Authorization in an ExpressRouteCircuit resource.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.authorizationKey

string

The authorization key.

properties.authorizationUseStatus

AuthorizationUseStatus

The authorization use status.

properties.provisioningState

ProvisioningState

The provisioning state of the authorization resource.

type

string

Type of the resource.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string