Delen via

Export-AzApiManagementApi

  • Referentie
Module:
Az.ApiManagement

Hiermee exporteert u een API naar een bestand.

Syntaxis

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

De cmdlet Export-AzApiManagementApi exporteert een Azure API Management-API naar een bestand in een van de ondersteunde indelingen.

Voorbeelden

Voorbeeld 1: Een API exporteren in WADL-indeling (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"

Met deze opdracht exporteert u een API naar een WADL-bestand.

Voorbeeld 2: Een API exporteren in OpenApi 3.0-specificatieindeling als Json-document

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

Met deze opdracht exporteert u een API-definities in Open Api-indeling als Json-document

Parameters

-ApiId

Hiermee geeft u de id van de API die moet worden geëxporteerd.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-ApiRevision

Id van API-revisie. Deze parameter is optioneel. Als dit niet is opgegeven, wordt de export uitgevoerd voor de momenteel actieve API-revisie.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Context

Hiermee geeft u een PsApiManagementContext-object .

Type:PsApiManagementContext
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-DefaultProfile

De referenties, het account, de tenant en het abonnement die worden gebruikt voor communicatie met Azure.

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Force

Hiermee wordt aangegeven dat het bestand met dezelfde naam wordt overschreven als deze al bestaat.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-PassThru

Geeft aan dat deze bewerking $True retourneert als de API is geëxporteerd of anders $False.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SaveAs

Hiermee geeft u het bestandspad op waarnaar de geëxporteerde API moet worden opgeslagen.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SpecificationFormat

Hiermee geeft u de API-indeling op. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi en OpenApiJson

Type:PsApiManagementApiFormat
Geaccepteerde waarden:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

PsApiManagementContext

String

PsApiManagementApiFormat

SwitchParameter

Uitvoerwaarden

String