Share via

Microsoft.Network networkManagers 2021-02-01-preview

  • Article

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@2021-02-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    displayName: '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
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
displayName A friendly name for the network manager. string
networkManagerScopeAccesses Scope Access. String array containing any of:
'Connectivity'
'SecurityAdmin'
'SecurityUser'
networkManagerScopes Scope of Network Manager. NetworkManagerPropertiesNetworkManagerScopes

NetworkManagerPropertiesNetworkManagerScopes

Name Description Value
managementGroups List of management groups. string[]
subscriptions List of subscriptions. string[]

ResourceTags

Name Description Value

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 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": "2021-02-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "networkManagerScopeAccesses": [ "string" ],
    "networkManagerScopes": {
      "managementGroups": [ "string" ],
      "subscriptions": [ "string" ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.Network/networkManagers

Name Description Value
apiVersion The api version '2021-02-01-preview'
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
displayName A friendly name for the network manager. string
networkManagerScopeAccesses Scope Access. String array containing any of:
'Connectivity'
'SecurityAdmin'
'SecurityUser'
networkManagerScopes Scope of Network Manager. NetworkManagerPropertiesNetworkManagerScopes

NetworkManagerPropertiesNetworkManagerScopes

Name Description Value
managementGroups List of management groups. string[]
subscriptions List of subscriptions. string[]

ResourceTags

Name Description Value

Quickstart templates

The following 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 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkManagers@2021-02-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "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)
properties The network manager properties NetworkManagerProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/networkManagers@2021-02-01-preview"

NetworkManagerProperties

Name Description Value
description A description of the network manager. string
displayName A friendly name for the network manager. string
networkManagerScopeAccesses Scope Access. String array containing any of:
'Connectivity'
'SecurityAdmin'
'SecurityUser'
networkManagerScopes Scope of Network Manager. NetworkManagerPropertiesNetworkManagerScopes

NetworkManagerPropertiesNetworkManagerScopes

Name Description Value
managementGroups List of management groups. string[]
subscriptions List of subscriptions. string[]

ResourceTags

Name Description Value