Microsoft.DocumentDB databaseAccounts/cassandraKeyspaces/tables 2021-04-01-preview

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-04-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      defaultTtl: int
      id: 'string'
      schema: {
        clusterKeys: [
          {
            name: 'string'
            orderBy: 'string'
          }
        ]
        columns: [
          {
            name: 'string'
            type: 'string'
          }
        ]
        partitionKeys: [
          {
            name: 'string'
          }
        ]
      }
    }
  }
}

プロパティ値

databaseAccounts/cassandraKeyspaces/tables

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
location リソースが属しているリソース グループの場所。 string
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。		 型のリソースのシンボル名: cassandraKeyspaces
identity リソースの ID。 ManagedServiceIdentity
properties Azure Cosmos DB Cassandra テーブルを作成および更新するためのプロパティ。 CassandraTableCreateUpdatePropertiesOrCassandraTable... (必須)

ManagedServiceIdentity

名前 説明 値
type リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

CassandraTableCreateUpdatePropertiesOrCassandraTable...

名前 説明 値
options 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...
resource Cassandra テーブルの標準的な JSON 形式 CassandraTableResourceOrCassandraTableGetPropertiesR... (必須)

CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...

名前 説明 値
autoscaleSettings 自動スケーリング設定を指定します。 AutoscaleSettings
throughput 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 INT

AutoscaleSettings

名前 説明 値
maxThroughput リソースがスケールアップできる最大スループットを表します。 INT

CassandraTableResourceOrCassandraTableGetPropertiesR...

名前 説明 値
analyticalStorageTtl 分析 TTL。 INT
defaultTtl Cosmos DB Cassandra テーブルの有効期間 INT
id Cosmos DB Cassandra テーブルの名前 string (必須)
schema Cosmos DB Cassandra テーブルのスキーマ CassandraSchema

CassandraSchema

名前 説明 値
clusterKeys クラスター キーの一覧。 ClusterKey[]
列 Cassandra テーブル列の一覧。 Column[]
partitionKeys パーティション キーの一覧。 CassandraPartitionKey[]

ClusterKey

名前 説明 値
name Cosmos DB Cassandra テーブル クラスター キーの名前 string
orderBy Cosmos DB Cassandra テーブル クラスター キーの順序。"Asc" と "Desc" のみがサポートされます string

列

名前 説明 値
name Cosmos DB Cassandra テーブル列の名前 string
type Cosmos DB Cassandra テーブル列の種類 string

CassandraPartitionKey

名前 説明 値
name Cosmos DB Cassandra テーブル パーティション キーの名前 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Cassandra API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、専用スループットのキースペースとテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Cassandra API の自動スケーリング Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、キースペースと自動スケーリング スループットを持つテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。

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

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

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "defaultTtl": "int",
      "id": "string",
      "schema": {
        "clusterKeys": [
          {
            "name": "string",
            "orderBy": "string"
          }
        ],
        "columns": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "partitionKeys": [
          {
            "name": "string"
          }
        ]
      }
    }
  }
}

プロパティ値

databaseAccounts/cassandraKeyspaces/tables

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables'
apiVersion リソース API のバージョン '2021-04-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
location リソースが属しているリソース グループの場所。 string
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
identity リソースの ID。 ManagedServiceIdentity
properties Azure Cosmos DB Cassandra テーブルを作成および更新するためのプロパティ。 CassandraTableCreateUpdatePropertiesOrCassandraTable... (必須)

ManagedServiceIdentity

名前 説明 値
type リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

CassandraTableCreateUpdatePropertiesOrCassandraTable...

名前 説明 値
options 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...
resource Cassandra テーブルの標準的な JSON 形式 CassandraTableResourceOrCassandraTableGetPropertiesR... (必須)

CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...

名前 説明 値
autoscaleSettings 自動スケーリング設定を指定します。 AutoscaleSettings
throughput 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 INT

AutoscaleSettings

