共用方式為

Set-AzApiManagementAuthorizationServer

  • 參考
模組:
Az.ApiManagement

修改授權伺服器。

語法

Set-AzApiManagementAuthorizationServer
   -Context <PsApiManagementContext>
   -ServerId <String>
   -Name <String>
   [-Description <String>]
   -ClientRegistrationPageUrl <String>
   -AuthorizationEndpointUrl <String>
   -TokenEndpointUrl <String>
   -ClientId <String>
   [-ClientSecret <String>]
   [-AuthorizationRequestMethods <PsApiManagementAuthorizationRequestMethod[]>]
   -GrantTypes <PsApiManagementGrantType[]>
   -ClientAuthenticationMethods <PsApiManagementClientAuthenticationMethod[]>
   [-TokenBodyParameters <Hashtable>]
   [-SupportState <Boolean>]
   [-DefaultScope <String>]
   -AccessTokenSendingMethods <PsApiManagementAccessTokenSendingMethod[]>
   [-ResourceOwnerUsername <String>]
   [-ResourceOwnerPassword <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Set-AzApiManagementAuthorizationServer Cmdlet 會修改 Azure API 管理授權伺服器詳細數據。

範例

範例 1：修改授權伺服器

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementAuthorizationServer -Context $ApiMgmtContext -ServerId 0123456789 -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signupv2" -AuthorizationEndpointUrl "https://contoso/authv2" -TokenEndpointUrl "https://contoso/tokenv2" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'} -AccessTokenSendingMethods @('AuthorizationHeader')

此命令會修改指定的 API 管理授權伺服器。

範例 2

修改授權伺服器。 （ 自動產生 ）

Set-AzApiManagementAuthorizationServer -AccessTokenSendingMethods AuthorizationHeader -AuthorizationEndpointUrl 'https://contoso/authv2' -AuthorizationRequestMethods Get -ClientAuthenticationMethods Basic -ClientId 'clientid' -ClientRegistrationPageUrl 'https://contoso/signupv2' -ClientSecret '0000000000000000000000000000000000000' -Context <PsApiManagementContext> -DefaultScope <String> -GrantTypes AuthorizationCode -Name 'Contoso OAuth2 server' -ServerId 0123456789 -TokenEndpointUrl 'https://contoso/tokenv2'

參數

-AccessTokenSendingMethods

指定要傳送存取令牌的方法陣列。 psdx_paramvalues AuthorizationHeader 和 Query。

類型:PsApiManagementAccessTokenSendingMethod[]
接受的值:AuthorizationHeader, Query
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-AuthorizationEndpointUrl

指定要驗證資源擁有者的授權端點，並取得授權授與。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-AuthorizationRequestMethods

指定授權要求方法的陣列。 psdx_paramvalues GET 和 POST。 預設值為 GET。

類型:PsApiManagementAuthorizationRequestMethod[]
接受的值:Get, Post, Head, Options, Trace, Put, Patch, Delete
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ClientAuthenticationMethods

指定客戶端驗證方法的陣列。 psdx_paramvalues基本和主體。

類型:PsApiManagementClientAuthenticationMethod[]
接受的值:Basic, Body
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-ClientId

指定用戶端應用程式之開發人員控制台的用戶端標識碼。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-ClientRegistrationPageUrl

指定客戶端註冊端點，以向授權伺服器註冊用戶端，並取得客戶端認證。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-ClientSecret

指定用戶端應用程式之開發人員主控台的客戶端密碼。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Context

指定 PsApiManagementContext 物件。

類型:PsApiManagementContext
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:IAzureContextContainer
別名:AzContext, AzureRmContext, AzureCredential
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-DefaultScope

指定授權伺服器的預設範圍。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Description

指定授權伺服器的描述。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-GrantTypes

指定授與類型的陣列。 psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • 含蓄
  • ResourceOwnerPassword
類型:PsApiManagementGrantType[]
接受的值:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-Name

指定要修改的授權伺服器名稱。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-PassThru

passthru

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ResourceOwnerPassword

指定資源擁有者密碼。 如果 ResourceOwnerPassword 是由 GrantTypes 參數指定，則必須指定此參數。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ResourceOwnerUsername

指定資源擁有者用戶名稱。 如果 ResourceOwnerPassword 是由 GrantTypes 參數指定，則必須指定此參數。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ServerId

指定要修改之授權伺服器的識別碼。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-SupportState

指出是否支援 State 參數。

類型:Nullable<T>[Boolean]
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-TokenBodyParameters

使用 application/x-www-form-urlencoded 格式指定其他主體參數。

類型:Hashtable
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-TokenEndpointUrl

指定用戶端取得存取令牌的令牌端點，以換取呈現授權授與或重新整理令牌。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

輸入

PsApiManagementContext

String

PsApiManagementAuthorizationRequestMethod[]

PsApiManagementGrantType[]

PsApiManagementClientAuthenticationMethod[]

Hashtable

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

PsApiManagementAccessTokenSendingMethod[]

SwitchParameter

輸出

PsApiManagementOAuth2AuthorizationServer