共用方式為


Locations - List

列出 Cosmos DB 位置和其屬性

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

URI 參數

名稱 位於 必要 類型 Description
subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

LocationListResult

作業已成功完成。

Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
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"
      }
    }
  ]
}

定義

名稱 Description
BackupStorageRedundancy

列舉,表示備份記憶體備援的類型。

CloudError

來自服務的錯誤回應。

ErrorResponse

錯誤回應。

LocationGetResult

Cosmos DB 位置取得結果

LocationListResult

列出作業回應,其中包含Cosmos DB位置和其屬性。

LocationProperties

Cosmos DB 位置元數據

Status

列舉,表示區域目前的建置狀態。

BackupStorageRedundancy

列舉,表示備份記憶體備援的類型。

名稱 類型 Description
Geo

string

Local

string

Zone

string

CloudError

來自服務的錯誤回應。

名稱 類型 Description
error

ErrorResponse

錯誤回應。

ErrorResponse

錯誤回應。

名稱 類型 Description
code

string

錯誤碼。

message

string

指出作業失敗原因的錯誤訊息。

LocationGetResult

Cosmos DB 位置取得結果

名稱 類型 Description
id

string

資料庫帳戶的唯一資源標識碼。

name

string

資料庫帳戶的名稱。

properties

LocationProperties

Cosmos DB 位置元數據

type

string

Azure 資源的類型。

LocationListResult

列出作業回應,其中包含Cosmos DB位置和其屬性。

名稱 類型 Description
value

LocationGetResult[]

Cosmos DB 位置和其屬性的清單。

LocationProperties

Cosmos DB 位置元數據

名稱 類型 Description
backupStorageRedundancies

BackupStorageRedundancy[]

可用備份記憶體備援的屬性。

isResidencyRestricted

boolean

指出位置是否區分落地的旗標。

isSubscriptionRegionAccessAllowedForAz

boolean

旗標,指出訂用帳戶是否具有 az) 可用性區域 (區域中的存取權。

isSubscriptionRegionAccessAllowedForRegular

boolean

旗標,指出訂用帳戶是否具有非 可用性區域 區域的存取權。

status

Status

列舉,表示區域目前的建置狀態。

supportsAvailabilityZone

boolean

指出位置是否支援可用性區域的旗標。

Status

列舉,表示區域目前的建置狀態。

名稱 類型 Description
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string