Import-AzureRmApiManagementApi
ファイルまたは URL から API をインポートします。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Import-AzureRmApiManagementApi
-Context <PsApiManagementContext>
[-ApiId <String>]
[-ApiRevision <String>]
-SpecificationFormat <PsApiManagementApiFormat>
-SpecificationPath <String>
[-Path <String>]
[-WsdlServiceName <String>]
[-WsdlEndpointName <String>]
[-ApiType <PsApiManagementApiType>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Import-AzureRmApiManagementApi
-Context <PsApiManagementContext>
[-ApiId <String>]
[-ApiRevision <String>]
-SpecificationFormat <PsApiManagementApiFormat>
-SpecificationUrl <String>
[-Path <String>]
[-WsdlServiceName <String>]
[-WsdlEndpointName <String>]
[-ApiType <PsApiManagementApiType>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Import-AzureRmApiManagementApi コマンドレットは、Web アプリケーション記述言語 (WADL)、Web サービス記述言語 (WSDL)、または Swagger 形式のファイルまたは URL から Azure API Management API をインポートします。
例
例 1 WADL ファイルから API をインポートする
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationPath "C:\contoso\specifications\echoapi.wadl" -Path "apis"このコマンドは、指定した WADL ファイルから API をインポートします。
例 2 Swagger ファイルから API をインポートする
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis"このコマンドは、指定された Swagger ファイルから API をインポートします。
例 3: WADL リンクから API をインポートする
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationUrl "http://contoso.com/specifications/wadl/echoapi" -Path "apis"このコマンドは、指定された WADL リンクから API をインポートします。
パラメーター
-ApiId
インポートする API の ID を指定します。 このパラメーターを指定しない場合は、ID が生成されます。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApiRevision
API リビジョンの識別子。 このパラメーターは省略可能です。 指定しない場合、インポートは現在アクティブなリビジョンまたは新しい API に対して行われます。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApiType
このパラメーターは省略可能で、既定値は Http です。 Soap オプションは、WSDL をインポートする場合にのみ適用され、SOAP パススルー API が作成されます。
| 型: | Nullable<T>[PsApiManagementApiType] |
| 承認された値: | Http, Soap |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| 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 |
-Path
API のパブリック URL の最後の部分として Web API パスを指定します。 この URL は、WEB サービスに要求を送信するために API コンシューマーによって使用されます。 長さは 1 ~ 400 文字にする必要があります。 既定値は $Null です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SpecificationFormat
指定形式を指定します。 Wadl、Wsdl、Swagger をpsdx_paramvaluesします。
| 型: | PsApiManagementApiFormat |
| 承認された値: | Wadl, Swagger, Wsdl |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SpecificationPath
仕様ファイルのパスを指定します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SpecificationUrl
指定 URL を指定します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WsdlEndpointName
インポートする WSDL エンドポイント (ポート) のローカル名。 長さは 1 ~ 400 文字にする必要があります。 このパラメーターは省略可能であり、Wsdl のインポートにのみ必要です。 既定値は $null です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WsdlServiceName
インポートする WSDL サービスのローカル名。 長さは 1 ~ 400 文字にする必要があります。 このパラメーターは省略可能であり、Wsdl のインポートにのみ必要です。 既定値は $null です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]]