Udostępnij za pośrednictwem

Export-AzApiManagementApi

  • Odwołanie
Moduł:
Az.ApiManagement

Eksportuje interfejs API do pliku.

Składnia

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>]

Opis

Polecenie cmdlet Export-AzApiManagementApi eksportuje interfejs API usługi Azure API Management do pliku w jednym z obsługiwanych formatów.

Przykłady

Przykład 1. Eksportowanie interfejsu API w formacie Języka opisu aplikacji internetowej (WADL)

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl"

To polecenie eksportuje interfejs API do pliku WADL.

Przykład 2. Eksportowanie interfejsu API w formacie specyfikacji OpenApi 3.0 jako dokumentu Json

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

To polecenie eksportuje definicje interfejsu API w formacie Open Api jako dokument Json

Parametry

-ApiId

Określa identyfikator interfejsu API do wyeksportowania.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ApiRevision

Identyfikator poprawki interfejsu API. Ten parametr jest opcjonalny. Jeśli nie zostanie określony, eksport zostanie wykonany dla aktualnie aktywnej poprawki interfejsu API.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Context

Określa obiekt PsApiManagementContext.

Typ:PsApiManagementContext
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Force

Wskazuje, że ta operacja zastępuje plik o tej samej nazwie, jeśli już istnieje.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-PassThru

Wskazuje, że ta operacja zwraca $True, jeśli interfejs API został pomyślnie wyeksportowany lub $False w przeciwnym razie.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-SaveAs

Określa ścieżkę pliku, do której ma być zapisywany wyeksportowany interfejs API.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-SpecificationFormat

Określa format interfejsu API. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi i OpenApiJson

Typ:PsApiManagementApiFormat
Dopuszczalne wartości:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

Dane wyjściowe