Microsoft.AVS privateClouds 2021-01-01-preview

Bicep resource definition

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

Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.AVS/privateClouds@2021-01-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    circuit: {}
    identitySources: [
      {
        alias: 'string'
        baseGroupDN: 'string'
        baseUserDN: 'string'
        domain: 'string'
        name: 'string'
        password: 'string'
        primaryServer: 'string'
        secondaryServer: 'string'
        ssl: 'string'
        username: 'string'
      }
    ]
    internet: 'string'
    managementCluster: {
      clusterSize: int
    }
    networkBlock: 'string'
    nsxtPassword: 'string'
    vcenterPassword: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.AVS/privateClouds

Name	Description	Value
location	Resource location	string
name	The resource name	string (required)
properties	The properties of a private cloud resource	PrivateCloudProperties
sku	The private cloud SKU	Sku (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

Circuit

Name	Description	Value

IdentitySource

Name	Description	Value
alias	The domain's NetBIOS name	string
baseGroupDN	The base distinguished name for groups	string
baseUserDN	The base distinguished name for users	string
domain	The domain's dns name	string
name	The name of the identity source	string
password	The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.	string Constraints: Sensitive value. Pass in as a secure parameter.
primaryServer	Primary server URL	string
secondaryServer	Secondary server URL	string
ssl	Protect LDAP communication using SSL certificate (LDAPS)	'Disabled' 'Enabled'
username	The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group	string

ManagementCluster

Name	Description	Value
clusterSize	The cluster size	int

PrivateCloudProperties

Name	Description	Value
circuit	An ExpressRoute Circuit	Circuit
identitySources	vCenter Single Sign On Identity Sources	IdentitySource[]
internet	Connectivity to internet is enabled or disabled	'Disabled' 'Enabled'
managementCluster	The default cluster used for management	ManagementCluster
networkBlock	The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22	string (required)
nsxtPassword	Optionally, set the NSX-T Manager password when the private cloud is created	string Constraints: Sensitive value. Pass in as a secure parameter.
vcenterPassword	Optionally, set the vCenter admin password when the private cloud is created	string Constraints: Sensitive value. Pass in as a secure parameter.

ResourceTags

Name	Description	Value

Sku

Name	Description	Value
name	The name of the SKU.	string (required)

Usage Examples

Bicep Samples

A basic example of deploying Azure VMware Solution Private Cloud.

param location string = 'centralus'
param resourceName string = 'acctest0001'

resource privateCloud 'Microsoft.AVS/privateClouds@2022-05-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'av36'
  }
  properties: {
    internet: 'Disabled'
    managementCluster: {
      clusterSize: 3
    }
    networkBlock: '192.168.48.0/22'
  }
}

ARM template resource definition

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

Resource groups - See resource group deployment commands

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

Resource format

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

{
  "type": "Microsoft.AVS/privateClouds",
  "apiVersion": "2021-01-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "circuit": {
    },
    "identitySources": [
      {
        "alias": "string",
        "baseGroupDN": "string",
        "baseUserDN": "string",
        "domain": "string",
        "name": "string",
        "password": "string",
        "primaryServer": "string",
        "secondaryServer": "string",
        "ssl": "string",
        "username": "string"
      }
    ],
    "internet": "string",
    "managementCluster": {
      "clusterSize": "int"
    },
    "networkBlock": "string",
    "nsxtPassword": "string",
    "vcenterPassword": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.AVS/privateClouds

