Set-AzureRmApiManagementApi
API を変更します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Set-AzureRmApiManagementApi
-Context <PsApiManagementContext>
-ApiId <String>
-Name <String>
[-Description <String>]
-ServiceUrl <String>
[-Path <String>]
-Protocols <PsApiManagementSchema[]>
[-AuthorizationServerId <String>]
[-AuthorizationScope <String>]
[-SubscriptionKeyHeaderName <String>]
[-SubscriptionKeyQueryParamName <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmApiManagementApi
-InputObject <PsApiManagementApi>
-Name <String>
[-Description <String>]
-ServiceUrl <String>
[-Path <String>]
-Protocols <PsApiManagementSchema[]>
[-AuthorizationServerId <String>]
[-AuthorizationScope <String>]
[-SubscriptionKeyHeaderName <String>]
[-SubscriptionKeyQueryParamName <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Set-AzureRmApiManagementApi コマンドレットは、Azure API Management API を変更します。
例
例 1 API の変更
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Set-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"パラメーター
-ApiId
変更する API の ID を指定します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AuthorizationScope
OAuth 操作スコープを指定します。 既定値は $Null です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AuthorizationServerId
OAuth 承認サーバー識別子を指定します。 既定値は $Null です。 AuthorizationScope が指定されている場合は、このパラメーターを指定する必要があります。
| 型: | String |
| 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 |
-Description
Web API の説明を指定します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
PsApiManagementApi のインスタンス。 このパラメーターは必須です。
| 型: | PsApiManagementApi |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Web API の名前を指定します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Passthru
| 型: | SwitchParameter |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| 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 |
-Protocols
Web API プロトコルの配列を指定します。 http と https をpsdx_paramvaluesします。 これらは、API を使用できるようにする Web プロトコルです。 既定値は $Null です。
| 型: | PsApiManagementSchema[] |
| 承認された値: | Http, Https |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServiceUrl
API を公開する Web サービスの URL を指定します。 この URL は Azure API Management でのみ使用され、公開されません。 URL の長さは 1 ~ 2,000 文字にする必要があります。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionKeyHeaderName
サブスクリプション キー ヘッダーの名前を指定します。 既定値は $Null です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionKeyQueryParamName
サブスクリプション キークエリ文字列パラメーターの名前を指定します。 既定値は $Null です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
Parameters: InputObject (ByValue)