Api Version Set - List By Service

Возвращает коллекцию наборов версий API в указанном экземпляре службы.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01

Параметры URI

Name In Required Type Description
resourceGroupName
path True
  • string

Имя группы ресурсов.

serviceName
path True
  • string

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

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True
  • string

Версия API, используемая с клиентским запросом.

$filter
query
  • string

| | полей | использования Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|

$skip
query
  • integer
int32

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

$top
query
  • integer
int32

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

Ответы

Name Type Description
200 OK

Перечисляет коллекцию сущностей набора версий API.

Other Status Codes

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

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

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

ApiManagementListApiVersionSets

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "vs1",
      "properties": {
        "displayName": "api set 1",
        "versioningScheme": "Segment",
        "description": "Version configuration"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "vs2",
      "properties": {
        "displayName": "api set 2",
        "versioningScheme": "Query",
        "description": "Version configuration 2"
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Определения

ApiVersionSetCollection

Представление списка "Набор версий API для страничных страниц".

ApiVersionSetContract

Сведения о контракте набора версий API.

ErrorFieldContract

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

ErrorResponse

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

versioningScheme

Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

ApiVersionSetCollection

Представление списка "Набор версий API для страничных страниц".

Name Type Description
count
  • integer

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

nextLink
  • string

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

value

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

ApiVersionSetContract

Сведения о контракте набора версий API.

Name Type Description
id
  • string

Полный идентификатор ресурса. Например, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Имя ресурса.

properties.description
  • string

Описание набора версий API.

properties.displayName
  • string

Имя набора версий API

properties.versionHeaderName
  • string

Имя параметра заголовка HTTP, указывающего версию API, если задано значение headerversioningScheme.

properties.versionQueryName
  • string

Имя параметра запроса, указывающего версию API, если параметр versioningScheme имеет значение query.

properties.versioningScheme

Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

type
  • string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft. служба хранилища/storageAccounts"

ErrorFieldContract

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

Name Type Description
code
  • string

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

message
  • string

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

target
  • string

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

ErrorResponse

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

Name Type Description
error.code
  • string

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

error.details

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

error.message
  • string

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

versioningScheme

Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

Name Type Description
Header
  • string

Версия API передается в заголовке HTTP.

Query
  • string

Версия API передается в параметре запроса.

Segment
  • string

Версия API передается в сегменте пути.