Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. WorkloadNetworkVMGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.WorkloadNetworkVMGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

NSX VM Group

Uses Azure REST API version 2023-09-01. In version 2.x of the Azure Native provider, it used API version 2022-05-01.

Other available API versions: 2022-05-01, 2023-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native avs [ApiVersion]. See the version guide for details.

Example Usage

WorkloadNetworks_CreateVMGroup

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

return await Deployment.RunAsync(() => 
{
    var workloadNetworkVMGroup = new AzureNative.AVS.WorkloadNetworkVMGroup("workloadNetworkVMGroup", new()
    {
        DisplayName = "vmGroup1",
        Members = new[]
        {
            "564d43da-fefc-2a3b-1d92-42855622fa50",
        },
        PrivateCloudName = "cloud1",
        ResourceGroupName = "group1",
        Revision = 1,
        VmGroupId = "vmGroup1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avs.NewWorkloadNetworkVMGroup(ctx, "workloadNetworkVMGroup", &avs.WorkloadNetworkVMGroupArgs{
			DisplayName: pulumi.String("vmGroup1"),
			Members: pulumi.StringArray{
				pulumi.String("564d43da-fefc-2a3b-1d92-42855622fa50"),
			},
			PrivateCloudName:  pulumi.String("cloud1"),
			ResourceGroupName: pulumi.String("group1"),
			Revision:          pulumi.Float64(1),
			VmGroupId:         pulumi.String("vmGroup1"),
		})
		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.avs.WorkloadNetworkVMGroup;
import com.pulumi.azurenative.avs.WorkloadNetworkVMGroupArgs;
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 workloadNetworkVMGroup = new WorkloadNetworkVMGroup("workloadNetworkVMGroup", WorkloadNetworkVMGroupArgs.builder()
            .displayName("vmGroup1")
            .members("564d43da-fefc-2a3b-1d92-42855622fa50")
            .privateCloudName("cloud1")
            .resourceGroupName("group1")
            .revision(1)
            .vmGroupId("vmGroup1")
            .build());

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

const workloadNetworkVMGroup = new azure_native.avs.WorkloadNetworkVMGroup("workloadNetworkVMGroup", {
    displayName: "vmGroup1",
    members: ["564d43da-fefc-2a3b-1d92-42855622fa50"],
    privateCloudName: "cloud1",
    resourceGroupName: "group1",
    revision: 1,
    vmGroupId: "vmGroup1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workload_network_vm_group = azure_native.avs.WorkloadNetworkVMGroup("workloadNetworkVMGroup",
    display_name="vmGroup1",
    members=["564d43da-fefc-2a3b-1d92-42855622fa50"],
    private_cloud_name="cloud1",
    resource_group_name="group1",
    revision=1,
    vm_group_id="vmGroup1")
Copy
resources:
  workloadNetworkVMGroup:
    type: azure-native:avs:WorkloadNetworkVMGroup
    properties:
      displayName: vmGroup1
      members:
        - 564d43da-fefc-2a3b-1d92-42855622fa50
      privateCloudName: cloud1
      resourceGroupName: group1
      revision: 1
      vmGroupId: vmGroup1
Copy

Create WorkloadNetworkVMGroup Resource

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

Constructor syntax

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

@overload
def WorkloadNetworkVMGroup(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           private_cloud_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           display_name: Optional[str] = None,
                           members: Optional[Sequence[str]] = None,
                           revision: Optional[float] = None,
                           vm_group_id: Optional[str] = None)
func NewWorkloadNetworkVMGroup(ctx *Context, name string, args WorkloadNetworkVMGroupArgs, opts ...ResourceOption) (*WorkloadNetworkVMGroup, error)
public WorkloadNetworkVMGroup(string name, WorkloadNetworkVMGroupArgs args, CustomResourceOptions? opts = null)
public WorkloadNetworkVMGroup(String name, WorkloadNetworkVMGroupArgs args)
public WorkloadNetworkVMGroup(String name, WorkloadNetworkVMGroupArgs args, CustomResourceOptions options)

type: azure-native:avs:WorkloadNetworkVMGroup
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. WorkloadNetworkVMGroupArgs
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. WorkloadNetworkVMGroupArgs
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. WorkloadNetworkVMGroupArgs
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. WorkloadNetworkVMGroupArgs
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. WorkloadNetworkVMGroupArgs
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 workloadNetworkVMGroupResource = new AzureNative.AVS.WorkloadNetworkVMGroup("workloadNetworkVMGroupResource", new()
{
    PrivateCloudName = "string",
    ResourceGroupName = "string",
    DisplayName = "string",
    Members = new[]
    {
        "string",
    },
    Revision = 0,
    VmGroupId = "string",
});
Copy
example, err := avs.NewWorkloadNetworkVMGroup(ctx, "workloadNetworkVMGroupResource", &avs.WorkloadNetworkVMGroupArgs{
	PrivateCloudName:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Revision:  pulumi.Float64(0),
	VmGroupId: pulumi.String("string"),
})
Copy
var workloadNetworkVMGroupResource = new WorkloadNetworkVMGroup("workloadNetworkVMGroupResource", WorkloadNetworkVMGroupArgs.builder()
    .privateCloudName("string")
    .resourceGroupName("string")
    .displayName("string")
    .members("string")
    .revision(0)
    .vmGroupId("string")
    .build());
Copy
workload_network_vm_group_resource = azure_native.avs.WorkloadNetworkVMGroup("workloadNetworkVMGroupResource",
    private_cloud_name="string",
    resource_group_name="string",
    display_name="string",
    members=["string"],
    revision=0,
    vm_group_id="string")
Copy
const workloadNetworkVMGroupResource = new azure_native.avs.WorkloadNetworkVMGroup("workloadNetworkVMGroupResource", {
    privateCloudName: "string",
    resourceGroupName: "string",
    displayName: "string",
    members: ["string"],
    revision: 0,
    vmGroupId: "string",
});
Copy
type: azure-native:avs:WorkloadNetworkVMGroup
properties:
    displayName: string
    members:
        - string
    privateCloudName: string
    resourceGroupName: string
    revision: 0
    vmGroupId: string
Copy

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

PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
DisplayName string
Display name of the VM group.
Members List<string>
Virtual machine members of this group.
Revision double
NSX revision number.
VmGroupId Changes to this property will trigger replacement. string
ID of the VM group.
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
DisplayName string
Display name of the VM group.
Members []string
Virtual machine members of this group.
Revision float64
NSX revision number.
VmGroupId Changes to this property will trigger replacement. string
ID of the VM group.
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
displayName String
Display name of the VM group.
members List<String>
Virtual machine members of this group.
revision Double
NSX revision number.
vmGroupId Changes to this property will trigger replacement. String
ID of the VM group.
privateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
displayName string
Display name of the VM group.
members string[]
Virtual machine members of this group.
revision number
NSX revision number.
vmGroupId Changes to this property will trigger replacement. string
ID of the VM group.
private_cloud_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the private cloud
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
display_name str
Display name of the VM group.
members Sequence[str]
Virtual machine members of this group.
revision float
NSX revision number.
vm_group_id Changes to this property will trigger replacement. str
ID of the VM group.
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
displayName String
Display name of the VM group.
members List<String>
Virtual machine members of this group.
revision Number
NSX revision number.
vmGroupId Changes to this property will trigger replacement. String
ID of the VM group.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The provisioning state
Status string
VM Group status.
SystemData Pulumi.AzureNative.AVS.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The provisioning state
Status string
VM Group status.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The provisioning state
status String
VM Group status.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
The provisioning state
status string
VM Group status.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
The provisioning state
status str
VM Group status.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The provisioning state
status String
VM Group status.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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:avs:WorkloadNetworkVMGroup vmGroup1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native