名前 説明 値
maxThroughput リソースがスケールアップできる最大スループットを表します。 INT

CassandraTableResourceOrCassandraTableGetPropertiesR...

名前 説明 値
analyticalStorageTtl 分析 TTL。 INT
defaultTtl Cosmos DB Cassandra テーブルの有効期間 INT
id Cosmos DB Cassandra テーブルの名前 string (必須)
schema Cosmos DB Cassandra テーブルのスキーマ CassandraSchema

CassandraSchema

名前 説明 値
clusterKeys クラスター キーの一覧。 ClusterKey[]
列 Cassandra テーブル列の一覧。 Column[]
partitionKeys パーティション キーの一覧。 CassandraPartitionKey[]

ClusterKey

名前 説明 値
name Cosmos DB Cassandra テーブル クラスター キーの名前 string
orderBy Cosmos DB Cassandra テーブル クラスター キーの順序。"Asc" と "Desc" のみがサポートされます string

列

名前 説明 値
name Cosmos DB Cassandra テーブル列の名前 string
type Cosmos DB Cassandra テーブル列の種類 string

CassandraPartitionKey

名前 説明 値
name Cosmos DB Cassandra テーブル パーティション キーの名前 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Cassandra API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、専用スループットのキースペースとテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Cassandra API の自動スケーリング Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、キースペースと自動スケーリング スループットを持つテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-04-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        defaultTtl = int
        id = "string"
        schema = {
          clusterKeys = [
            {
              name = "string"
              orderBy = "string"
            }
          ]
          columns = [
            {
              name = "string"
              type = "string"
            }
          ]
          partitionKeys = [
            {
              name = "string"
            }
          ]
        }
      }
    }
  })
}

プロパティ値

databaseAccounts/cassandraKeyspaces/tables

名前 説明 値
type リソースの種類 "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-04-01-preview"
name リソース名 string (必須)
location リソースが属しているリソース グループの場所。 string
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: cassandraKeyspaces
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグの名前と値のディクショナリ。
identity リソースの ID。 ManagedServiceIdentity
properties Azure Cosmos DB Cassandra テーブルを作成および更新するためのプロパティ。 CassandraTableCreateUpdatePropertiesOrCassandraTable... (必須)

ManagedServiceIdentity

名前 説明 値
type リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 ユーザー ID ID の配列。

ManagedServiceIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

CassandraTableCreateUpdatePropertiesOrCassandraTable...

名前 説明 値
options 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...
resource Cassandra テーブルの標準的な JSON 形式 CassandraTableResourceOrCassandraTableGetPropertiesR... (必須)

CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...

名前 説明 値
autoscaleSettings 自動スケーリング設定を指定します。 AutoscaleSettings
throughput 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 INT

AutoscaleSettings

名前 説明 値
maxThroughput リソースがスケールアップできる最大スループットを表します。 INT

CassandraTableResourceOrCassandraTableGetPropertiesR...

名前 説明 値
analyticalStorageTtl 分析 TTL。 INT
defaultTtl Cosmos DB Cassandra テーブルの有効期間 INT
id Cosmos DB Cassandra テーブルの名前 string (必須)
schema Cosmos DB Cassandra テーブルのスキーマ CassandraSchema

CassandraSchema

名前 説明 値
clusterKeys クラスター キーの一覧。 ClusterKey[]
列 Cassandra テーブル列の一覧。 Column[]
partitionKeys パーティション キーの一覧。 CassandraPartitionKey[]

ClusterKey

名前 説明 値
name Cosmos DB Cassandra テーブル クラスター キーの名前 string
orderBy Cosmos DB Cassandra テーブル クラスター キーの順序。"Asc" と "Desc" のみがサポートされます string

列

名前 説明 値
name Cosmos DB Cassandra テーブル列の名前 string
type Cosmos DB Cassandra テーブル列の種類 string

CassandraPartitionKey

名前 説明 値
name Cosmos DB Cassandra テーブル パーティション キーの名前 string