Export-AzApiManagementApi
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.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | 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.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Le solicita su confirmación antes de ejecutar el cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Position: | Named |
valor predeterminado: | False |
Requerido: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Context
Especifica un objeto PsApiManagementContext .
Tipo: | PsApiManagementContext |
Position: | Named |
valor predeterminado: | None |
Requerido: | 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.
Tipo: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Indica que esta operación sobrescribe el archivo del mismo nombre si ya existe.
Tipo: | SwitchParameter |
Position: | Named |
valor predeterminado: | None |
Requerido: | 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.
Tipo: | SwitchParameter |
Position: | Named |
valor predeterminado: | None |
Requerido: | 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.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SpecificationFormat
Especifica el formato de API. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi y OpenApiJson
Tipo: | PsApiManagementApiFormat |
valores aceptados: | Wadl, Swagger, Wsdl, OpenApi, OpenApiJson |
Position: | Named |
valor predeterminado: | None |
Requerido: | 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.
Tipo: | SwitchParameter |
Aliases: | wi |
Position: | Named |
valor predeterminado: | False |
Requerido: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entradas
Salidas
Vínculos relacionados
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de