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

Api Version Set - Create Or Update

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

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?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.
versionSetId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

Идентификатор набора версий API. Должен быть уникальным в текущем экземпляре службы управления API.
api-version
 query True

string

minLength: 1

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

Заголовок запроса

Имя Обязательно Тип Описание
If-Match

string

ETag сущности. Не требуется при создании сущности, но требуется при обновлении сущности.

Текст запроса

Имя Обязательно Тип Описание
properties.displayName True

string

minLength: 1
maxLength: 100

Имя набора версий API
properties.versioningScheme True

versioningScheme

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

string

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

string

minLength: 1
maxLength: 100

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

string

minLength: 1
maxLength: 100

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

Ответы

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

ApiVersionSetContract

Набор версий API успешно обновлен.

Заголовки

ETag: string
201 Created

ApiVersionSetContract

Набор версий API успешно создан.

Заголовки

ETag: string
Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementCreateApiVersionSet

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

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

{
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

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

Код состояния:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "api1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}
Код состояния:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "api1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Определения

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

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

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

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

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

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

ApiVersionSetContract

Object

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

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

string

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

string

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

string

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

string

minLength: 1
maxLength: 100

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

string

minLength: 1
maxLength: 100

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

string

minLength: 1
maxLength: 100

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

versioningScheme

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

string

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

ErrorAdditionalInfo

Object

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

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

object

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

string

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

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

Object

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

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

ErrorDetail

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

versioningScheme

Перечисление

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

Значение Описание
Header

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

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

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