Поделиться через


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

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

LocationListResult

Операция выполнена успешно.

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
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

Ответ операции List, содержащий расположения Cosmos DB и их свойства.

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

Ответ операции List, содержащий расположения Cosmos DB и их свойства.

Имя Тип Описание
value

LocationGetResult[]

Список расположений Cosmos DB и их свойств.

LocationProperties

Метаданные расположения Cosmos DB

Имя Тип Описание
backupStorageRedundancies

BackupStorageRedundancy[]

Свойства доступных резервных хранилищ избыточности.

isResidencyRestricted

boolean

Флаг, указывающий, является ли расположение чувствительным к месту расположения.

isSubscriptionRegionAccessAllowedForAz

boolean

Флаг, указывающий, имеет ли подписка доступ в регионе для Зоны доступности(Az).

isSubscriptionRegionAccessAllowedForRegular

boolean

Флаг, указывающий, имеет ли подписка доступ в регионе для Зоны доступности.

status

Status

Перечисление для указания текущего состояния сборки региона.

supportsAvailabilityZone

boolean

Флаг, указывающий, поддерживает ли расположение зоны доступности.

Status

Перечисление для указания текущего состояния сборки региона.

Имя Тип Описание
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string