Set-AzApiManagementAuthorizationServer

  • Referenz
Modul:
Az.ApiManagement

Ändert einen Autorisierungsserver.

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

Beschreibung

Das Cmdlet Set-AzApiManagementAuthorizationServer ändert Details des Azure API Management-Autorisierungsservers.

Beispiele

Beispiel 1: Ändern eines Autorisierungsservers

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

Dieser Befehl ändert den angegebenen API-Verwaltungsautorisierungsserver.

Beispiel 2

Ändert einen Autorisierungsserver. (automatisch generiert)

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'

Parameter

-AccessTokenSendingMethods

Gibt ein Array von Methoden an, die ein Zugriffstoken senden sollen. psdx_paramvalues AuthorizationHeader und Query.

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

-AuthorizationEndpointUrl

Gibt den Autorisierungsendpunkt an, um Ressourcenbesitzer zu authentifizieren und Autorisierungserteilungen zu erhalten.

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

-AuthorizationRequestMethods

Gibt ein Array von Autorisierungsanforderungsmethoden an. psdx_paramvalues GET und POST. Der Standardwert ist 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

Gibt ein Array von Clientauthentifizierungsmethoden an. psdx_paramvalues Basic und Body.

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

-ClientId

Gibt die Client-ID der Entwicklerkonsole an, die die Clientanwendung ist.

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

-ClientRegistrationPageUrl

Gibt den Clientregistrierungsendpunkt an, um Clients mit dem Autorisierungsserver zu registrieren und Clientanmeldeinformationen abzurufen.

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

-ClientSecret

Gibt den geheimen Clientschlüssel der Entwicklerkonsole an, bei der es sich um die Clientanwendung handelt.

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

-Context

Gibt ein PsApiManagementContext -Objekt an.

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

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultScope

Gibt den Standardbereich für den Autorisierungsserver an.

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

-Description

Gibt eine Beschreibung für einen Autorisierungsserver an.

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

-GrantTypes

Gibt ein Array von Grant-Typen an. psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • Implizit
  • 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

Gibt den Namen des zu ändernden Autorisierungsservers an.

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

Gibt das Kennwort für den Ressourcenbesitzer an. Sie müssen diesen Parameter angeben, wenn ResourceOwnerPassword durch den GrantTypes-Parameter angegeben wird.

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

-ResourceOwnerUsername

Gibt den Benutzernamen des Ressourcenbesitzers an. Sie müssen diesen Parameter angeben, wenn ResourceOwnerPassword durch den GrantTypes-Parameter angegeben wird.

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

-ServerId

Gibt die ID des zu ändernden Autorisierungsservers an.

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

-SupportState

Gibt an, ob der State-Parameter unterstützt werden soll.

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

-TokenBodyParameters

Gibt zusätzliche Textparameter mithilfe des Anwendungs-/x-www-form-urlencoded-Formats an.

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

-TokenEndpointUrl

Gibt den Tokenendpunkt für Clients an, um Zugriffstoken im Austausch für die Darstellung von Autorisierungserteilungen oder Aktualisierungstoken abzurufen.

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

Eingaben

PsApiManagementContext

String

PsApiManagementAuthorizationRequestMethod[]

PsApiManagementGrantType[]

PsApiManagementClientAuthenticationMethod[]

Hashtable

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

PsApiManagementAccessTokenSendingMethod[]

SwitchParameter

Ausgaben

PsApiManagementOAuth2AuthorizationServer