Microsoft.DocumentDB cassandraClusters/dataCenters 2023-09-15-preview

  • [アーティクル]

Bicep リソース定義

cassandraClusters/dataCenters リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/cassandraClusters/dataCenters リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-09-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
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    sku: 'string'
  }
}

プロパティ値

cassandraClusters/dataCenters

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 種類のリソースのシンボル名: cassandraClusters
properties マネージド Cassandra データ センターのプロパティ。 DataCenterResourceProperties

DataCenterResourceProperties

名前 説明 値
authenticationMethodLdapProperties Ldap 認証方法のプロパティ。 この機能はプレビュー段階にあります。 AuthenticationMethodLdapProperties
availabilityZone データ センターに可用性ゾーンのサポートがある場合は、cassandra データ センターの仮想マシンをホストする仮想マシン スケールセットに適用します。 [bool]
backupStorageCustomerKeyUri バックアップ ストレージ アカウントの暗号化に使用する顧客キーのキー URI を示します。 string
base64EncodedCassandraYamlFragment このデータ センター内のすべてのノードの cassandra.yaml に含める cassandra.yaml 構成ファイルのフラグメント。 フラグメントは Base64 でエンコードする必要があり、キーのサブセットのみが許可されます。 string
dataCenterLocation このデータ センターを作成するリージョン。 string
解放 データ センターの割り当てが解除されているかどうか。 [bool]
delegatedSubnetId このデータ センター内のノードがネットワーク インターフェイスに接続されている必要があるサブネットのリソース ID。 サブネットは、'dataCenterLocation' で指定されたのと同じリージョンに存在し、クラスターの 'delegatedManagementSubnetId' プロパティで指定されたサブネットにルーティングできる必要があります。 このリソース ID は、'/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' の形式になります。 string
diskCapacity 各ノードに接続されているディスクの数。 既定値は 4 です。 INT
diskSku データ センターに使用されるディスク SKU。 既定値は P30 です。 string
managedDiskCustomerKeyUri マネージド ディスクの暗号化に使用するキー URI。 クラスターのシステム割り当て ID に、キーに対する適切なアクセス許可 (キーの取得/ラップ/ラップ解除のアクセス許可) が割り当てられていることを確認します。 string
nodeCount データ センターに必要なノードの数。 これは目的の数値です。 設定後、データ センターが一致するようにスケーリングされるまでに時間がかかる場合があります。 ノードの数とその状態を監視するには、クラスターで fetchNodeStatus メソッドを使用します。 INT
provisionError リソースのプロビジョニングに関連するエラー。 CassandraError
provisioningState 操作が呼び出された時点のリソースの状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'
sku データ センターに使用される仮想マシン SKU。 既定値は Standard_DS14_v2 string

AuthenticationMethodLdapProperties

名前 説明 値
connectionTimeoutInMs LDAP サーバーに接続するためのタイムアウト (ミリ秒単位)。 既定値は 5000 ミリ秒です。 INT
searchBaseDistinguishedName ユーザーの再帰的検索を開始するオブジェクトの識別名。 string
searchFilterTemplate 検索に使用するテンプレート。 既定値は (cn=%s) で、%s はログインに使用されるユーザー名に置き換えられます。 string
serverCertificates Certificate[]
serverHostname LDAP サーバーのホスト名。 string
serverPort LDAP サーバーのポート。 INT
serviceUserDistinguishedName 認証に関するユーザーの詳細を検索できる検索ユーザー アカウントの識別名。 string
serviceUserPassword 検索ユーザーのパスワード。 string

Certificate

名前 説明 値
Pem PEM 形式の公開キー。 string

CassandraError

名前 説明 値
additionalErrorInfo エラーに関する追加情報。 string
code 発生したエラーのコード。 string
message エラーのメッセージ。 string
ターゲット (target) エラーのターゲット リソース。 string

ARM テンプレート リソース定義

