Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. Cluster
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.Cluster

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    A cluster resource

    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

    Clusters_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var cluster = new AzureNative.AVS.Cluster("cluster", new()
    {
        ClusterName = "cluster1",
        ClusterSize = 3,
        PrivateCloudName = "cloud1",
        ResourceGroupName = "group1",
        Sku = new AzureNative.AVS.Inputs.SkuArgs
        {
            Name = "AV20",
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avs.NewCluster(ctx, "cluster", &avs.ClusterArgs{
			ClusterName:       pulumi.String("cluster1"),
			ClusterSize:       pulumi.Int(3),
			PrivateCloudName:  pulumi.String("cloud1"),
			ResourceGroupName: pulumi.String("group1"),
			Sku: &avs.SkuArgs{
				Name: pulumi.String("AV20"),
			},
		})
		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.avs.Cluster;
import com.pulumi.azurenative.avs.ClusterArgs;
import com.pulumi.azurenative.avs.inputs.SkuArgs;
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 cluster = new Cluster("cluster", ClusterArgs.builder()
            .clusterName("cluster1")
            .clusterSize(3)
            .privateCloudName("cloud1")
            .resourceGroupName("group1")
            .sku(SkuArgs.builder()
                .name("AV20")
                .build())
            .build());

    }
}

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

const cluster = new azure_native.avs.Cluster("cluster", {
    clusterName: "cluster1",
    clusterSize: 3,
    privateCloudName: "cloud1",
    resourceGroupName: "group1",
    sku: {
        name: "AV20",
    },
});

    import pulumi
import pulumi_azure_native as azure_native

cluster = azure_native.avs.Cluster("cluster",
    cluster_name="cluster1",
    cluster_size=3,
    private_cloud_name="cloud1",
    resource_group_name="group1",
    sku={
        "name": "AV20",
    })

    resources:
  cluster:
    type: azure-native:avs:Cluster
    properties:
      clusterName: cluster1
      clusterSize: 3
      privateCloudName: cloud1
      resourceGroupName: group1
      sku:
        name: AV20

    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,
            private_cloud_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            sku: Optional[SkuArgs] = None,
            cluster_name: Optional[str] = None,
            cluster_size: Optional[int] = None,
            hosts: Optional[Sequence[str]] = None,
            vsan_datastore_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-native: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 AzureNative.AVS.Cluster("clusterResource", new()
{
    PrivateCloudName = "string",
    ResourceGroupName = "string",
    Sku = new AzureNative.AVS.Inputs.SkuArgs
    {
        Name = "string",
        Capacity = 0,
        Family = "string",
        Size = "string",
        Tier = AzureNative.AVS.SkuTier.Free,
    },
    ClusterName = "string",
    ClusterSize = 0,
    Hosts = new[]
    {
        "string",
    },
    VsanDatastoreName = "string",
});

    example, err := avs.NewCluster(ctx, "clusterResource", &avs.ClusterArgs{
	PrivateCloudName:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Sku: &avs.SkuArgs{
		Name:     pulumi.String("string"),
		Capacity: pulumi.Int(0),
		Family:   pulumi.String("string"),
		Size:     pulumi.String("string"),
		Tier:     avs.SkuTierFree,
	},
	ClusterName: pulumi.String("string"),
	ClusterSize: pulumi.Int(0),
	Hosts: pulumi.StringArray{
		pulumi.String("string"),
	},
	VsanDatastoreName: pulumi.String("string"),
})

    var clusterResource = new com.pulumi.azurenative.avs.Cluster("clusterResource", com.pulumi.azurenative.avs.ClusterArgs.builder()
    .privateCloudName("string")
    .resourceGroupName("string")
    .sku(SkuArgs.builder()
        .name("string")
        .capacity(0)
        .family("string")
        .size("string")
        .tier("Free")
        .build())
    .clusterName("string")
    .clusterSize(0)
    .hosts("string")
    .vsanDatastoreName("string")
    .build());

    cluster_resource = azure_native.avs.Cluster("clusterResource",
    private_cloud_name="string",
    resource_group_name="string",
    sku={
        "name": "string",
        "capacity": 0,
        "family": "string",
        "size": "string",
        "tier": azure_native.avs.SkuTier.FREE,
    },
    cluster_name="string",
    cluster_size=0,
    hosts=["string"],
    vsan_datastore_name="string")

    const clusterResource = new azure_native.avs.Cluster("clusterResource", {
    privateCloudName: "string",
    resourceGroupName: "string",
    sku: {
        name: "string",
        capacity: 0,
        family: "string",
        size: "string",
        tier: azure_native.avs.SkuTier.Free,
    },
    clusterName: "string",
    clusterSize: 0,
    hosts: ["string"],
    vsanDatastoreName: "string",
});

    type: azure-native:avs:Cluster
properties:
    clusterName: string
    clusterSize: 0
    hosts:
        - string
    privateCloudName: string
    resourceGroupName: string
    sku:
        capacity: 0
        family: string
        name: string
        size: string
        tier: Free
    vsanDatastoreName: 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:

    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Sku Pulumi.AzureNative.AVS.Inputs.Sku
    The SKU (Stock Keeping Unit) assigned to this resource.
    ClusterName string
    Name of the cluster
    ClusterSize int
    The cluster size
    Hosts List<string>
    The hosts
    VsanDatastoreName string
    Name of the vsan datastore associated with the cluster
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Sku SkuArgs
    The SKU (Stock Keeping Unit) assigned to this resource.
    ClusterName string
    Name of the cluster
    ClusterSize int
    The cluster size
    Hosts []string
    The hosts
    VsanDatastoreName string
    Name of the vsan datastore associated with the cluster
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sku Sku
    The SKU (Stock Keeping Unit) assigned to this resource.
    clusterName String
    Name of the cluster
    clusterSize Integer
    The cluster size
    hosts List<String>
    The hosts
    vsanDatastoreName String
    Name of the vsan datastore associated with the cluster
    privateCloudName string
    Name of the private cloud
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    sku Sku
    The SKU (Stock Keeping Unit) assigned to this resource.
    clusterName string
    Name of the cluster
    clusterSize number
    The cluster size
    hosts string[]
    The hosts
    vsanDatastoreName string
    Name of the vsan datastore associated with the cluster
    private_cloud_name str
    Name of the private cloud
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    sku SkuArgs
    The SKU (Stock Keeping Unit) assigned to this resource.
    cluster_name str
    Name of the cluster
    cluster_size int
    The cluster size
    hosts Sequence[str]
    The hosts
    vsan_datastore_name str
    Name of the vsan datastore associated with the cluster
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sku Property Map
    The SKU (Stock Keeping Unit) assigned to this resource.
    clusterName String
    Name of the cluster
    clusterSize Number
    The cluster size
    hosts List<String>
    The hosts
    vsanDatastoreName String
    Name of the vsan datastore associated with the cluster

    Outputs

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

    AzureApiVersion string
    The Azure API version of the resource.
    ClusterId int
    The identity
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The state of the cluster provisioning
    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.
    ClusterId int
    The identity
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The state of the cluster provisioning
    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.
    clusterId Integer
    The identity
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The state of the cluster provisioning
    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.
    clusterId number
    The identity
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The state of the cluster provisioning
    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.
    cluster_id int
    The identity
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The state of the cluster provisioning
    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.
    clusterId Number
    The identity
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The state of the cluster provisioning
    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

    Sku, SkuArgs

    Name string
    The name of the SKU. E.g. P3. It is typically a letter+number code
    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier Pulumi.AzureNative.AVS.SkuTier
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    Name string
    The name of the SKU. E.g. P3. It is typically a letter+number code
    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier SkuTier
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name String
    The name of the SKU. E.g. P3. It is typically a letter+number code
    capacity Integer
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier SkuTier
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name string
    The name of the SKU. E.g. P3. It is typically a letter+number code
    capacity number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier SkuTier
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name str
    The name of the SKU. E.g. P3. It is typically a letter+number code
    capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family str
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size str
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier SkuTier
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name String
    The name of the SKU. E.g. P3. It is typically a letter+number code
    capacity Number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier "Free" | "Basic" | "Standard" | "Premium"
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    SkuResponse, SkuResponseArgs

    Name string
    The name of the SKU. E.g. P3. It is typically a letter+number code
    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    Name string
    The name of the SKU. E.g. P3. It is typically a letter+number code
    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name String
    The name of the SKU. E.g. P3. It is typically a letter+number code
    capacity Integer
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier String
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name string
    The name of the SKU. E.g. P3. It is typically a letter+number code
    capacity number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name str
    The name of the SKU. E.g. P3. It is typically a letter+number code
    capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family str
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size str
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier str
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name String
    The name of the SKU. E.g. P3. It is typically a letter+number code
    capacity Number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier String
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    SkuTier, SkuTierArgs

    Free
    Free
    Basic
    Basic
    Standard
    Standard
    Premium
    Premium
    SkuTierFree
    Free
    SkuTierBasic
    Basic
    SkuTierStandard
    Standard
    SkuTierPremium
    Premium
    Free
    Free
    Basic
    Basic
    Standard
    Standard
    Premium
    Premium
    Free
    Free
    Basic
    Basic
    Standard
    Standard
    Premium
    Premium
    FREE
    Free
    BASIC
    Basic
    STANDARD
    Standard
    PREMIUM
    Premium
    "Free"
    Free
    "Basic"
    Basic
    "Standard"
    Standard
    "Premium"
    Premium

    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:Cluster cluster1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native