Api Version Set - Update

Обновляет сведения о наборе версий API, указанном идентификатором.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?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 для каждого вызова службы.

versionSetId
path True
  • string

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

Regex pattern: ^[^*#&+:<>?]+$

api-version
query True
  • string

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

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

Name Required Type Description
If-Match True
  • string

ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или должно быть * для безусловного обновления.

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

Name Type Description
properties.description
  • string

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

properties.displayName
  • string

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

properties.versionHeaderName
  • string

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

properties.versionQueryName
  • string

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

properties.versioningScheme

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

Ответы

Name Type Description
200 OK

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

Headers

  • ETag: string
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 олицетворения учетной записи пользователя

Примеры

ApiManagementUpdateApiVersionSet

Sample Request

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


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

Sample Response

{
  "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"
  }
}

Определения

ApiVersionSetContract

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

ApiVersionSetUpdateParameters

Параметры для обновления или создания контракта набора версий API.

ErrorFieldContract

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

ErrorResponse

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

versioningScheme

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

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"

ApiVersionSetUpdateParameters

Параметры для обновления или создания контракта набора версий API.

Name Type Description
properties.description
  • string

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

properties.displayName
  • string

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

properties.versionHeaderName
  • string

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

properties.versionQueryName
  • string

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

properties.versioningScheme

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

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 передается в сегменте пути.