Share via


Express Route Circuit Connections - Create Or Update

Creates or updates a Express Route Circuit Connection in the specified express route circuits.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}?api-version=2024-05-01

URI Parameters

Name In Required Type Description
circuitName
path True

string

The name of the express route circuit.

connectionName
path True

string

The name of the express route circuit connection.

peeringName
path True

string

The name of the peering.

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.

Request Body

Name Type Description
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.addressPrefix

string

/29 IP address space to carve out Customer addresses for tunnels.

properties.authorizationKey

string

The authorization key.

properties.expressRouteCircuitPeering

SubResource

Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.

properties.ipv6CircuitConnectionConfig

Ipv6CircuitConnectionConfig

IPv6 Address PrefixProperties of the express route circuit connection.

properties.peerExpressRouteCircuitPeering

SubResource

Reference to Express Route Circuit Private Peering Resource of the peered circuit.

Responses

Name Type Description
200 OK

ExpressRouteCircuitConnection

Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.

201 Created

ExpressRouteCircuitConnection

Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.

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

ExpressRouteCircuitConnectionCreate

Sample request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS?api-version=2024-05-01

{
  "properties": {
    "expressRouteCircuitPeering": {
      "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"
    },
    "peerExpressRouteCircuitPeering": {
      "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"
    },
    "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a",
    "addressPrefix": "10.0.0.0/29",
    "ipv6CircuitConnectionConfig": {
      "addressPrefix": "aa:bb::/125"
    }
  }
}

Sample response

{
  "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "name": "circuitConnectionUSAUS",
  "properties": {
    "expressRouteCircuitPeering": {
      "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"
    },
    "peerExpressRouteCircuitPeering": {
      "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"
    },
    "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a",
    "addressPrefix": "10.0.0.0/24",
    "circuitConnectionStatus": "Connected",
    "provisioningState": "Succeeded",
    "ipv6CircuitConnectionConfig": {
      "addressPrefix": "aa:bb::1/125",
      "circuitConnectionStatus": "Connected"
    }
  }
}
{
  "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "name": "circuitConnectionUSAUS",
  "properties": {
    "expressRouteCircuitPeering": {
      "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"
    },
    "peerExpressRouteCircuitPeering": {
      "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"
    },
    "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a",
    "addressPrefix": "10.0.0.0/24",
    "circuitConnectionStatus": "Connected",
    "provisioningState": "Succeeded",
    "ipv6CircuitConnectionConfig": {
      "addressPrefix": "aa:bb::1/125",
      "circuitConnectionStatus": "Connected"
    }
  }
}

Definitions

Name Description
CircuitConnectionStatus

Express Route Circuit connection state.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ExpressRouteCircuitConnection

Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

Ipv6CircuitConnectionConfig

IPv6 Circuit Connection properties for global reach.

ProvisioningState

The current provisioning state.

SubResource

Reference to another subresource.

CircuitConnectionStatus

Express Route Circuit connection state.

Value Description
Connected
Connecting
Disconnected

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.

ExpressRouteCircuitConnection

Express Route Circuit Connection in an ExpressRouteCircuitPeering 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.addressPrefix

string

/29 IP address space to carve out Customer addresses for tunnels.

properties.authorizationKey

string

The authorization key.

properties.circuitConnectionStatus

CircuitConnectionStatus

Express Route Circuit connection state.

properties.expressRouteCircuitPeering

SubResource

Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.

properties.ipv6CircuitConnectionConfig

Ipv6CircuitConnectionConfig

IPv6 Address PrefixProperties of the express route circuit connection.

properties.peerExpressRouteCircuitPeering

SubResource

Reference to Express Route Circuit Private Peering Resource of the peered circuit.

properties.provisioningState

ProvisioningState

The provisioning state of the express route circuit connection resource.

type

string

Type of the resource.

Ipv6CircuitConnectionConfig

IPv6 Circuit Connection properties for global reach.

Name Type Description
addressPrefix

string

/125 IP address space to carve out customer addresses for global reach.

circuitConnectionStatus

CircuitConnectionStatus

Express Route Circuit connection state.

ProvisioningState

The current provisioning state.

Value Description
Succeeded
Updating
Deleting
Failed

SubResource

Reference to another subresource.

Name Type Description
id

string

Resource ID.