Sdílet prostřednictvím

Export-AzApiManagementApi

  • Reference
Modul:
Az.ApiManagement

Exportuje rozhraní API do souboru.

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

Rutina Export-AzApiManagementApi exportuje rozhraní API služby Azure API Management do souboru v jednom z podporovaných formátů.

Příklady

Příklad 1: Export rozhraní API ve formátu 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"

Tento příkaz exportuje rozhraní API do souboru WADL.

Příklad 2: Export rozhraní API ve formátu specifikace OpenApi 3.0 jako dokument JSON

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

Tento příkaz exportuje definice rozhraní API ve formátu Open Api jako dokument JSON.

Parametry

-ApiId

Určuje ID rozhraní API k exportu.

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

-ApiRevision

Identifikátor revize rozhraní API. Tento parametr je volitelný. Pokud není zadaný, export se provede pro aktuálně aktivní revizi rozhraní API.

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

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

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

-Context

Určuje PsApiManagementContext objektu.

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

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

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

-Force

Označuje, že tato operace přepíše soubor se stejným názvem, pokud již existuje.

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

-PassThru

Označuje, že tato operace vrátí $True, pokud se rozhraní API úspěšně exportuje, nebo $False jinak.

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

-SaveAs

Určuje cestu k souboru, do které se má exportované rozhraní API uložit.

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

-SpecificationFormat

Určuje formát rozhraní API. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi a 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

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

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

Vstupy

PsApiManagementContext

String

PsApiManagementApiFormat

SwitchParameter

Výstupy

String