Export-AzApiManagementApi
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"
Esse 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 |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-ApiRevision
Identificador de revisão da API. Esse parâmetro é opcional. Se não for especificado, a exportação será feita para a revisão da API ativa no momento.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Context
Especifica um objeto PsApiManagementContext .
Tipo: | PsApiManagementContext |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | 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 |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Force
Indica que essa operação substitui o arquivo de mesmo nome, se ele já existir.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-PassThru
Indica que essa operação retorna $True se a API for exportada com êxito ou $False caso contrário.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-SaveAs
Especifica o caminho do arquivo no qual salvar a API exportada.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-SpecificationFormat
Especifica o formato da API. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi e OpenApiJson
Tipo: | PsApiManagementApiFormat |
Valores aceitos: | Wadl, Swagger, Wsdl, OpenApi, OpenApiJson |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Entradas
Saídas
Links Relacionados
Azure PowerShell
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de