Microsoft.Network networkManagers/networkGroups 2023-05-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/networkManagers/networkGroups@2023-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
  }
}

Property Values

Microsoft.Network/networkManagers/networkGroups

NetworkGroupProperties

Usage Examples

Bicep Samples

A basic example of deploying Network Manager Network Group.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource networkManager 'Microsoft.Network/networkManagers@2024-10-01' = {
  name: resourceName
  location: location
  properties: {
    description: ''
    networkManagerScopeAccesses: [
      'Routing'
    ]
    networkManagerScopes: {
      managementGroups: []
      subscriptions: [
        subscription().id
      ]
    }
  }
}

resource networkGroup 'Microsoft.Network/networkManagers/networkGroups@2024-10-01' = {
  name: resourceName
  parent: networkManager
  properties: {
    description: 'example network group'
    memberType: 'VirtualNetwork'
  }
}

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

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

{
  "type": "Microsoft.Network/networkManagers/networkGroups",
  "apiVersion": "2023-05-01",
  "name": "string",
  "properties": {
    "description": "string"
  }
}

Property Values

Microsoft.Network/networkManagers/networkGroups

NetworkGroupProperties

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:

• Resource groups

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@2023-05-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
    }
  }
}

Property Values

Microsoft.Network/networkManagers/networkGroups

NetworkGroupProperties

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    = ["*"]
}