Dela via


Set-AzApiManagementAuthorizationServer

Ändrar en auktoriseringsserver.

Syntax

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

Cmdleten Set-AzApiManagementAuthorizationServer ändrar information om Azure API Management-auktoriseringsservern.

Exempel

Exempel 1: Ändra en auktoriseringsserver

$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')

Det här kommandot ändrar den angivna API Management-auktoriseringsservern.

Exempel 2

Ändrar en auktoriseringsserver. (automatiskt genererad)

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'

Parametrar

-AccessTokenSendingMethods

Anger en matris med metoder för att skicka en åtkomsttoken. psdx_paramvalues AuthorizationHeader och Query.

Typ:PsApiManagementAccessTokenSendingMethod[]
Godkända värden:AuthorizationHeader, Query
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-AuthorizationEndpointUrl

Anger auktoriseringsslutpunkten för att autentisera resursägare och erhålla auktoriseringsbidrag.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-AuthorizationRequestMethods

Anger en matris med metoder för auktoriseringsbegäran. psdx_paramvalues GET och POST. Standardvärdet är GET.

Typ:PsApiManagementAuthorizationRequestMethod[]
Godkända värden:Get, Post, Head, Options, Trace, Put, Patch, Delete
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ClientAuthenticationMethods

Anger en matris med klientautentiseringsmetoder. psdx_paramvalues Grundläggande och Brödtext.

Typ:PsApiManagementClientAuthenticationMethod[]
Godkända värden:Basic, Body
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ClientId

Anger klient-ID för utvecklarkonsolen som är klientprogrammet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ClientRegistrationPageUrl

Anger klientregistreringsslutpunkten för att registrera klienter med auktoriseringsservern och hämta klientautentiseringsuppgifter.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ClientSecret

Anger klienthemligheten för utvecklarkonsolen som är klientprogrammet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Context

Anger ett PsApiManagementContext- objekt.

Typ:PsApiManagementContext
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DefaultScope

Anger standardomfånget för auktoriseringsservern.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Description

Anger en beskrivning för en auktoriseringsserver.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-GrantTypes

Anger en matris med beviljandetyper. psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • Underförstådd
  • ResourceOwnerPassword
Typ:PsApiManagementGrantType[]
Godkända värden:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Name

Anger namnet på den auktoriseringsserver som ska ändras.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ResourceOwnerPassword

Anger resursägarens lösenord. Du måste ange den här parametern om ResourceOwnerPassword anges av parametern GrantTypes.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ResourceOwnerUsername

Anger resursägarens användarnamn. Du måste ange den här parametern om ResourceOwnerPassword anges av parametern GrantTypes.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ServerId

Anger ID för den auktoriseringsserver som ska ändras.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SupportState

Anger om parametern State ska stödjas.

Typ:Nullable<T>[Boolean]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-TokenBodyParameters

Anger ytterligare brödtextparametrar med hjälp av formatet application/x-www-form-urlencoded.

Typ:Hashtable
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-TokenEndpointUrl

Anger tokenslutpunkten för klienter för att hämta åtkomsttoken i utbyte mot att visa auktoriseringsbidrag eller uppdateringstoken.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

Indata

PsApiManagementContext

String

PsApiManagementAuthorizationRequestMethod[]

PsApiManagementGrantType[]

PsApiManagementClientAuthenticationMethod[]

Hashtable

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

PsApiManagementAccessTokenSendingMethod[]

SwitchParameter

Utdata

PsApiManagementOAuth2AuthorizationServer