Database Accounts - Online Region

指定した Azure Cosmos DB データベース アカウントの指定したリージョンをオンラインにします。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion?api-version=2021-11-15-preview

URI パラメーター

Name In Required Type Description
accountName
path True
  • string

DB データベース アカウント名をCosmosします。

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

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

要求本文

Name Required Type Description
region True
  • string

Cosmos DB 領域で、単語と各単語の間にスペースが大文字で表示されます。

応答

Name Type Description
200 OK

オンライン リージョンの操作が正常に完了しました。

202 Accepted

受理されました。 オンライン リージョンの操作は非同期で完了します。

Other Status Codes

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

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

Scopes

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

CosmosDBDatabaseAccountOnlineRegion

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/onlineRegion?api-version=2021-11-15-preview

[
  {
    "region": "North Europe"
  }
]

Sample Response

定義

ErrorResponse

エラー応答。

RegionForOnlineOffline

DB リージョンをオンラインまたはオフラインにCosmosします。

ErrorResponse

エラー応答。

Name Type Description
code
  • string

エラー コード。

message
  • string

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

RegionForOnlineOffline

DB リージョンをオンラインまたはオフラインにCosmosします。

Name Type Description
region
  • string

Cosmos DB 領域で、単語と各単語の間にスペースが大文字で表示されます。