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


Region - List By Service

Выводит список всех регионов Azure, в которых существует служба.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions?api-version=2022-08-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.

serviceName
path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Имя службы управления API.

subscriptionId
path True

string

minLength: 1

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

api-version
query True

string

minLength: 1

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

Ответы

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

RegionListResult

Списки регионов, в которых развернута служба.

Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

ApiManagementListRegions

Образец запроса

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/regions?api-version=2022-08-01

Пример ответа

{
  "value": [
    {
      "name": "West US",
      "isMasterRegion": true,
      "isDeleted": false
    }
  ],
  "count": 1,
  "nextLink": ""
}

Определения

Имя Описание
ErrorFieldContract

Контракт поля ошибки.

ErrorResponse

Ответ на ошибку.

RegionContract

Профиль региона.

RegionListResult

Выводит сведения об ответе на операцию "Регионы".

ErrorFieldContract

Контракт поля ошибки.

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

string

Код ошибки уровня свойств.

message

string

Удобочитаемое пользователем представление ошибки уровня свойств.

target

string

Имя свойства.

ErrorResponse

Ответ на ошибку.

Имя Тип Описание
error.code

string

Код ошибки, определенный службой. Этот код служит вложенным состоянием для кода ошибки HTTP, указанного в ответе.

error.details

ErrorFieldContract[]

Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.

error.message

string

Читаемое человеком представление ошибки.

RegionContract

Профиль региона.

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

boolean

Удаляется ли регион.

isMasterRegion

boolean

Является ли регион главным регионом.

name

string

Имя региона.

RegionListResult

Выводит сведения об ответе на операцию "Регионы".

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

integer (int64)

Общее число записей на всех страницах.

nextLink

string

Следующая ссылка на страницу, если она есть.

value

RegionContract[]

Списки регионов.