Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. avs
  5. Cluster

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.avs.Cluster

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

    Manages an Azure VMware Solution Cluster.

    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 examplePrivateCloud = new azure.avs.PrivateCloud("example", {
    name: "example-vmware-private-cloud",
    resourceGroupName: example.name,
    location: example.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("example", {
    name: "example-Cluster",
    vmwareCloudId: examplePrivateCloud.id,
    clusterNodeCount: 3,
    skuName: "av36",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_private_cloud = azure.avs.PrivateCloud("example",
    name="example-vmware-private-cloud",
    resource_group_name=example.name,
    location=example.location,
    sku_name="av36",
    management_cluster={
        "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("example",
    name="example-Cluster",
    vmware_cloud_id=example_private_cloud.id,
    cluster_node_count=3,
    sku_name="av36")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/avs"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"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
		}
		examplePrivateCloud, err := avs.NewPrivateCloud(ctx, "example", &avs.PrivateCloudArgs{
			Name:              pulumi.String("example-vmware-private-cloud"),
			ResourceGroupName: example.Name,
			Location:          example.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("QazWsx13$Edc"),
			VcenterPassword:           pulumi.String("WsxEdc23$Rfv"),
		})
		if err != nil {
			return err
		}
		_, err = avs.NewCluster(ctx, "example", &avs.ClusterArgs{
			Name:             pulumi.String("example-Cluster"),
			VmwareCloudId:    examplePrivateCloud.ID(),
			ClusterNodeCount: pulumi.Int(3),
			SkuName:          pulumi.String("av36"),
		})
		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 examplePrivateCloud = new Azure.Avs.PrivateCloud("example", new()
    {
        Name = "example-vmware-private-cloud",
        ResourceGroupName = example.Name,
        Location = example.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("example", new()
    {
        Name = "example-Cluster",
        VmwareCloudId = examplePrivateCloud.Id,
        ClusterNodeCount = 3,
        SkuName = "av36",
    });

});

    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.avs.PrivateCloud;
import com.pulumi.azure.avs.PrivateCloudArgs;
import com.pulumi.azure.avs.inputs.PrivateCloudManagementClusterArgs;
import com.pulumi.azure.avs.Cluster;
import com.pulumi.azure.avs.ClusterArgs;
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());

        var examplePrivateCloud = new PrivateCloud("examplePrivateCloud", PrivateCloudArgs.builder()
            .name("example-vmware-private-cloud")
            .resourceGroupName(example.name())
            .location(example.location())
            .skuName("av36")
            .managementCluster(PrivateCloudManagementClusterArgs.builder()
                .size(3)
                .build())
            .networkSubnetCidr("192.168.48.0/22")
            .internetConnectionEnabled(false)
            .nsxtPassword("QazWsx13$Edc")
            .vcenterPassword("WsxEdc23$Rfv")
            .build());

        var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
            .name("example-Cluster")
            .vmwareCloudId(examplePrivateCloud.id())
            .clusterNodeCount(3)
            .skuName("av36")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  examplePrivateCloud:
    type: azure:avs:PrivateCloud
    name: example
    properties:
      name: example-vmware-private-cloud
      resourceGroupName: ${example.name}
      location: ${example.location}
      skuName: av36
      managementCluster:
        size: 3
      networkSubnetCidr: 192.168.48.0/22
      internetConnectionEnabled: false
      nsxtPassword: QazWsx13$Edc
      vcenterPassword: WsxEdc23$Rfv
  exampleCluster:
    type: azure:avs:Cluster
    name: example
    properties:
      name: example-Cluster
      vmwareCloudId: ${examplePrivateCloud.id}
      clusterNodeCount: 3
      skuName: av36

    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 azureClusterResource = new Azure.Avs.Cluster("azureClusterResource", new()
{
    ClusterNodeCount = 0,
    SkuName = "string",
    VmwareCloudId = "string",
    Name = "string",
});

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

    var azureClusterResource = new Cluster("azureClusterResource", ClusterArgs.builder()
    .clusterNodeCount(0)
    .skuName("string")
    .vmwareCloudId("string")
    .name("string")
    .build());

    azure_cluster_resource = azure.avs.Cluster("azureClusterResource",
    cluster_node_count=0,
    sku_name="string",
    vmware_cloud_id="string",
    name="string")

    const azureClusterResource = new azure.avs.Cluster("azureClusterResource", {
    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 Azure VMware Solution Cluster nodes.
    SkuName string
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    VmwareCloudId string
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    Name string
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    ClusterNodeCount int
    The count of the Azure VMware Solution Cluster nodes.
    SkuName string
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    VmwareCloudId string
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    Name string
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    clusterNodeCount Integer
    The count of the Azure VMware Solution Cluster nodes.
    skuName String
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    vmwareCloudId String
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    name String
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    clusterNodeCount number
    The count of the Azure VMware Solution Cluster nodes.
    skuName string
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    vmwareCloudId string
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    name string
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    cluster_node_count int
    The count of the Azure VMware Solution Cluster nodes.
    sku_name str
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    vmware_cloud_id str
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    name str
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    clusterNodeCount Number
    The count of the Azure VMware Solution Cluster nodes.
    skuName String
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    vmwareCloudId String
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    name String
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution 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 Cluster in its Azure VMware Solution Private Cloud.
    Hosts List<string>
    A list of hosts in the Azure VMware Solution Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    ClusterNumber int
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    Hosts []string
    A list of hosts in the Azure VMware Solution Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    clusterNumber Integer
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    hosts List<String>
    A list of hosts in the Azure VMware Solution Cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    clusterNumber number
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    hosts string[]
    A list of hosts in the Azure VMware Solution Cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    cluster_number int
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    hosts Sequence[str]
    A list of hosts in the Azure VMware Solution Cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    clusterNumber Number
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    hosts List<String>
    A list of hosts in the Azure VMware Solution 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 Azure VMware Solution Cluster nodes.
    ClusterNumber int
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    Hosts List<string>
    A list of hosts in the Azure VMware Solution Cluster.
    Name string
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    SkuName string
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    VmwareCloudId string
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    ClusterNodeCount int
    The count of the Azure VMware Solution Cluster nodes.
    ClusterNumber int
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    Hosts []string
    A list of hosts in the Azure VMware Solution Cluster.
    Name string
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    SkuName string
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    VmwareCloudId string
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    clusterNodeCount Integer
    The count of the Azure VMware Solution Cluster nodes.
    clusterNumber Integer
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    hosts List<String>
    A list of hosts in the Azure VMware Solution Cluster.
    name String
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    skuName String
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    vmwareCloudId String
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    clusterNodeCount number
    The count of the Azure VMware Solution Cluster nodes.
    clusterNumber number
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    hosts string[]
    A list of hosts in the Azure VMware Solution Cluster.
    name string
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    skuName string
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    vmwareCloudId string
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    cluster_node_count int
    The count of the Azure VMware Solution Cluster nodes.
    cluster_number int
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    hosts Sequence[str]
    A list of hosts in the Azure VMware Solution Cluster.
    name str
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    sku_name str
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    vmware_cloud_id str
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    clusterNodeCount Number
    The count of the Azure VMware Solution Cluster nodes.
    clusterNumber Number
    A number that identifies this Cluster in its Azure VMware Solution Private Cloud.
    hosts List<String>
    A list of hosts in the Azure VMware Solution Cluster.
    name String
    The name which should be used for this Azure VMware Solution Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.
    skuName String
    The Cluster SKU to use. Possible values are av20, av36, av36t, av36p, av48, av48t, av36pt, av52, av52t, and av64. Changing this forces a new Azure VMware Solution Cluster to be created.
    vmwareCloudId String
    The ID of the Azure VMware Solution Private Cloud in which to create this Cluster. Changing this forces a new Azure VMware Solution Cluster to be created.

    Import

    Azure VMware Solution 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.
    azure logo

    We recommend using Azure Native.

    Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
    pulumi/pulumi-azure