1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. NetworkManager
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.network.NetworkManager

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

The Managed Network resource Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2021-02-01-preview.

Other available API versions: 2021-02-01-preview, 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-01-01-preview, 2024-03-01, 2024-05-01.

Example Usage

Put Network Manager

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var networkManager = new AzureNative.Network.NetworkManager("networkManager", new()
    {
        Description = "My Test Network Manager",
        NetworkManagerName = "TestNetworkManager",
        NetworkManagerScopeAccesses = new[]
        {
            AzureNative.Network.ConfigurationType.Connectivity,
        },
        NetworkManagerScopes = new AzureNative.Network.Inputs.NetworkManagerPropertiesNetworkManagerScopesArgs
        {
            ManagementGroups = new[]
            {
                "/providers/Microsoft.Management/managementGroups/sampleMG",
            },
            Subscriptions = new[]
            {
                "/subscriptions/00000000-0000-0000-0000-000000000000",
            },
        },
        ResourceGroupName = "rg1",
    });

});
Copy
package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewNetworkManager(ctx, "networkManager", &network.NetworkManagerArgs{
			Description:        pulumi.String("My Test Network Manager"),
			NetworkManagerName: pulumi.String("TestNetworkManager"),
			NetworkManagerScopeAccesses: pulumi.StringArray{
				pulumi.String(network.ConfigurationTypeConnectivity),
			},
			NetworkManagerScopes: &network.NetworkManagerPropertiesNetworkManagerScopesArgs{
				ManagementGroups: pulumi.StringArray{
					pulumi.String("/providers/Microsoft.Management/managementGroups/sampleMG"),
				},
				Subscriptions: pulumi.StringArray{
					pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000"),
				},
			},
			ResourceGroupName: pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.NetworkManager;
import com.pulumi.azurenative.network.NetworkManagerArgs;
import com.pulumi.azurenative.network.inputs.NetworkManagerPropertiesNetworkManagerScopesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var networkManager = new NetworkManager("networkManager", NetworkManagerArgs.builder()
            .description("My Test Network Manager")
            .networkManagerName("TestNetworkManager")
            .networkManagerScopeAccesses("Connectivity")
            .networkManagerScopes(NetworkManagerPropertiesNetworkManagerScopesArgs.builder()
                .managementGroups("/providers/Microsoft.Management/managementGroups/sampleMG")
                .subscriptions("/subscriptions/00000000-0000-0000-0000-000000000000")
                .build())
            .resourceGroupName("rg1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const networkManager = new azure_native.network.NetworkManager("networkManager", {
    description: "My Test Network Manager",
    networkManagerName: "TestNetworkManager",
    networkManagerScopeAccesses: [azure_native.network.ConfigurationType.Connectivity],
    networkManagerScopes: {
        managementGroups: ["/providers/Microsoft.Management/managementGroups/sampleMG"],
        subscriptions: ["/subscriptions/00000000-0000-0000-0000-000000000000"],
    },
    resourceGroupName: "rg1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

network_manager = azure_native.network.NetworkManager("networkManager",
    description="My Test Network Manager",
    network_manager_name="TestNetworkManager",
    network_manager_scope_accesses=[azure_native.network.ConfigurationType.CONNECTIVITY],
    network_manager_scopes={
        "management_groups": ["/providers/Microsoft.Management/managementGroups/sampleMG"],
        "subscriptions": ["/subscriptions/00000000-0000-0000-0000-000000000000"],
    },
    resource_group_name="rg1")
Copy
resources:
  networkManager:
    type: azure-native:network:NetworkManager
    properties:
      description: My Test Network Manager
      networkManagerName: TestNetworkManager
      networkManagerScopeAccesses:
        - Connectivity
      networkManagerScopes:
        managementGroups:
          - /providers/Microsoft.Management/managementGroups/sampleMG
        subscriptions:
          - /subscriptions/00000000-0000-0000-0000-000000000000
      resourceGroupName: rg1
Copy

Create NetworkManager Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NetworkManager(name: string, args: NetworkManagerArgs, opts?: CustomResourceOptions);
@overload
def NetworkManager(resource_name: str,
                   args: NetworkManagerArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def NetworkManager(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   network_manager_scope_accesses: Optional[Sequence[Union[str, ConfigurationType]]] = None,
                   network_manager_scopes: Optional[NetworkManagerPropertiesNetworkManagerScopesArgs] = None,
                   resource_group_name: Optional[str] = None,
                   description: Optional[str] = None,
                   id: Optional[str] = None,
                   location: Optional[str] = None,
                   network_manager_name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
func NewNetworkManager(ctx *Context, name string, args NetworkManagerArgs, opts ...ResourceOption) (*NetworkManager, error)
public NetworkManager(string name, NetworkManagerArgs args, CustomResourceOptions? opts = null)
public NetworkManager(String name, NetworkManagerArgs args)
public NetworkManager(String name, NetworkManagerArgs args, CustomResourceOptions options)
type: azure-native:network:NetworkManager
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NetworkManagerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NetworkManagerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkManagerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkManagerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NetworkManagerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var networkManagerResource = new AzureNative.Network.NetworkManager("networkManagerResource", new()
{
    NetworkManagerScopeAccesses = new[]
    {
        "string",
    },
    NetworkManagerScopes = 
    {
        { "managementGroups", new[]
        {
            "string",
        } },
        { "subscriptions", new[]
        {
            "string",
        } },
    },
    ResourceGroupName = "string",
    Description = "string",
    Id = "string",
    Location = "string",
    NetworkManagerName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := network.NewNetworkManager(ctx, "networkManagerResource", &network.NetworkManagerArgs{
	NetworkManagerScopeAccesses: []string{
		"string",
	},
	NetworkManagerScopes: map[string]interface{}{
		"managementGroups": []string{
			"string",
		},
		"subscriptions": []string{
			"string",
		},
	},
	ResourceGroupName:  "string",
	Description:        "string",
	Id:                 "string",
	Location:           "string",
	NetworkManagerName: "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var networkManagerResource = new NetworkManager("networkManagerResource", NetworkManagerArgs.builder()
    .networkManagerScopeAccesses("string")
    .networkManagerScopes(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .description("string")
    .id("string")
    .location("string")
    .networkManagerName("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
network_manager_resource = azure_native.network.NetworkManager("networkManagerResource",
    network_manager_scope_accesses=[string],
    network_manager_scopes={
        managementGroups: [string],
        subscriptions: [string],
    },
    resource_group_name=string,
    description=string,
    id=string,
    location=string,
    network_manager_name=string,
    tags={
        string: string,
    })
Copy
const networkManagerResource = new azure_native.network.NetworkManager("networkManagerResource", {
    networkManagerScopeAccesses: ["string"],
    networkManagerScopes: {
        managementGroups: ["string"],
        subscriptions: ["string"],
    },
    resourceGroupName: "string",
    description: "string",
    id: "string",
    location: "string",
    networkManagerName: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:network:NetworkManager
properties:
    description: string
    id: string
    location: string
    networkManagerName: string
    networkManagerScopeAccesses:
        - string
    networkManagerScopes:
        managementGroups:
            - string
        subscriptions:
            - string
    resourceGroupName: string
    tags:
        string: string
Copy

NetworkManager Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NetworkManager resource accepts the following input properties:

NetworkManagerScopeAccesses This property is required. List<Union<string, Pulumi.AzureNative.Network.ConfigurationType>>
Scope Access.
NetworkManagerScopes This property is required. Pulumi.AzureNative.Network.Inputs.NetworkManagerPropertiesNetworkManagerScopes
Scope of Network Manager.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Description string
A description of the network manager.
Id string
Resource ID.
Location string
Resource location.
NetworkManagerName Changes to this property will trigger replacement. string
The name of the network manager.
Tags Dictionary<string, string>
Resource tags.
NetworkManagerScopeAccesses This property is required. []string
Scope Access.
NetworkManagerScopes This property is required. NetworkManagerPropertiesNetworkManagerScopesArgs
Scope of Network Manager.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Description string
A description of the network manager.
Id string
Resource ID.
Location string
Resource location.
NetworkManagerName Changes to this property will trigger replacement. string
The name of the network manager.
Tags map[string]string
Resource tags.
networkManagerScopeAccesses This property is required. List<Either<String,ConfigurationType>>
Scope Access.
networkManagerScopes This property is required. NetworkManagerPropertiesNetworkManagerScopes
Scope of Network Manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
description String
A description of the network manager.
id String
Resource ID.
location String
Resource location.
networkManagerName Changes to this property will trigger replacement. String
The name of the network manager.
tags Map<String,String>
Resource tags.
networkManagerScopeAccesses This property is required. (string | ConfigurationType)[]
Scope Access.
networkManagerScopes This property is required. NetworkManagerPropertiesNetworkManagerScopes
Scope of Network Manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
description string
A description of the network manager.
id string
Resource ID.
location string
Resource location.
networkManagerName Changes to this property will trigger replacement. string
The name of the network manager.
tags {[key: string]: string}
Resource tags.
network_manager_scope_accesses This property is required. Sequence[Union[str, ConfigurationType]]
Scope Access.
network_manager_scopes This property is required. NetworkManagerPropertiesNetworkManagerScopesArgs
Scope of Network Manager.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
description str
A description of the network manager.
id str
Resource ID.
location str
Resource location.
network_manager_name Changes to this property will trigger replacement. str
The name of the network manager.
tags Mapping[str, str]
Resource tags.
networkManagerScopeAccesses This property is required. List<String | "SecurityAdmin" | "Connectivity">
Scope Access.
networkManagerScopes This property is required. Property Map
Scope of Network Manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
description String
A description of the network manager.
id String
Resource ID.
location String
Resource location.
networkManagerName Changes to this property will trigger replacement. String
The name of the network manager.
tags Map<String>
Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkManager resource produces the following output properties:

Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
The provisioning state of the network manager resource.
ResourceGuid string
Unique identifier for this resource.
SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
The system metadata related to this resource.
Type string
Resource type.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
The provisioning state of the network manager resource.
ResourceGuid string
Unique identifier for this resource.
SystemData SystemDataResponse
The system metadata related to this resource.
Type string
Resource type.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
The provisioning state of the network manager resource.
resourceGuid String
Unique identifier for this resource.
systemData SystemDataResponse
The system metadata related to this resource.
type String
Resource type.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
provisioningState string
The provisioning state of the network manager resource.
resourceGuid string
Unique identifier for this resource.
systemData SystemDataResponse
The system metadata related to this resource.
type string
Resource type.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name.
provisioning_state str
The provisioning state of the network manager resource.
resource_guid str
Unique identifier for this resource.
system_data SystemDataResponse
The system metadata related to this resource.
type str
Resource type.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
The provisioning state of the network manager resource.
resourceGuid String
Unique identifier for this resource.
systemData Property Map
The system metadata related to this resource.
type String
Resource type.

Supporting Types

ConfigurationType
, ConfigurationTypeArgs

SecurityAdmin
SecurityAdmin
Connectivity
Connectivity
ConfigurationTypeSecurityAdmin
SecurityAdmin
ConfigurationTypeConnectivity
Connectivity
SecurityAdmin
SecurityAdmin
Connectivity
Connectivity
SecurityAdmin
SecurityAdmin
Connectivity
Connectivity
SECURITY_ADMIN
SecurityAdmin
CONNECTIVITY
Connectivity
"SecurityAdmin"
SecurityAdmin
"Connectivity"
Connectivity

CrossTenantScopesResponse
, CrossTenantScopesResponseArgs

ManagementGroups This property is required. List<string>
List of management groups.
Subscriptions This property is required. List<string>
List of subscriptions.
TenantId This property is required. string
Tenant ID.
ManagementGroups This property is required. []string
List of management groups.
Subscriptions This property is required. []string
List of subscriptions.
TenantId This property is required. string
Tenant ID.
managementGroups This property is required. List<String>
List of management groups.
subscriptions This property is required. List<String>
List of subscriptions.
tenantId This property is required. String
Tenant ID.
managementGroups This property is required. string[]
List of management groups.
subscriptions This property is required. string[]
List of subscriptions.
tenantId This property is required. string
Tenant ID.
management_groups This property is required. Sequence[str]
List of management groups.
subscriptions This property is required. Sequence[str]
List of subscriptions.
tenant_id This property is required. str
Tenant ID.
managementGroups This property is required. List<String>
List of management groups.
subscriptions This property is required. List<String>
List of subscriptions.
tenantId This property is required. String
Tenant ID.

NetworkManagerPropertiesNetworkManagerScopes
, NetworkManagerPropertiesNetworkManagerScopesArgs

ManagementGroups List<string>
List of management groups.
Subscriptions List<string>
List of subscriptions.
ManagementGroups []string
List of management groups.
Subscriptions []string
List of subscriptions.
managementGroups List<String>
List of management groups.
subscriptions List<String>
List of subscriptions.
managementGroups string[]
List of management groups.
subscriptions string[]
List of subscriptions.
management_groups Sequence[str]
List of management groups.
subscriptions Sequence[str]
List of subscriptions.
managementGroups List<String>
List of management groups.
subscriptions List<String>
List of subscriptions.

NetworkManagerPropertiesResponseNetworkManagerScopes
, NetworkManagerPropertiesResponseNetworkManagerScopesArgs

CrossTenantScopes This property is required. List<Pulumi.AzureNative.Network.Inputs.CrossTenantScopesResponse>
List of cross tenant scopes.
ManagementGroups List<string>
List of management groups.
Subscriptions List<string>
List of subscriptions.
CrossTenantScopes This property is required. []CrossTenantScopesResponse
List of cross tenant scopes.
ManagementGroups []string
List of management groups.
Subscriptions []string
List of subscriptions.
crossTenantScopes This property is required. List<CrossTenantScopesResponse>
List of cross tenant scopes.
managementGroups List<String>
List of management groups.
subscriptions List<String>
List of subscriptions.
crossTenantScopes This property is required. CrossTenantScopesResponse[]
List of cross tenant scopes.
managementGroups string[]
List of management groups.
subscriptions string[]
List of subscriptions.
cross_tenant_scopes This property is required. Sequence[CrossTenantScopesResponse]
List of cross tenant scopes.
management_groups Sequence[str]
List of management groups.
subscriptions Sequence[str]
List of subscriptions.
crossTenantScopes This property is required. List<Property Map>
List of cross tenant scopes.
managementGroups List<String>
List of management groups.
subscriptions List<String>
List of subscriptions.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The type of identity that last modified the resource.
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The type of identity that last modified the resource.
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:NetworkManager TestNetworkManager /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi