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 do URI

Name	Em	Necessário	Tipo	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.
productId	path	True	string minLength: 1 maxLength: 256	Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
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 um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	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 descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementCreateProductApi

Pedido de amostra

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 da amostra

Código de estado:: 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 estado:: 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

Name	Description
ApiContactInformation	Informações de contato da API
ApiContract	Detalhes da API.
ApiLicenseInformation	Informações de licença da API
ApiType	Tipo de API.
ApiVersionSetContractDetails	Um conjunto de versões de 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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
OAuth2AuthenticationSettingsContract	Detalhes das configurações de autenticação da API OAuth2.
OpenIdAuthenticationSettingsContract	Detalhes das configurações de autenticação da API OAuth2.
Protocol	Descreve em quais protocolos as operações nesta API podem ser invocadas.
SubscriptionKeyParameterNamesContract	Detalhes dos nomes dos parâmetros de chave de assinatura.
versioningScheme	Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP.

ApiContactInformation

Object

Informações de contato da API

Name	Tipo	Description
email	string	O endereço de e-mail da pessoa/organização de contato. DEVE estar no formato de um endereço de e-mail
name	string	O nome de identificação da pessoa/organização de contacto
url	string	O URL apontando para as informações de contato. DEVE estar no formato de um URL

ApiContract

Object

Detalhes da API.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado 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 estiver versionada
properties.apiVersionDescription	string maxLength: 256	Descrição da versão da API.
properties.apiVersionSet	ApiVersionSetContractDetails	Detalhes do conjunto de versões
properties.apiVersionSetId	string	Um identificador de recurso para o ApiVersionSet relacionado.
properties.authenticationSettings	AuthenticationSettingsContract	Coleção de configurações de autenticação incluídas nesta API.
properties.contact	ApiContactInformation	Informações de contato para a API.
properties.description	string	Descrição da API. Pode incluir tags 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 atual da api.
properties.isOnline	boolean	Indica se a revisão da API está acessível através do gateway.
properties.license	ApiLicenseInformation	Informações de licença para a API.
properties.path	string minLength: 0 maxLength: 400	URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recursos dentro da instância do serviço de Gerenciamento de API. Ele é anexado à URL base do ponto de extremidade da 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 esta API. Não pode ter mais de 2000 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 API ou assinatura de Produto é necessária para acessar a API.
properties.termsOfServiceUrl	string	Um URL para os Termos de Serviço da API. DEVE estar no formato de um URL.
properties.type	ApiType	Tipo de API.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Object

Informações de licença da API

Name	Tipo	Description
name	string	O nome da licença usado para a API
url	string	Um URL para a licença usada para a API. DEVE estar no formato de um URL

ApiType

Enumeração

Tipo de API.

Valor	Description
http
soap
websocket
graphql
odata
grpc

ApiVersionSetContractDetails

Object

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

Name	Tipo	Description
description	string	Descrição do conjunto de versões da API.
id	string	Identificador para o 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 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

Object

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

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

bearerTokenSendingMethods

Enumeração

Como enviar token para o servidor.

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

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

OAuth2AuthenticationSettingsContract

Object

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

Name	Tipo	Description
authorizationServerId	string	Identificador do servidor de autorização OAuth.
scope	string	âmbito das operações.

OpenIdAuthenticationSettingsContract

Object

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

Name	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

Object

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

Name	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.

Partilhar via

Product Api - Create Or Update

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementCreateProductApi

Pedido de amostra

Resposta da amostra

Definições

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme