Set-AzApiManagementApiRevision
修改 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>] 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 會使用新的描述、通訊協定和路徑，更新 API echo-api 的 2 修訂。
參數
-ApiId
現有 API 的識別碼。 這是必要參數。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-ApiRevision
現有 API 修訂的識別碼。 這是必要參數。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-AuthorizationScope
OAuth 作業範圍。 這個參數是選擇性的。 預設值為 $null。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-AuthorizationServerId
OAuth 授權伺服器標識碼。 這個參數是選擇性的。 預設值為 $null。 如果 AuthorizationScope 指定，則必須指定 。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-BearerTokenSendingMethod
OpenId 授權伺服器機制，可透過此機制將存取令牌傳遞至 API。 請參閱 https://datatracker.ietf.org/doc/html/rfc6749#section-4。 這個參數是選擇性的。 預設值為 $null。
| 類型: | String[] |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-Confirm
在執行 Cmdlet 之前，提示您進行確認。
| 類型: | SwitchParameter |
| 別名: | cf |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Context
PsApiManagementContext 的實例。 這是必要參數。
| 類型: | PsApiManagementContext |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-DefaultProfile
用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。
| 類型: | IAzureContextContainer |
| 別名: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Description
Web API 描述。 這個參數是選擇性的。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-InputObject
PsApiManagementApi 的實例。 這是必要參數。
| 類型: | PsApiManagementApi |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-Name
Web API 名稱。 API 的公用名稱，因為它會顯示在開發人員和系統管理入口網站上。 這是必要參數。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-OpenIdProviderId
OpenId 授權伺服器識別碼。 這個參數是選擇性的。 預設值為 $null。 如果指定 BearerTokenSendingMethods，則必須指定 。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-PassThru
如果指定，則表示設定 API 的 Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi 類型的實例。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-Path
Web API 路徑。 API 公用 URL 的最後一個部分。 API 取用者會使用此 URL 將要求傳送至 Web 服務。 長度必須為 1 到 400 個字元。 這個參數是選擇性的。 預設值為 $null。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-Protocols
Web API 通訊協定 （http， https） 。 API 可供使用之通訊協定。 這是必要參數。 預設值為 $null。
| 類型: | PsApiManagementSchema[] |
| 接受的值: | Http, Https |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-ServiceUrl
公開 API 之 Web 服務的 URL。 此 URL 只會由 Azure API 管理使用，而且不會公開。 長度必須為 1 到 2000 個字元。 這是必要參數。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-SubscriptionKeyHeaderName
訂用帳戶金鑰標頭名稱。 這個參數是選擇性的。 預設值為 $null。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-SubscriptionKeyQueryParamName
訂用帳戶金鑰查詢字串參數名稱。 這個參數是選擇性的。 預設值為 $null。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-SubscriptionRequired
針對對 Api 的要求強制執行 SubscriptionRequired 的旗標。 這個參數是選擇性的。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。
| 類型: | SwitchParameter |
| 別名: | wi |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
