Set-AzApiManagementApiRevision

參考

模組:: Az.ApiManagement

修改 API 修訂

Syntax

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>]

Description

Set-AzApiManagementApiRevision Cmdlet 會修改 Azure API 管理 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"

Cmdlet 會以新的描述、通訊協定和路徑來更新 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

OpenId 授權伺服器機制，可透過此機制將存取令牌傳遞至 API。請參閱 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

執行 Cmdlet 之前先提示您確認。

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 的最後一個部分。 API 取用者會使用此 URL 將要求傳送至 Web 服務。長度必須為 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 管理使用，而且不會公開。長度必須為 1 到 2000 個字元。此為必要參數。

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

顯示執行 Cmdlet 後會發生的情況。未執行 Cmdlet。

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

輸入

String

PsApiManagementContext

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

輸出