Compartir a través de

Export-AzApiManagementApi

  • Referencia
Módulo:
Az.ApiManagement

Exporta una API a un archivo.

Syntax

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

El cmdlet Export-AzApiManagementApi exporta una API de Azure API Management a un archivo en uno de los formatos admitidos.

Ejemplos

Ejemplo 1: Exportación de una API en formato de lenguaje de descripción de aplicaciones web (WADL)

$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 una API a un archivo WADL.

Ejemplo 2: Exportación de una API en formato de especificación de 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 una definición de API en formato Open Api como documento Json.

Parámetros

-ApiId

Especifica el identificador de la API que se va a exportar.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiRevision

Identificador de revisión de API. Este parámetro es opcional. Si no se especifica, la exportación se realizará para la revisión de api activa actualmente.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Especifica un objeto PsApiManagementContext .

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indica que esta operación sobrescribe el archivo del mismo nombre si ya existe.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Indica que esta operación devuelve $True si la API se exporta correctamente o $False de lo contrario.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SaveAs

Especifica la ruta de acceso del archivo a la que se va a guardar la API exportada.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SpecificationFormat

Especifica el formato de API. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi y OpenApiJson

Type:PsApiManagementApiFormat
Accepted values:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PsApiManagementContext

String

PsApiManagementApiFormat

SwitchParameter

Salidas

String