Name	Description	Value
apiVersion	The api version	'2021-01-01-preview'
location	Resource location	string
name	The resource name	string (required)
properties	The properties of a private cloud resource	PrivateCloudProperties
sku	The private cloud SKU	Sku (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.AVS/privateClouds'

Circuit

Name	Description	Value

IdentitySource

Name	Description	Value
alias	The domain's NetBIOS name	string
baseGroupDN	The base distinguished name for groups	string
baseUserDN	The base distinguished name for users	string
domain	The domain's dns name	string
name	The name of the identity source	string
password	The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.	string Constraints: Sensitive value. Pass in as a secure parameter.
primaryServer	Primary server URL	string
secondaryServer	Secondary server URL	string
ssl	Protect LDAP communication using SSL certificate (LDAPS)	'Disabled' 'Enabled'
username	The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group	string

ManagementCluster

Name	Description	Value
clusterSize	The cluster size	int

PrivateCloudProperties

Name	Description	Value
circuit	An ExpressRoute Circuit	Circuit
identitySources	vCenter Single Sign On Identity Sources	IdentitySource[]
internet	Connectivity to internet is enabled or disabled	'Disabled' 'Enabled'
managementCluster	The default cluster used for management	ManagementCluster
networkBlock	The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22	string (required)
nsxtPassword	Optionally, set the NSX-T Manager password when the private cloud is created	string Constraints: Sensitive value. Pass in as a secure parameter.
vcenterPassword	Optionally, set the vCenter admin password when the private cloud is created	string Constraints: Sensitive value. Pass in as a secure parameter.

ResourceTags

Name	Description	Value

Sku

Name	Description	Value
name	The name of the SKU.	string (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The privateClouds 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AVS/privateClouds@2021-01-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      circuit = {
      }
      identitySources = [
        {
          alias = "string"
          baseGroupDN = "string"
          baseUserDN = "string"
          domain = "string"
          name = "string"
          password = "string"
          primaryServer = "string"
          secondaryServer = "string"
          ssl = "string"
          username = "string"
        }
      ]
      internet = "string"
      managementCluster = {
        clusterSize = int
      }
      networkBlock = "string"
      nsxtPassword = "string"
      vcenterPassword = "string"
    }
    sku = {
      name = "string"
    }
  }
}

Property Values

Microsoft.AVS/privateClouds

Name	Description	Value
location	Resource location	string
name	The resource name	string (required)
properties	The properties of a private cloud resource	PrivateCloudProperties
sku	The private cloud SKU	Sku (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.AVS/privateClouds@2021-01-01-preview"

Circuit

Name	Description	Value

IdentitySource

Name	Description	Value
alias	The domain's NetBIOS name	string
baseGroupDN	The base distinguished name for groups	string
baseUserDN	The base distinguished name for users	string
domain	The domain's dns name	string
name	The name of the identity source	string
password	The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.	string Constraints: Sensitive value. Pass in as a secure parameter.
primaryServer	Primary server URL	string
secondaryServer	Secondary server URL	string
ssl	Protect LDAP communication using SSL certificate (LDAPS)	'Disabled' 'Enabled'
username	The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group	string

ManagementCluster

Name	Description	Value
clusterSize	The cluster size	int

PrivateCloudProperties

Name	Description	Value
circuit	An ExpressRoute Circuit	Circuit
identitySources	vCenter Single Sign On Identity Sources	IdentitySource[]
internet	Connectivity to internet is enabled or disabled	'Disabled' 'Enabled'
managementCluster	The default cluster used for management	ManagementCluster
networkBlock	The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22	string (required)
nsxtPassword	Optionally, set the NSX-T Manager password when the private cloud is created	string Constraints: Sensitive value. Pass in as a secure parameter.
vcenterPassword	Optionally, set the vCenter admin password when the private cloud is created	string Constraints: Sensitive value. Pass in as a secure parameter.

ResourceTags

Name	Description	Value

Sku

Name	Description	Value
name	The name of the SKU.	string (required)

Usage Examples

Terraform Samples

A basic example of deploying Azure VMware Solution Private Cloud.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "centralus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "privateCloud" {
  type      = "Microsoft.AVS/privateClouds@2022-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      internet = "Disabled"
      managementCluster = {
        clusterSize = 3
      }
      networkBlock = "192.168.48.0/22"
    }
    sku = {
      name = "av36"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
AVS Private Cloud	AVM Resource Module for AVS Private Cloud

Feedback

Was this page helpful?

Last updated on 2026-01-20

Microsoft.AVS privateClouds 2021-01-01-preview

Bicep resource definition

Resource format

Property Values

Microsoft.AVS/privateClouds

Circuit

IdentitySource

ManagementCluster

PrivateCloudProperties

ResourceTags

Sku

Usage Examples

Bicep Samples

ARM template resource definition

Resource format

Property Values

Microsoft.AVS/privateClouds

Circuit

IdentitySource

ManagementCluster

PrivateCloudProperties

ResourceTags

Sku

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.AVS/privateClouds

Circuit

IdentitySource

ManagementCluster

PrivateCloudProperties

ResourceTags

Sku

Usage Examples

Terraform Samples

Azure Verified Modules

Feedback

Additional resources