Set-​Azure​Rm​Api​Management​Authorization​Server

Modifies an authorization server.

Syntax

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

Description

The Set-AzureRmApiManagementAuthorizationServer cmdlet modifies Azure API Management authorization server details.

Examples

Example 1: Modify an authorization server

PS C:\>Set-AzureRmApiManagementAuthrizarionServer -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')

This command modifies the specified API Management authorization server.

Required Parameters

-AccessTokenSendingMethods

Specifies an array of methods to send an access token. psdx_paramvalues AuthorizationHeader and Query.

Type:PsApiManagementAccessTokenSendingMethod[]
Parameter Sets:AuthorizationHeader, Query
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-AuthorizationEndpointUrl

Specifies the authorization endpoint to authenticate resource owners and obtain authorization grants.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ClientAuthenticationMethods

Specifies an array of client authentication methods. psdx_paramvalues Basic and Body.

Type:PsApiManagementClientAuthenticationMethod[]
Parameter Sets:Basic, Body
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ClientId

Specifies the client ID of the developer console that is the client application.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ClientRegistrationPageUrl

Specifies the client registration endpoint to register clients with the authorization server and obtain client credentials.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Context

Specifies a PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-GrantTypes

Specifies an array of grant types. psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • Implicit
  • ResourceOwnerPassword
Type:PsApiManagementGrantType[]
Parameter Sets:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the name of the authorization server to modify.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServerId

Specifies the ID of the authorization server to modify.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TokenEndpointUrl

Specifies the token endpoint for clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AuthorizationRequestMethods

Specifies an array of authorization request methods. psdx_paramvalues GET and POST. The default value is GET.

Type:PsApiManagementAuthorizationRequestMethod[]
Parameter Sets:Get, Post
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ClientSecret

Specifies the client secret of the developer console that is the client application.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DefaultScope

Specifies the default scope for the authorization server.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Description

Specifies a description for an authorization server.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

passthru

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceOwnerPassword

Specifies the resource owner password. You must specify this parameter if ResourceOwnerPassword is specified by the GrantTypes parameter.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceOwnerUsername

Specifies the resource owner user name. You must specify this parameter if ResourceOwnerPassword is specified by the GrantTypes parameter.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SupportState

Indicates whether to support the State parameter.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TokenBodyParameters

Specifies additional body parameters using application/x-www-form-urlencoded format.

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer