Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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-06-01' = {
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) |
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-06-01",
"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-06-01' |
| 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-06-01"
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-06-01" |
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
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 |