次の方法で共有


Locations - List

Cosmos DB の場所とそのプロパティを一覧表示する

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations?api-version=2024-05-15

URI パラメーター

名前 / 必須 説明
subscriptionId
path True

string

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

api-version
query True

string

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

応答

名前 説明
200 OK

LocationListResult

操作は正常に完了しました。

Other Status Codes

CloudError

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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

CosmosDBLocationList

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations?api-version=2024-05-15

応答のサンプル

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus",
      "type": "Microsoft.DocumentDB/locations",
      "name": "westus",
      "properties": {
        "supportsAvailabilityZone": false,
        "isResidencyRestricted": false,
        "backupStorageRedundancies": [
          "Local",
          "Geo"
        ],
        "isSubscriptionRegionAccessAllowedForRegular": true,
        "isSubscriptionRegionAccessAllowedForAz": false,
        "status": "Online"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/centralus",
      "type": "Microsoft.DocumentDB/locations",
      "name": "centralus",
      "properties": {
        "supportsAvailabilityZone": true,
        "isResidencyRestricted": false,
        "backupStorageRedundancies": [
          "Zone",
          "Geo"
        ],
        "isSubscriptionRegionAccessAllowedForRegular": false,
        "isSubscriptionRegionAccessAllowedForAz": true,
        "status": "Online"
      }
    }
  ]
}

定義

名前 説明
BackupStorageRedundancy

バックアップ ストレージの冗長性の種類を示す列挙型。

CloudError

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

ErrorResponse

エラー応答。

LocationGetResult

Cosmos DB の場所の結果の取得

LocationListResult

Cosmos DB の場所とそのプロパティを含む List 操作応答。

LocationProperties

Cosmos DB の場所のメタデータ

Status

リージョンの現在のビルドアウト状態を示す列挙型。

BackupStorageRedundancy

バックアップ ストレージの冗長性の種類を示す列挙型。

名前 説明
Geo

string

Local

string

Zone

string

CloudError

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

名前 説明
error

ErrorResponse

エラー応答。

ErrorResponse

エラー応答。

名前 説明
code

string

エラー コード。

message

string

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

LocationGetResult

Cosmos DB の場所の結果の取得

名前 説明
id

string

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

name

string

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

properties

LocationProperties

Cosmos DB の場所のメタデータ

type

string

Azure リソースの種類。

LocationListResult

Cosmos DB の場所とそのプロパティを含む List 操作応答。

名前 説明
value

LocationGetResult[]

Cosmos DB の場所とそのプロパティの一覧。

LocationProperties

Cosmos DB の場所のメタデータ

名前 説明
backupStorageRedundancies

BackupStorageRedundancy[]

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

isResidencyRestricted

boolean

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

isSubscriptionRegionAccessAllowedForAz

boolean

サブスクリプションが Availability Zones(Az) のリージョンでアクセスできるかどうかを示すフラグ。

isSubscriptionRegionAccessAllowedForRegular

boolean

サブスクリプションが非Availability Zonesのリージョンでアクセスできるかどうかを示すフラグ。

status

Status

リージョンの現在のビルドアウト状態を示す列挙型。

supportsAvailabilityZone

boolean

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

Status

リージョンの現在のビルドアウト状態を示す列挙型。

名前 説明
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string