Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. network
  5. NetworkManager
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.NetworkManager

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    The Managed Network resource API Version: 2021-02-01-preview.

    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",
        DisplayName = "TestNetworkManager",
        NetworkManagerName = "TestNetworkManager",
        NetworkManagerScopeAccesses = new[]
        {
            "Connectivity",
        },
        NetworkManagerScopes = new AzureNative.Network.Inputs.NetworkManagerPropertiesNetworkManagerScopesArgs
        {
            ManagementGroups = new[]
            {
                "/Microsoft.Management/testmg",
            },
            Subscriptions = new[]
            {
                "/subscriptions/00000000-0000-0000-0000-000000000000",
            },
        },
        ResourceGroupName = "rg1",
    });

});

    package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network"
	"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"),
			DisplayName:        pulumi.String("TestNetworkManager"),
			NetworkManagerName: pulumi.String("TestNetworkManager"),
			NetworkManagerScopeAccesses: pulumi.StringArray{
				pulumi.String("Connectivity"),
			},
			NetworkManagerScopes: &network.NetworkManagerPropertiesNetworkManagerScopesArgs{
				ManagementGroups: pulumi.StringArray{
					pulumi.String("/Microsoft.Management/testmg"),
				},
				Subscriptions: pulumi.StringArray{
					pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000"),
				},
			},
			ResourceGroupName: pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 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")
            .displayName("TestNetworkManager")
            .networkManagerName("TestNetworkManager")
            .networkManagerScopeAccesses("Connectivity")
            .networkManagerScopes(Map.ofEntries(
                Map.entry("managementGroups", "/Microsoft.Management/testmg"),
                Map.entry("subscriptions", "/subscriptions/00000000-0000-0000-0000-000000000000")
            ))
            .resourceGroupName("rg1")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

network_manager = azure_native.network.NetworkManager("networkManager",
    description="My Test Network Manager",
    display_name="TestNetworkManager",
    network_manager_name="TestNetworkManager",
    network_manager_scope_accesses=["Connectivity"],
    network_manager_scopes=azure_native.network.NetworkManagerPropertiesNetworkManagerScopesArgs(
        management_groups=["/Microsoft.Management/testmg"],
        subscriptions=["/subscriptions/00000000-0000-0000-0000-000000000000"],
    ),
    resource_group_name="rg1")

    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",
    displayName: "TestNetworkManager",
    networkManagerName: "TestNetworkManager",
    networkManagerScopeAccesses: ["Connectivity"],
    networkManagerScopes: {
        managementGroups: ["/Microsoft.Management/testmg"],
        subscriptions: ["/subscriptions/00000000-0000-0000-0000-000000000000"],
    },
    resourceGroupName: "rg1",
});

    resources:
  networkManager:
    type: azure-native:network:NetworkManager
    properties:
      description: My Test Network Manager
      displayName: TestNetworkManager
      networkManagerName: TestNetworkManager
      networkManagerScopeAccesses:
        - Connectivity
      networkManagerScopes:
        managementGroups:
          - /Microsoft.Management/testmg
        subscriptions:
          - /subscriptions/00000000-0000-0000-0000-000000000000
      resourceGroupName: rg1

    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,
                   resource_group_name: Optional[str] = None,
                   description: Optional[str] = None,
                   display_name: Optional[str] = None,
                   id: Optional[str] = None,
                   location: Optional[str] = None,
                   network_manager_name: Optional[str] = None,
                   network_manager_scope_accesses: Optional[Sequence[Union[str, ConfigurationType]]] = None,
                   network_manager_scopes: Optional[NetworkManagerPropertiesNetworkManagerScopesArgs] = 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 string
    The unique name of the resource.
    args NetworkManagerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args NetworkManagerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkManagerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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()
{
    ResourceGroupName = "string",
    Description = "string",
    DisplayName = "string",
    Id = "string",
    Location = "string",
    NetworkManagerName = "string",
    NetworkManagerScopeAccesses = new[]
    {
        "string",
    },
    NetworkManagerScopes = 
    {
        { "managementGroups", new[]
        {
            "string",
        } },
        { "subscriptions", new[]
        {
            "string",
        } },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := network.NewNetworkManager(ctx, "networkManagerResource", &network.NetworkManagerArgs{
	ResourceGroupName:  "string",
	Description:        "string",
	DisplayName:        "string",
	Id:                 "string",
	Location:           "string",
	NetworkManagerName: "string",
	NetworkManagerScopeAccesses: []string{
		"string",
	},
	NetworkManagerScopes: map[string]interface{}{
		"managementGroups": []string{
			"string",
		},
		"subscriptions": []string{
			"string",
		},
	},
	Tags: map[string]interface{}{
		"string": "string",
	},
})

    var networkManagerResource = new NetworkManager("networkManagerResource", NetworkManagerArgs.builder()
    .resourceGroupName("string")
    .description("string")
    .displayName("string")
    .id("string")
    .location("string")
    .networkManagerName("string")
    .networkManagerScopeAccesses("string")
    .networkManagerScopes(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    network_manager_resource = azure_native.network.NetworkManager("networkManagerResource",
    resource_group_name=string,
    description=string,
    display_name=string,
    id=string,
    location=string,
    network_manager_name=string,
    network_manager_scope_accesses=[string],
    network_manager_scopes={
        managementGroups: [string],
        subscriptions: [string],
    },
    tags={
        string: string,
    })

    const networkManagerResource = new azure_native.network.NetworkManager("networkManagerResource", {
    resourceGroupName: "string",
    description: "string",
    displayName: "string",
    id: "string",
    location: "string",
    networkManagerName: "string",
    networkManagerScopeAccesses: ["string"],
    networkManagerScopes: {
        managementGroups: ["string"],
        subscriptions: ["string"],
    },
    tags: {
        string: "string",
    },
});

    type: azure-native:network:NetworkManager
properties:
    description: string
    displayName: string
    id: string
    location: string
    networkManagerName: string
    networkManagerScopeAccesses:
        - string
    networkManagerScopes:
        managementGroups:
            - string
        subscriptions:
            - string
    resourceGroupName: string
    tags:
        string: string

    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:

    ResourceGroupName string
    The name of the resource group.
    Description string
    A description of the network manager.
    DisplayName string
    A friendly name for the network manager.
    Id string
    Resource ID.
    Location string
    Resource location.
    NetworkManagerName string
    The name of the network manager.
    NetworkManagerScopeAccesses List<Union<string, Pulumi.AzureNative.Network.ConfigurationType>>
    Scope Access.
    NetworkManagerScopes Pulumi.AzureNative.Network.Inputs.NetworkManagerPropertiesNetworkManagerScopes
    Scope of Network Manager.
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group.
    Description string
    A description of the network manager.
    DisplayName string
    A friendly name for the network manager.
    Id string
    Resource ID.
    Location string
    Resource location.
    NetworkManagerName string
    The name of the network manager.
    NetworkManagerScopeAccesses []string
    Scope Access.
    NetworkManagerScopes NetworkManagerPropertiesNetworkManagerScopesArgs
    Scope of Network Manager.
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group.
    description String
    A description of the network manager.
    displayName String
    A friendly name for the network manager.
    id String
    Resource ID.
    location String
    Resource location.
    networkManagerName String
    The name of the network manager.
    networkManagerScopeAccesses List<Either<String,ConfigurationType>>
    Scope Access.
    networkManagerScopes NetworkManagerPropertiesNetworkManagerScopes
    Scope of Network Manager.
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group.
    description string
    A description of the network manager.
    displayName string
    A friendly name for the network manager.
    id string
    Resource ID.
    location string
    Resource location.
    networkManagerName string
    The name of the network manager.
    networkManagerScopeAccesses (string | ConfigurationType)[]
    Scope Access.
    networkManagerScopes NetworkManagerPropertiesNetworkManagerScopes
    Scope of Network Manager.
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group.
    description str
    A description of the network manager.
    display_name str
    A friendly name for the network manager.
    id str
    Resource ID.
    location str
    Resource location.
    network_manager_name str
    The name of the network manager.
    network_manager_scope_accesses Sequence[Union[str, ConfigurationType]]
    Scope Access.
    network_manager_scopes NetworkManagerPropertiesNetworkManagerScopesArgs
    Scope of Network Manager.
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group.
    description String
    A description of the network manager.
    displayName String
    A friendly name for the network manager.
    id String
    Resource ID.
    location String
    Resource location.
    networkManagerName String
    The name of the network manager.
    networkManagerScopeAccesses List<String | "SecurityAdmin" | "SecurityUser" | "Connectivity">
    Scope Access.
    networkManagerScopes Property Map
    Scope of 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 scope assignment 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 scope assignment 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 scope assignment 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 scope assignment 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 scope assignment 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 scope assignment resource.
    systemData Property Map
    The system metadata related to this resource.
    type String
    Resource type.

    Supporting Types

    ConfigurationType, ConfigurationTypeArgs

    SecurityAdmin
    SecurityAdmin
    SecurityUser
    SecurityUser
    Connectivity
    Connectivity
    ConfigurationTypeSecurityAdmin
    SecurityAdmin
    ConfigurationTypeSecurityUser
    SecurityUser
    ConfigurationTypeConnectivity
    Connectivity
    SecurityAdmin
    SecurityAdmin
    SecurityUser
    SecurityUser
    Connectivity
    Connectivity
    SecurityAdmin
    SecurityAdmin
    SecurityUser
    SecurityUser
    Connectivity
    Connectivity
    SECURITY_ADMIN
    SecurityAdmin
    SECURITY_USER
    SecurityUser
    CONNECTIVITY
    Connectivity
    "SecurityAdmin"
    SecurityAdmin
    "SecurityUser"
    SecurityUser
    "Connectivity"
    Connectivity

    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

    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.

    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/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native