Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The networkManagers/networkGroups 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/networkGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkManagers/networkGroups@2025-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
memberType: 'string'
}
}
Property Values
Microsoft.Network/networkManagers/networkGroups
| 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 | The Network Group properties | NetworkGroupProperties |
NetworkGroupProperties
| Name | Description | Value |
|---|---|---|
| description | A description of the network group. | string |
| memberType | The type of the group member. | 'Subnet' 'VirtualNetwork' |
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/networkGroups 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/networkGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkManagers/networkGroups",
"apiVersion": "2025-01-01",
"name": "string",
"properties": {
"description": "string",
"memberType": "string"
}
}
Property Values
Microsoft.Network/networkManagers/networkGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-01-01' |
| name | The resource name | string (required) |
| properties | The Network Group properties | NetworkGroupProperties |
| type | The resource type | 'Microsoft.Network/networkManagers/networkGroups' |
NetworkGroupProperties
| Name | Description | Value |
|---|---|---|
| description | A description of the network group. | string |
| memberType | The type of the group member. | 'Subnet' 'VirtualNetwork' |
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 |
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/networkGroups 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/networkGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkManagers/networkGroups@2025-01-01"
name = "string"
parent_id = "string"
body = {
properties = {
description = "string"
memberType = "string"
}
}
}
Property Values
Microsoft.Network/networkManagers/networkGroups
| 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 | The Network Group properties | NetworkGroupProperties |
| type | The resource type | "Microsoft.Network/networkManagers/networkGroups@2025-01-01" |
NetworkGroupProperties
| Name | Description | Value |
|---|---|---|
| description | A description of the network group. | string |
| memberType | The type of the group member. | 'Subnet' 'VirtualNetwork' |
Usage Examples
Terraform Samples
A basic example of deploying Network Manager Network Group.
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@2024-10-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
___location = var.___location
body = {
properties = {
description = ""
networkManagerScopeAccesses = [
"Routing",
]
networkManagerScopes = {
managementGroups = [
]
subscriptions = [
data.azapi_resource.subscription.id,
]
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "networkGroup" {
type = "Microsoft.Network/networkManagers/networkGroups@2024-10-01"
parent_id = azapi_resource.networkManager.id
name = var.resource_name
body = {
properties = {
description = "example network group"
memberType = "VirtualNetwork"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}