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