Microsoft.AVS privateClouds/globalReachConnections

  • Article

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@2022-05-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authorizationKey: 'string'
    expressRouteId: 'string'
    peerExpressRouteCircuit: 'string'
  }
}

Property values

privateClouds/globalReachConnections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (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 properties of a global reach connection 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": "2022-05-01",
  "name": "string",
  "properties": {
    "authorizationKey": "string",
    "expressRouteId": "string",
    "peerExpressRouteCircuit": "string"
  }
}

Property values

privateClouds/globalReachConnections

Name Description Value
type The resource type 'Microsoft.AVS/privateClouds/globalReachConnections'
apiVersion The resource api version '2022-05-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties The properties of a global reach connection 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

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@2022-05-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authorizationKey = "string"
      expressRouteId = "string"
      peerExpressRouteCircuit = "string"
    }
  })
}

Property values

privateClouds/globalReachConnections

Name Description Value
type The resource type "Microsoft.AVS/privateClouds/globalReachConnections@2022-05-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: privateClouds
properties The properties of a global reach connection 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