你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.AVS privateClouds

项目
04/11/2023

Bicep 资源定义

可以使用面向以下操作部署 privateClouds 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.AVS/privateClouds 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.AVS/privateClouds@2022-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  identity: {
    type: 'string'
  }
  properties: {
    availability: {
      secondaryZone: int
      strategy: 'string'
      zone: int
    }
    circuit: {}
    encryption: {
      keyVaultProperties: {
        keyName: 'string'
        keyVaultUrl: 'string'
        keyVersion: 'string'
      }
      status: 'string'
    }
    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
      hosts: [
        'string'
      ]
    }
    networkBlock: 'string'
    nsxtPassword: 'string'
    secondaryCircuit: {}
    vcenterPassword: 'string'
  }
}

属性值

privateClouds

名称	说明	值
name	资源名称	字符串 (必需)
location	资源位置	string
标记	资源标记	标记名称和值的字典。请参阅模板中的标记
sku	私有云 SKU	需要 sku ()
identity	私有云的标识（如果已配置）。	PrivateCloudIdentity
properties	私有云资源的属性	PrivateCloudProperties

PrivateCloudIdentity

名称	说明	Value
type	用于私有云的标识类型。类型“SystemAssigned”是指隐式创建的标识。类型“None”将从私有云中删除任何标识。	“None” “SystemAssigned”

PrivateCloudProperties

名称	说明	值
availability	描述云如何跨可用性区域分布的属性	AvailabilityProperties
线路	ExpressRoute 线路	电路
加密	客户管理的密钥加密，可以启用或禁用	加密
identitySources	vCenter 单一登录标识源	IdentitySource[]
Internet	已启用或禁用与 Internet 的连接	“Disabled” “已启用”
managementCluster	用于管理的默认群集	ManagementCluster
networkBlock	地址块在订阅中和本地的 VNet 中应是唯一的。确保 CIDR 格式符合 (A.B.C.D/X) 其中 A、B、C、D 介于 0 和 255 之间，X 介于 0 到 22 之间	字符串 (必需)
nsxtPassword	（可选）在创建私有云时设置 NSX-T Manager 密码	string
secondaryCircuit	来自单独 AZ 的辅助 expressRoute 线路。仅存在于拉伸私有云中	电路
vcenterPassword	（可选）在创建私有云时设置 vCenter 管理员密码	字符串

AvailabilityProperties

名称	说明	值
secondaryZone	私有云的辅助可用性区域	int
strategy	私有云的可用性策略	“DualZone” “SingleZone”
区域	私有云的主要可用性区域	int

线路

此对象不包含部署期间要设置的任何属性。所有属性均为 ReadOnly。

加密

名称	说明	值
keyVaultProperties	存储加密密钥的密钥保管库	EncryptionKeyVaultProperties
status	客户管理的加密密钥的状态	'Disabled' 'Enabled'

EncryptionKeyVaultProperties

名称	说明	值
keyName	键的名称。	字符串
keyVaultUrl	保管库的 URL。	字符串
keyVersion	密钥的版本。	字符串

IdentitySource

名称	说明	值
alias	域的 NetBIOS 名称	字符串
baseGroupDN	组的基本可分辨名称	字符串
baseUserDN	用户的基本可分辨名称	字符串
域	域的 DNS 名称	字符串
name	标识源的名称	字符串
password	对用户和组具有最低基本 DN 只读访问权限的 Active Directory 用户的密码。	string
primaryServer	主服务器 URL	string
secondaryServer	辅助服务器 URL	string
SSL	使用 SSL 证书 (LDAPS) 保护 LDAP 通信	'Disabled' 'Enabled'
username	对用户和组具有最低基本 DN 只读访问权限的 Active Directory 用户的 ID	字符串

ManagementCluster

名称	说明	值
clusterSize	群集大小	int
hosts	主机	string[]

SKU

名称	说明	值
name	SKU 的名称。	字符串 (必需)

ARM 模板资源定义

