Share via

Microsoft.AVS privateClouds/globalReachConnections

Bicep resource definition

The privateClouds/globalReachConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/globalReachConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AVS/privateClouds/globalReachConnections@2024-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authorizationKey: 'string'
    expressRouteId: 'string'
    peerExpressRouteCircuit: 'string'
  }
}

Property Values

Microsoft.AVS/privateClouds/globalReachConnections

Name Description Value
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: privateClouds
properties The resource-specific properties for this resource. GlobalReachConnectionProperties

GlobalReachConnectionProperties

Name Description Value
authorizationKey Authorization key from the peer express route used for the global reach
connection		 string
expressRouteId The ID of the Private Cloud's ExpressRoute Circuit that is participating in the
global reach connection		 string
peerExpressRouteCircuit Identifier of the ExpressRoute Circuit to peer with in the global reach
connection		 string

ARM template resource definition

The privateClouds/globalReachConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/globalReachConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.AVS/privateClouds/globalReachConnections",
  "apiVersion": "2024-09-01",
  "name": "string",
  "properties": {
    "authorizationKey": "string",
    "expressRouteId": "string",
    "peerExpressRouteCircuit": "string"
  }
}

Property Values

Microsoft.AVS/privateClouds/globalReachConnections

Name Description Value
apiVersion The api version '2024-09-01'
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
properties The resource-specific properties for this resource. GlobalReachConnectionProperties
type The resource type 'Microsoft.AVS/privateClouds/globalReachConnections'

GlobalReachConnectionProperties

Name Description Value
authorizationKey Authorization key from the peer express route used for the global reach
connection		 string
expressRouteId The ID of the Private Cloud's ExpressRoute Circuit that is participating in the
global reach connection		 string
peerExpressRouteCircuit Identifier of the ExpressRoute Circuit to peer with in the global reach
connection		 string

Usage Examples

Terraform (AzAPI provider) resource definition

The privateClouds/globalReachConnections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/globalReachConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AVS/privateClouds/globalReachConnections@2024-09-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      authorizationKey = "string"
      expressRouteId = "string"
      peerExpressRouteCircuit = "string"
    }
  }
}

Property Values

Microsoft.AVS/privateClouds/globalReachConnections

Name Description Value
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: privateClouds
properties The resource-specific properties for this resource. GlobalReachConnectionProperties
type The resource type "Microsoft.AVS/privateClouds/globalReachConnections@2024-09-01"

GlobalReachConnectionProperties

Name Description Value
authorizationKey Authorization key from the peer express route used for the global reach
connection		 string
expressRouteId The ID of the Private Cloud's ExpressRoute Circuit that is participating in the
global reach connection		 string
peerExpressRouteCircuit Identifier of the ExpressRoute Circuit to peer with in the global reach
connection		 string