Microsoft.AVS privateClouds/clusters

Bicep resource definition

The privateClouds/clusters resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/clusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AVS/privateClouds/clusters@2025-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clusterSize: int
    hosts: [
      'string'
    ]
    vsanDatastoreName: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
}

Property Values

Microsoft.AVS/privateClouds/clusters

Name Description Value
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: privateClouds
properties The resource-specific properties for this resource. ClusterProperties
sku The SKU (Stock Keeping Unit) assigned to this resource. Sku (required)

ClusterProperties

Name Description Value
clusterSize The cluster size int
hosts The hosts string[]
vsanDatastoreName Name of the vsan datastore associated with the cluster string

Sku

Name Description Value
capacity 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. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. E.g. P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier 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. 'Basic'
'Free'
'Premium'
'Standard'

ARM template resource definition

The privateClouds/clusters resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/clusters resource, add the following JSON to your template.

{
  "type": "Microsoft.AVS/privateClouds/clusters",
  "apiVersion": "2025-09-01",
  "name": "string",
  "properties": {
    "clusterSize": "int",
    "hosts": [ "string" ],
    "vsanDatastoreName": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  }
}

Property Values

Microsoft.AVS/privateClouds/clusters

Name Description Value
apiVersion The api version '2025-09-01'
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
properties The resource-specific properties for this resource. ClusterProperties
sku The SKU (Stock Keeping Unit) assigned to this resource. Sku (required)
type The resource type 'Microsoft.AVS/privateClouds/clusters'

ClusterProperties

Name Description Value
clusterSize The cluster size int
hosts The hosts string[]
vsanDatastoreName Name of the vsan datastore associated with the cluster string

Sku

Name Description Value
capacity 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. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. E.g. P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier 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. 'Basic'
'Free'
'Premium'
'Standard'

Usage Examples

Terraform (AzAPI provider) resource definition

The privateClouds/clusters resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/clusters resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AVS/privateClouds/clusters@2025-09-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      clusterSize = int
      hosts = [
        "string"
      ]
      vsanDatastoreName = "string"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  }
}

Property Values

Microsoft.AVS/privateClouds/clusters

Name Description Value
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: privateClouds
properties The resource-specific properties for this resource. ClusterProperties
sku The SKU (Stock Keeping Unit) assigned to this resource. Sku (required)
type The resource type "Microsoft.AVS/privateClouds/clusters@2025-09-01"

ClusterProperties

Name Description Value
clusterSize The cluster size int
hosts The hosts string[]
vsanDatastoreName Name of the vsan datastore associated with the cluster string

Sku

Name Description Value
capacity 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. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. E.g. P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier 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. 'Basic'
'Free'
'Premium'
'Standard'
  • Last updated on