Api Version Set - Update
Обновления сведения о наборе версий API, заданном его идентификатором.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2022-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
service
|
path | True |
string |
Имя службы Управление API. Regex pattern: |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
version
|
path | True |
string |
Идентификатор набора версий API. Должен быть уникальным в текущем экземпляре службы Управление API. Regex pattern: |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
If-Match | True |
string |
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
properties.description |
string |
Описание набора версий API. |
properties.displayName |
string |
Имя набора версий API |
properties.versionHeaderName |
string |
Имя параметра заголовка HTTP, указывающее версию API, если versioningScheme имеет значение |
properties.versionQueryName |
string |
Имя параметра запроса, указывающее версию API, если versioningScheme имеет значение |
properties.versioningScheme |
Значение , определяющее расположение идентификатора версии API в HTTP-запросе. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Набор версий API успешно обновлен. Headers ETag: string |
|
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 | олицетворения учетной записи пользователя |
Примеры
ApiManagementUpdateApiVersionSet
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1?api-version=2022-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"
}
}
Определения
Имя | Описание |
---|---|
Api |
Сведения о контракте набора версий API. |
Api |
Параметры для обновления или создания контракта набора версий API. |
Error |
Контракт поля ошибки. |
Error |
Ответ на ошибку. |
versioning |
Значение , определяющее расположение идентификатора версии API в HTTP-запросе. |
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" |
ApiVersionSetUpdateParameters
Параметры для обновления или создания контракта набора версий API.
Имя | Тип | Описание |
---|---|---|
properties.description |
string |
Описание набора версий API. |
properties.displayName |
string |
Имя набора версий API |
properties.versionHeaderName |
string |
Имя параметра заголовка HTTP, указывающее версию API, если versioningScheme имеет значение |
properties.versionQueryName |
string |
Имя параметра запроса, указывающее версию API, если versioningScheme имеет значение |
properties.versioningScheme |
Значение , определяющее расположение идентификатора версии API в HTTP-запросе. |
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 передается в сегменте пути. |