Api Export - Get

Obtém os detalhes da API especificada pelo respetivo identificador no formato especificado para o Blob de Armazenamento com Chave SAS válido durante 5 minutos.

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

Parâmetros do URI

Name Em Necessário Tipo Description
apiId
path True

string

Identificador de revisão da API. Tem de ser exclusivo na instância de serviço de Gestão 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. O nome não é sensível a maiúsculas e minúsculas.

serviceName
path True

string

O nome do serviço Gestão de API.

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

subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

A versão da API a utilizar para esta operação.

export
query True

ExportApi

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

format
query True

ExportFormat

Formatar para exportar os Detalhes da API para o Blob de Armazenamento com Chave Sas válido durante 5 minutos.

Respostas

Name Tipo Description
200 OK

ApiExportResult

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

Other Status Codes

ErrorResponse

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

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=2022-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=2022-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?storage-sas-signature"
  }
}

Definições

Name Description
ApiExportResult

Resultado da Exportação da API.

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta a Erros.

ExportApi

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

ExportFormat

Formatar para exportar os Detalhes da API para o Blob de Armazenamento com Chave Sas válido durante 5 minutos.

ExportResultFormat

Formatar em que os Detalhes da API são exportados para o Blob de Armazenamento com Chave Sas válido durante 5 minutos.

Value

O objeto que define o esquema do Detalhe da API exportada

ApiExportResult

Resultado da Exportação da API.

Name Tipo Description
format

ExportResultFormat

Formatar em que os Detalhes da API são exportados para o Blob de Armazenamento com Chave Sas válido durante 5 minutos.

id

string

ResourceId da API que foi exportada.

value

Value

O objeto que define o esquema do Detalhe da API exportada

ErrorFieldContract

Contrato de campo de erro.

Name Tipo Description
code

string

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

message

string

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

target

string

Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name Tipo Description
error.code

string

Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.

error.details

ErrorFieldContract[]

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

error.message

string

Representação legível por humanos do erro.

ExportApi

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

Name Tipo Description
true

string

ExportFormat

Formatar para exportar os Detalhes da API para o Blob de Armazenamento com Chave Sas válido durante 5 minutos.

Name Tipo Description
openapi+json-link

string

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

openapi-link

string

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

swagger-link

string

Exporte a Definição da API em OpenAPI 2.0 Specification como documento JSON para o Blob de Armazenamento.

wadl-link

string

Exporte a Definição de API no Esquema WADL para o Blob de Armazenamento.

wsdl-link

string

Exporte a Definição de API no Esquema WSDL para o Blob de Armazenamento. Isto só é suportado para APIs do Tipo soap

ExportResultFormat

Formatar em que os Detalhes da API são exportados para o Blob de Armazenamento com Chave Sas válido durante 5 minutos.

Name Tipo Description
openapi-link

string

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

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 o Blob de Armazenamento.

wsdl-link+xml

string

A Definição de API é exportada no Esquema WSDL para o Blob de Armazenamento. Isto só é suportado para APIs do Tipo soap

Value

O objeto que define o esquema do Detalhe da API exportada

Name Tipo Description
link

string

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