你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Set-AzApiManagementAuthorizationServer

修改授权服务器。

语法

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

说明

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。

Type:PsApiManagementAccessTokenSendingMethod[]
Accepted values:AuthorizationHeader, Query
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-AuthorizationEndpointUrl

指定要对资源所有者进行身份验证并获取授权授权的授权终结点。

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

-AuthorizationRequestMethods

指定授权请求方法的数组。 psdx_paramvalues GET 和 POST。 默认值为 GET。

Type:PsApiManagementAuthorizationRequestMethod[]
Accepted values:Get, Post, Head, Options, Trace, Put, Patch, Delete
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ClientAuthenticationMethods

指定客户端身份验证方法的数组。 psdx_paramvalues基本和正文。

Type:PsApiManagementClientAuthenticationMethod[]
Accepted values:Basic, Body
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ClientId

指定开发人员控制台的客户端 ID,即客户端应用程序。

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

-ClientRegistrationPageUrl

指定客户端注册终结点,以向授权服务器注册客户端并获取客户端凭据。

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

-ClientSecret

指定作为客户端应用程序的开发人员控制台的客户端密码。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

-DefaultScope

指定授权服务器的默认范围。

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

-Description

指定授权服务器的说明。

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

-GrantTypes

指定授予类型的数组。 psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • 隐式
  • ResourceOwnerPassword
Type:PsApiManagementGrantType[]
Accepted values:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

指定要修改的授权服务器的名称。

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

-PassThru

passthru

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

-ResourceOwnerPassword

指定资源所有者密码。 如果 ResourceOwnerPassword 是由 GrantTypes 参数指定的,则必须指定此参数。

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

-ResourceOwnerUsername

指定资源所有者用户名。 如果 ResourceOwnerPassword 是由 GrantTypes 参数指定的,则必须指定此参数。

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

-ServerId

指定要修改的授权服务器的 ID。

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

-SupportState

指示是否支持 State 参数。

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TokenBodyParameters

使用 application/x-www-form-urlencoded 格式指定其他正文参数。

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

-TokenEndpointUrl

指定客户端获取访问令牌的令牌终结点,以换取提供授权或刷新令牌。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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