Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. avs
  5. Cluster
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.avs.Cluster

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

A cluster resource Azure REST API version: 2022-05-01. Prior API version in Azure Native 1.x: 2020-03-20.

Other available API versions: 2020-03-20, 2021-06-01, 2023-03-01, 2023-09-01.

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",
        },
    });

});
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.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
	})
}
Copy
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());

    }
}
Copy
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",
    },
});
Copy
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",
    })
Copy
resources:
  cluster:
    type: azure-native:avs:Cluster
    properties:
      clusterName: cluster1
      clusterSize: 3
      privateCloudName: cloud1
      resourceGroupName: group1
      sku:
        name: AV20
Copy

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)
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 This property is required. string
The unique name of the resource.
args This property is required. ClusterArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. ClusterArgs
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. ClusterArgs
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. 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 = 
    {
        { "name", "string" },
    },
    ClusterName = "string",
    ClusterSize = 0,
    Hosts = new[]
    {
        "string",
    },
});
Copy
example, err := avs.NewCluster(ctx, "clusterResource", &avs.ClusterArgs{
	PrivateCloudName:  "string",
	ResourceGroupName: "string",
	Sku: map[string]interface{}{
		"name": "string",
	},
	ClusterName: "string",
	ClusterSize: 0,
	Hosts: []string{
		"string",
	},
})
Copy
var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
    .privateCloudName("string")
    .resourceGroupName("string")
    .sku(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .clusterName("string")
    .clusterSize(0)
    .hosts("string")
    .build());
Copy
cluster_resource = azure_native.avs.Cluster("clusterResource",
    private_cloud_name=string,
    resource_group_name=string,
    sku={
        name: string,
    },
    cluster_name=string,
    cluster_size=0,
    hosts=[string])
Copy
const clusterResource = new azure_native.avs.Cluster("clusterResource", {
    privateCloudName: "string",
    resourceGroupName: "string",
    sku: {
        name: "string",
    },
    clusterName: "string",
    clusterSize: 0,
    hosts: ["string"],
});
Copy
type: azure-native:avs:Cluster
properties:
    clusterName: string
    clusterSize: 0
    hosts:
        - string
    privateCloudName: string
    resourceGroupName: string
    sku:
        name: string
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
The 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.
Sku This property is required. Pulumi.AzureNative.AVS.Inputs.Sku
The cluster SKU
ClusterName Changes to this property will trigger replacement. string
Name of the cluster in the private cloud
ClusterSize int
The cluster size
Hosts List<string>
The hosts
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
The 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.
Sku This property is required. SkuArgs
The cluster SKU
ClusterName Changes to this property will trigger replacement. string
Name of the cluster in the private cloud
ClusterSize int
The cluster size
Hosts []string
The hosts
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
The 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.
sku This property is required. Sku
The cluster SKU
clusterName Changes to this property will trigger replacement. String
Name of the cluster in the private cloud
clusterSize Integer
The cluster size
hosts List<String>
The hosts
privateCloudName
This property is required.
Changes to this property will trigger replacement.
string
The 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.
sku This property is required. Sku
The cluster SKU
clusterName Changes to this property will trigger replacement. string
Name of the cluster in the private cloud
clusterSize number
The cluster size
hosts string[]
The hosts
private_cloud_name
This property is required.
Changes to this property will trigger replacement.
str
The 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.
sku This property is required. SkuArgs
The cluster SKU
cluster_name Changes to this property will trigger replacement. str
Name of the cluster in the private cloud
cluster_size int
The cluster size
hosts Sequence[str]
The hosts
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
The 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.
sku This property is required. Property Map
The cluster SKU
clusterName Changes to this property will trigger replacement. String
Name of the cluster in the private cloud
clusterSize Number
The cluster size
hosts List<String>
The hosts

Outputs

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

ClusterId int
The identity
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
The state of the cluster provisioning
Type string
Resource type.
ClusterId int
The identity
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
The state of the cluster provisioning
Type string
Resource type.
clusterId Integer
The identity
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
The state of the cluster provisioning
type String
Resource type.
clusterId number
The identity
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
provisioningState string
The state of the cluster provisioning
type string
Resource type.
cluster_id int
The identity
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name.
provisioning_state str
The state of the cluster provisioning
type str
Resource type.
clusterId Number
The identity
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
The state of the cluster provisioning
type String
Resource type.

Supporting Types

Sku
, SkuArgs

Name This property is required. string
The name of the SKU.
Name This property is required. string
The name of the SKU.
name This property is required. String
The name of the SKU.
name This property is required. string
The name of the SKU.
name This property is required. str
The name of the SKU.
name This property is required. String
The name of the SKU.

SkuResponse
, SkuResponseArgs

Name This property is required. string
The name of the SKU.
Name This property is required. string
The name of the SKU.
name This property is required. String
The name of the SKU.
name This property is required. string
The name of the SKU.
name This property is required. str
The name of the SKU.
name This property is required. String
The name of the SKU.

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}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native