Apis - Get

Obtém os detalhes da API especificada por seu identificador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?api-version=2021-12-01-preview

Parâmetros de URI

Name In Required Type Description
apiId
path True
  • string

Identificador de revisão de API. Deve ser exclusivo na instância de serviço do 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.

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço Gerenciamento de API.

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

subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

Respostas

Name Type Description
200 OK

O corpo da resposta contém a entidade API especificada.

Headers

  • ETag: string
Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementGetApiContract
ApiManagementGetApiRevisionContract

ApiManagementGetApiContract

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a?api-version=2021-12-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "displayName": "Service",
    "apiRevision": "1",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementGetApiRevisionContract

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3?api-version=2021-12-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Service",
    "apiRevision": "3",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "fixed bug in contract"
  }
}

Definições

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.

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.

SubscriptionKeyParameterNamesContract

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

ApiContactInformation

Informações de contato da API

Name Type 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 de contato/organização

url
  • string

A URL que aponta para as informações de contato. DEVE estar no formato de uma URL

ApiContract

Detalhes da API.

Name Type 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 estiver em versão

properties.apiVersionDescription
  • string

Descrição da versão da API.

properties.apiVersionSet

Detalhes do conjunto de versão

properties.apiVersionSetId
  • string

Um identificador de recurso para o ApiVersionSet relacionado.

properties.authenticationSettings

Coleção de configurações de autenticação incluídas nessa API.

properties.contact

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

properties.license

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
  • string[]

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

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

Tipo de API.

type
  • string

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

ApiLicenseInformation

Informações de licença de API

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

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

Name Type 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 o versioningScheme estiver definido como query.

versioningScheme enum:
  • Header
  • Query
  • Segment

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.

Name Type Description
oAuth2

Configurações de Autenticação OAuth2

openid

Configurações de Autenticação de Conexão OpenID

ErrorFieldContract

Contrato de campo de erro.

Name Type Description
code
  • string

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

message
  • string

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

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

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

A lista de campos inválidos enviada 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.

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

Name Type Description
bearerTokenSendingMethods
  • string[]

Como enviar o token para o servidor.

openidProviderId
  • string

Identificador do servidor de autorização OAuth.

SubscriptionKeyParameterNamesContract

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

Name Type Description
header
  • string

Nome do cabeçalho da chave de assinatura.

query
  • string

Nome do parâmetro de cadeia de caracteres de consulta de chave de assinatura.