Api Export - Get

Obtém os detalhes da API especificada por seu identificador no formato especificado para o blob de Armazenamento com chave SAS válido por 5 minutos.

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

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.

export
query True

Parâmetro de consulta necessário para exportar os detalhes da API.

format
query True

Formato no qual exportar os Detalhes da API para o Blob de Armazenamento com Chave Sas válido por 5 minutos.

Respostas

Name Type Description
200 OK

A resposta contém um fluxo com um conjunto completo de metadados de API e inclui a entidade de API com uma matriz integrada de entidades de operação.

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

ApiManagementGetApiExportInOpenApi2dot0
ApiManagementGetApiExportInOpenApi3dot0

ApiManagementGetApiExportInOpenApi2dot0

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api?format=swagger-link&export=true&api-version=2021-08-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
  "format": "swagger-link-json",
  "value": {
    "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?sv=2015-07-08&sr=b&sig=mxhLsFuOonu8EXIjyFPV%2FnDra0qTIoip7N7MuU%2BTFsA%3D&se=2019-04-10T22:41:31Z&sp=r"
  }
}

ApiManagementGetApiExportInOpenApi3dot0

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676?format=openapi-link&export=true&api-version=2021-08-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676",
  "format": "openapi-link",
  "value": {
    "link": "https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?sv=2015-07-08&sr=b&sig=qqtR1y5iTbz5P7USBduqB5vriIU4gmiGqe0lKVV8j9k%3D&se=2019-04-10T22:40:57Z&sp=r"
  }
}

Definições

ApiExportResult

Resultado da Exportação de API.

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

ExportApi

Parâmetro de consulta necessário para exportar os detalhes da API.

ExportFormat

Formato no qual exportar os Detalhes da API para o Blob de Armazenamento com Chave Sas válido por 5 minutos.

ExportResultFormat

Formato no qual os Detalhes da API são exportados para o Blob Armazenamento com Chave Sas válido por 5 minutos.

Value

O objeto que define o esquema do Detalhe da API exportada

ApiExportResult

Resultado da Exportação de API.

Name Type Description
format

Formato no qual os Detalhes da API são exportados para o Blob Armazenamento com Chave Sas válido por 5 minutos.

id
  • string

ResourceId da API que foi exportada.

value

O objeto que define o esquema do Detalhe da API exportada

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.

ExportApi

Parâmetro de consulta necessário para exportar os detalhes da API.

Name Type Description
true
  • string

ExportFormat

Formato no qual exportar os Detalhes da API para o Blob de Armazenamento com Chave Sas válido por 5 minutos.

Name Type Description
openapi+json-link
  • string

Exporte a definição de API na Especificação do OpenAPI 3.0 como documento JSON para Armazenamento Blob.

openapi-link
  • string

Exporte a definição de API na Especificação do OpenAPI 3.0 como documento YAML para Armazenamento Blob.

swagger-link
  • string

Exporte a definição de API na Especificação do OpenAPI 2.0 como documento JSON para o blob de Armazenamento.

wadl-link
  • string

Exporte a definição de API no esquema WADL para Armazenamento Blob.

wsdl-link
  • string

Exporte a definição de API no esquema WSDL para Armazenamento Blob. Isso só tem suporte para APIs do Tipo soap

ExportResultFormat

Formato no qual os Detalhes da API são exportados para o Blob Armazenamento com Chave Sas válido por 5 minutos.

Name Type Description
openapi-link
  • string

Exporte a definição de API na Especificação 3.0 do OpenAPI para Armazenamento Blob.

swagger-link-json
  • string

A Definição de API é exportada no formato OpenAPI Specification 2.0 para o blob de Armazenamento.

wadl-link-json
  • string

Exporte a definição de API no esquema WADL para Armazenamento Blob.

wsdl-link+xml
  • string

A Definição de API é exportada no esquema WSDL para Armazenamento Blob. Isso só tem suporte para APIs do Tipo soap

Value

O objeto que define o esquema do Detalhe da API exportada

Name Type Description
link
  • string

Link para o Blob Armazenamento que contém o resultado da operação de exportação. O Uri de Blob só é válido por 5 minutos.