Microsoft.DocumentDB cassandraClusters/dataCenters 2024-02-15-preview

• 最新の を する
• 2024-12-01-preview
• 2024-11-15
• 2024-09-01-preview
• 2024-08-15
• 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-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@2024-02-15-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'
  }
}

プロパティ値

AuthenticationMethodLdapProperties

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

CassandraError

名前	形容	価値
additionalErrorInfo	エラーに関する追加情報。	糸
コード	発生したエラーのコード。	糸
メッセージ	エラーのメッセージ。	糸
ターゲット	エラーのターゲット リソース。	糸

証書

名前	形容	価値
pem	PEM 形式の公開キー。	糸

DataCenterResourceProperties

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

Microsoft.DocumentDB/cassandraClusters/dataCenters

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 1 パターン = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: cassandraClusters
プロパティ	マネージド Cassandra データ センターのプロパティ。	DataCenterResourceProperties

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

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

• リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2024-02-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"
  }
}

プロパティ値

AuthenticationMethodLdapProperties

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

CassandraError

名前	形容	価値
additionalErrorInfo	エラーに関する追加情報。	糸
コード	発生したエラーのコード。	糸
メッセージ	エラーのメッセージ。	糸
ターゲット	エラーのターゲット リソース。	糸

証書

名前	形容	価値
pem	PEM 形式の公開キー。	糸

DataCenterResourceProperties

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

Microsoft.DocumentDB/cassandraClusters/dataCenters

名前	形容	価値
apiVersion	API のバージョン	'2024-02-15-preview'
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 1 パターン = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (必須)
プロパティ	マネージド Cassandra データ センターのプロパティ。	DataCenterResourceProperties
種類	リソースの種類	'Microsoft.DocumentDB/cassandraClusters/dataCenters'

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

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

• リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-02-15-preview"
  name = "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"
    }
  })
}

プロパティ値

AuthenticationMethodLdapProperties

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

CassandraError

名前	形容	価値
additionalErrorInfo	エラーに関する追加情報。	糸
コード	発生したエラーのコード。	糸
メッセージ	エラーのメッセージ。	糸
ターゲット	エラーのターゲット リソース。	糸

証書

名前	形容	価値
pem	PEM 形式の公開キー。	糸

DataCenterResourceProperties

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

Microsoft.DocumentDB/cassandraClusters/dataCenters

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 1 パターン = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: cassandraClusters
プロパティ	マネージド Cassandra データ センターのプロパティ。	DataCenterResourceProperties
種類	リソースの種類	"Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-02-15-preview"