Share via

Set-AzApiManagementApiRevision

  • リファレンス
モジュール:
Az.ApiManagement

API リビジョンを変更します

構文

Set-AzApiManagementApiRevision
   -ApiRevision <String>
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-Name <String>]
   [-Description <String>]
   [-ServiceUrl <String>]
   [-Path <String>]
   [-Protocols <PsApiManagementSchema[]>]
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-SubscriptionRequired]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementApiRevision
   -InputObject <PsApiManagementApi>
   [-Name <String>]
   [-Description <String>]
   [-ServiceUrl <String>]
   [-Path <String>]
   [-Protocols <PsApiManagementSchema[]>]
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-SubscriptionRequired]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzApiManagementApiRevision コマンドレットは、Azure API Management API リビジョンを変更します。

例

例 1: API リビジョンを変更する

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiRevision -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 の識別子。 このパラメーターは必須です。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiRevision

既存の API リビジョンの識別子。 このパラメーターは必須です。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-AuthorizationScope

OAuth 操作スコープ。 このパラメーターは省略可能です。 既定値は $null です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AuthorizationServerId

OAuth 承認サーバー識別子。 このパラメーターは省略可能です。 既定値は $null です。 AuthorizationScope が指定されている場合は、指定する必要があります。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-BearerTokenSendingMethod

アクセス トークンが API に渡される OpenId 承認サーバー メカニズム。 [https://aka.ms/classiciaasmigrationfaqs](https://datatracker.ietf.org/doc/html/rfc6749#section-4 ) を参照してください。 このパラメーターは省略可能です。 既定値は $null です。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

PsApiManagementContext のインスタンス。 このパラメーターは必須です。

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Web API の説明。 このパラメーターは省略可能です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

PsApiManagementApi のインスタンス。 このパラメーターは必須です。

Type:PsApiManagementApi
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Web API 名。 開発者ポータルと管理ポータルに表示される API のパブリック名。 このパラメーターは必須です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OpenIdProviderId

OpenId 承認サーバー識別子。 このパラメーターは省略可能です。 既定値は $null です。 BearerTokenSendingMethods が指定されている場合は、指定する必要があります。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

指定した場合、セット API を表す Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi 型のインスタンス。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Path

Web API パス。 API のパブリック URL の最後の部分。 この URL は、Web サービスに要求を送信するために API コンシューマーによって使用されます。 長さは 1 ~ 400 文字にする必要があります。 このパラメーターは省略可能です。 既定値は $null です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Protocols

Web API プロトコル (http、https)。 API を使用できるようにするプロトコル。 このパラメーターは必須です。 既定値は $null です。

Type:PsApiManagementSchema[]
Accepted values:Http, Https
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ServiceUrl

API を公開する Web サービスの URL。 この URL は Azure API Management でのみ使用され、公開されません。 長さは 1 ~ 2,000 文字にする必要があります。 このパラメーターは必須です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionKeyHeaderName

サブスクリプション キーのヘッダー名。 このパラメーターは省略可能です。 既定値は $null です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionKeyQueryParamName

サブスクリプション キークエリ文字列パラメーター名。 このパラメーターは省略可能です。 既定値は $null です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionRequired

Api への要求に SubscriptionRequired を適用するフラグ。 このパラメーターは省略可能です。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

PsApiManagementContext

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

出力

PsApiManagementApi