AuthorizationServerUpdateContract interface

Pacchetto:

@azure/arm-apimanagement

Impostazioni esterne del server di autorizzazione OAuth.

Extends

ProxyResource

Proprietà

authorizationEndpoint	Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2.
authorizationMethods	Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo.
bearerTokenSendingMethods	Specifica il meccanismo in base al quale viene passato il token di accesso all'API.
clientAuthenticationMethod	Metodo di autenticazione supportato dall'endpoint token di questo server di autorizzazione. I valori possibili sono Basic e/o Body. Quando si specifica Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded.
clientId	ID client o app registrato con questo server di autorizzazione.
clientRegistrationEndpoint	Riferimento facoltativo a una pagina in cui viene eseguita la registrazione del client o dell'app per questo server di autorizzazione. Contiene l'URL assoluto a cui viene fatto riferimento all'entità.
clientSecret	Segreto client o app registrato con questo server di autorizzazione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
defaultScope	Ambito del token di accesso che verrà richiesto per impostazione predefinita. Può essere sottoposto a override a livello di API. Deve essere specificato sotto forma di stringa contenente valori delimitati da spazi.
description	Descrizione del server di autorizzazione. Può contenere tag di formattazione HTML.
displayName	Nome del server di autorizzazione descrittivo.
grantTypes	Forma di una concessione di autorizzazione, usata dal client per richiedere il token di accesso.
resourceOwnerPassword	Può essere specificato facoltativamente quando il tipo di concessione password del proprietario della risorsa è supportato da questo server di autorizzazione. Password predefinita del proprietario della risorsa.
resourceOwnerUsername	Può essere specificato facoltativamente quando il tipo di concessione password del proprietario della risorsa è supportato da questo server di autorizzazione. Nome utente predefinito del proprietario della risorsa.
supportState	Se true, il server di autorizzazione includerà il parametro di stato dalla richiesta di autorizzazione alla risposta. Il client può usare il parametro di stato per generare la sicurezza del protocollo.
tokenBodyParameters	Parametri aggiuntivi richiesti dall'endpoint token di questo server di autorizzazione rappresentato come matrice di oggetti JSON con proprietà nome e stringa valore, ad esempio {"name" : "name value", "value": "a value"}.
tokenEndpoint	Endpoint del token OAuth. Contiene l'URI assoluto a cui viene fatto riferimento all'entità.
useInApiDocumentation	Se true, il server di autorizzazione verrà usato nella documentazione dell'API nel portale per sviluppatori. False per impostazione predefinita se non viene specificato alcun valore.
useInTestConsole	Se true, il server di autorizzazione può essere usato nella console di test del portale per sviluppatori. True per impostazione predefinita se non viene specificato alcun valore.

Proprietà ereditate

id	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
name	Nome della risorsa NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
type	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

Dettagli proprietà

authorizationEndpoint

Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Valore della proprietà

string

authorizationMethods

Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo.

authorizationMethods?: AuthorizationMethod[]

Valore della proprietà

AuthorizationMethod[]

bearerTokenSendingMethods

Specifica il meccanismo in base al quale viene passato il token di accesso all'API.

bearerTokenSendingMethods?: string[]

Valore della proprietà

string[]

clientAuthenticationMethod

Metodo di autenticazione supportato dall'endpoint token di questo server di autorizzazione. I valori possibili sono Basic e/o Body. Quando si specifica Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Valore della proprietà

string[]

clientId

ID client o app registrato con questo server di autorizzazione.

clientId?: string

Valore della proprietà

string

clientRegistrationEndpoint

Riferimento facoltativo a una pagina in cui viene eseguita la registrazione del client o dell'app per questo server di autorizzazione. Contiene l'URL assoluto a cui viene fatto riferimento all'entità.

clientRegistrationEndpoint?: string

Valore della proprietà

string

clientSecret

Segreto client o app registrato con questo server di autorizzazione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.

clientSecret?: string

Valore della proprietà

string

defaultScope

Ambito del token di accesso che verrà richiesto per impostazione predefinita. Può essere sottoposto a override a livello di API. Deve essere specificato sotto forma di stringa contenente valori delimitati da spazi.

defaultScope?: string

Valore della proprietà

string

description

Descrizione del server di autorizzazione. Può contenere tag di formattazione HTML.

description?: string

Valore della proprietà

string

displayName

Nome del server di autorizzazione descrittivo.

displayName?: string

Valore della proprietà

string

grantTypes

Forma di una concessione di autorizzazione, usata dal client per richiedere il token di accesso.

grantTypes?: string[]

Valore della proprietà

string[]

resourceOwnerPassword

Può essere specificato facoltativamente quando il tipo di concessione password del proprietario della risorsa è supportato da questo server di autorizzazione. Password predefinita del proprietario della risorsa.

resourceOwnerPassword?: string

Valore della proprietà

string

resourceOwnerUsername

Può essere specificato facoltativamente quando il tipo di concessione password del proprietario della risorsa è supportato da questo server di autorizzazione. Nome utente predefinito del proprietario della risorsa.

resourceOwnerUsername?: string

Valore della proprietà

string

supportState

Se true, il server di autorizzazione includerà il parametro di stato dalla richiesta di autorizzazione alla risposta. Il client può usare il parametro di stato per generare la sicurezza del protocollo.

supportState?: boolean

Valore della proprietà

boolean

tokenBodyParameters

Parametri aggiuntivi richiesti dall'endpoint token di questo server di autorizzazione rappresentato come matrice di oggetti JSON con proprietà nome e stringa valore, ad esempio {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Valore della proprietà

TokenBodyParameterContract[]

tokenEndpoint

Endpoint del token OAuth. Contiene l'URI assoluto a cui viene fatto riferimento all'entità.

tokenEndpoint?: string

Valore della proprietà

string

useInApiDocumentation

Se true, il server di autorizzazione verrà usato nella documentazione dell'API nel portale per sviluppatori. False per impostazione predefinita se non viene specificato alcun valore.

useInApiDocumentation?: boolean

Valore della proprietà

boolean

useInTestConsole

Se true, il server di autorizzazione può essere usato nella console di test del portale per sviluppatori. True per impostazione predefinita se non viene specificato alcun valore.

useInTestConsole?: boolean

Valore della proprietà

boolean

Dettagli proprietà ereditate

id

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

id?: string

Valore della proprietà

string

ereditato daProxyResource.id

name

Nome della risorsa NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

name?: string

Valore della proprietà

string

ereditato daProxyResource.name

type

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

type?: string

Valore della proprietà

string

Ereditato daProxyResource.type