Microsoft.Network networkManagers/connectivityConfigurations

• Latest
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-04-01-preview
• 2022-02-01-preview
• 2022-01-01
• 2021-05-01-preview
• 2021-02-01-preview

Bicep resource definition

The networkManagers/connectivityConfigurations resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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@2024-03-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

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

Microsoft.Network/networkManagers/connectivityConfigurations

Name	Description	Value
name	The resource name	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

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create an Azure Virtual Network Manager and sample VNETs	This template deploys an Azure Virtual Network Manager and sample virtual networks into the named resource group. It supports multiple connectivity topologies and network group membership types.

ARM template resource definition

The networkManagers/connectivityConfigurations resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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": "2024-03-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

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

Microsoft.Network/networkManagers/connectivityConfigurations

Name	Description	Value
apiVersion	The api version	'2024-03-01'
name	The resource name	string (required)
properties	Properties of a network manager connectivity configuration	ConnectivityConfigurationProperties
type	The resource type	'Microsoft.Network/networkManagers/connectivityConfigurations'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create an Azure Virtual Network Manager and sample VNETs	This template deploys an Azure Virtual Network Manager and sample virtual networks into the named resource group. It supports multiple connectivity topologies and network group membership types.

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@2024-03-01"
  name = "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

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

Microsoft.Network/networkManagers/connectivityConfigurations

Name	Description	Value
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
type	The resource type	"Microsoft.Network/networkManagers/connectivityConfigurations@2024-03-01"