Aracılığıyla paylaş

Export-AzApiManagementApi

  • Başvuru
Modül:
Az.ApiManagement

API'yi bir dosyaya aktarır.

Sözdizimi

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

Export-AzApiManagementApi cmdlet'i azure API Management API'sini desteklenen biçimlerden birinde bir dosyaya aktarır.

Örnekler

Örnek 1: Api'yi Web Uygulaması Açıklama Dili (WADL) biçiminde dışarı aktarma

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

Bu komut, BIR API'yi WADL dosyasına aktarır.

Örnek 2: OpenApi 3.0 Belirtim Biçimindeki BIR API'yi Json Belgesi Olarak Dışarı Aktarma

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

Bu komut, Open API biçimindeki bir API tanımlarını Json belgesi olarak dışarı aktarır

Parametreler

-ApiId

Dışarı aktaracak API'nin kimliğini belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ApiRevision

API Düzeltme tanımlayıcısı. Bu parametre isteğe bağlıdır. Belirtilmezse, şu anda etkin olan API düzeltmesi için dışarı aktarma yapılır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Confirm

Cmdlet'i çalıştırmadan önce sizden onay ister.

Tür:SwitchParameter
Diğer adlar:cf
Position:Named
Default value:False
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Context

PsApiManagementContext nesnesini belirtir.

Tür:PsApiManagementContext
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-DefaultProfile

Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik.

Tür:IAzureContextContainer
Diğer adlar:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Force

Bu işlemin zaten varsa aynı ada sahip dosyanın üzerine yazdığını gösterir.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-PassThru

API başarıyla dışarı aktarıldığında bu işlemin $True döndürdüğünü veya aksi takdirde $False gösterir.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-SaveAs

Dışarı aktarılan API'nin kaydedildiği dosya yolunu belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-SpecificationFormat

API biçimini belirtir. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi ve OpenApiJson

Tür:PsApiManagementApiFormat
Kabul edilen değerler:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-WhatIf

Cmdlet çalıştırılıyorsa ne olacağını gösterir. Cmdlet çalıştırılmaz.

Tür:SwitchParameter
Diğer adlar:wi
Position:Named
Default value:False
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

Girişler

PsApiManagementContext

String

PsApiManagementApiFormat

SwitchParameter

Çıkışlar

String