Cassandra Resources - Update Cassandra Keyspace Throughput

Azure Cosmos DB Cassandra Keyspace の 1 秒あたりの RU の更新

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default?api-version=2023-11-15

URI パラメーター

名前 / 必須 説明
accountName
path True

string

Cosmos DB データベース アカウント名。

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

keyspaceName
path True

string

Cosmos DB キースペース名。

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 必須 説明
properties.resource True

ThroughputSettingsResource

リソース スループットの標準 JSON 形式

location

string

リソースが属しているリソース グループの場所。

tags

object

タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。

応答

名前 説明
200 OK

ThroughputSettingsGetResults

Cassandra Keyspace 更新操作の 1 秒あたりの RU が正常に完了しました。

202 Accepted

Cassandra Keyspace 更新操作の 1 秒あたりの RU は非同期的に完了します。

Headers

  • azure-AsyncOperation: string
  • location: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

CosmosDBCassandraKeyspaceThroughputUpdate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/throughputSettings/default?api-version=2023-11-15

{
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400,
      "minimumThroughput": "400",
      "offerReplacePending": "true",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

定義

名前 説明
AutoscaleSettingsResource

Cosmos DB のプロビジョニング済みスループット設定オブジェクト

AutoUpgradePolicyResource

Cosmos DB リソースの自動アップグレード ポリシー

Resource
ThroughputPolicyResource

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

ThroughputSettingsGetResults

Azure Cosmos DB リソースのスループット。

ThroughputSettingsResource

Cosmos DB リソース スループット オブジェクト。 スループットが必要か、自動scaleSettings が必要ですが、両方は必要ありません。

ThroughputSettingsUpdateParameters

Cosmos DB リソースのスループットを更新するためのパラメーター。

AutoscaleSettingsResource

Cosmos DB のプロビジョニング済みスループット設定オブジェクト

名前 説明
autoUpgradePolicy

AutoUpgradePolicyResource

Cosmos DB リソースの自動アップグレード ポリシー

maxThroughput

integer

スケールアップできる最大スループット コンテナーを表します。

targetMaxThroughput

integer

オファーが保留中の状態でなくなったら、ターゲットの最大スループット コンテナーをスケールアップできるを表します。

AutoUpgradePolicyResource

Cosmos DB リソースの自動アップグレード ポリシー

名前 説明
throughputPolicy

ThroughputPolicyResource

自動アップグレードのためにどのサービスに準拠する必要があるスループット ポリシーを表します

Resource

名前 説明
_etag

string

オプティミスティック コンカレンシー制御に必要なリソース etag を表すシステム生成プロパティ。

_rid

string

システムによって生成されたプロパティ。 一意識別子。

_ts

number

リソースの最後に更新されたタイムスタンプを示すシステム生成プロパティ。

autoscaleSettings

AutoscaleSettingsResource

自動スケーリング設定用の Cosmos DB リソース。 スループットが必要か、自動scaleSettings が必要ですが、両方は必要ありません。

instantMaximumThroughput

string

分割をトリガーせずに即座にスケールアップするオファーのスループット値

minimumThroughput

string

リソースの最小スループット

offerReplacePending

string

スループットの置換が保留中です

softAllowedMaximumThroughput

string

指定できる最大スループット値または最大 maxThroughput 値 (自動スケーリングの場合)

throughput

integer

Cosmos DB リソースのスループットの値。 スループットが必要か、自動scaleSettings が必要ですが、両方は必要ありません。

ThroughputPolicyResource

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

名前 説明
incrementPercent

integer

スループット ポリシーが開始されるたびにスループットが増加する割合を表します。

isEnabled

boolean

ThroughputPolicy がアクティブかどうかを判断します

ThroughputSettingsGetResults

Azure Cosmos DB リソースのスループット。

名前 説明
id

string

ARM リソースの一意のリソース識別子。

location

string

リソースが属しているリソース グループの場所。

name

string

ARM リソースの名前。

properties.resource

Resource

tags

object

タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。

type

string

Azure リソースの種類。

ThroughputSettingsResource

Cosmos DB リソース スループット オブジェクト。 スループットが必要か、自動scaleSettings が必要ですが、両方は必要ありません。

名前 説明
autoscaleSettings

AutoscaleSettingsResource

自動スケーリング設定用の Cosmos DB リソース。 スループットが必要か、自動scaleSettings が必要ですが、両方は必要ありません。

instantMaximumThroughput

string

分割をトリガーせずに即座にスケールアップするオファーのスループット値

minimumThroughput

string

リソースの最小スループット

offerReplacePending

string

スループットの置換が保留中です

softAllowedMaximumThroughput

string

指定できる最大スループット値または最大 maxThroughput 値 (自動スケーリングの場合)

throughput

integer

Cosmos DB リソースのスループットの値。 スループットが必要か、自動scaleSettings が必要ですが、両方は必要ありません。

ThroughputSettingsUpdateParameters

Cosmos DB リソースのスループットを更新するためのパラメーター。

名前 説明
id

string

ARM リソースの一意のリソース識別子。

location

string

リソースが属しているリソース グループの場所。

name

string

ARM リソースの名前。

properties.resource

ThroughputSettingsResource

リソース スループットの標準 JSON 形式

tags

object

タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。

type

string

Azure リソースの種類。