你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
- 最新
- 2025-05-01-预览版
- 2025-04-15
- 2024-12-01-预览版
- 2024-11-15
- 2024-09-01-预览版
- 2024-08-15
- 2024-05-15
- 2024-05-15-预览版
- 2024-02-15-预览版
- 2023-11-15
- 2023-11-15-预览版
- 2023-09-15
- 2023-09-15-预览版
- 2023-04-15
- 2023-03-15
- 2023-03-15-预览版
- 2023-03-01-预览版
- 2022-11-15
- 2022-11-15-预览版
- 2022-08-15
- 2022-08-15-预览版
- 2022-05-15
- 2022-05-15-预览版
- 2022-02-15-预览版
- 2021-11-15-预览版
- 2021-10-15
- 2021-10-15-预览版
- 2021-07-01-预览版
- 2021-04-01-预览版
- 2021-03-01-预览版
Bicep 资源定义
cassandraClusters/dataCenters 资源类型可以使用目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/cassandraClusters/dataCenters 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2025-05-01-preview' = {
parent: resourceSymbolicName
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'
}
}
属性值
Microsoft.DocumentDB/cassandraClusters/数据中心
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 姓名 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 100 模式 = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ （必需） |
| 家长 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：cassandraClusters |
| 属性 | 托管 Cassandra 数据中心的属性。 | DataCenterResourceProperties |
AuthenticationMethodLdapProperties
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| connectionTimeoutInMs | 在 miliseconds 中连接到 LDAP 服务器的超时。 默认值为 5000 毫秒。 | 整数 (int) |
| searchBaseDistinguishedName | 要从中启动用户递归搜索的对象可分辨名称。 | 字符串 |
| searchFilter模板 | 用于搜索的模板。 默认为 （cn=%s），其中 %s 将替换为用于登录的用户名。 | 字符串 |
| 服务器证书 | 证书[] | |
| serverHostname （服务器主机名） | LDAP 服务器的主机名。 | 字符串 |
| 服务器端口 | LDAP 服务器的端口。 | 整数 (int) |
| serviceUserDistinguishedName 服务 | 查找用户帐户的可分辨名称，他们可以查找有关身份验证的用户详细信息。 | 字符串 |
| serviceUserPassword | 查找用户的密码。 | 字符串 |
CassandraError
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| additionalErrorInfo | 有关错误的其他信息。 | 字符串 |
| 代码 | 发生的错误代码。 | 字符串 |
| 消息 | 错误的消息。 | 字符串 |
| 目标 | 错误的目标资源。 | 字符串 |
证书
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| PEM | PEM 格式的公钥。 | 字符串 |
DataCenterResourceProperties
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| authenticationMethodLdap属性 | Ldap 身份验证方法属性。 此功能处于预览状态。 | AuthenticationMethodLdapProperties |
| 可用性区域 | 如果数据中心具有可用性区域支持，请将其应用到托管 cassandra 数据中心虚拟机的虚拟机 ScaleSet。 | 布尔 |
| backupStorageCustomerKeyUri 的 | 指示用于加密备份存储帐户的客户密钥的密钥 URI。 | 字符串 |
| base64EncodedCassandraYamlFragment | 要包含在此数据中心内所有节点的 cassandra.yaml 中的 cassandra.yaml 配置文件的片段。 片段应进行 Base64 编码，只允许一部分键。 | 字符串 |
| 数据中心位置 | 应在其中创建此数据中心的区域。 | 字符串 |
| 已解除分配 | 数据中心是否已解除分配。 | 布尔 |
| 委托子网 ID | 此数据中心中的节点应连接到其网络接口的子网的资源 ID。 子网必须位于“dataCenterLocation”中指定的同一区域，并且必须能够路由到群集的“delegatedManagementSubnetId”属性中指定的子网。 此资源 ID 的格式为“/subscriptions/<订阅 ID>/resourceGroups/<资源组>/providers/Microsoft.Network/virtualNetworks/<虚拟网络>/subnets/<子网>”。 | 字符串 |
| diskCapacity 磁盘容量 | 附加到每个节点的磁盘数。 默认值为 4。 | 整数 (int) |
| diskSku 磁盘 | 用于数据中心的磁盘 SKU。 默认值为 P30。 | 字符串 |
| managedDiskCustomerKeyUri | 用于加密托管磁盘的密钥 URI。 确保为群集的系统分配标识分配了相应的权限（密钥获取/包装/解包权限）。 | 字符串 |
| nodeCount 节点计数 | 数据中心应具有的节点数。 这是所需的数字。 设置后，数据中心可能需要一些时间才能进行缩放才能匹配。 若要监视节点数及其状态，请使用群集上的 fetchNodeStatus 方法。 | 整数 (int) |
| privateEndpointIpAddress（私有端点 IpAddress） | 此数据中心的 VPN 终结点的 IP。 | 字符串 |
| provisionError | 与资源预配相关的错误。 | CassandraError |
| provisioningState | 调用操作时资源的状态。 | “Canceled” “创建” “删除” “Failed” “Succeeded” “正在更新” |
| SKU | 用于数据中心的虚拟机 SKU。 默认值为Standard_DS14_v2 | 字符串 |
ARM 模板资源定义
cassandraClusters/dataCenters 资源类型可以使用目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/cassandraClusters/dataCenters 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
"apiVersion": "2025-05-01-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"
}
}
属性值
Microsoft.DocumentDB/cassandraClusters/数据中心
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| apiVersion | API 版本 | “2025-05-01-预览” |
| 姓名 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 100 模式 = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ （必需） |
| 属性 | 托管 Cassandra 数据中心的属性。 | DataCenterResourceProperties |
| 类型 | 资源类型 | “Microsoft.DocumentDB/cassandraClusters/dataCenters” |
AuthenticationMethodLdapProperties
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| connectionTimeoutInMs | 在 miliseconds 中连接到 LDAP 服务器的超时。 默认值为 5000 毫秒。 | 整数 (int) |
| searchBaseDistinguishedName | 要从中启动用户递归搜索的对象可分辨名称。 | 字符串 |
| searchFilter模板 | 用于搜索的模板。 默认为 （cn=%s），其中 %s 将替换为用于登录的用户名。 | 字符串 |
| 服务器证书 | 证书[] | |
| serverHostname （服务器主机名） | LDAP 服务器的主机名。 | 字符串 |
| 服务器端口 | LDAP 服务器的端口。 | 整数 (int) |
| serviceUserDistinguishedName 服务 | 查找用户帐户的可分辨名称，他们可以查找有关身份验证的用户详细信息。 | 字符串 |
| serviceUserPassword | 查找用户的密码。 | 字符串 |
CassandraError
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| additionalErrorInfo | 有关错误的其他信息。 | 字符串 |
| 代码 | 发生的错误代码。 | 字符串 |
| 消息 | 错误的消息。 | 字符串 |
| 目标 | 错误的目标资源。 | 字符串 |
证书
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| PEM | PEM 格式的公钥。 | 字符串 |
DataCenterResourceProperties
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| authenticationMethodLdap属性 | Ldap 身份验证方法属性。 此功能处于预览状态。 | AuthenticationMethodLdapProperties |
| 可用性区域 | 如果数据中心具有可用性区域支持，请将其应用到托管 cassandra 数据中心虚拟机的虚拟机 ScaleSet。 | 布尔 |
| backupStorageCustomerKeyUri 的 | 指示用于加密备份存储帐户的客户密钥的密钥 URI。 | 字符串 |
| base64EncodedCassandraYamlFragment | 要包含在此数据中心内所有节点的 cassandra.yaml 中的 cassandra.yaml 配置文件的片段。 片段应进行 Base64 编码，只允许一部分键。 | 字符串 |
| 数据中心位置 | 应在其中创建此数据中心的区域。 | 字符串 |
| 已解除分配 | 数据中心是否已解除分配。 | 布尔 |
| 委托子网 ID | 此数据中心中的节点应连接到其网络接口的子网的资源 ID。 子网必须位于“dataCenterLocation”中指定的同一区域，并且必须能够路由到群集的“delegatedManagementSubnetId”属性中指定的子网。 此资源 ID 的格式为“/subscriptions/<订阅 ID>/resourceGroups/<资源组>/providers/Microsoft.Network/virtualNetworks/<虚拟网络>/subnets/<子网>”。 | 字符串 |
| diskCapacity 磁盘容量 | 附加到每个节点的磁盘数。 默认值为 4。 | 整数 (int) |
| diskSku 磁盘 | 用于数据中心的磁盘 SKU。 默认值为 P30。 | 字符串 |
| managedDiskCustomerKeyUri | 用于加密托管磁盘的密钥 URI。 确保为群集的系统分配标识分配了相应的权限（密钥获取/包装/解包权限）。 | 字符串 |
| nodeCount 节点计数 | 数据中心应具有的节点数。 这是所需的数字。 设置后，数据中心可能需要一些时间才能进行缩放才能匹配。 若要监视节点数及其状态，请使用群集上的 fetchNodeStatus 方法。 | 整数 (int) |
| privateEndpointIpAddress（私有端点 IpAddress） | 此数据中心的 VPN 终结点的 IP。 | 字符串 |
| provisionError | 与资源预配相关的错误。 | CassandraError |
| provisioningState | 调用操作时资源的状态。 | “Canceled” “创建” “删除” “Failed” “Succeeded” “正在更新” |
| SKU | 用于数据中心的虚拟机 SKU。 默认值为Standard_DS14_v2 | 字符串 |
用法示例
Terraform （AzAPI 提供程序）资源定义
cassandraClusters/dataCenters 资源类型可以使用目标操作进行部署：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/cassandraClusters/dataCenters 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2025-05-01-preview"
name = "string"
parent_id = "string"
body = {
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"
}
}
}
属性值
Microsoft.DocumentDB/cassandraClusters/数据中心
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 姓名 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 100 模式 = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ （必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：cassandraClusters |
| 属性 | 托管 Cassandra 数据中心的属性。 | DataCenterResourceProperties |
| 类型 | 资源类型 | “Microsoft.DocumentDB/cassandraClusters/dataCenters@2025-05-01-preview” |
AuthenticationMethodLdapProperties
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| connectionTimeoutInMs | 在 miliseconds 中连接到 LDAP 服务器的超时。 默认值为 5000 毫秒。 | 整数 (int) |
| searchBaseDistinguishedName | 要从中启动用户递归搜索的对象可分辨名称。 | 字符串 |
| searchFilter模板 | 用于搜索的模板。 默认为 （cn=%s），其中 %s 将替换为用于登录的用户名。 | 字符串 |
| 服务器证书 | 证书[] | |
| serverHostname （服务器主机名） | LDAP 服务器的主机名。 | 字符串 |
| 服务器端口 | LDAP 服务器的端口。 | 整数 (int) |
| serviceUserDistinguishedName 服务 | 查找用户帐户的可分辨名称，他们可以查找有关身份验证的用户详细信息。 | 字符串 |
| serviceUserPassword | 查找用户的密码。 | 字符串 |
CassandraError
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| additionalErrorInfo | 有关错误的其他信息。 | 字符串 |
| 代码 | 发生的错误代码。 | 字符串 |
| 消息 | 错误的消息。 | 字符串 |
| 目标 | 错误的目标资源。 | 字符串 |
证书
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| PEM | PEM 格式的公钥。 | 字符串 |
DataCenterResourceProperties
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| authenticationMethodLdap属性 | Ldap 身份验证方法属性。 此功能处于预览状态。 | AuthenticationMethodLdapProperties |
| 可用性区域 | 如果数据中心具有可用性区域支持，请将其应用到托管 cassandra 数据中心虚拟机的虚拟机 ScaleSet。 | 布尔 |
| backupStorageCustomerKeyUri 的 | 指示用于加密备份存储帐户的客户密钥的密钥 URI。 | 字符串 |
| base64EncodedCassandraYamlFragment | 要包含在此数据中心内所有节点的 cassandra.yaml 中的 cassandra.yaml 配置文件的片段。 片段应进行 Base64 编码，只允许一部分键。 | 字符串 |
| 数据中心位置 | 应在其中创建此数据中心的区域。 | 字符串 |
| 已解除分配 | 数据中心是否已解除分配。 | 布尔 |
| 委托子网 ID | 此数据中心中的节点应连接到其网络接口的子网的资源 ID。 子网必须位于“dataCenterLocation”中指定的同一区域，并且必须能够路由到群集的“delegatedManagementSubnetId”属性中指定的子网。 此资源 ID 的格式为“/subscriptions/<订阅 ID>/resourceGroups/<资源组>/providers/Microsoft.Network/virtualNetworks/<虚拟网络>/subnets/<子网>”。 | 字符串 |
| diskCapacity 磁盘容量 | 附加到每个节点的磁盘数。 默认值为 4。 | 整数 (int) |
| diskSku 磁盘 | 用于数据中心的磁盘 SKU。 默认值为 P30。 | 字符串 |
| managedDiskCustomerKeyUri | 用于加密托管磁盘的密钥 URI。 确保为群集的系统分配标识分配了相应的权限（密钥获取/包装/解包权限）。 | 字符串 |
| nodeCount 节点计数 | 数据中心应具有的节点数。 这是所需的数字。 设置后，数据中心可能需要一些时间才能进行缩放才能匹配。 若要监视节点数及其状态，请使用群集上的 fetchNodeStatus 方法。 | 整数 (int) |
| privateEndpointIpAddress（私有端点 IpAddress） | 此数据中心的 VPN 终结点的 IP。 | 字符串 |
| provisionError | 与资源预配相关的错误。 | CassandraError |
| provisioningState | 调用操作时资源的状态。 | “Canceled” “创建” “删除” “Failed” “Succeeded” “正在更新” |
| SKU | 用于数据中心的虚拟机 SKU。 默认值为Standard_DS14_v2 | 字符串 |