Compartilhar via


Product Api - Create Or Update

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=2022-08-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
apiId
path True

string

Identificador de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ; rev=n como um sufixo em que n é o número de revisão.

Padrão Regex: ^[^*#&+:<>?]+$

productId
path True

string

Identificador do produto. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName
path True

string

O nome do serviço Gerenciamento de API.

Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

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

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

Resposta de exemplo

{
  "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
  }
}

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 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 o token para o servidor.

ErrorFieldContract

Contrato de campo de 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 nessa 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

Informações de contato da API

Nome Tipo Description
email

string

O endereço de email da pessoa/organização do contato. 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

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

Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada

properties.apiRevisionDescription

string

Descrição da Revisão de API.

properties.apiVersion

string

Indica o identificador de versão da API se a API for versão

properties.apiVersionDescription

string

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 nessa API.

properties.contact

ApiContactInformation

Informações de contato para a API.

properties.description

string

A descrição da API. Pode incluir marcas de formatação HTML.

properties.displayName

string

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 de API está acessível por meio do gateway.

properties.license

ApiLicenseInformation

Informações de licença para a API.

properties.path

string

A URL relativa que identifica exclusivamente esta 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 nessa API podem ser invocadas.

properties.serviceUrl

string

A URL absoluta do serviço de back-end implementado esta 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

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

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

Tipo de API.

Nome Tipo Description
graphql

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

Um Conjunto de Versões de 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 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

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

Como enviar o token para o servidor.

Nome Tipo Description
authorizationHeader

string

O token de acesso será transmitido no cabeçalho autorização usando o esquema de portador

query

string

O token de acesso será transmitido como parâmetros de consulta.

ErrorFieldContract

Contrato de campo de erro.

Nome Tipo Description
code

string

Código de erro no nível da propriedade.

message

string

Representação legível por humanos do erro no nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome Tipo Description
error.code

string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

ErrorFieldContract[]

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.

error.message

string

Representação legível ao olho humano do erro.

OAuth2AuthenticationSettingsContract

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

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

Nome Tipo Description
bearerTokenSendingMethods

bearerTokenSendingMethods[]

Como enviar o token para o servidor.

openidProviderId

string

Identificador do servidor de autorização OAuth.

Protocol

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

Nome Tipo Description
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

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 consulta de chave de assinatura.

versioningScheme

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

Nome Tipo Description
Header

string

A Versão da API é passada em um cabeçalho HTTP.

Query

string

A Versão da API é passada em um parâmetro de consulta.

Segment

string

A Versão da API é passada em um segmento de caminho.