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

Gateway - List By Service

  • Ссылка
Служба:
API Management
Версия API:
2024-05-01

Содержит коллекцию шлюзов, зарегистрированных в экземпляре службы.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways?api-version=2024-05-01
С использованием необязательных параметров: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-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 (uuid)

Идентификатор целевой подписки. Значение должно быть UUID.
api-version
 query True

string

minLength: 1

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

string

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| регион | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| описание | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip
 query

integer (int32)

minimum: 0

Количество пропускаемых записей.
$top
 query

integer (int32)

minimum: 1

Количество возвращаемых записей.

Ответы

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

GatewayCollection

Перечисляет коллекцию сущностей шлюза.
Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementListGateways

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

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways?api-version=2024-05-01

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

Код состояния:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
      "type": "Microsoft.ApiManagement/service/gateways",
      "name": "a1",
      "properties": {
        "description": "my gateway 1",
        "locationData": {
          "name": "my location 1"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw2",
      "type": "Microsoft.ApiManagement/service/gateways",
      "name": "5a73933b8f27f7cc82a2d533",
      "properties": {
        "description": "my gateway 2",
        "locationData": {
          "name": "my location 2"
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Определения

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

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

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

Представление списка страничных шлюзов.
GatewayContract

Сведения о шлюзе.
ResourceLocationDataContract

Свойства данных расположения ресурсов.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

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

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

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

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

ErrorDetail

Объект ошибки.

GatewayCollection

Object

Представление списка страничных шлюзов.

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

integer (int64)

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

string

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

GatewayContract[]

Значения страницы.

GatewayContract

Object

Сведения о шлюзе.

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

string

Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.description

string

maxLength: 1000

Описание шлюза
properties.locationData

ResourceLocationDataContract

Расположение шлюза.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ResourceLocationDataContract

Object

Свойства данных расположения ресурсов.

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

string

maxLength: 256

Город или город, где находится ресурс.
countryOrRegion

string

maxLength: 256

Страна или регион, в котором находится ресурс.
district

string

maxLength: 256

Район, штат или провинция, где находится ресурс.
name

string

maxLength: 256

Каноническое имя географического или физического расположения.