Set-AzApiManagementAuthorizationServer

  • Riferimento
Modulo:
Az.ApiManagement

Modifica un server di autorizzazione.

Sintassi

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

Descrizione

Il cmdlet Set-AzApiManagementAuthorizationServer modifica i dettagli del server di autorizzazione di Azure Gestione API.

Esempio

Esempio 1: Modificare un server di autorizzazione

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

Questo comando modifica il server di autorizzazione Gestione API specificato.

Esempio 2

Modifica un server di autorizzazione. (generato automaticamente)

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'

Parametri

-AccessTokenSendingMethods

Specifica una matrice di metodi per inviare un token di accesso. psdx_paramvalues AuthorizationHeader e Query.

Tipo:PsApiManagementAccessTokenSendingMethod[]
Valori accettati:AuthorizationHeader, Query
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-AuthorizationEndpointUrl

Specifica l'endpoint di autorizzazione per autenticare i proprietari delle risorse e ottenere le concessioni di autorizzazione.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-AuthorizationRequestMethods

Specifica una matrice di metodi di richiesta di autorizzazione. psdx_paramvalues GET e POST. Il valore predefinito è GET.

Tipo:PsApiManagementAuthorizationRequestMethod[]
Valori accettati:Get, Post, Head, Options, Trace, Put, Patch, Delete
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ClientAuthenticationMethods

Specifica una matrice di metodi di autenticazione client. psdx_paramvalues Basic e Body.

Tipo:PsApiManagementClientAuthenticationMethod[]
Valori accettati:Basic, Body
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ClientId

Specifica l'ID client della console di sviluppo che è l'applicazione client.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ClientRegistrationPageUrl

Specifica l'endpoint di registrazione client per registrare i client con il server di autorizzazione e ottenere le credenziali client.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ClientSecret

Specifica il segreto client della console per sviluppatori che è l'applicazione client.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Context

Specifica un oggetto PsApiManagementContext .

Tipo:PsApiManagementContext
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-DefaultScope

Specifica l'ambito predefinito per il server di autorizzazione.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Description

Specifica una descrizione per un server di autorizzazione.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-GrantTypes

Specifica una matrice di tipi di concessione. psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • Implicito
  • ResourceOwnerPassword
Tipo:PsApiManagementGrantType[]
Valori accettati:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Name

Specifica il nome del server di autorizzazione da modificare.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-PassThru

passthru

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ResourceOwnerPassword

Specifica la password del proprietario della risorsa. È necessario specificare questo parametro se ResourceOwnerPassword è specificato dal parametro GrantTypes .

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ResourceOwnerUsername

Specifica il nome utente del proprietario della risorsa. È necessario specificare questo parametro se ResourceOwnerPassword è specificato dal parametro GrantTypes .

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ServerId

Specifica l'ID del server di autorizzazione da modificare.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-SupportState

Indica se supportare il parametro State .

Tipo:Nullable<T>[Boolean]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-TokenBodyParameters

Specifica parametri del corpo aggiuntivi usando il formato application/x-www-form-urlencoded.

Tipo:Hashtable
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-TokenEndpointUrl

Specifica l'endpoint del token per i client per ottenere i token di accesso in cambio della presentazione delle concessioni di autorizzazione o dei token di aggiornamento.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

Input

PsApiManagementContext

String

PsApiManagementAuthorizationRequestMethod[]

PsApiManagementGrantType[]

PsApiManagementClientAuthenticationMethod[]

Hashtable

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

PsApiManagementAccessTokenSendingMethod[]

SwitchParameter

Output

PsApiManagementOAuth2AuthorizationServer