Api Version Set - List By Service
Возвращает коллекцию наборов версий API в указанном экземпляре службы.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?api-version=2022-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=2022-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
service
|
path | True |
string |
Имя службы Управление API. Regex pattern: |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
$filter
|
query |
string |
| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции | |
|
$skip
|
query |
integer int32 |
Количество записей, которые будут пропущены. |
|
$top
|
query |
integer int32 |
Количество возвращаемых записей. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Перечисляет коллекцию сущностей набора версий API. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementListApiVersionSets
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets?api-version=2022-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": ""
}
Определения
Имя | Описание |
---|---|
Api |
Представление списка наборов версий API для страничных страниц. |
Api |
Сведения о контракте набора версий API. |
Error |
Контракт поля ошибки. |
Error |
Ответ об ошибке. |
versioning |
Значение , определяющее расположение идентификатора версии API в HTTP-запросе. |
ApiVersionSetCollection
Представление списка наборов версий API для страничных страниц.
Имя | Тип | Описание |
---|---|---|
count |
integer |
Общее число записей на всех страницах. |
nextLink |
string |
Ссылка на следующую страницу, если она есть. |
value |
Значения страницы. |
ApiVersionSetContract
Сведения о контракте набора версий API.
Имя | Тип | Описание |
---|---|---|
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, если versioningScheme имеет значение |
properties.versionQueryName |
string |
Имя параметра запроса, указывающего версию API, если versioningScheme имеет значение |
properties.versioningScheme |
Значение , определяющее расположение идентификатора версии API в HTTP-запросе. |
|
type |
string |
Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойства. |
message |
string |
Удобочитаемое представление ошибки на уровне свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ об ошибке.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
versioningScheme
Значение , определяющее расположение идентификатора версии API в HTTP-запросе.
Имя | Тип | Описание |
---|---|---|
Header |
string |
Версия API передается в заголовке HTTP. |
Query |
string |
Версия API передается в параметре запроса. |
Segment |
string |
Версия API передается в сегменте пути. |