Export-AzureRmApiManagementApi
API をファイルにエクスポートします。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Export-AzureRmApiManagementApi
-Context <PsApiManagementContext>
-ApiId <String>
[-ApiRevision <String>]
-SpecificationFormat <PsApiManagementApiFormat>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Export-AzureRmApiManagementApi
-Context <PsApiManagementContext>
-ApiId <String>
[-ApiRevision <String>]
-SpecificationFormat <PsApiManagementApiFormat>
-SaveAs <String>
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Export-AzureRmApiManagementApi コマンドレットは、サポートされている形式のいずれかで Azure API Management API をファイルにエクスポートします。
例
例 1: Web アプリケーション記述言語 (WADL) 形式で API をエクスポートする
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Export-AzureRmApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl"このコマンドは、API を WADL ファイルにエクスポートします。
パラメーター
-ApiId
エクスポートする API の ID を指定します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApiRevision
API リビジョンの識別子。 このパラメーターは省略可能です。 指定しない場合、エクスポートは現在アクティブな API リビジョンに対して行われます。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| 既定値: | False |
| 必須: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Context
PsApiManagementContext オブジェクトを指定します。
| 型: | PsApiManagementContext |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
同じ名前のファイルが既に存在する場合、この操作によって上書きされることを示します。
| 型: | SwitchParameter |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
API が正常にエクスポートされた場合は、この操作によって$Trueが返されるか、それ以外の場合は$False返されることを示します。
| 型: | SwitchParameter |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SaveAs
エクスポートされた API を保存するファイル パスを指定します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SpecificationFormat
API 形式を指定します。 Wadl と Swagger をpsdx_paramvaluesします。
| 型: | PsApiManagementApiFormat |
| 承認された値: | Wadl, Swagger, Wsdl |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| 既定値: | False |
| 必須: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
出力
このコマンドレットは、エクスポートされた API コンテンツを文字列として返します。