Workspace Api - Update

Служба:: API Management

Версия API:: 2024-05-01

Обновляет указанный API рабочей области в экземпляре службы управления API.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}?api-version=2024-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.
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.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Идентификатор рабочей области. Должен быть уникальным в текущем экземпляре службы управления API.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

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

Имя	Обязательно	Тип	Описание
If-Match	True	string	ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или оно должно быть * для безусловного обновления.

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

Имя	Тип	Описание
properties.apiRevision	string minLength: 1 maxLength: 100	Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию
properties.apiRevisionDescription	string maxLength: 256	Описание редакции API.
properties.apiVersion	string maxLength: 100	Указывает идентификатор версии API, если API имеет версию
properties.apiVersionDescription	string maxLength: 256	Описание версии API.
properties.apiVersionSetId	string	Идентификатор ресурса для связанного ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Коллекция параметров проверки подлинности, включенных в этот API.
properties.contact	ApiContactInformation	Контактные данные API.
properties.description	string	Описание API. Может включать теги форматирования HTML.
properties.displayName	string minLength: 1 maxLength: 300	Имя API.
properties.isCurrent	boolean	Указывает, является ли редакция API текущей редакцией API.
properties.license	ApiLicenseInformation	Сведения о лицензии для API.
properties.path	string minLength: 0 maxLength: 400	Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.
properties.protocols	Protocol[]	Описывает, какие протоколы могут вызываться в этом API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Абсолютный URL-адрес серверной службы, реализующего этот API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Протоколы, через которые предоставляется API.
properties.subscriptionRequired	boolean	Указывает, требуется ли api или подписка на продукт для доступа к API.
properties.termsOfServiceUrl	string	URL-адрес условий обслуживания для API. ДОЛЖЕН быть в формате URL-адреса.
properties.type	ApiType	Тип API.

Ответы

Имя	Тип	Описание
200 OK	ApiContract	API успешно обновлен. Заголовки ETag: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

ApiContract

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

Примеры

ApiManagementUpdateWorkspaceApi

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

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api?api-version=2024-05-01


{
  "properties": {
    "displayName": "Echo API New",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho"
  }
}

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

