Cluster

Azure v4.42.0 (4.x), Mar 9 26

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var examplePrivateCloud = new Azure.Avs.PrivateCloud("examplePrivateCloud", new Azure.Avs.PrivateCloudArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            SkuName = "av36",
            ManagementCluster = new Azure.Avs.Inputs.PrivateCloudManagementClusterArgs
            {
                Size = 3,
            },
            NetworkSubnetCidr = "192.168.48.0/22",
            InternetConnectionEnabled = false,
            NsxtPassword = "QazWsx13$Edc",
            VcenterPassword = "WsxEdc23$Rfv",
        });
        var exampleCluster = new Azure.Avs.Cluster("exampleCluster", new Azure.Avs.ClusterArgs
        {
            VmwareCloudId = examplePrivateCloud.Id,
            ClusterNodeCount = 3,
            SkuName = "av36",
        });
    }

}

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/avs"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		examplePrivateCloud, err := avs.NewPrivateCloud(ctx, "examplePrivateCloud", &avs.PrivateCloudArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			SkuName:           pulumi.String("av36"),
			ManagementCluster: &avs.PrivateCloudManagementClusterArgs{
				Size: pulumi.Int(3),
			},
			NetworkSubnetCidr:         pulumi.String("192.168.48.0/22"),
			InternetConnectionEnabled: pulumi.Bool(false),
			NsxtPassword:              pulumi.String(fmt.Sprintf("%v%v%v", "QazWsx13", "$", "Edc")),
			VcenterPassword:           pulumi.String(fmt.Sprintf("%v%v%v", "WsxEdc23", "$", "Rfv")),
		})
		if err != nil {
			return err
		}
		_, err = avs.NewCluster(ctx, "exampleCluster", &avs.ClusterArgs{
			VmwareCloudId:    examplePrivateCloud.ID(),
			ClusterNodeCount: pulumi.Int(3),
			SkuName:          pulumi.String("av36"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const examplePrivateCloud = new azure.avs.PrivateCloud("examplePrivateCloud", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    skuName: "av36",
    managementCluster: {
        size: 3,
    },
    networkSubnetCidr: "192.168.48.0/22",
    internetConnectionEnabled: false,
    nsxtPassword: `QazWsx13$Edc`,
    vcenterPassword: `WsxEdc23$Rfv`,
});
const exampleCluster = new azure.avs.Cluster("exampleCluster", {
    vmwareCloudId: examplePrivateCloud.id,
    clusterNodeCount: 3,
    skuName: "av36",
});

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_private_cloud = azure.avs.PrivateCloud("examplePrivateCloud",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku_name="av36",
    management_cluster=azure.avs.PrivateCloudManagementClusterArgs(
        size=3,
    ),
    network_subnet_cidr="192.168.48.0/22",
    internet_connection_enabled=False,
    nsxt_password="QazWsx13$Edc",
    vcenter_password="WsxEdc23$Rfv")
example_cluster = azure.avs.Cluster("exampleCluster",
    vmware_cloud_id=example_private_cloud.id,
    cluster_node_count=3,
    sku_name="av36")

Example coming soon!

Create Cluster Resource

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

Constructor syntax

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cluster_node_count: Optional[int] = None,
            sku_name: Optional[str] = None,
            vmware_cloud_id: Optional[str] = None,
            name: Optional[str] = None)

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: azure:avs:Cluster
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 ClusterArgs: 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 ClusterArgs: 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 ClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args ClusterArgs: 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 clusterResource = new Azure.Avs.Cluster("clusterResource", new()
{
    ClusterNodeCount = 0,
    SkuName = "string",
    VmwareCloudId = "string",
    Name = "string",
});

example, err := avs.NewCluster(ctx, "clusterResource", &avs.ClusterArgs{
	ClusterNodeCount: pulumi.Int(0),
	SkuName:          pulumi.String("string"),
	VmwareCloudId:    pulumi.String("string"),
	Name:             pulumi.String("string"),
})

var clusterResource = new com.pulumi.azure.avs.Cluster("clusterResource", com.pulumi.azure.avs.ClusterArgs.builder()
    .clusterNodeCount(0)
    .skuName("string")
    .vmwareCloudId("string")
    .name("string")
    .build());

cluster_resource = azure.avs.Cluster("clusterResource",
    cluster_node_count=0,
    sku_name="string",
    vmware_cloud_id="string",
    name="string")

const clusterResource = new azure.avs.Cluster("clusterResource", {
    clusterNodeCount: 0,
    skuName: "string",
    vmwareCloudId: "string",
    name: "string",
});

type: azure:avs:Cluster
properties:
    clusterNodeCount: 0
    name: string
    skuName: string
    vmwareCloudId: string

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

ClusterNodeCount int: The count of the Vmware Cluster nodes.
SkuName string: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
VmwareCloudId string: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
Name string: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

ClusterNodeCount int: The count of the Vmware Cluster nodes.
SkuName string: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
VmwareCloudId string: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
Name string: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

clusterNodeCount Integer: The count of the Vmware Cluster nodes.
skuName String: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
vmwareCloudId String: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
name String: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

clusterNodeCount number: The count of the Vmware Cluster nodes.
skuName string: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
vmwareCloudId string: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
name string: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

cluster_node_count int: The count of the Vmware Cluster nodes.
sku_name str: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
vmware_cloud_id str: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
name str: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

clusterNodeCount Number: The count of the Vmware Cluster nodes.
skuName String: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
vmwareCloudId String: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
name String: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

Outputs

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

ClusterNumber int: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
Hosts List<string>: A list of host of the Vmware Cluster.
Id string: The provider-assigned unique ID for this managed resource.

ClusterNumber int: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
Hosts []string: A list of host of the Vmware Cluster.
Id string: The provider-assigned unique ID for this managed resource.

clusterNumber Integer: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
hosts List<String>: A list of host of the Vmware Cluster.
id String: The provider-assigned unique ID for this managed resource.

clusterNumber number: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
hosts string[]: A list of host of the Vmware Cluster.
id string: The provider-assigned unique ID for this managed resource.

cluster_number int: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
hosts Sequence[str]: A list of host of the Vmware Cluster.
id str: The provider-assigned unique ID for this managed resource.

clusterNumber Number: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
hosts List<String>: A list of host of the Vmware Cluster.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing Cluster Resource

Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_node_count: Optional[int] = None,
        cluster_number: Optional[int] = None,
        hosts: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        sku_name: Optional[str] = None,
        vmware_cloud_id: Optional[str] = None) -> Cluster

func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)

public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)

public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)

resources:  _:    type: azure:avs:Cluster    get:      id: ${id}

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:

ClusterNodeCount int: The count of the Vmware Cluster nodes.
ClusterNumber int: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
Hosts List<string>: A list of host of the Vmware Cluster.
Name string: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
SkuName string: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
VmwareCloudId string: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

ClusterNodeCount int: The count of the Vmware Cluster nodes.
ClusterNumber int: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
Hosts []string: A list of host of the Vmware Cluster.
Name string: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
SkuName string: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
VmwareCloudId string: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

clusterNodeCount Integer: The count of the Vmware Cluster nodes.
clusterNumber Integer: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
hosts List<String>: A list of host of the Vmware Cluster.
name String: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
skuName String: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
vmwareCloudId String: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

clusterNodeCount number: The count of the Vmware Cluster nodes.
clusterNumber number: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
hosts string[]: A list of host of the Vmware Cluster.
name string: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
skuName string: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
vmwareCloudId string: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

cluster_node_count int: The count of the Vmware Cluster nodes.
cluster_number int: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
hosts Sequence[str]: A list of host of the Vmware Cluster.
name str: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
sku_name str: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
vmware_cloud_id str: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

clusterNodeCount Number: The count of the Vmware Cluster nodes.
clusterNumber Number: A number that identifies this Vmware Cluster in its Vmware Private Cloud.
hosts List<String>: A list of host of the Vmware Cluster.
name String: The name which should be used for this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.
skuName String: The cluster sku to use. Possible values are av20, av36, and av36t. Changing this forces a new Vmware Cluster to be created.
vmwareCloudId String: The ID of the Vmware Private Cloud in which to create this Vmware Cluster. Changing this forces a new Vmware Cluster to be created.

Import

Vmware Clusters can be imported using the resource id, e.g.

 $ pulumi import azure:avs/cluster:Cluster example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.AVS/privateClouds/privateCloud1/clusters/cluster1

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.

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

azure.avs.Cluster

On this page

On this page

Example Usage

Create Cluster Resource

Constructor syntax

Parameters

Constructor example

Cluster Resource Properties

Inputs

Outputs

Look up Existing Cluster Resource

Import

Package Details

On this page

On this page