cassandraClusters/dataCenters リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/cassandraClusters/dataCenters リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2023-09-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",
    "provisionError": {
      "additionalErrorInfo": "string",
      "code": "string",
      "message": "string",
      "target": "string"
    },
    "provisioningState": "string",
    "sku": "string"
  }
}

プロパティ値

cassandraClusters/dataCenters

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/cassandraClusters/dataCenters'
apiVersion リソース API のバージョン '2023-09-15-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties マネージド Cassandra データ センターのプロパティ。 DataCenterResourceProperties

DataCenterResourceProperties

名前 説明 値
authenticationMethodLdapProperties Ldap 認証方法のプロパティ。 この機能はプレビュー段階にあります。 AuthenticationMethodLdapProperties
availabilityZone データ センターで可用性ゾーンがサポートされている場合は、cassandra データ センター仮想マシンをホストする仮想マシン スケール セットに適用します。 [bool]
backupStorageCustomerKeyUri バックアップ ストレージ アカウントの暗号化に使用する顧客キーのキー URI を示します。 string
base64EncodedCassandraYamlFragment このデータ センター内のすべてのノードの cassandra.yaml に含める cassandra.yaml 構成ファイルのフラグメント。 フラグメントは Base64 でエンコードする必要があり、キーのサブセットのみが許可されます。 string
dataCenterLocation このデータ センターを作成するリージョン。 string
解放 データ センターの割り当てが解除されているかどうか。 [bool]
delegatedSubnetId このデータ センター内のノードがネットワーク インターフェイスに接続されている必要があるサブネットのリソース ID。 サブネットは、'dataCenterLocation' で指定されたのと同じリージョンに存在し、クラスターの 'delegatedManagementSubnetId' プロパティで指定されたサブネットにルーティングできる必要があります。 このリソース ID は、'/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' の形式になります。 string
diskCapacity 各ノードに接続されているディスクの数。 既定値は 4 です。 INT
diskSku データ センターに使用されるディスク SKU。 既定値は P30 です。 string
managedDiskCustomerKeyUri マネージド ディスクの暗号化に使用するキー URI。 クラスターのシステム割り当て ID に、キーに対する適切なアクセス許可 (キーの取得/ラップ/ラップ解除のアクセス許可) が割り当てられていることを確認します。 string
nodeCount データ センターに必要なノードの数。 これは目的の数値です。 設定後、データ センターが一致するようにスケーリングされるまでに時間がかかる場合があります。 ノードの数とその状態を監視するには、クラスターで fetchNodeStatus メソッドを使用します。 INT
provisionError リソースのプロビジョニングに関連するエラー。 CassandraError
provisioningState 操作が呼び出されたときのリソースの状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'
sku データ センターに使用される仮想マシン SKU。 既定値は Standard_DS14_v2 string

AuthenticationMethodLdapProperties

名前 説明 値
connectionTimeoutInMs LDAP サーバーに接続するためのタイムアウト (ミリ秒単位)。 既定値は 5000 ミリ秒です。 INT
searchBaseDistinguishedName ユーザーの再帰的検索を開始するオブジェクトの識別名。 string
searchFilterTemplate 検索に使用するテンプレート。 既定値は (cn=%s) で、%s はログインに使用されるユーザー名に置き換えられます。 string
serverCertificates Certificate[]
serverHostname LDAP サーバーのホスト名。 string
serverPort LDAP サーバーのポート。 INT
serviceUserDistinguishedName 認証に関するユーザーの詳細を検索できる検索ユーザー アカウントの識別名。 string
serviceUserPassword 検索ユーザーのパスワード。 string

Certificate

名前 説明 値
Pem PEM 形式の公開キー。 string

CassandraError

名前 説明 値
additionalErrorInfo エラーに関する追加情報。 string
code 発生したエラーのコード。 string
message エラーのメッセージ。 string
ターゲット (target) エラーのターゲット リソース。 string

Terraform (AzAPI プロバイダー) リソース定義

