Microsoft.Network networkManagers/connectivityConfigurations

  • Article

Bicep resource definition

The networkManagers/connectivityConfigurations 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.Network/networkManagers/connectivityConfigurations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/networkManagers/connectivityConfigurations@2023-04-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    appliesToGroups: [
      {
        groupConnectivity: 'string'
        isGlobal: 'string'
        networkGroupId: 'string'
        useHubGateway: 'string'
      }
    ]
    connectivityTopology: 'string'
    deleteExistingPeering: 'string'
    description: 'string'
    hubs: [
      {
        resourceId: 'string'
        resourceType: 'string'
      }
    ]
    isGlobal: 'string'
  }
}

Property values

networkManagers/connectivityConfigurations

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: networkManagers
properties Properties of a network manager connectivity configuration ConnectivityConfigurationProperties

ConnectivityConfigurationProperties

Name Description Value
appliesToGroups Groups for configuration ConnectivityGroupItem[] (required)
connectivityTopology Connectivity topology type. 'HubAndSpoke'
'Mesh' (required)
deleteExistingPeering Flag if need to remove current existing peerings. 'False'
'True'
description A description of the connectivity configuration. string
hubs List of hubItems Hub[]
isGlobal Flag if global mesh is supported. 'False'
'True'

ConnectivityGroupItem

Name Description Value
groupConnectivity Group connectivity type. 'DirectlyConnected'
'None' (required)
isGlobal Flag if global is supported. 'False'
'True'
networkGroupId Network group Id. string (required)
useHubGateway Flag if need to use hub gateway. 'False'
'True'

Hub

Name Description Value
resourceId Resource Id. string
resourceType Resource Type. string

ARM template resource definition

The networkManagers/connectivityConfigurations 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.Network/networkManagers/connectivityConfigurations resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/networkManagers/connectivityConfigurations",
  "apiVersion": "2023-04-01",
  "name": "string",
  "properties": {
    "appliesToGroups": [
      {
        "groupConnectivity": "string",
        "isGlobal": "string",
        "networkGroupId": "string",
        "useHubGateway": "string"
      }
    ],
    "connectivityTopology": "string",
    "deleteExistingPeering": "string",
    "description": "string",
    "hubs": [
      {
        "resourceId": "string",
        "resourceType": "string"
      }
    ],
    "isGlobal": "string"
  }
}

Property values

networkManagers/connectivityConfigurations

Name Description Value
type The resource type 'Microsoft.Network/networkManagers/connectivityConfigurations'
apiVersion The resource api version '2023-04-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Properties of a network manager connectivity configuration ConnectivityConfigurationProperties

ConnectivityConfigurationProperties

Name Description Value
appliesToGroups Groups for configuration ConnectivityGroupItem[] (required)
connectivityTopology Connectivity topology type. 'HubAndSpoke'
'Mesh' (required)
deleteExistingPeering Flag if need to remove current existing peerings. 'False'
'True'
description A description of the connectivity configuration. string
hubs List of hubItems Hub[]
isGlobal Flag if global mesh is supported. 'False'
'True'

ConnectivityGroupItem

Name Description Value
groupConnectivity Group connectivity type. 'DirectlyConnected'
'None' (required)
isGlobal Flag if global is supported. 'False'
'True'
networkGroupId Network group Id. string (required)
useHubGateway Flag if need to use hub gateway. 'False'
'True'

Hub

Name Description Value
resourceId Resource Id. string
resourceType Resource Type. string

Terraform (AzAPI provider) resource definition

The networkManagers/connectivityConfigurations 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.Network/networkManagers/connectivityConfigurations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkManagers/connectivityConfigurations@2023-04-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appliesToGroups = [
        {
          groupConnectivity = "string"
          isGlobal = "string"
          networkGroupId = "string"
          useHubGateway = "string"
        }
      ]
      connectivityTopology = "string"
      deleteExistingPeering = "string"
      description = "string"
      hubs = [
        {
          resourceId = "string"
          resourceType = "string"
        }
      ]
      isGlobal = "string"
    }
  })
}

Property values

networkManagers/connectivityConfigurations

Name Description Value
type The resource type "Microsoft.Network/networkManagers/connectivityConfigurations@2023-04-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: networkManagers
properties Properties of a network manager connectivity configuration ConnectivityConfigurationProperties

ConnectivityConfigurationProperties

Name Description Value
appliesToGroups Groups for configuration ConnectivityGroupItem[] (required)
connectivityTopology Connectivity topology type. "HubAndSpoke"
"Mesh" (required)
deleteExistingPeering Flag if need to remove current existing peerings. "False"
"True"
description A description of the connectivity configuration. string
hubs List of hubItems Hub[]
isGlobal Flag if global mesh is supported. "False"
"True"

ConnectivityGroupItem

Name Description Value
groupConnectivity Group connectivity type. "DirectlyConnected"
"None" (required)
isGlobal Flag if global is supported. "False"
"True"
networkGroupId Network group Id. string (required)
useHubGateway Flag if need to use hub gateway. "False"
"True"

Hub

Name Description Value
resourceId Resource Id. string
resourceType Resource Type. string