Microsoft.AVS privateClouds 2020-07-17-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@2020-07-17-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
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'
}
}
Property values
privateClouds
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
location | Resource location | string |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
sku | The private cloud SKU | Sku (required) |
properties | The properties of a private cloud resource | PrivateCloudProperties |
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 |
vcenterPassword | Optionally, set the vCenter admin password when the private cloud is created | string |
Circuit
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
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 |
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": "2020-07-17-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"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"
}
}
Property values
privateClouds
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.AVS/privateClouds' |
apiVersion | The resource api version | '2020-07-17-preview' |
name | The resource name | string (required) |
location | Resource location | string |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
sku | The private cloud SKU | Sku (required) |
properties | The properties of a private cloud resource | PrivateCloudProperties |
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 |
vcenterPassword | Optionally, set the vCenter admin password when the private cloud is created | string |
Circuit
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
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 |
Sku
Name | Description | Value |
---|---|---|
name | The name of the SKU. | string (required) |
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@2020-07-17-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
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
privateClouds
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.AVS/privateClouds@2020-07-17-preview" |
name | The resource name | string (required) |
location | Resource location | string |
parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
tags | Resource tags | Dictionary of tag names and values. |
sku | The private cloud SKU | Sku (required) |
properties | The properties of a private cloud resource | PrivateCloudProperties |
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 |
vcenterPassword | Optionally, set the vCenter admin password when the private cloud is created | string |
Circuit
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
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 |
Sku
Name | Description | Value |
---|---|---|
name | The name of the SKU. | string (required) |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for