Код состояния:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/workspaces/pis",
  "name": "echo-api",
  "properties": {
    "displayName": "Echo API New",
    "apiRevision": "1",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

Определения

Имя	Описание
ApiContactInformation	Контактные данные API
ApiContract	Сведения об API.
ApiLicenseInformation	Сведения о лицензии API
ApiType	Тип API.
ApiUpdateContract	Сведения о контракте обновления API.
ApiVersionSetContractDetails	Набор версий API содержит общую конфигурацию для набора версий API, связанных с
AuthenticationSettingsContract	Параметры проверки подлинности API.
bearerTokenSendingMethods	Как отправить маркер на сервер.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
OAuth2AuthenticationSettingsContract	Сведения о параметрах проверки подлинности OAuth2 API.
OpenIdAuthenticationSettingsContract	Сведения о параметрах проверки подлинности OAuth2 API.
Protocol	Описывает, какие протоколы могут вызываться в этом API.
SubscriptionKeyParameterNamesContract	Сведения о именах параметров ключа подписки.
versioningScheme	Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

ApiContactInformation

Object

Контактные данные API

Имя	Тип	Описание
email	string	Адрес электронной почты контактного лица или организации. Должен быть в формате адреса электронной почты
name	string	Идентификация имени контактного лица или организации
url	string	URL-адрес, указывающий на контактные данные. ДОЛЖЕН быть в формате URL-адреса

ApiContract

Object

Сведения об API.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.apiRevision	string minLength: 1 maxLength: 100	Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию
properties.apiRevisionDescription	string maxLength: 256	Описание редакции API.
properties.apiVersion	string maxLength: 100	Указывает идентификатор версии API, если API имеет версию
properties.apiVersionDescription	string maxLength: 256	Описание версии API.
properties.apiVersionSet	ApiVersionSetContractDetails	Сведения о наборе версий
properties.apiVersionSetId	string	Идентификатор ресурса для связанного ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Коллекция параметров проверки подлинности, включенных в этот API.
properties.contact	ApiContactInformation	Контактные данные API.
properties.description	string	Описание API. Может включать теги форматирования HTML.
properties.displayName	string minLength: 1 maxLength: 300	Имя API. Должно составлять от 1 до 300 символов.
properties.isCurrent	boolean	Указывает, является ли редакция API текущей редакцией API.
properties.isOnline	boolean	Указывает, доступна ли редакция API через шлюз.
properties.license	ApiLicenseInformation	Сведения о лицензии для API.
properties.path	string minLength: 0 maxLength: 400	Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.
properties.protocols	Protocol[]	Описывает, какие протоколы могут вызываться в этом API.
properties.provisioningState	string	Состояние подготовки
properties.serviceUrl	string minLength: 0 maxLength: 2000	Абсолютный URL-адрес серверной службы, реализующего этот API. Не может превышать 2000 символов.
properties.sourceApiId	string	Идентификатор API исходного API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Протоколы, через которые предоставляется API.
properties.subscriptionRequired	boolean	Указывает, требуется ли api или подписка на продукт для доступа к API.
properties.termsOfServiceUrl	string	URL-адрес условий обслуживания для API. ДОЛЖЕН быть в формате URL-адреса.
properties.type	ApiType	Тип API.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Object

Сведения о лицензии API

Имя	Тип	Описание
name	string	Имя лицензии, используемое для API
url	string	URL-адрес лицензии, используемой для API. ДОЛЖЕН быть в формате URL-адреса

ApiType

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

Тип API.

Значение	Описание
http
soap
websocket
graphql
odata
grpc

ApiUpdateContract

Object

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

Имя	Тип	Описание
properties.apiRevision	string minLength: 1 maxLength: 100	Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию
properties.apiRevisionDescription	string maxLength: 256	Описание редакции API.
properties.apiVersion	string maxLength: 100	Указывает идентификатор версии API, если API имеет версию
properties.apiVersionDescription	string maxLength: 256	Описание версии API.
properties.apiVersionSetId	string	Идентификатор ресурса для связанного ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Коллекция параметров проверки подлинности, включенных в этот API.
properties.contact	ApiContactInformation	Контактные данные API.
properties.description	string	Описание API. Может включать теги форматирования HTML.
properties.displayName	string minLength: 1 maxLength: 300	Имя API.
properties.isCurrent	boolean	Указывает, является ли редакция API текущей редакцией API.
properties.isOnline	boolean	Указывает, доступна ли редакция API через шлюз.
properties.license	ApiLicenseInformation	Сведения о лицензии для API.
properties.path	string minLength: 0 maxLength: 400	Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.
properties.protocols	Protocol[]	Описывает, какие протоколы могут вызываться в этом API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Абсолютный URL-адрес серверной службы, реализующего этот API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Протоколы, через которые предоставляется API.
properties.subscriptionRequired	boolean	Указывает, требуется ли api или подписка на продукт для доступа к API.
properties.termsOfServiceUrl	string	URL-адрес условий обслуживания для API. ДОЛЖЕН быть в формате URL-адреса.
properties.type	ApiType	Тип API.

ApiVersionSetContractDetails

Object

Набор версий API содержит общую конфигурацию для набора версий API, связанных с

Имя	Тип	Описание
description	string	Описание набора версий API.
id	string	Идентификатор существующего набора версий API. Опустим это значение, чтобы создать новый набор версий.
name	string	Отображаемое имя набора версий API.
versionHeaderName	string	Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение `header`.
versionQueryName	string	Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение `query`.
versioningScheme	versioningScheme	Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

AuthenticationSettingsContract

Object

Параметры проверки подлинности API.

Имя	Тип	Описание
oAuth2	OAuth2AuthenticationSettingsContract	Параметры проверки подлинности OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Коллекция параметров проверки подлинности OAuth2, включенных в этот API.
openid	OpenIdAuthenticationSettingsContract	Параметры проверки подлинности OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Коллекция параметров проверки подлинности Open ID Connect, включенных в этот API.

bearerTokenSendingMethods

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

Как отправить маркер на сервер.

Значение	Описание
authorizationHeader	Маркер доступа передается в заголовке авторизации с помощью схемы носителя
query	Маркер доступа передается в качестве параметров запроса.

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

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

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

OAuth2AuthenticationSettingsContract

Object

Сведения о параметрах проверки подлинности OAuth2 API.

Имя	Тип	Описание
authorizationServerId	string	Идентификатор сервера авторизации OAuth.
scope	string	область операций.

OpenIdAuthenticationSettingsContract

Object

Сведения о параметрах проверки подлинности OAuth2 API.

Имя	Тип	Описание
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Как отправить маркер на сервер.
openidProviderId	string	Идентификатор сервера авторизации OAuth.

Protocol

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

Описывает, какие протоколы могут вызываться в этом API.

Значение	Описание
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Сведения о именах параметров ключа подписки.

Имя	Тип	Описание
header	string	Имя заголовка ключа подписки.
query	string	Имя параметра строки запроса ключа подписки.

versioningScheme

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

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

Значение	Описание
Segment	Версия API передается в сегмент пути.
Query	Версия API передается в параметре запроса.
Header	Версия API передается в заголовке HTTP.

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

Workspace Api - Update

Параметры URI

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

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

Ответы

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

azure_auth

Области

Примеры

ApiManagementUpdateWorkspaceApi

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

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

Определения

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiUpdateContract

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme