1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. NetworkGroup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.network.NetworkGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    The network group 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, 2022-04-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01.

    Example Usage

    NetworkGroupsPut

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var networkGroup = new AzureNative.Network.NetworkGroup("networkGroup", new()
        {
            Description = "A sample group",
            NetworkGroupName = "testNetworkGroup",
            NetworkManagerName = "testNetworkManager",
            ResourceGroupName = "rg1",
        });
    
    });
    
    package main
    
    import (
    	"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.NewNetworkGroup(ctx, "networkGroup", &network.NetworkGroupArgs{
    			Description:        pulumi.String("A sample group"),
    			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()        
                .description("A sample group")
                .networkGroupName("testNetworkGroup")
                .networkManagerName("testNetworkManager")
                .resourceGroupName("rg1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    network_group = azure_native.network.NetworkGroup("networkGroup",
        description="A sample group",
        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", {
        description: "A sample group",
        networkGroupName: "testNetworkGroup",
        networkManagerName: "testNetworkManager",
        resourceGroupName: "rg1",
    });
    
    resources:
      networkGroup:
        type: azure-native:network:NetworkGroup
        properties:
          description: A sample group
          networkGroupName: testNetworkGroup
          networkManagerName: testNetworkManager
          resourceGroupName: rg1
    

    Create NetworkGroup Resource

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

    Constructor syntax

    new NetworkGroup(name: string, args: NetworkGroupArgs, opts?: CustomResourceOptions);
    @overload
    def NetworkGroup(resource_name: str,
                     args: NetworkGroupArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def NetworkGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     network_manager_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     description: Optional[str] = None,
                     network_group_name: Optional[str] = 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.
    
    

    Parameters

    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.

    Example

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

    var networkGroupResource = new AzureNative.Network.NetworkGroup("networkGroupResource", new()
    {
        NetworkManagerName = "string",
        ResourceGroupName = "string",
        Description = "string",
        NetworkGroupName = "string",
    });
    
    example, err := network.NewNetworkGroup(ctx, "networkGroupResource", &network.NetworkGroupArgs{
    NetworkManagerName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    Description: pulumi.String("string"),
    NetworkGroupName: pulumi.String("string"),
    })
    
    var networkGroupResource = new NetworkGroup("networkGroupResource", NetworkGroupArgs.builder()        
        .networkManagerName("string")
        .resourceGroupName("string")
        .description("string")
        .networkGroupName("string")
        .build());
    
    network_group_resource = azure_native.network.NetworkGroup("networkGroupResource",
        network_manager_name="string",
        resource_group_name="string",
        description="string",
        network_group_name="string")
    
    const networkGroupResource = new azure_native.network.NetworkGroup("networkGroupResource", {
        networkManagerName: "string",
        resourceGroupName: "string",
        description: "string",
        networkGroupName: "string",
    });
    
    type: azure-native:network:NetworkGroup
    properties:
        description: string
        networkGroupName: string
        networkManagerName: string
        resourceGroupName: string
    

    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.
    Description string
    A description of the network group.
    NetworkGroupName string
    The name of the network group.
    NetworkManagerName string
    The name of the network manager.
    ResourceGroupName string
    The name of the resource group.
    Description string
    A description of the network group.
    NetworkGroupName string
    The name of the network group.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group.
    description String
    A description of the network group.
    networkGroupName String
    The name of the network group.
    networkManagerName string
    The name of the network manager.
    resourceGroupName string
    The name of the resource group.
    description string
    A description of the network group.
    networkGroupName string
    The name of the network group.
    network_manager_name str
    The name of the network manager.
    resource_group_name str
    The name of the resource group.
    description str
    A description of the network group.
    network_group_name str
    The name of the network group.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group.
    description String
    A description of the network group.
    networkGroupName String
    The name of the network group.

    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.
    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 scope assignment 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 scope assignment 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 scope assignment 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 scope assignment 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 scope assignment resource.
    resourceGuid String
    Unique identifier for this resource.
    systemData Property Map
    The system metadata related to this resource.
    type String
    Resource type.

    Supporting Types

    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:NetworkGroup testNetworkGroup /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi