次の方法で共有

Export-AzApiManagementApi

  • リファレンス
モジュール:
Az.ApiManagement

API をファイルにエクスポートします。

構文

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

説明

Export-AzApiManagementApi コマンドレットは、サポートされている形式のいずれかで Azure API Management API をファイルにエクスポートします。

例

例 1: Web アプリケーション記述言語 (WADL) 形式で API をエクスポートする

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

このコマンドは、API を WADL ファイルにエクスポートします。

例 2: OpenApi 3.0 仕様形式の API を Json ドキュメントとしてエクスポートする

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

このコマンドは、Open Api 形式の API 定義を Json ドキュメントとしてエクスポートします

パラメーター

-ApiId

エクスポートする API の ID を指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ApiRevision

API リビジョンの識別子。 このパラメーターは省略可能です。 指定しない場合、エクスポートは現在アクティブな API リビジョンに対して行われます。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Context

PsApiManagementContext オブジェクトを指定します。

型:PsApiManagementContext
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

同じ名前のファイルが既に存在する場合、この操作によって上書きされることを示します。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-PassThru

API が正常にエクスポートされた場合は、この操作によって$Trueが返されるか、それ以外の場合は$False返されることを示します。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-SaveAs

エクスポートされた API を保存するファイル パスを指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-SpecificationFormat

API 形式を指定します。 psdx_paramvalues Wadl、Wsdl、Swagger、OpenApi、OpenApiJson

型:PsApiManagementApiFormat
指定可能な値:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PsApiManagementContext

String

PsApiManagementApiFormat

SwitchParameter

出力

String