Share via

Microsoft.Network networkManagers/connectivityConfigurations 2025-01-01

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@2025-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    appliesToGroups: [
      {
        groupConnectivity: 'string'
        isGlobal: 'string'
        networkGroupId: 'string'
        useHubGateway: 'string'
      }
    ]
    connectivityCapabilities: {
      connectedGroupAddressOverlap: 'string'
      connectedGroupPrivateEndpointsScale: 'string'
      peeringEnforcement: 'string'
    }
    connectivityTopology: 'string'
    deleteExistingPeering: 'string'
    description: 'string'
    hubs: [
      {
        resourceId: 'string'
        resourceType: 'string'
      }
    ]
    isGlobal: 'string'
  }
}

Property Values

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

ConnectivityConfigurationProperties

Name Description Value
appliesToGroups Groups for configuration ConnectivityGroupItem[] (required)
connectivityCapabilities Collection of additional settings to enhance specific topology behaviors of the connectivity configuration resource. ConnectivityConfigurationPropertiesConnectivityCapabilities
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'

ConnectivityConfigurationPropertiesConnectivityCapabilities

Name Description Value
connectedGroupAddressOverlap Behavior to handle overlapped IP address space among members of the connected group of the connectivity configuration. 'Allowed'
'Disallowed' (required)
connectedGroupPrivateEndpointsScale Option indicating the scale of private endpoints allowed in the connected group of the connectivity configuration. 'HighScale'
'Standard' (required)
peeringEnforcement Option indicating enforcement of peerings created by the connectivity configuration. 'Enforced'
'Unenforced' (required)

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

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying 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:

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": "2025-01-01",
  "name": "string",
  "properties": {
    "appliesToGroups": [
      {
        "groupConnectivity": "string",
        "isGlobal": "string",
        "networkGroupId": "string",
        "useHubGateway": "string"
      }
    ],
    "connectivityCapabilities": {
      "connectedGroupAddressOverlap": "string",
      "connectedGroupPrivateEndpointsScale": "string",
      "peeringEnforcement": "string"
    },
    "connectivityTopology": "string",
    "deleteExistingPeering": "string",
    "description": "string",
    "hubs": [
      {
        "resourceId": "string",
        "resourceType": "string"
      }
    ],
    "isGlobal": "string"
  }
}

Property Values

Microsoft.Network/networkManagers/connectivityConfigurations

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

ConnectivityConfigurationProperties

Name Description Value
appliesToGroups Groups for configuration ConnectivityGroupItem[] (required)
connectivityCapabilities Collection of additional settings to enhance specific topology behaviors of the connectivity configuration resource. ConnectivityConfigurationPropertiesConnectivityCapabilities
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'

ConnectivityConfigurationPropertiesConnectivityCapabilities

Name Description Value
connectedGroupAddressOverlap Behavior to handle overlapped IP address space among members of the connected group of the connectivity configuration. 'Allowed'
'Disallowed' (required)
connectedGroupPrivateEndpointsScale Option indicating the scale of private endpoints allowed in the connected group of the connectivity configuration. 'HighScale'
'Standard' (required)
peeringEnforcement Option indicating enforcement of peerings created by the connectivity configuration. 'Enforced'
'Unenforced' (required)

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

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create an Azure Virtual Network Manager and sample VNETs

Deploy to Azure		 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:

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@2025-01-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      appliesToGroups = [
        {
          groupConnectivity = "string"
          isGlobal = "string"
          networkGroupId = "string"
          useHubGateway = "string"
        }
      ]
      connectivityCapabilities = {
        connectedGroupAddressOverlap = "string"
        connectedGroupPrivateEndpointsScale = "string"
        peeringEnforcement = "string"
      }
      connectivityTopology = "string"
      deleteExistingPeering = "string"
      description = "string"
      hubs = [
        {
          resourceId = "string"
          resourceType = "string"
        }
      ]
      isGlobal = "string"
    }
  }
}

Property Values

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@2025-01-01"

ConnectivityConfigurationProperties

Name Description Value
appliesToGroups Groups for configuration ConnectivityGroupItem[] (required)
connectivityCapabilities Collection of additional settings to enhance specific topology behaviors of the connectivity configuration resource. ConnectivityConfigurationPropertiesConnectivityCapabilities
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'

ConnectivityConfigurationPropertiesConnectivityCapabilities

Name Description Value
connectedGroupAddressOverlap Behavior to handle overlapped IP address space among members of the connected group of the connectivity configuration. 'Allowed'
'Disallowed' (required)
connectedGroupPrivateEndpointsScale Option indicating the scale of private endpoints allowed in the connected group of the connectivity configuration. 'HighScale'
'Standard' (required)
peeringEnforcement Option indicating enforcement of peerings created by the connectivity configuration. 'Enforced'
'Unenforced' (required)

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

Usage Examples

Terraform Samples

A basic example of deploying Network Manager Connectivity Configuration.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westeurope"
}

data "azurerm_client_config" "current" {
}

data "azapi_resource" "subscription" {
  type                   = "Microsoft.Resources/subscriptions@2021-01-01"
  resource_id            = "/subscriptions/${data.azurerm_client_config.current.subscription_id}"
  response_export_values = ["*"]
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "networkManager" {
  type      = "Microsoft.Network/networkManagers@2022-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      description = ""
      networkManagerScopeAccesses = [
        "SecurityAdmin",
        "Connectivity",
      ]
      networkManagerScopes = {
        managementGroups = [
        ]
        subscriptions = [
          data.azapi_resource.subscription.id,
        ]
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "virtualNetwork" {
  type      = "Microsoft.Network/virtualNetworks@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "10.0.0.0/16",
        ]
      }
      dhcpOptions = {
        dnsServers = [
        ]
      }
      flowTimeoutInMinutes = 10
      subnets = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.subnets]
  }
}

resource "azapi_resource" "networkGroup" {
  type      = "Microsoft.Network/networkManagers/networkGroups@2022-09-01"
  parent_id = azapi_resource.networkManager.id
  name      = var.resource_name
  body = {
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "connectivityConfiguration" {
  type      = "Microsoft.Network/networkManagers/connectivityConfigurations@2022-09-01"
  parent_id = azapi_resource.networkManager.id
  name      = var.resource_name
  body = {
    properties = {
      appliesToGroups = [
        {
          groupConnectivity = "None"
          isGlobal          = "False"
          networkGroupId    = azapi_resource.networkGroup.id
          useHubGateway     = "False"
        },
      ]
      connectivityTopology  = "HubAndSpoke"
      deleteExistingPeering = "False"
      hubs = [
        {
          resourceId   = azapi_resource.virtualNetwork.id
          resourceType = azapi_resource.virtualNetwork.output.type
        },
      ]
      isGlobal = "False"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}