你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DocumentDB cassandraClusters/dataCenters 2023-11-15-preview
- 最新
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023 年 3 月 15 日
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-04-01-preview
- 2021-03-01-preview
Bicep 资源定义
cassandraClusters/dataCenters 资源类型可以使用以下目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/cassandraClusters/dataCenters 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
authenticationMethodLdapProperties: {
connectionTimeoutInMs: int
searchBaseDistinguishedName: 'string'
searchFilterTemplate: 'string'
serverCertificates: [
{
pem: 'string'
}
]
serverHostname: 'string'
serverPort: int
serviceUserDistinguishedName: 'string'
serviceUserPassword: 'string'
}
availabilityZone: bool
backupStorageCustomerKeyUri: 'string'
base64EncodedCassandraYamlFragment: 'string'
dataCenterLocation: 'string'
deallocated: bool
delegatedSubnetId: 'string'
diskCapacity: int
diskSku: 'string'
managedDiskCustomerKeyUri: 'string'
nodeCount: int
privateEndpointIpAddress: 'string'
provisionError: {
additionalErrorInfo: 'string'
code: 'string'
message: 'string'
target: 'string'
}
provisioningState: 'string'
sku: 'string'
}
}
属性值
cassandraClusters/dataCenters
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中设置子资源的名称和类型。 |
字符串 (必需) |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为 的资源的符号名称： cassandraClusters |
| properties | 托管 Cassandra 数据中心的属性。 | DataCenterResourceProperties |
DataCenterResourceProperties
| 名称 | 说明 | 值 |
|---|---|---|
| authenticationMethodLdapProperties | Ldap 身份验证方法属性。 此功能为预览版。 | AuthenticationMethodLdapProperties |
| availabilityZone | 如果数据中心具有可用性区域支持，请将其应用于托管 cassandra 数据中心虚拟机的虚拟机规模集。 | bool |
| backupStorageCustomerKeyUri | 指示用于加密备份存储帐户的客户密钥的密钥 URI。 | 字符串 |
| base64EncodedCassandraYamlFragment | 要在此数据中心的所有节点的 cassandra.yaml 中包含的 cassandra.yaml 配置文件片段。 片段应采用 Base64 编码，并且只允许一部分键。 | 字符串 |
| dataCenterLocation | 应创建此数据中心的区域。 | 字符串 |
| 已解除分配 | 数据中心是否已解除分配。 | bool |
| delegatedSubnetId | 此数据中心中的节点应连接到其网络接口的子网的资源 ID。 子网必须位于“dataCenterLocation”中指定的同一区域，并且必须能够路由到群集的“delegatedManagementSubnetId”属性中指定的子网。 此资源 ID 的格式为“/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}”。 | 字符串 |
| diskCapacity | 附加到每个节点的磁盘数。 默认值为 4。 | int |
| diskSku | 用于数据中心的磁盘 SKU。 默认值为 P30。 | 字符串 |
| managedDiskCustomerKeyUri | 用于加密托管磁盘的密钥 URI。 确保已为群集的系统分配标识分配适当的权限， (密钥获取/包装/解包权限) 密钥。 | 字符串 |
| nodeCount | 数据中心应具有的节点数。 这是所需的数字。 设置后，可能需要一些时间才能缩放数据中心以匹配。 若要监视节点数及其状态，请在群集上使用 fetchNodeStatus 方法。 | int |
| privateEndpointIpAddress | 此数据中心的 VPN 终结点的 IP。 | 字符串 |
| provisionError | 与资源预配相关的错误。 | CassandraError |
| provisioningState | 调用操作时资源的状态。 | “已取消” “正在创建” “正在删除” “失败” “成功” “正在更新” |
| sku | 用于数据中心的虚拟机 SKU。 默认值为 Standard_DS14_v2 | 字符串 |
AuthenticationMethodLdapProperties
| 名称 | 说明 | 值 |
|---|---|---|
| connectionTimeoutInMs | 连接到 LDAP 服务器的超时（以 miliseconds 为单位）。 默认值为 5000 毫秒。 | int |
| searchBaseDistinguishedName | 要从中开始对用户进行递归搜索的对象的可分辨名称。 | 字符串 |
| searchFilterTemplate | 用于搜索的模板。 默认为 (cn=%s) 其中 %s 将替换为用于登录的用户名。 | 字符串 |
| serverCertificates | Certificate[] | |
| serverHostname | LDAP 服务器的主机名。 | 字符串 |
| serverPort | LDAP 服务器的端口。 | int |
| serviceUserDistinguishedName | 查找用户帐户的可分辨名称，可查找有关身份验证的用户详细信息。 | 字符串 |
| serviceUserPassword | 查找用户的密码。 | 字符串 |
证书
| 名称 | 说明 | 值 |
|---|---|---|
| Pem | PEM 格式的公钥。 | 字符串 |
CassandraError
| 名称 | 说明 | 值 |
|---|---|---|
| additionalErrorInfo | 有关错误的其他信息。 | 字符串 |
| code | 发生的错误代码。 | 字符串 |
| message | 错误的消息。 | string |
| 目标 | 错误的目标资源。 | 字符串 |
ARM 模板资源定义
cassandraClusters/dataCenters 资源类型可以使用以下目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/cassandraClusters/dataCenters 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
"apiVersion": "2023-11-15-preview",
"name": "string",
"properties": {
"authenticationMethodLdapProperties": {
"connectionTimeoutInMs": "int",
"searchBaseDistinguishedName": "string",
"searchFilterTemplate": "string",
"serverCertificates": [
{
"pem": "string"
}
],
"serverHostname": "string",
"serverPort": "int",
"serviceUserDistinguishedName": "string",
"serviceUserPassword": "string"
},
"availabilityZone": "bool",
"backupStorageCustomerKeyUri": "string",
"base64EncodedCassandraYamlFragment": "string",
"dataCenterLocation": "string",
"deallocated": "bool",
"delegatedSubnetId": "string",
"diskCapacity": "int",
"diskSku": "string",
"managedDiskCustomerKeyUri": "string",
"nodeCount": "int",
"privateEndpointIpAddress": "string",
"provisionError": {
"additionalErrorInfo": "string",
"code": "string",
"message": "string",
"target": "string"
},
"provisioningState": "string",
"sku": "string"
}
}
属性值
cassandraClusters/dataCenters
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.DocumentDB/cassandraClusters/dataCenters' |
| apiVersion | 资源 API 版本 | “2023-11-15-preview” |
| name | 资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。 |
字符串 (必需) |
| properties | 托管 Cassandra 数据中心的属性。 | DataCenterResourceProperties |
DataCenterResourceProperties
| 名称 | 说明 | 值 |
|---|---|---|
| authenticationMethodLdapProperties | Ldap 身份验证方法属性。 此功能为预览版。 | AuthenticationMethodLdapProperties |
| availabilityZone | 如果数据中心具有可用性区域支持，请将其应用于托管 cassandra 数据中心虚拟机的虚拟机 ScaleSet。 | bool |
| backupStorageCustomerKeyUri | 指示用于备份存储帐户加密的客户密钥的密钥 URI。 | 字符串 |
| base64EncodedCassandraYamlFragment | 要包含在此数据中心所有节点的 cassandra.yaml 中的 cassandra.yaml 配置文件的片段。 片段应采用 Base64 编码，并且只允许一部分键。 | 字符串 |
| dataCenterLocation | 应创建此数据中心的区域。 | 字符串 |
| deallocated | 数据中心是否已解除分配。 | bool |
| delegatedSubnetId | 此数据中心中的节点应连接到其网络接口的子网的资源 ID。 子网必须位于“dataCenterLocation”中指定的同一区域，并且必须能够路由到群集的“delegatedManagementSubnetId”属性中指定的子网。 此资源 ID 的格式为“/subscriptions/{subscription id}/resourceGroups/{resourcegroups}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}”。 | 字符串 |
| diskCapacity | 附加到每个节点的磁盘数。 默认值为 4。 | int |
| diskSku | 用于数据中心的磁盘 SKU。 默认值为 P30。 | 字符串 |
| managedDiskCustomerKeyUri | 用于加密托管磁盘的密钥 URI。 确保为群集的系统分配标识分配了适当的权限， (密钥获取/包装/取消包装权限) 密钥。 | 字符串 |
| nodeCount | 数据中心应具有的节点数。 这是所需的数字。 设置后，可能需要一些时间才能缩放数据中心以匹配。 若要监视节点数及其状态，请在群集上使用 fetchNodeStatus 方法。 | int |
| privateEndpointIpAddress | 此数据中心的 VPN 终结点的 IP。 | 字符串 |
| provisionError | 与资源预配相关的错误。 | CassandraError |
| provisioningState | 调用操作时资源的状态。 | “已取消” “正在创建” “正在删除” “失败” “成功” “正在更新” |
| sku | 用于数据中心的虚拟机 SKU。 默认值为 Standard_DS14_v2 | 字符串 |
AuthenticationMethodLdapProperties
| 名称 | 说明 | 值 |
|---|---|---|
| connectionTimeoutInMs | 连接到 LDAP 服务器的超时（以 miliseconds 为单位）。 默认值为 5000 毫秒。 | int |
| searchBaseDistinguishedName | 要从中开始对用户进行递归搜索的对象的可分辨名称。 | 字符串 |
| searchFilterTemplate | 用于搜索的模板。 默认为 (cn=%s) 其中 %s 将替换为用于登录的用户名。 | 字符串 |
| serverCertificates | Certificate[] | |
| serverHostname | LDAP 服务器的主机名。 | 字符串 |
| serverPort | LDAP 服务器的端口。 | int |
| serviceUserDistinguishedName | 查找用户帐户的可分辨名称，可查找有关身份验证的用户详细信息。 | 字符串 |
| serviceUserPassword | 查找用户的密码。 | 字符串 |
证书
| 名称 | 说明 | 值 |
|---|---|---|
| Pem | PEM 格式的公钥。 | 字符串 |
CassandraError
| 名称 | 说明 | 值 |
|---|---|---|
| additionalErrorInfo | 有关错误的其他信息。 | 字符串 |
| code | 发生的错误代码。 | 字符串 |
| message | 错误的消息。 | string |
| 目标 | 错误的目标资源。 | 字符串 |
Terraform (AzAPI 提供程序) 资源定义
cassandraClusters/dataCenters 资源类型可以使用以下目标操作进行部署：
- 资源组
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/cassandraClusters/dataCenters 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
authenticationMethodLdapProperties = {
connectionTimeoutInMs = int
searchBaseDistinguishedName = "string"
searchFilterTemplate = "string"
serverCertificates = [
{
pem = "string"
}
]
serverHostname = "string"
serverPort = int
serviceUserDistinguishedName = "string"
serviceUserPassword = "string"
}
availabilityZone = bool
backupStorageCustomerKeyUri = "string"
base64EncodedCassandraYamlFragment = "string"
dataCenterLocation = "string"
deallocated = bool
delegatedSubnetId = "string"
diskCapacity = int
diskSku = "string"
managedDiskCustomerKeyUri = "string"
nodeCount = int
privateEndpointIpAddress = "string"
provisionError = {
additionalErrorInfo = "string"
code = "string"
message = "string"
target = "string"
}
provisioningState = "string"
sku = "string"
}
})
}
属性值
cassandraClusters/dataCenters
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15-preview” |
| name | 资源名称 | 字符串 (必需) |
| parent_id | 此资源的父资源 ID。 | 类型为：cassandraClusters 的资源的 ID |
| properties | 托管 Cassandra 数据中心的属性。 | DataCenterResourceProperties |
DataCenterResourceProperties
| 名称 | 说明 | 值 |
|---|---|---|
| authenticationMethodLdapProperties | Ldap 身份验证方法属性。 此功能为预览版。 | AuthenticationMethodLdapProperties |
| availabilityZone | 如果数据中心具有可用性区域支持，请将其应用于托管 cassandra 数据中心虚拟机的虚拟机 ScaleSet。 | bool |
| backupStorageCustomerKeyUri | 指示用于备份存储帐户加密的客户密钥的密钥 URI。 | 字符串 |
| base64EncodedCassandraYamlFragment | 要包含在此数据中心所有节点的 cassandra.yaml 中的 cassandra.yaml 配置文件的片段。 片段应采用 Base64 编码，并且只允许一部分键。 | 字符串 |
| dataCenterLocation | 应创建此数据中心的区域。 | 字符串 |
| deallocated | 数据中心是否已解除分配。 | bool |
| delegatedSubnetId | 此数据中心中的节点应连接到其网络接口的子网的资源 ID。 子网必须位于“dataCenterLocation”中指定的同一区域，并且必须能够路由到群集的“delegatedManagementSubnetId”属性中指定的子网。 此资源 ID 的格式为“/subscriptions/{subscription id}/resourceGroups/{resourcegroups}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}”。 | 字符串 |
| diskCapacity | 附加到每个节点的磁盘数。 默认值为 4。 | int |
| diskSku | 用于数据中心的磁盘 SKU。 默认值为 P30。 | 字符串 |
| managedDiskCustomerKeyUri | 用于加密托管磁盘的密钥 URI。 确保为群集的系统分配标识分配了适当的权限， (密钥获取/包装/取消包装权限) 密钥。 | 字符串 |
| nodeCount | 数据中心应具有的节点数。 这是所需的数字。 设置后，可能需要一些时间才能缩放数据中心以匹配。 若要监视节点数及其状态，请在群集上使用 fetchNodeStatus 方法。 | int |
| privateEndpointIpAddress | 此数据中心的 VPN 终结点的 IP。 | 字符串 |
| provisionError | 与资源预配相关的错误。 | CassandraError |
| provisioningState | 调用操作时资源的状态。 | “已取消” “正在创建” “正在删除” “失败” “成功” “正在更新” |
| sku | 用于数据中心的虚拟机 SKU。 默认值为 Standard_DS14_v2 | 字符串 |
AuthenticationMethodLdapProperties
| 名称 | 说明 | 值 |
|---|---|---|
| connectionTimeoutInMs | 连接到 LDAP 服务器的超时（以 miliseconds 为单位）。 默认值为 5000 毫秒。 | int |
| searchBaseDistinguishedName | 要从中开始对用户进行递归搜索的对象的可分辨名称。 | 字符串 |
| searchFilterTemplate | 用于搜索的模板。 默认为 (cn=%s) 其中 %s 将替换为用于登录的用户名。 | 字符串 |
| serverCertificates | Certificate[] | |
| serverHostname | LDAP 服务器的主机名。 | 字符串 |
| serverPort | LDAP 服务器的端口。 | int |
| serviceUserDistinguishedName | 查找用户帐户的可分辨名称，可查找有关身份验证的用户详细信息。 | 字符串 |
| serviceUserPassword | 查找用户的密码。 | 字符串 |
证书
| 名称 | 说明 | 值 |
|---|---|---|
| Pem | PEM 格式的公钥。 | 字符串 |
CassandraError
| 名称 | 说明 | 值 |
|---|---|---|
| additionalErrorInfo | 有关错误的其他信息。 | 字符串 |
| code | 发生的错误代码。 | 字符串 |
| message | 错误的消息。 | string |
| 目标 | 错误的目标资源。 | 字符串 |