Locations - Get

既存の Cosmos DB の場所のプロパティを取得する

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}?api-version=2021-11-15-preview

URI パラメーター

Name In Required Type Description
location
path True
  • string

Cosmos DB リージョン。単語と各単語の間にスペースが大文字で表示されます。

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

応答

Name Type Description
200 OK

Cosmos DB の場所のプロパティが正常に取得されました。

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 ユーザー アカウントの借用

CosmosDBLocationGet

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus?api-version=2021-11-15-preview

Sample Response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus",
  "type": "Microsoft.DocumentDB/locations",
  "name": "westus",
  "properties": {
    "status": "ProductionSLA",
    "supportsAvailabilityZone": true,
    "isResidencyRestricted": true,
    "backupStorageRedundancies": [
      "Local",
      "Geo"
    ]
  }
}

定義

CloudError

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

ErrorResponse

エラー応答。

LocationGetResult

Cosmos DB の場所の結果の取得

LocationProperties

Cosmos DB の場所のメタデータ

CloudError

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

Name Type Description
error

エラー応答。

ErrorResponse

エラー応答。

Name Type Description
code
  • string

エラー コード。

message
  • string

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

LocationGetResult

Cosmos DB の場所の結果の取得

Name Type Description
id
  • string

データベース アカウントの一意のリソース識別子。

name
  • string

データベース アカウントの名前。

properties

Cosmos DB の場所のメタデータ

type
  • string

Azure リソースの種類。

LocationProperties

Cosmos DB の場所のメタデータ

Name Type Description
backupStorageRedundancies
  • string[]

使用可能なバックアップ ストレージの冗長性のプロパティ。

isResidencyRestricted
  • boolean

場所が所在地に依存しているかどうかを示すフラグ。

status
  • string

Azure の場所の現在の状態。

supportsAvailabilityZone
  • boolean

場所が可用性ゾーンをサポートしているかどうかを示すフラグ。