次の方法で共有


Microsoft.DocumentDB データベースAccounts/cassandraKeyspaces 2022-08-15

Bicep リソース定義

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

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2022-08-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

名前 形容 価値
位置 リソースが属するリソース グループの場所。 文字列
名前 リソース名 string (必須)
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。
種類のリソースのシンボリック名: databaseAccounts
プロパティ Azure Cosmos DB Cassandra キースペースを作成および更新するためのプロパティ。 CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

Autoscale設定

名前 形容 価値
最大スループット リソースをスケールアップできる最大スループットを表します。 整数 (int)

CassandraKeyspaceCreateUpdatePropertiesまたはCassandraKeyspaceGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsまたはCassandraKeyspaceGetPropertiesOptions
リソース Cassandra キースペースの標準 JSON 形式 CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource (必須)

CassandraKeyspaceResourceまたはCassandraKeyspaceGetPropertiesResource

名前 形容 価値
身分証明書 Cosmos DB Cassandra キースペースの名前 string (必須)

CreateUpdateOptionsまたはCassandraKeyspaceGetPropertiesOptions

名前 形容 価値
自動スケール設定 自動スケール設定を指定します。 Autoscale設定
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 整数 (int)

タグ

名前 形容 価値

使用例

Azure クイック スタートのサンプル

Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces",
  "apiVersion": "2022-08-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

名前 形容 価値
apiVersion (英語) API のバージョン '2022-08-15'
位置 リソースが属するリソース グループの場所。 文字列
名前 リソース名 string (必須)
プロパティ Azure Cosmos DB Cassandra キースペースを作成および更新するためのプロパティ。 CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
リソースの種類 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces'

Autoscale設定

名前 形容 価値
最大スループット リソースをスケールアップできる最大スループットを表します。 整数 (int)

CassandraKeyspaceCreateUpdatePropertiesまたはCassandraKeyspaceGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsまたはCassandraKeyspaceGetPropertiesOptions
リソース Cassandra キースペースの標準 JSON 形式 CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource (必須)

CassandraKeyspaceResourceまたはCassandraKeyspaceGetPropertiesResource

名前 形容 価値
身分証明書 Cosmos DB Cassandra キースペースの名前 string (必須)

CreateUpdateOptionsまたはCassandraKeyspaceGetPropertiesOptions

名前 形容 価値
自動スケール設定 自動スケール設定を指定します。 Autoscale設定
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 整数 (int)

タグ

名前 形容 価値

使用例

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

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート 形容
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 リソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2022-08-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
      }
    }
  }
}

プロパティ値

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

名前 形容 価値
位置 リソースが属するリソース グループの場所。 文字列
名前 リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts
プロパティ Azure Cosmos DB Cassandra キースペースを作成および更新するためのプロパティ。 CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。
リソースの種類 「Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2022-08-15」

Autoscale設定

名前 形容 価値
最大スループット リソースをスケールアップできる最大スループットを表します。 整数 (int)

CassandraKeyspaceCreateUpdatePropertiesまたはCassandraKeyspaceGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsまたはCassandraKeyspaceGetPropertiesOptions
リソース Cassandra キースペースの標準 JSON 形式 CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource (必須)

CassandraKeyspaceResourceまたはCassandraKeyspaceGetPropertiesResource

名前 形容 価値
身分証明書 Cosmos DB Cassandra キースペースの名前 string (必須)

CreateUpdateOptionsまたはCassandraKeyspaceGetPropertiesOptions

名前 形容 価値
自動スケール設定 自動スケール設定を指定します。 Autoscale設定
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 整数 (int)

タグ

名前 形容 価値

使用例

Terraformサンプル

Cosmos DB アカウント内に Cassandra KeySpace をデプロイする基本的な例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
        {
          name = "EnableCassandra"
        },
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "Strong"
        maxIntervalInSeconds    = 5
        maxStalenessPrefix      = 100
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "cassandraKeyspace" {
  type      = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}