Mongo DB Resources - Migrate Mongo DB Collection To Manual Throughput

Azure Cosmos DB MongoDB コレクションを自動スケールから手動スループットに移行する

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToManualThroughput?api-version=2021-07-01-preview

URI パラメーター

Name In Required Type Description
accountName
path True
  • string

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

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

collectionName
path True
  • string

Cosmos DB コレクション名。

databaseName
path True
  • string

Cosmos DB データベース名。

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

応答

Name Type Description
200 OK

MongoDB コレクションの移行操作が正常に完了しました。

202 Accepted

MongoDB コレクションの移行操作は非同期的に完了します。

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

Name Description
user_impersonation ユーザー アカウントの借用

CosmosDBMongoDBCollectionMigrateToManualThroughput

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/collections/collectionName/throughputSettings/default/migrateToManualThroughput?api-version=2021-07-01-preview

Sample Response

{
  "properties": {
    "resource": {
      "throughput": 400,
      "minimumThroughput": "400",
      "offerReplacePending": "true",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

定義

AutoscaleSettingsResource

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

AutoUpgradePolicyResource

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

CloudError

サービスからのエラー応答。

ErrorResponse

エラー応答。

ManagedServiceIdentity

リソースの ID。

Resource
ResourceIdentityType

リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスから ID を削除します。

ThroughputPolicyResource

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

ThroughputSettingsGetResults

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

UserAssignedIdentities

リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

AutoscaleSettingsResource

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

Name Type Description
autoUpgradePolicy

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

maxThroughput
  • integer

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

targetMaxThroughput
  • integer

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

AutoUpgradePolicyResource

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

Name Type Description
throughputPolicy

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

CloudError

サービスからのエラー応答。

Name Type Description
error

エラー応答。

ErrorResponse

エラー応答。

Name Type Description
code
  • string

エラー コード。

message
  • string

操作が失敗した理由を示すエラー メッセージ。

ManagedServiceIdentity

リソースの ID。

Name Type Description
principalId
  • string

システム割り当て ID のプリンシパル ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。

tenantId
  • string

システム割り当て ID のテナント ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。

type

リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスから ID を削除します。

userAssignedIdentities

リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

Resource

Name Type Description
_etag
  • string

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

_rid
  • string

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

_ts
  • number

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

autoscaleSettings

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

minimumThroughput
  • string

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

offerReplacePending
  • string

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

throughput
  • integer

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

ResourceIdentityType

リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスから ID を削除します。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

ThroughputPolicyResource

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

Name Type Description
incrementPercent
  • integer

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

isEnabled
  • boolean

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

ThroughputSettingsGetResults

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

Name Type Description
id
  • string

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

identity

リソースの ID。

location
  • string

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

name
  • string

ARM リソースの名前。

properties.resource
tags
  • object

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

type
  • string

Azure リソースの種類。

UserAssignedIdentities

リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

Name Type Description