cassandraClusters/dataCenters リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/cassandraClusters/dataCenters リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-09-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
      provisionError = {
        additionalErrorInfo = "string"
        code = "string"
        message = "string"
        target = "string"
      }
      provisioningState = "string"
      sku = "string"
    }
  })
}

プロパティ値

cassandraClusters/dataCenters

名前 説明 値
type リソースの種類 "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-09-15-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: cassandraClusters
properties マネージド Cassandra データ センターのプロパティ。 DataCenterResourceProperties

DataCenterResourceProperties

名前 説明 値
authenticationMethodLdapProperties Ldap 認証方法のプロパティ。 この機能はプレビュー段階にあります。 AuthenticationMethodLdapProperties
availabilityZone データ センターに可用性ゾーンのサポートがある場合は、cassandra データ センターの仮想マシンをホストする仮想マシン スケールセットに適用します。 [bool]
backupStorageCustomerKeyUri バックアップ ストレージ アカウントの暗号化に使用する顧客キーのキー URI を示します。 string
base64EncodedCassandraYamlFragment このデータ センター内のすべてのノードの cassandra.yaml に含める cassandra.yaml 構成ファイルのフラグメント。 フラグメントは Base64 でエンコードする必要があり、キーのサブセットのみが許可されます。 string
dataCenterLocation このデータ センターを作成するリージョン。 string
解放 データ センターの割り当てが解除されているかどうか。 [bool]
delegatedSubnetId このデータ センター内のノードがネットワーク インターフェイスに接続されている必要があるサブネットのリソース ID。 サブネットは、'dataCenterLocation' で指定されたのと同じリージョンに存在し、クラスターの 'delegatedManagementSubnetId' プロパティで指定されたサブネットにルーティングできる必要があります。 このリソース ID は、'/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' の形式になります。 string
diskCapacity 各ノードに接続されているディスクの数。 既定値は 4 です。 INT
diskSku データ センターに使用されるディスク SKU。 既定値は P30 です。 string
managedDiskCustomerKeyUri マネージド ディスクの暗号化に使用するキー URI。 クラスターのシステム割り当て ID に、キーに対する適切なアクセス許可 (キーの取得/ラップ/ラップ解除のアクセス許可) が割り当てられていることを確認します。 string
nodeCount データ センターに必要なノードの数。 これは目的の数値です。 設定後、データ センターが一致するようにスケーリングされるまでに時間がかかる場合があります。 ノードの数とその状態を監視するには、クラスターで fetchNodeStatus メソッドを使用します。 INT
provisionError リソースのプロビジョニングに関連するエラー。 CassandraError
provisioningState 操作が呼び出されたときのリソースの状態。 "キャンセル済み"
"作成中"
"削除中"
"Failed"
"Succeeded"
"更新中"
sku データ センターに使用される仮想マシン SKU。 既定値は Standard_DS14_v2 string

AuthenticationMethodLdapProperties

名前 説明 値
connectionTimeoutInMs LDAP サーバーに接続するためのタイムアウト (ミリ秒単位)。 既定値は 5000 ミリ秒です。 INT
searchBaseDistinguishedName ユーザーの再帰的検索を開始するオブジェクトの識別名。 string
searchFilterTemplate 検索に使用するテンプレート。 既定値は (cn=%s) で、%s はログインに使用されるユーザー名に置き換えられます。 string
serverCertificates Certificate[]
serverHostname LDAP サーバーのホスト名。 string
serverPort LDAP サーバーのポート。 INT
serviceUserDistinguishedName 認証に関するユーザーの詳細を検索できる検索ユーザー アカウントの識別名。 string
serviceUserPassword 検索ユーザーのパスワード。 string

Certificate

名前 説明 値
Pem PEM 形式の公開キー。 string

CassandraError

名前 説明 値
additionalErrorInfo エラーに関する追加情報。 string
code 発生したエラーのコード。 string
message エラーのメッセージ。 string
ターゲット (target) エラーのターゲット リソース。 string