Azure Native v1.102.0, May 2 23

azure-native.network.NetworkGroup

Explore with Pulumi AI

The network group resource API Version: 2021-02-01-preview.

Example Usage

NetworkGroupsPut

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

return await Deployment.RunAsync(() => 
{
    var networkGroup = new AzureNative.Network.NetworkGroup("networkGroup", new()
    {
        ConditionalMembership = "",
        Description = "A sample group",
        DisplayName = "My Network Group",
        GroupMembers = new[]
        {
            new AzureNative.Network.Inputs.GroupMembersItemArgs
            {
                ResourceId = "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1",
            },
        },
        MemberType = "VirtualNetwork",
        NetworkGroupName = "TestNetworkGroup",
        NetworkManagerName = "testNetworkManager",
        ResourceGroupName = "rg1",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewNetworkGroup(ctx, "networkGroup", &network.NetworkGroupArgs{
			ConditionalMembership: pulumi.String(""),
			Description:           pulumi.String("A sample group"),
			DisplayName:           pulumi.String("My Network Group"),
			GroupMembers: []network.GroupMembersItemArgs{
				{
					ResourceId: pulumi.String("/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1"),
				},
			},
			MemberType:         pulumi.String("VirtualNetwork"),
			NetworkGroupName:   pulumi.String("TestNetworkGroup"),
			NetworkManagerName: pulumi.String("testNetworkManager"),
			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.NetworkGroup;
import com.pulumi.azurenative.network.NetworkGroupArgs;
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 networkGroup = new NetworkGroup("networkGroup", NetworkGroupArgs.builder()        
            .conditionalMembership("")
            .description("A sample group")
            .displayName("My Network Group")
            .groupMembers(Map.of("resourceId", "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1"))
            .memberType("VirtualNetwork")
            .networkGroupName("TestNetworkGroup")
            .networkManagerName("testNetworkManager")
            .resourceGroupName("rg1")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

network_group = azure_native.network.NetworkGroup("networkGroup",
    conditional_membership="",
    description="A sample group",
    display_name="My Network Group",
    group_members=[azure_native.network.GroupMembersItemArgs(
        resource_id="/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1",
    )],
    member_type="VirtualNetwork",
    network_group_name="TestNetworkGroup",
    network_manager_name="testNetworkManager",
    resource_group_name="rg1")

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

const networkGroup = new azure_native.network.NetworkGroup("networkGroup", {
    conditionalMembership: "",
    description: "A sample group",
    displayName: "My Network Group",
    groupMembers: [{
        resourceId: "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1",
    }],
    memberType: "VirtualNetwork",
    networkGroupName: "TestNetworkGroup",
    networkManagerName: "testNetworkManager",
    resourceGroupName: "rg1",
});

resources:
  networkGroup:
    type: azure-native:network:NetworkGroup
    properties:
      conditionalMembership:
      description: A sample group
      displayName: My Network Group
      groupMembers:
        - resourceId: /subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1
      memberType: VirtualNetwork
      networkGroupName: TestNetworkGroup
      networkManagerName: testNetworkManager
      resourceGroupName: rg1

Create NetworkGroup Resource

new NetworkGroup(name: string, args: NetworkGroupArgs, opts?: CustomResourceOptions);

@overload
def NetworkGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 conditional_membership: Optional[str] = None,
                 description: Optional[str] = None,
                 display_name: Optional[str] = None,
                 group_members: Optional[Sequence[GroupMembersItemArgs]] = None,
                 member_type: Optional[str] = None,
                 network_group_name: Optional[str] = None,
                 network_manager_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None)
@overload
def NetworkGroup(resource_name: str,
                 args: NetworkGroupArgs,
                 opts: Optional[ResourceOptions] = None)

func NewNetworkGroup(ctx *Context, name string, args NetworkGroupArgs, opts ...ResourceOption) (*NetworkGroup, error)

public NetworkGroup(string name, NetworkGroupArgs args, CustomResourceOptions? opts = null)

public NetworkGroup(String name, NetworkGroupArgs args)
public NetworkGroup(String name, NetworkGroupArgs args, CustomResourceOptions options)

type: azure-native:network:NetworkGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NetworkGroupArgs: 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 NetworkGroupArgs: 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 NetworkGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NetworkGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args NetworkGroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

NetworkGroup 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 NetworkGroup resource accepts the following input properties:

NetworkManagerName string: The name of the network manager.
ResourceGroupName string: The name of the resource group.
ConditionalMembership string: Network group conditional filter.
Description string: A description of the network group.
DisplayName string: A friendly name for the network group.
GroupMembers List<Pulumi.AzureNative.Network.Inputs.GroupMembersItemArgs>: Group members of network group.
MemberType string: Group member type.
NetworkGroupName string: The name of the network group to get.

NetworkManagerName string: The name of the network manager.
ResourceGroupName string: The name of the resource group.
ConditionalMembership string: Network group conditional filter.
Description string: A description of the network group.
DisplayName string: A friendly name for the network group.
GroupMembers []GroupMembersItemArgs: Group members of network group.
MemberType string: Group member type.
NetworkGroupName string: The name of the network group to get.

networkManagerName String: The name of the network manager.
resourceGroupName String: The name of the resource group.
conditionalMembership String: Network group conditional filter.
description String: A description of the network group.
displayName String: A friendly name for the network group.
groupMembers List<GroupMembersItemArgs>: Group members of network group.
memberType String: Group member type.
networkGroupName String: The name of the network group to get.

networkManagerName string: The name of the network manager.
resourceGroupName string: The name of the resource group.
conditionalMembership string: Network group conditional filter.
description string: A description of the network group.
displayName string: A friendly name for the network group.
groupMembers GroupMembersItemArgs[]: Group members of network group.
memberType string: Group member type.
networkGroupName string: The name of the network group to get.

network_manager_name str: The name of the network manager.
resource_group_name str: The name of the resource group.
conditional_membership str: Network group conditional filter.
description str: A description of the network group.
display_name str: A friendly name for the network group.
group_members Sequence[GroupMembersItemArgs]: Group members of network group.
member_type str: Group member type.
network_group_name str: The name of the network group to get.

networkManagerName String: The name of the network manager.
resourceGroupName String: The name of the resource group.
conditionalMembership String: Network group conditional filter.
description String: A description of the network group.
displayName String: A friendly name for the network group.
groupMembers List<Property Map>: Group members of network group.
memberType String: Group member type.
networkGroupName String: The name of the network group to get.

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkGroup 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

GroupMembersItem

ResourceId string: Resource Id.

ResourceId string: Resource Id.

resourceId String: Resource Id.

resourceId string: Resource Id.

resource_id str: Resource Id.

resourceId String: Resource Id.

GroupMembersItemResponse

ResourceId string: Resource Id.

ResourceId string: Resource Id.

resourceId String: Resource Id.

resourceId string: Resource Id.

resource_id str: Resource Id.

resourceId String: Resource Id.

SystemDataResponse

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:NetworkGroup TestNetworkGroup /subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/TestNetworkGroup

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0