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 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkManagers@2022-11-01' = {
scope: resourceSymbolicName or scope
___location: 'string'
name: 'string'
properties: {
description: 'string'
networkManagerScopeAccesses: [
'string'
]
networkManagerScopes: {
managementGroups: [
'string'
]
subscriptions: [
'string'
]
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Network/networkManagers
| Name | Description | Value |
|---|---|---|
| ___location | Resource ___location. | string |
| name | The resource name | string (required) |
| properties | The network manager properties | NetworkManagerProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
NetworkManagerProperties
| Name | Description | Value |
|---|---|---|
| description | A description of the network manager. | string |
| networkManagerScopeAccesses | Scope Access. | String array containing any of: 'Connectivity' 'SecurityAdmin' (required) |
| networkManagerScopes | Scope of Network Manager. | NetworkManagerPropertiesNetworkManagerScopes (required) |
NetworkManagerPropertiesNetworkManagerScopes
| Name | Description | Value |
|---|---|---|
| managementGroups | List of management groups. | string[] |
| subscriptions | List of subscriptions. | string[] |
ResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Network Manager | AVM Resource Module for Network Manager |
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 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 resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkManagers",
"apiVersion": "2022-11-01",
"name": "string",
"___location": "string",
"properties": {
"description": "string",
"networkManagerScopeAccesses": [ "string" ],
"networkManagerScopes": {
"managementGroups": [ "string" ],
"subscriptions": [ "string" ]
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Network/networkManagers
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-11-01' |
| ___location | Resource ___location. | string |
| name | The resource name | string (required) |
| properties | The network manager properties | NetworkManagerProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Network/networkManagers' |
NetworkManagerProperties
| Name | Description | Value |
|---|---|---|
| description | A description of the network manager. | string |
| networkManagerScopeAccesses | Scope Access. | String array containing any of: 'Connectivity' 'SecurityAdmin' (required) |
| networkManagerScopes | Scope of Network Manager. | NetworkManagerPropertiesNetworkManagerScopes (required) |
NetworkManagerPropertiesNetworkManagerScopes
| Name | Description | Value |
|---|---|---|
| managementGroups | List of management groups. | string[] |
| subscriptions | List of subscriptions. | string[] |
ResourceTags
| Name | Description | Value |
|---|
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 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkManagers@2022-11-01"
name = "string"
parent_id = "string"
___location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
description = "string"
networkManagerScopeAccesses = [
"string"
]
networkManagerScopes = {
managementGroups = [
"string"
]
subscriptions = [
"string"
]
}
}
}
}
Property Values
Microsoft.Network/networkManagers
| Name | Description | Value |
|---|---|---|
| ___location | Resource ___location. | string |
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | The network manager properties | NetworkManagerProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Network/networkManagers@2022-11-01" |
NetworkManagerProperties
| Name | Description | Value |
|---|---|---|
| description | A description of the network manager. | string |
| networkManagerScopeAccesses | Scope Access. | String array containing any of: 'Connectivity' 'SecurityAdmin' (required) |
| networkManagerScopes | Scope of Network Manager. | NetworkManagerPropertiesNetworkManagerScopes (required) |
NetworkManagerPropertiesNetworkManagerScopes
| Name | Description | Value |
|---|---|---|
| managementGroups | List of management groups. | string[] |
| subscriptions | List of subscriptions. | string[] |
ResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform Samples
A basic example of deploying Network Manager.
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",
]
networkManagerScopes = {
managementGroups = [
]
subscriptions = [
data.azapi_resource.subscription.id,
]
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Virtual Network Manager | AVM Resource Module for Azure Virtual Network Manager |