Partilhar via

Export-AzApiManagementApi

  • Referência
Módulo:
Az.ApiManagement

Exporta uma API para um arquivo.

Sintaxe

Export-AzApiManagementApi
      -Context <PsApiManagementContext>
      -ApiId <String>
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-AzApiManagementApi
      -Context <PsApiManagementContext>
      -ApiId <String>
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      -SaveAs <String>
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Export-AzApiManagementApi exporta uma API de Gerenciamento de API do Azure para um arquivo em um dos formatos com suporte.

Exemplos

Exemplo 1: Exportar uma API no formato WADL (Web Application Description Language)

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl"

Este comando exporta uma API para um arquivo WADL.

Exemplo 2: Exportar uma API no formato de especificação OpenApi 3.0 como documento Json

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId swagger-petstore -SpecificationFormat OpenApiJson -SaveAs D:\github\petstore.json

Este comando exporta definições de API no formato Open Api como documento Json

Parâmetros

-ApiId

Especifica a ID da API a ser exportada.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ApiRevision

Identificador da revisão da API. Este parâmetro é opcional. Se não for especificado, a exportação será feita para a revisão da api atualmente ativa.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Context

Especifica um objeto PsApiManagementContext .

Tipo:PsApiManagementContext
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Force

Indica que essa operação substitui o arquivo de mesmo nome, se ele já existir.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-PassThru

Indica que essa operação retorna $True se a API for exportada com êxito ou $False outra forma.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-SaveAs

Especifica o caminho do arquivo no qual salvar a API exportada.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-SpecificationFormat

Especifica o formato da API. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi e OpenApiJson

Tipo:PsApiManagementApiFormat
Valores aceites:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

PsApiManagementContext

String

PsApiManagementApiFormat

SwitchParameter

Saídas

String