Partager via

Set-AzApiManagementAuthorizationServer

  • Référence
Module:
Az.ApiManagement

Modifie un serveur d’autorisation.

Syntaxe

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

La cmdlet Set-AzApiManagementAuthorizationServer modifie les détails du serveur d’autorisation Gestion des API Azure.

Exemples

Exemple 1 : Modifier un serveur d’autorisation

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

Cette commande modifie le serveur d’autorisation Gestion des API spécifié.

Exemple 2

Modifie un serveur d’autorisation. (généré automatiquement)

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'

Paramètres

-AccessTokenSendingMethods

Spécifie un tableau de méthodes pour envoyer un jeton d’accès. psdx_paramvalues AuthorizationHeader et requête.

Type:PsApiManagementAccessTokenSendingMethod[]
Valeurs acceptées:AuthorizationHeader, Query
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-AuthorizationEndpointUrl

Spécifie le point de terminaison d’autorisation pour authentifier les propriétaires de ressources et obtenir des octrois d’autorisation.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-AuthorizationRequestMethods

Spécifie un tableau de méthodes de demande d’autorisation. psdx_paramvalues GET et POST. La valeur par défaut est GET.

Type:PsApiManagementAuthorizationRequestMethod[]
Valeurs acceptées:Get, Post, Head, Options, Trace, Put, Patch, Delete
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ClientAuthenticationMethods

Spécifie un tableau de méthodes d’authentification client. psdx_paramvalues De base et corps.

Type:PsApiManagementClientAuthenticationMethod[]
Valeurs acceptées:Basic, Body
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ClientId

Spécifie l’ID client de la console développeur qui est l’application cliente.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ClientRegistrationPageUrl

Spécifie le point de terminaison d’inscription du client pour inscrire les clients auprès du serveur d’autorisation et obtenir les informations d’identification du client.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ClientSecret

Spécifie la clé secrète client de la console développeur qui est l’application cliente.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Context

Spécifie un objet PsApiManagementContext.

Type:PsApiManagementContext
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultScope

Spécifie l’étendue par défaut du serveur d’autorisation.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Description

Spécifie une description pour un serveur d’autorisation.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-GrantTypes

Spécifie un tableau de types d’octroi. psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • Implicite
  • ResourceOwnerPassword
Type:PsApiManagementGrantType[]
Valeurs acceptées:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Name

Spécifie le nom du serveur d’autorisation à modifier.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-PassThru

passthru

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ResourceOwnerPassword

Spécifie le mot de passe du propriétaire de la ressource. Vous devez spécifier ce paramètre si ResourceOwnerPassword est spécifié par le paramètre GrantTypes.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ResourceOwnerUsername

Spécifie le nom d’utilisateur du propriétaire de la ressource. Vous devez spécifier ce paramètre si ResourceOwnerPassword est spécifié par le paramètre GrantTypes.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ServerId

Spécifie l’ID du serveur d’autorisation à modifier.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-SupportState

Indique s’il faut prendre en charge le paramètre d’état .

Type:Nullable<T>[Boolean]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TokenBodyParameters

Spécifie des paramètres de corps supplémentaires à l’aide du format application/x-www-form-urlencoded.

Type:Hashtable
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TokenEndpointUrl

Spécifie le point de terminaison de jeton pour que les clients obtiennent des jetons d’accès en échange de la présentation des octrois d’autorisation ou des jetons d’actualisation.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

PsApiManagementContext

String

PsApiManagementAuthorizationRequestMethod[]

PsApiManagementGrantType[]

PsApiManagementClientAuthenticationMethod[]

Hashtable

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

PsApiManagementAccessTokenSendingMethod[]

SwitchParameter

Sorties

PsApiManagementOAuth2AuthorizationServer