Product Api - Create Or Update

Serviço:: API Management

Versão da API:: 2024-05-01

Adiciona uma API ao produto especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificador de revisão de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.
productId	path	True	string minLength: 1 maxLength: 256	Identificador do produto. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ApiContract	A API especificada já foi adicionada ao produto.
201 Created	ApiContract	A API foi adicionada com êxito ao produto.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementCreateProductApi

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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
  }
}

Código de status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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
  }
}

Definições

Nome	Description
ApiContactInformation	Informações de contato da API
ApiContract	Detalhes da API.
ApiLicenseInformation	Informações de licença de API
ApiType	Tipo de API.
ApiVersionSetContractDetails	Um conjunto de versões da API contém a configuração comum para um conjunto de versões de API relacionadas
AuthenticationSettingsContract	Configurações de Autenticação de API.
bearerTokenSendingMethods	Como enviar token para o servidor.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
OAuth2AuthenticationSettingsContract	Detalhes das configurações de Autenticação OAuth2 da API.
OpenIdAuthenticationSettingsContract	Detalhes das configurações de Autenticação OAuth2 da API.
Protocol	Descreve em quais protocolos as operações nesta API podem ser invocadas.
SubscriptionKeyParameterNamesContract	Detalhes dos nomes dos parâmetros da chave de assinatura.
versioningScheme	Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP.

ApiContactInformation

Objeto

Informações de contato da API

Nome	Tipo	Description
email	string	O endereço de email da pessoa de contato/organização. DEVE estar no formato de um endereço de email
name	string	O nome de identificação da pessoa/organização do contato
url	string	A URL que aponta para as informações de contato. DEVE estar no formato de uma URL

ApiContract

Objeto

Detalhes da API.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.apiRevision	string minLength: 1 maxLength: 100	Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada
properties.apiRevisionDescription	string maxLength: 256	Descrição da Revisão da API.
properties.apiVersion	string maxLength: 100	Indica o identificador de versão da API se a API for versão
properties.apiVersionDescription	string maxLength: 256	Descrição da versão da API.
properties.apiVersionSet	ApiVersionSetContractDetails	Detalhes do conjunto de versão
properties.apiVersionSetId	string	Um identificador de recurso para o ApiVersionSet relacionado.
properties.authenticationSettings	AuthenticationSettingsContract	Coleção de configurações de autenticação incluídas nessa API.
properties.contact	ApiContactInformation	Informações de contato para a API.
properties.description	string	Descrição da API. Pode incluir marcas de formatação HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nome da API. Deve ter de 1 a 300 caracteres.
properties.isCurrent	boolean	Indica se a revisão da API é a revisão de API atual.
properties.isOnline	boolean	Indica se a revisão da API está acessível por meio do gateway.
properties.license	ApiLicenseInformation	Informações de licença para a API.
properties.path	string minLength: 0 maxLength: 400	URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API.
properties.protocols	Protocol[]	Descreve em quais protocolos as operações nesta API podem ser invocadas.
properties.provisioningState	string	O estado de provisionamento
properties.serviceUrl	string minLength: 0 maxLength: 2000	URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 caracteres.
properties.sourceApiId	string	Identificador de API da API de origem.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolos sobre os quais a API é disponibilizada.
properties.subscriptionRequired	boolean	Especifica se uma assinatura de API ou produto é necessária para acessar a API.
properties.termsOfServiceUrl	string	Uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.
properties.type	ApiType	Tipo de API.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Objeto

Informações de licença de API

Nome	Tipo	Description
name	string	O nome da licença usado para a API
url	string	Uma URL para a licença usada para a API. DEVE estar no formato de uma URL

ApiType

Enumeração

Tipo de API.

Valor	Description
http
soap
websocket
graphql
odata
grpc

ApiVersionSetContractDetails

Objeto

Um conjunto de versões da API contém a configuração comum para um conjunto de versões de API relacionadas

Nome	Tipo	Description
description	string	Descrição do Conjunto de Versões da API.
id	string	Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões.
name	string	O nome de exibição do conjunto de versões da API.
versionHeaderName	string	Nome do parâmetro de cabeçalho HTTP que indica a versão da API se o versioningScheme estiver definido como `header`.
versionQueryName	string	Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como `query`.
versioningScheme	versioningScheme	Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP.

AuthenticationSettingsContract

Objeto

Configurações de Autenticação de API.

Nome	Tipo	Description
oAuth2	OAuth2AuthenticationSettingsContract	Configurações de Autenticação OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Coleção de configurações de autenticação OAuth2 incluídas nessa API.
openid	OpenIdAuthenticationSettingsContract	Configurações de autenticação do OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Coleção de configurações de autenticação do Open ID Connect incluídas nessa API.

bearerTokenSendingMethods

Enumeração

Como enviar token para o servidor.

Valor	Description
authorizationHeader	O token de acesso será transmitido no cabeçalho autorização usando o esquema de portador
query	O token de acesso será transmitido como parâmetros de consulta.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

OAuth2AuthenticationSettingsContract

Objeto

Detalhes das configurações de Autenticação OAuth2 da API.

Nome	Tipo	Description
authorizationServerId	string	Identificador do servidor de autorização OAuth.
scope	string	escopo de operações.

OpenIdAuthenticationSettingsContract

Objeto

Detalhes das configurações de Autenticação OAuth2 da API.

Nome	Tipo	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Como enviar token para o servidor.
openidProviderId	string	Identificador do servidor de autorização OAuth.

Protocol

Enumeração

Descreve em quais protocolos as operações nesta API podem ser invocadas.

Valor	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Objeto

Detalhes dos nomes dos parâmetros da chave de assinatura.

Nome	Tipo	Description
header	string	Nome do cabeçalho da chave de assinatura.
query	string	Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.

versioningScheme

Enumeração

Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP.

Valor	Description
Segment	A versão da API é passada em um segmento de caminho.
Query	A versão da API é passada em um parâmetro de consulta.
Header	A versão da API é passada em um cabeçalho HTTP.

Compartilhar via

Product Api - Create Or Update

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementCreateProductApi

Solicitação de exemplo

Resposta de exemplo

Definições

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme