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


Product Api - Create Or Update

Добавляет API в указанный продукт.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}?api-version=2022-08-01

Параметры URI

Имя В Обязательно Тип Описание
apiId
path True

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Текущая редакция имеет ; rev=n в виде суффикса, где n — номер редакции.

Шаблон регулярного выражения: ^[^*#&+:<>?]+$

productId
path True

string

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

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName
path True

string

Имя службы Управление API.

Шаблон регулярного выражения: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

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

Ответы

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

ApiContract

Указанный API уже добавлен в продукт.

201 Created

ApiContract

API успешно добавлен в продукт.

Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

ApiManagementCreateProductApi

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

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apis/echo-api?api-version=2022-08-01

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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

Определения

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

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

ApiContract

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

ApiLicenseInformation

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

ApiType

Тип API.

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

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

bearerTokenSendingMethods

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

ErrorFieldContract

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

ErrorResponse

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

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

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

Protocol

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

SubscriptionKeyParameterNamesContract

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

versioningScheme

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

ApiContactInformation

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

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

string

Адрес электронной почты контактного лица или организации. ДОЛЖЕН быть в формате адреса электронной почты

name

string

Идентифицирующие имя контактного лица или организации

url

string

URL-адрес, указывающий на контактные данные. ДОЛЖЕН быть в формате URL-адреса.

ApiContract

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

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

string

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

name

string

Имя ресурса.

properties.apiRevision

string

Описывает редакцию API. Если значение не указано, создается редакция 1 по умолчанию

properties.apiRevisionDescription

string

Описание редакции API.

properties.apiVersion

string

Указывает идентификатор версии API, если API имеет версию

properties.apiVersionDescription

string

Описание версии API.

properties.apiVersionSet

ApiVersionSetContractDetails

Сведения о наборе версий

properties.apiVersionSetId

string

Идентификатор ресурса для связанного ApiVersionSet.

properties.authenticationSettings

AuthenticationSettingsContract

Коллекция параметров проверки подлинности, включенных в этот API.

properties.contact

ApiContactInformation

Контактные данные ДЛЯ API.

properties.description

string

Описание API. Может содержать теги форматирования HTML.

properties.displayName

string

Имя API. Должен содержать от 1 до 300 символов.

properties.isCurrent

boolean

Указывает, является ли редакция API текущей редакцией API.

properties.isOnline

boolean

Указывает, доступна ли редакция API через шлюз.

properties.license

ApiLicenseInformation

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

properties.path

string

Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.

properties.protocols

Protocol[]

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

properties.serviceUrl

string

Абсолютный 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

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

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

string

Имя лицензии, используемое для API

url

string

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

ApiType

Тип API.

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

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

Набор версий 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

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

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

OAuth2AuthenticationSettingsContract

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

oAuth2AuthenticationSettings

OAuth2AuthenticationSettingsContract[]

Коллекция параметров проверки подлинности OAuth2, включенных в этот API.

openid

OpenIdAuthenticationSettingsContract

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

openidAuthenticationSettings

OpenIdAuthenticationSettingsContract[]

Коллекция параметров проверки подлинности Open ID Connect, включенных в этот API.

bearerTokenSendingMethods

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

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

string

Маркер доступа будет передаваться в заголовке авторизации с помощью схемы носителя

query

string

Маркер доступа будет передаваться в качестве параметров запроса.

ErrorFieldContract

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

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

string

Код ошибки уровня свойства.

message

string

Понятное представление ошибки на уровне свойств.

target

string

Имя свойства.

ErrorResponse

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

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

string

Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.

error.details

ErrorFieldContract[]

Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.

error.message

string

Читаемое представление ошибки.

OAuth2AuthenticationSettingsContract

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

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

string

Идентификатор сервера авторизации OAuth.

scope

string

операции область.

OpenIdAuthenticationSettingsContract

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

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

bearerTokenSendingMethods[]

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

openidProviderId

string

Идентификатор сервера авторизации OAuth.

Protocol

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

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

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

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

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

string

Имя заголовка ключа подписки.

query

string

Имя параметра строки запроса ключа подписки.

versioningScheme

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

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

string

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

Query

string

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

Segment

string

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