1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. NetworkManagerNetworkGroup

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi

azure.network.NetworkManagerNetworkGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi

    Manages a Network Manager Network Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const current = azure.core.getSubscription({});
    const exampleNetworkManager = new azure.network.NetworkManager("example", {
        name: "example-network-manager",
        location: example.location,
        resourceGroupName: example.name,
        scope: {
            subscriptionIds: [current.then(current => current.id)],
        },
        scopeAccesses: [
            "Connectivity",
            "SecurityAdmin",
        ],
        description: "example network manager",
    });
    const exampleNetworkManagerNetworkGroup = new azure.network.NetworkManagerNetworkGroup("example", {
        name: "example-group",
        networkManagerId: exampleNetworkManager.id,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    current = azure.core.get_subscription()
    example_network_manager = azure.network.NetworkManager("example",
        name="example-network-manager",
        location=example.location,
        resource_group_name=example.name,
        scope=azure.network.NetworkManagerScopeArgs(
            subscription_ids=[current.id],
        ),
        scope_accesses=[
            "Connectivity",
            "SecurityAdmin",
        ],
        description="example network manager")
    example_network_manager_network_group = azure.network.NetworkManagerNetworkGroup("example",
        name="example-group",
        network_manager_id=example_network_manager.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		current, err := core.LookupSubscription(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		exampleNetworkManager, err := network.NewNetworkManager(ctx, "example", &network.NetworkManagerArgs{
    			Name:              pulumi.String("example-network-manager"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Scope: &network.NetworkManagerScopeArgs{
    				SubscriptionIds: pulumi.StringArray{
    					pulumi.String(current.Id),
    				},
    			},
    			ScopeAccesses: pulumi.StringArray{
    				pulumi.String("Connectivity"),
    				pulumi.String("SecurityAdmin"),
    			},
    			Description: pulumi.String("example network manager"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = network.NewNetworkManagerNetworkGroup(ctx, "example", &network.NetworkManagerNetworkGroupArgs{
    			Name:             pulumi.String("example-group"),
    			NetworkManagerId: exampleNetworkManager.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var current = Azure.Core.GetSubscription.Invoke();
    
        var exampleNetworkManager = new Azure.Network.NetworkManager("example", new()
        {
            Name = "example-network-manager",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Scope = new Azure.Network.Inputs.NetworkManagerScopeArgs
            {
                SubscriptionIds = new[]
                {
                    current.Apply(getSubscriptionResult => getSubscriptionResult.Id),
                },
            },
            ScopeAccesses = new[]
            {
                "Connectivity",
                "SecurityAdmin",
            },
            Description = "example network manager",
        });
    
        var exampleNetworkManagerNetworkGroup = new Azure.Network.NetworkManagerNetworkGroup("example", new()
        {
            Name = "example-group",
            NetworkManagerId = exampleNetworkManager.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.core.CoreFunctions;
    import com.pulumi.azure.core.inputs.GetSubscriptionArgs;
    import com.pulumi.azure.network.NetworkManager;
    import com.pulumi.azure.network.NetworkManagerArgs;
    import com.pulumi.azure.network.inputs.NetworkManagerScopeArgs;
    import com.pulumi.azure.network.NetworkManagerNetworkGroup;
    import com.pulumi.azure.network.NetworkManagerNetworkGroupArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-resources")
                .location("West Europe")
                .build());
    
            final var current = CoreFunctions.getSubscription();
    
            var exampleNetworkManager = new NetworkManager("exampleNetworkManager", NetworkManagerArgs.builder()        
                .name("example-network-manager")
                .location(example.location())
                .resourceGroupName(example.name())
                .scope(NetworkManagerScopeArgs.builder()
                    .subscriptionIds(current.applyValue(getSubscriptionResult -> getSubscriptionResult.id()))
                    .build())
                .scopeAccesses(            
                    "Connectivity",
                    "SecurityAdmin")
                .description("example network manager")
                .build());
    
            var exampleNetworkManagerNetworkGroup = new NetworkManagerNetworkGroup("exampleNetworkManagerNetworkGroup", NetworkManagerNetworkGroupArgs.builder()        
                .name("example-group")
                .networkManagerId(exampleNetworkManager.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleNetworkManager:
        type: azure:network:NetworkManager
        name: example
        properties:
          name: example-network-manager
          location: ${example.location}
          resourceGroupName: ${example.name}
          scope:
            subscriptionIds:
              - ${current.id}
          scopeAccesses:
            - Connectivity
            - SecurityAdmin
          description: example network manager
      exampleNetworkManagerNetworkGroup:
        type: azure:network:NetworkManagerNetworkGroup
        name: example
        properties:
          name: example-group
          networkManagerId: ${exampleNetworkManager.id}
    variables:
      current:
        fn::invoke:
          Function: azure:core:getSubscription
          Arguments: {}
    

    Create NetworkManagerNetworkGroup Resource

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

    Constructor syntax

    new NetworkManagerNetworkGroup(name: string, args: NetworkManagerNetworkGroupArgs, opts?: CustomResourceOptions);
    @overload
    def NetworkManagerNetworkGroup(resource_name: str,
                                   args: NetworkManagerNetworkGroupArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def NetworkManagerNetworkGroup(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   network_manager_id: Optional[str] = None,
                                   description: Optional[str] = None,
                                   name: Optional[str] = None)
    func NewNetworkManagerNetworkGroup(ctx *Context, name string, args NetworkManagerNetworkGroupArgs, opts ...ResourceOption) (*NetworkManagerNetworkGroup, error)
    public NetworkManagerNetworkGroup(string name, NetworkManagerNetworkGroupArgs args, CustomResourceOptions? opts = null)
    public NetworkManagerNetworkGroup(String name, NetworkManagerNetworkGroupArgs args)
    public NetworkManagerNetworkGroup(String name, NetworkManagerNetworkGroupArgs args, CustomResourceOptions options)
    
    type: azure:network:NetworkManagerNetworkGroup
    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 NetworkManagerNetworkGroupArgs
    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 NetworkManagerNetworkGroupArgs
    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 NetworkManagerNetworkGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkManagerNetworkGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkManagerNetworkGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var networkManagerNetworkGroupResource = new Azure.Network.NetworkManagerNetworkGroup("networkManagerNetworkGroupResource", new()
    {
        NetworkManagerId = "string",
        Description = "string",
        Name = "string",
    });
    
    example, err := network.NewNetworkManagerNetworkGroup(ctx, "networkManagerNetworkGroupResource", &network.NetworkManagerNetworkGroupArgs{
    	NetworkManagerId: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Name:             pulumi.String("string"),
    })
    
    var networkManagerNetworkGroupResource = new NetworkManagerNetworkGroup("networkManagerNetworkGroupResource", NetworkManagerNetworkGroupArgs.builder()        
        .networkManagerId("string")
        .description("string")
        .name("string")
        .build());
    
    network_manager_network_group_resource = azure.network.NetworkManagerNetworkGroup("networkManagerNetworkGroupResource",
        network_manager_id="string",
        description="string",
        name="string")
    
    const networkManagerNetworkGroupResource = new azure.network.NetworkManagerNetworkGroup("networkManagerNetworkGroupResource", {
        networkManagerId: "string",
        description: "string",
        name: "string",
    });
    
    type: azure:network:NetworkManagerNetworkGroup
    properties:
        description: string
        name: string
        networkManagerId: string
    

    NetworkManagerNetworkGroup Resource Properties

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

    Inputs

    The NetworkManagerNetworkGroup resource accepts the following input properties:

    NetworkManagerId string
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    Description string
    A description of the Network Manager Network Group.
    Name string
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    NetworkManagerId string
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    Description string
    A description of the Network Manager Network Group.
    Name string
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    networkManagerId String
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    description String
    A description of the Network Manager Network Group.
    name String
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    networkManagerId string
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    description string
    A description of the Network Manager Network Group.
    name string
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    network_manager_id str
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    description str
    A description of the Network Manager Network Group.
    name str
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    networkManagerId String
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    description String
    A description of the Network Manager Network Group.
    name String
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NetworkManagerNetworkGroup Resource

    Get an existing NetworkManagerNetworkGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NetworkManagerNetworkGroupState, opts?: CustomResourceOptions): NetworkManagerNetworkGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            network_manager_id: Optional[str] = None) -> NetworkManagerNetworkGroup
    func GetNetworkManagerNetworkGroup(ctx *Context, name string, id IDInput, state *NetworkManagerNetworkGroupState, opts ...ResourceOption) (*NetworkManagerNetworkGroup, error)
    public static NetworkManagerNetworkGroup Get(string name, Input<string> id, NetworkManagerNetworkGroupState? state, CustomResourceOptions? opts = null)
    public static NetworkManagerNetworkGroup get(String name, Output<String> id, NetworkManagerNetworkGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    A description of the Network Manager Network Group.
    Name string
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    NetworkManagerId string
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    Description string
    A description of the Network Manager Network Group.
    Name string
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    NetworkManagerId string
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    description String
    A description of the Network Manager Network Group.
    name String
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    networkManagerId String
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    description string
    A description of the Network Manager Network Group.
    name string
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    networkManagerId string
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    description str
    A description of the Network Manager Network Group.
    name str
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    network_manager_id str
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.
    description String
    A description of the Network Manager Network Group.
    name String
    Specifies the name which should be used for this Network Manager Network Group. Changing this forces a new Network Manager Network Group to be created.
    networkManagerId String
    Specifies the ID of the Network Manager. Changing this forces a new Network Manager Network Group to be created.

    Import

    Network Manager Network Group can be imported using the resource id, e.g.

    $ pulumi import azure:network/networkManagerNetworkGroup:NetworkManagerNetworkGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Network/networkManagers/networkManager1/networkGroups/networkGroup1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi