New-AzureRmApiManagementApi
API を作成します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
New-AzureRmApiManagementApi
-Context <PsApiManagementContext>
[-ApiId <String>]
-Name <String>
[-Description <String>]
-ServiceUrl <String>
-Path <String>
-Protocols <PsApiManagementSchema[]>
[-AuthorizationServerId <String>]
[-AuthorizationScope <String>]
[-SubscriptionKeyHeaderName <String>]
[-SubscriptionKeyQueryParamName <String>]
[-ProductIds <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
New-AzureRmApiManagementApi コマンドレットは、Azure API Management API を作成します。
例
例 1: API を作成する
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>New-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi"このコマンドは、指定された URL を使用して EchoApi という名前の API を作成します。
パラメーター
-ApiId
作成する API の ID を指定します。 このパラメーターを指定しない場合、このコマンドレットによって ID が生成されます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AuthorizationScope
OAuth 操作スコープを指定します。 既定値は $Null です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AuthorizationServerId
OAuth 承認サーバー ID を指定します。 既定値は $Null です。 AuthorizationScope が指定されている場合は、このパラメーターを指定する必要があります。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Context
PsApiManagementContext オブジェクトを指定します。
| 型: | PsApiManagementContext |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Description
Web API の説明を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
Web API の名前を指定します。 これは、開発者ポータルと管理ポータルに表示される API のパブリック名です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Path
WEB API パスを指定します。これは API のパブリック URL の最後の部分であり、管理ポータルの Web API URL サフィックス フィールドに対応します。 この URL は、WEB サービスに要求を送信するために API コンシューマーによって使用され、1 から 400 文字の長さにする必要があります。 既定値は $Null です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ProductIds
新しい API を追加する製品 ID の配列を指定します。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Protocols
Web API プロトコルの配列を指定します。 有効な値は http、https です。 これらは、API を使用できるようにする Web プロトコルです。 既定値は $Null です。
| 型: | PsApiManagementSchema[] |
| 指定可能な値: | Http, Https |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ServiceUrl
API を公開する Web サービスの URL を指定します。 この URL は Azure API Management でのみ使用され、公開されません。 URL の長さは 1 ~ 2,000 文字にする必要があります。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SubscriptionKeyHeaderName
サブスクリプション キーのヘッダー名を指定します。 既定値は $Null です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SubscriptionKeyQueryParamName
サブスクリプション キークエリ文字列パラメーター名を指定します。 既定値は $Null です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
入力
String[]