可以使用面向以下操作部署 privateClouds 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.AVS/privateClouds 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.AVS/privateClouds",
  "apiVersion": "2022-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "availability": {
      "secondaryZone": "int",
      "strategy": "string",
      "zone": "int"
    },
    "circuit": {},
    "encryption": {
      "keyVaultProperties": {
        "keyName": "string",
        "keyVaultUrl": "string",
        "keyVersion": "string"
      },
      "status": "string"
    },
    "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",
      "hosts": [ "string" ]
    },
    "networkBlock": "string",
    "nsxtPassword": "string",
    "secondaryCircuit": {},
    "vcenterPassword": "string"
  }
}

属性值

privateClouds

名称	说明	Value
type	资源类型	'Microsoft.AVS/privateClouds'
apiVersion	资源 API 版本	'2022-05-01'
name	资源名称	字符串 (必需)
location	资源位置	string
标记	资源标记	标记名称和值的字典。请参阅模板中的标记
sku	私有云 SKU	需要 sku ()
identity	私有云的标识（如果已配置）。	PrivateCloudIdentity
properties	私有云资源的属性	PrivateCloudProperties

PrivateCloudIdentity

名称	说明	Value
type	用于私有云的标识类型。类型“SystemAssigned”是指隐式创建的标识。类型“None”将从私有云中删除任何标识。	“None” “SystemAssigned”

PrivateCloudProperties

名称	说明	值
availability	描述云如何跨可用性区域分布的属性	AvailabilityProperties
线路	ExpressRoute 线路	电路
加密	客户管理的密钥加密，可以启用或禁用	加密
identitySources	vCenter 单一登录标识源	IdentitySource[]
Internet	已启用或禁用与 Internet 的连接	“Disabled” “已启用”
managementCluster	用于管理的默认群集	ManagementCluster
networkBlock	地址块在订阅中和本地的 VNet 中应是唯一的。确保 CIDR 格式符合 (A.B.C.D/X) 其中 A、B、C、D 介于 0 和 255 之间，X 介于 0 到 22 之间	字符串 (必需)
nsxtPassword	（可选）在创建私有云时设置 NSX-T Manager 密码	string
secondaryCircuit	来自单独 AZ 的辅助 expressRoute 线路。仅存在于拉伸私有云中	电路
vcenterPassword	（可选）在创建私有云时设置 vCenter 管理员密码	字符串

AvailabilityProperties

名称	说明	值
secondaryZone	私有云的辅助可用性区域	int
strategy	私有云的可用性策略	“DualZone” “SingleZone”
区域	私有云的主要可用性区域	int

线路

此对象不包含在部署期间要设置的任何属性。所有属性均为 ReadOnly。

加密

名称	说明	值
keyVaultProperties	存储加密密钥的密钥保管库	EncryptionKeyVaultProperties
status	客户管理的加密密钥的状态	“Disabled” “已启用”

EncryptionKeyVaultProperties

名称	说明	值
keyName	键的名称。	string
keyVaultUrl	保管库的 URL。	字符串
keyVersion	密钥的版本。	string

IdentitySource

名称	说明	值
alias	域的 NetBIOS 名称	字符串
baseGroupDN	组的基本可分辨名称	string
baseUserDN	用户的基本可分辨名称	字符串
域	域的 DNS 名称	字符串
name	标识源的名称	字符串
password	对用户和组具有最低基本 DN 只读访问权限的 Active Directory 用户的密码。	字符串
primaryServer	主服务器 URL	字符串
secondaryServer	辅助服务器 URL	字符串
SSL	使用 SSL 证书 (LDAPS) 保护 LDAP 通信	'Disabled' 'Enabled'
username	对用户和组具有最低基本 DN 只读访问权限的 Active Directory 用户的 ID	字符串

ManagementCluster

名称	说明	值
clusterSize	群集大小	int
hosts	主机	string[]

SKU

名称	说明	值
name	SKU 的名称。	字符串 (必需)

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 privateClouds 资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.AVS/privateClouds 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AVS/privateClouds@2022-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      availability = {
        secondaryZone = int
        strategy = "string"
        zone = int
      }
      circuit = {}
      encryption = {
        keyVaultProperties = {
          keyName = "string"
          keyVaultUrl = "string"
          keyVersion = "string"
        }
        status = "string"
      }
      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
        hosts = [
          "string"
        ]
      }
      networkBlock = "string"
      nsxtPassword = "string"
      secondaryCircuit = {}
      vcenterPassword = "string"
    }
    sku = {
      name = "string"
    }
  })
}

