Microsoft.DocumentDB cassandraClusters/dataCenters
- 最新
- 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-03-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-預覽版
- 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@2024-05-15' = {
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 數據中心虛擬機的虛擬機器 ScaleSet。 | bool |
| backupStorageCustomerKeyUri | 指出要用於備份記憶體帳戶加密之客戶金鑰的金鑰 URI。 | 字串 |
| base64EncodedCassandraYamlFragment | 此數據中心內所有節點要包含在cassandra.yaml中的cassandra.yaml組態檔片段。 片段應該是Base64編碼，而且只允許一部分的索引鍵。 | 字串 |
| dataCenterLocation | 應該在此數據中心建立的區域。 | 字串 |
| 已解除分配 | 數據中心是否已解除分配。 | bool |
| delegatedSubnetId | 此數據中心節點應連線到其網路介面的子網資源標識碼。 子網必須位於 『dataCenterLocation』 中指定的相同區域，而且必須能夠路由至叢集 'delegatedManagementSubnetId' 属性中指定的子網。 此資源標識符的格式為 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtualNetworks/{virtual network}/subnets/{subnet}'。 | 字串 |
| diskCapacity | 連結至每個節點的磁碟數目。 預設值為 4。 | int |
| diskSku | 用於數據中心的磁碟 SKU。 預設值為 P30。 | 字串 |
| managedDiskCustomerKeyUri | 用於加密受控磁碟的金鑰 URI。 請確定叢集的系統指派身分識別已獲指派適當的許可權， (密鑰取得/包裝/解除包裝許可權) 密鑰。 | 字串 |
| nodeCount | 數據中心應該擁有的節點數目。 這是所需的數位。 設定好之後，可能需要一些時間來調整數據中心以符合。 若要監視節點數目及其狀態，請使用叢集上的 fetchNodeStatus 方法。 | int |
| privateEndpointIpAddress | 此資料中心的 VPN 端點 IP。 | 字串 |
| provisionError | 與資源布建相關的錯誤。 | CassandraError |
| provisioningState | 呼叫作業時的資源狀態。 | 'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing' |
| sku | 用於資料中心的虛擬機 SKU。 預設值為 Standard_DS14_v2 | 字串 |
AuthenticationMethodLdapProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| connectionTimeoutInMs | 聯機到 miliseconds 中 LDAP 伺服器的逾時。 預設值為 5000 毫秒。 | int |
| searchBaseDistinguishedName | 要啟動使用者遞歸搜尋的物件辨別名稱。 | 字串 |
| searchFilterTemplate | 用於搜尋的範本。 默認為 (cn=%s) ，其中 %s 會取代為用來登入的用戶名稱。 | 字串 |
| serverCertificates | Certificate[] | |
| serverHostname | LDAP 伺服器的主機名。 | 字串 |
| serverPort | LDAP 伺服器的埠。 | int |
| serviceUserDistinguishedName | 查閱使用者帳戶的辨別名稱，可查閱驗證的使用者詳細數據。 | 字串 |
| serviceUserPassword | 查閱用戶的密碼。 | 字串 |
憑證
| 名稱 | 描述 | 值 |
|---|---|---|
| Pem | PEM 格式化的公鑰。 | 字串 |
CassandraError
| 名稱 | 描述 | 值 |
|---|---|---|
| additionalErrorInfo | 錯誤的其他資訊。 | 字串 |
| code | 發生的錯誤碼。 | 字串 |
| message | 錯誤的訊息。 | 字串 |
| 目標 | 錯誤的目標資源。 | 字串 |
ARM 範本資源定義
cassandraClusters/dataCenters 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.DocumentDB/cassandraClusters/dataCenters 資源，請將下列 JSON 新增至您的範本。
{
"type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
"apiVersion": "2024-05-15",
"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
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.DocumentDB/cassandraClusters/dataCenters' |
| apiVersion | 資源 API 版本 | '2024-05-15' |
| NAME | 資源名稱 請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。 |
字串 (必要) |
| properties | 受控 Cassandra 資料中心的屬性。 | DataCenterResourceProperties |
DataCenterResourceProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| authenticationMethodLdapProperties | Ldap 驗證方法屬性。 這項功能處於預覽狀態。 | AuthenticationMethodLdapProperties |
| availabilityZone | 如果數據中心具有可用性區域支援，請將它套用至裝載 cassandra 數據中心虛擬機的虛擬機器 ScaleSet。 | bool |
| backupStorageCustomerKeyUri | 指出要用於備份記憶體帳戶加密之客戶金鑰的金鑰 URI。 | 字串 |
| base64EncodedCassandraYamlFragment | 此數據中心內所有節點的 cassandra.yaml 組態檔片段，要包含在 cassandra.yaml 中。 片段應該是Base64編碼，而且只允許索引鍵子集。 | 字串 |
| dataCenterLocation | 應該在此數據中心建立的區域。 | 字串 |
| 已解除分配 | 數據中心是否已解除分配。 | bool |
| delegatedSubnetId | 此數據中心節點應連線到其網路介面的子網資源標識碼。 子網必須位於 『dataCenterLocation』 中指定的相同區域，而且必須能夠路由至叢集 'delegatedManagementSubnetId' 属性中指定的子網。 此資源標識符的格式為 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{虛擬網络}/subnets/{subnet}'。 | 字串 |
| diskCapacity | 連結至每個節點的磁碟數目。 預設值為 4。 | int |
| diskSku | 用於數據中心的磁碟 SKU。 預設值為 P30。 | 字串 |
| managedDiskCustomerKeyUri | 用於加密受控磁碟的金鑰 URI。 確定叢集的系統指派身分識別已獲指派適當的許可權， (密鑰取得/包裝/解除包裝密鑰的許可權) 。 | 字串 |
| nodeCount | 數據中心應該擁有的節點數目。 這是所需的數位。 設定之後，可能需要一些時間來調整數據中心以符合。 若要監視節點數目及其狀態，請使用叢集上的 fetchNodeStatus 方法。 | int |
| privateEndpointIpAddress | 此資料中心的 VPN 端點 IP。 | 字串 |
| provisionError | 與資源布建相關的錯誤。 | CassandraError |
| provisioningState | 呼叫作業時的資源狀態。 | 'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing' |
| sku | 用於資料中心的虛擬機 SKU。 預設值為 Standard_DS14_v2 | 字串 |
AuthenticationMethodLdapProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| connectionTimeoutInMs | 聯機到 miliseconds 中 LDAP 伺服器的逾時。 預設值為 5000 毫秒。 | int |
| searchBaseDistinguishedName | 要啟動使用者遞歸搜尋的物件辨別名稱。 | 字串 |
| searchFilterTemplate | 用於搜尋的範本。 默認為 (cn=%s) ，其中 %s 會取代為用來登入的用戶名稱。 | 字串 |
| serverCertificates | Certificate[] | |
| serverHostname | LDAP 伺服器的主機名。 | 字串 |
| serverPort | LDAP 伺服器的埠。 | int |
| serviceUserDistinguishedName | 查閱使用者帳戶的辨別名稱，可查閱驗證的使用者詳細數據。 | 字串 |
| serviceUserPassword | 查閱用戶的密碼。 | 字串 |
憑證
| 名稱 | 描述 | 值 |
|---|---|---|
| Pem | PEM 格式化的公鑰。 | 字串 |
CassandraError
| 名稱 | 描述 | 值 |
|---|---|---|
| additionalErrorInfo | 錯誤的其他資訊。 | 字串 |
| code | 發生的錯誤碼。 | 字串 |
| message | 錯誤的訊息。 | 字串 |
| 目標 | 錯誤的目標資源。 | 字串 |
Terraform (AzAPI 提供者) 資源定義
cassandraClusters/dataCenters 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.DocumentDB/cassandraClusters/dataCenters 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15"
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
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15” |
| NAME | 資源名稱 | 字串 (必要) |
| parent_id | 此資源之父系的資源標識碼。 | 類型資源的標識碼： cassandraClusters |
| properties | 受控 Cassandra 資料中心的屬性。 | DataCenterResourceProperties |
DataCenterResourceProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| authenticationMethodLdapProperties | Ldap 驗證方法屬性。 這項功能處於預覽狀態。 | AuthenticationMethodLdapProperties |
| availabilityZone | 如果數據中心具有可用性區域支援，請將它套用至裝載 cassandra 數據中心虛擬機的虛擬機器 ScaleSet。 | bool |
| backupStorageCustomerKeyUri | 指出要用於備份記憶體帳戶加密之客戶金鑰的金鑰 URI。 | 字串 |
| base64EncodedCassandraYamlFragment | 此數據中心內所有節點的 cassandra.yaml 組態檔片段，要包含在 cassandra.yaml 中。 片段應該是Base64編碼，而且只允許索引鍵子集。 | 字串 |
| dataCenterLocation | 應該在此數據中心建立的區域。 | 字串 |
| 已解除分配 | 數據中心是否已解除分配。 | bool |
| delegatedSubnetId | 此數據中心節點應連線到其網路介面的子網資源標識碼。 子網必須位於 『dataCenterLocation』 中指定的相同區域，而且必須能夠路由至叢集 'delegatedManagementSubnetId' 属性中指定的子網。 此資源標識符的格式為 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{虛擬網络}/subnets/{subnet}'。 | 字串 |
| diskCapacity | 連結至每個節點的磁碟數目。 預設值為 4。 | int |
| diskSku | 用於數據中心的磁碟 SKU。 預設值為 P30。 | 字串 |
| managedDiskCustomerKeyUri | 用於加密受控磁碟的金鑰 URI。 確定叢集的系統指派身分識別已獲指派適當的許可權， (密鑰取得/包裝/解除包裝密鑰的許可權) 。 | 字串 |
| nodeCount | 數據中心應該擁有的節點數目。 這是所需的數位。 設定之後，可能需要一些時間來調整數據中心以符合。 若要監視節點數目及其狀態，請使用叢集上的 fetchNodeStatus 方法。 | int |
| privateEndpointIpAddress | 此資料中心的 VPN 端點 IP。 | 字串 |
| provisionError | 與資源布建相關的錯誤。 | CassandraError |
| provisioningState | 呼叫作業時的資源狀態。 | “Canceled” “建立” “刪除” “Failed” “Succeeded” “Updateing” |
| sku | 用於資料中心的虛擬機 SKU。 預設值為 Standard_DS14_v2 | 字串 |
AuthenticationMethodLdapProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| connectionTimeoutInMs | 聯機到 miliseconds 中 LDAP 伺服器的逾時。 預設值為 5000 毫秒。 | int |
| searchBaseDistinguishedName | 要啟動使用者遞歸搜尋的物件辨別名稱。 | 字串 |
| searchFilterTemplate | 用於搜尋的範本。 默認為 (cn=%s) ，其中 %s 會取代為用來登入的用戶名稱。 | 字串 |
| serverCertificates | Certificate[] | |
| serverHostname | LDAP 伺服器的主機名。 | 字串 |
| serverPort | LDAP 伺服器的埠。 | int |
| serviceUserDistinguishedName | 查閱使用者帳戶的辨別名稱，可查閱驗證的使用者詳細數據。 | 字串 |
| serviceUserPassword | 查閱用戶的密碼。 | 字串 |
憑證
| 名稱 | 描述 | 值 |
|---|---|---|
| Pem | PEM 格式化的公鑰。 | 字串 |
CassandraError
| 名稱 | 描述 | 值 |
|---|---|---|
| additionalErrorInfo | 錯誤的其他資訊。 | 字串 |
| code | 發生的錯誤碼。 | 字串 |
| message | 錯誤的訊息。 | 字串 |
| 目標 | 錯誤的目標資源。 | 字串 |