次の方法で共有


Microsoft.DocumentDB データベースAccounts/cassandraKeyspaces/throughputSettings 2024-12-01-preview

Bicep リソース定義

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

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2024-12-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'default'
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
      throughputBuckets: [
        {
          id: int
          maxThroughputPercentage: int
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings

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

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

AutoscaleSettingsResource

名前 形容 価値
autoUpgradePolicy (英語) Cosmos DB リソースの自動アップグレード ポリシー AutoUpgradePolicyResource の
最大スループット スケールアップできる最大スループット コンテナーを表します。 int (必須)

AutoUpgradePolicyResource

名前 形容 価値
スループットポリシー 自動アップグレードに準拠する必要があるサービスのスループット ポリシーを表します スループットポリシーリソース

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

マネージドサービスアイデンティティ

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

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

タグ

名前 形容 価値

スループットバケットリソース

名前 形容 価値
身分証明書 スループット バケット ID を表します int (必須)
maxThroughputPercentage バケットで使用できる最大スループットの割合を表します。 int (必須)

スループットポリシーリソース

名前 形容 価値
incrementPercent(インクリメントパーセント) スループット ポリシーが開始されるたびにスループットを増加できる割合を表します。 整数 (int)
有効化されている ThroughputPolicy がアクティブかどうかを判断します ブール (bool)

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名前 形容 価値
自動スケール設定 自動スケール設定用の Cosmos DB リソース。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 AutoscaleSettingsResource の
スループット Cosmos DB リソースのスループットの値。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 整数 (int)
スループットバケット Cosmos DB コンテナーに適用されるスループット バケットの制限の配列 スループットバケットリソース[]

ThroughputSettingsUpdatePropertiesまたはThroughputSettingsGetProperties

名前 形容 価値
リソース リソース スループットの標準 JSON 形式 ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (必須)

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

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

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

リソースの形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int",
      "throughputBuckets": [
        {
          "id": "int",
          "maxThroughputPercentage": "int"
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings

名前 形容 価値
apiVersion (英語) API のバージョン '2024-12-01-プレビュー'
ID リソースの ID。 ManagedServiceIdentity の
位置 リソースが属するリソース グループの場所。 文字列
名前 リソース名 'default' (必須)
プロパティ Azure Cosmos DB リソースのスループットを更新するプロパティ。 ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
リソースの種類 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings'

AutoscaleSettingsResource

名前 形容 価値
autoUpgradePolicy (英語) Cosmos DB リソースの自動アップグレード ポリシー AutoUpgradePolicyResource の
最大スループット スケールアップできる最大スループット コンテナーを表します。 int (必須)

AutoUpgradePolicyResource

名前 形容 価値
スループットポリシー 自動アップグレードに準拠する必要があるサービスのスループット ポリシーを表します スループットポリシーリソース

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

マネージドサービスアイデンティティ

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

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

タグ

名前 形容 価値

スループットバケットリソース

名前 形容 価値
身分証明書 スループット バケット ID を表します int (必須)
maxThroughputPercentage バケットで使用できる最大スループットの割合を表します。 int (必須)

スループットポリシーリソース

名前 形容 価値
incrementPercent(インクリメントパーセント) スループット ポリシーが開始されるたびにスループットを増加できる割合を表します。 整数 (int)
有効化されている ThroughputPolicy がアクティブかどうかを判断します ブール (bool)

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名前 形容 価値
自動スケール設定 自動スケール設定用の Cosmos DB リソース。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 AutoscaleSettingsResource の
スループット Cosmos DB リソースのスループットの値。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 整数 (int)
スループットバケット Cosmos DB コンテナーに適用されるスループット バケットの制限の配列 スループットバケットリソース[]

ThroughputSettingsUpdatePropertiesまたはThroughputSettingsGetProperties

名前 形容 価値
リソース リソース スループットの標準 JSON 形式 ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (必須)

使用例

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

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

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2024-12-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
        throughputBuckets = [
          {
            id = int
            maxThroughputPercentage = int
          }
        ]
      }
    }
  }
}

プロパティ値

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings

名前 形容 価値
ID リソースの ID。 ManagedServiceIdentity の
位置 リソースが属するリソース グループの場所。 文字列
名前 リソース名 'default' (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts/cassandraKeyspaces
プロパティ Azure Cosmos DB リソースのスループットを更新するプロパティ。 ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。
リソースの種類 "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2024-12-01-preview" (英語)

AutoscaleSettingsResource

名前 形容 価値
autoUpgradePolicy (英語) Cosmos DB リソースの自動アップグレード ポリシー AutoUpgradePolicyResource の
最大スループット スケールアップできる最大スループット コンテナーを表します。 int (必須)

AutoUpgradePolicyResource

名前 形容 価値
スループットポリシー 自動アップグレードに準拠する必要があるサービスのスループット ポリシーを表します スループットポリシーリソース

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

マネージドサービスアイデンティティ

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

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

タグ

名前 形容 価値

スループットバケットリソース

名前 形容 価値
身分証明書 スループット バケット ID を表します int (必須)
maxThroughputPercentage バケットで使用できる最大スループットの割合を表します。 int (必須)

スループットポリシーリソース

名前 形容 価値
incrementPercent(インクリメントパーセント) スループット ポリシーが開始されるたびにスループットを増加できる割合を表します。 整数 (int)
有効化されている ThroughputPolicy がアクティブかどうかを判断します ブール (bool)

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名前 形容 価値
自動スケール設定 自動スケール設定用の Cosmos DB リソース。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 AutoscaleSettingsResource の
スループット Cosmos DB リソースのスループットの値。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 整数 (int)
スループットバケット Cosmos DB コンテナーに適用されるスループット バケットの制限の配列 スループットバケットリソース[]

ThroughputSettingsUpdatePropertiesまたはThroughputSettingsGetProperties

名前 形容 価値
リソース リソース スループットの標準 JSON 形式 ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (必須)