属性值

privateClouds

名称	说明	Value
type	资源类型	“Microsoft.AVS/privateClouds@2022-05-01”
name	资源名称	字符串 (必需)
location	资源位置	string
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记	标记名称和值的字典。
sku	私有云 SKU	需要 sku ()
identity	私有云的标识（如果已配置）。	PrivateCloudIdentity
properties	私有云资源的属性	PrivateCloudProperties

PrivateCloudIdentity

名称	说明	Value
type	用于私有云的标识类型。类型“SystemAssigned”是指隐式创建的标识。类型“None”将从私有云中删除任何标识。	“SystemAssigned”

PrivateCloudProperties

名称	说明	值
availability	描述云如何跨可用性区域分布的属性	AvailabilityProperties
线路	ExpressRoute 线路	电路
加密	客户管理的密钥加密，可以启用或禁用	加密
identitySources	vCenter 单一登录标识源	IdentitySource[]
Internet	已启用或禁用与 Internet 的连接	“Disabled” “已启用”
managementCluster	用于管理的默认群集	ManagementCluster
networkBlock	地址块在订阅中和本地的 VNet 中应是唯一的。确保 CIDR 格式符合 (A.B.C.D/X) 其中 A、B、C、D 介于 0 和 255 之间，X 介于 0 到 22 之间	字符串 (必需)
nsxtPassword	（可选）在创建私有云时设置 NSX-T Manager 密码	string
secondaryCircuit	来自单独 AZ 的辅助 expressRoute 线路。仅存在于拉伸私有云中	电路
vcenterPassword	（可选）在创建私有云时设置 vCenter 管理员密码	string

AvailabilityProperties

名称	说明	值
secondaryZone	私有云的辅助可用性区域	int
strategy	私有云的可用性策略	“DualZone” “SingleZone”
区域	私有云的主要可用性区域	int

线路

此对象不包含在部署期间要设置的任何属性。所有属性均为 ReadOnly。

加密

名称	说明	值
keyVaultProperties	存储加密密钥的密钥保管库	EncryptionKeyVaultProperties
status	客户管理的加密密钥的状态	“Disabled” “已启用”

EncryptionKeyVaultProperties

名称	说明	值
keyName	键的名称。	字符串
keyVaultUrl	保管库的 URL。	string
keyVersion	密钥的版本。	字符串

IdentitySource

名称	说明	值
alias	域的 NetBIOS 名称	字符串
baseGroupDN	组的基本可分辨名称	字符串
baseUserDN	用户的基本可分辨名称	字符串
域	域的 dns 名称	字符串
name	标识源的名称	字符串
password	对用户和组具有最低基本 DN 只读访问权限的 Active Directory 用户的密码。	字符串
primaryServer	主服务器 URL	字符串
secondaryServer	辅助服务器 URL	字符串
SSL	使用 SSL 证书 (LDAPS) 保护 LDAP 通信	“Disabled” “Enabled”
username	对用户和组具有最低基本 DN 只读访问权限的 Active Directory 用户的 ID	string

ManagementCluster

名称	说明	值
clusterSize	群集大小	int
hosts	主机	string[]

SKU

名称	说明	值
name	SKU 的名称。	字符串 (必需)

Microsoft.AVS privateClouds

Bicep 资源定义

资源格式

属性值

privateClouds

PrivateCloudIdentity

PrivateCloudProperties

AvailabilityProperties

线路

加密

EncryptionKeyVaultProperties

IdentitySource

ManagementCluster

SKU

ARM 模板资源定义

资源格式

属性值

privateClouds

PrivateCloudIdentity

PrivateCloudProperties

AvailabilityProperties

线路

加密

EncryptionKeyVaultProperties

IdentitySource

ManagementCluster

SKU

Terraform (AzAPI 提供程序) 资源定义

资源格式

属性值

privateClouds

PrivateCloudIdentity

PrivateCloudProperties

AvailabilityProperties

线路

加密

EncryptionKeyVaultProperties

IdentitySource

ManagementCluster

SKU

反馈

反馈

其他资源