Bagikan melalui

Export-AzApiManagementApi

  • Referensi
Modul:
Az.ApiManagement

Mengekspor API ke file.

Sintaks

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

Deskripsi

Cmdlet Export-AzApiManagementApi mengekspor API Azure API Management ke file dalam salah satu format yang didukung.

Contoh

Contoh 1: Mengekspor API dalam format Web Application Description Language (WADL)

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

Perintah ini mengekspor API ke file WADL.

Contoh 2: Mengekspor API dalam Format Spesifikasi OpenApi 3.0 sebagai Dokumen Json

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

Perintah ini mengekspor definisi API dalam format Open Api sebagai dokumen Json

Parameter

-ApiId

Menentukan ID API yang akan diekspor.

Jenis:String
Position:Named
nilai default:None
Diperlukan:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiRevision

Pengidentifikasi Revisi API. Parameter ini bersifat opsional. Jika tidak ditentukan, ekspor akan dilakukan untuk revisi api yang saat ini aktif.

Jenis:String
Position:Named
nilai default:None
Diperlukan:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.

Jenis:SwitchParameter
Aliases:cf
Position:Named
nilai default:False
Diperlukan:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Menentukan objek PsApiManagementContext.

Jenis:PsApiManagementContext
Position:Named
nilai default:None
Diperlukan:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan azure.

Jenis:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
nilai default:None
Diperlukan:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Menunjukkan bahwa operasi ini menimpa file dengan nama yang sama jika sudah ada.

Jenis:SwitchParameter
Position:Named
nilai default:None
Diperlukan:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Menunjukkan bahwa operasi ini mengembalikan $True jika API berhasil diekspor, atau $False sebaliknya.

Jenis:SwitchParameter
Position:Named
nilai default:None
Diperlukan:False
Accept pipeline input:True
Accept wildcard characters:False

-SaveAs

Menentukan jalur file untuk menyimpan API yang diekspor.

Jenis:String
Position:Named
nilai default:None
Diperlukan:True
Accept pipeline input:True
Accept wildcard characters:False

-SpecificationFormat

Menentukan format API. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi dan OpenApiJson

Jenis:PsApiManagementApiFormat
nilai yang diterima:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson
Position:Named
nilai default:None
Diperlukan:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.

Jenis:SwitchParameter
Aliases:wi
Position:Named
nilai default:False
Diperlukan:False
Accept pipeline input:False
Accept wildcard characters:False

Input

PsApiManagementContext

String

PsApiManagementApiFormat

SwitchParameter

Output

String