Authorization Server - Update

Aggiornamenti i dettagli del server di autorizzazione specificati dal relativo identificatore.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}?api-version=2022-08-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
authsid
path True

string

Identificatore del server di autorizzazione.

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName
path True

string

Nome del servizio Gestione API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
If-Match True

string

ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

Corpo della richiesta

Nome Tipo Descrizione
properties.authorizationEndpoint

string

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

properties.authorizationMethods

AuthorizationMethod[]

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

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.

properties.clientAuthenticationMethod

ClientAuthenticationMethod[]

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

properties.clientId

string

ID client o app registrato con il server di autorizzazione.

properties.clientRegistrationEndpoint

string

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

properties.clientSecret

string

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

properties.defaultScope

string

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.

properties.description

string

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

properties.displayName

string

Nome del server di autorizzazione descrittivo.

properties.grantTypes

GrantType[]

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

properties.resourceOwnerPassword

string

Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Password del proprietario delle risorse predefinito.

properties.resourceOwnerUsername

string

Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Nome utente del proprietario delle risorse predefinito.

properties.supportState

boolean

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 aumentare la sicurezza del protocollo.

properties.tokenBodyParameters

TokenBodyParameterContract[]

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

properties.tokenEndpoint

string

Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento.

properties.useInApiDocumentation

boolean

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

properties.useInTestConsole

boolean

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

Risposte

Nome Tipo Descrizione
200 OK

AuthorizationServerContract

Le impostazioni del server autorizzazione sono state aggiornate.

Headers

ETag: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ApiManagementUpdateAuthorizationServer

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2022-08-01


{
  "properties": {
    "clientId": "update",
    "clientSecret": "updated",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test3",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "clientAuthenticationMethod": [
      "Basic"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "updated",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Definizioni

Nome Descrizione
AuthorizationMethod

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

AuthorizationServerContract

Impostazioni del server di autorizzazione OAuth esterne.

AuthorizationServerUpdateContract

Impostazioni del server di autorizzazione OAuth esterne.

BearerTokenSendingMethod

Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.

ClientAuthenticationMethod

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

ErrorFieldContract

Contratto campo errore.

ErrorResponse

Risposta errore.

GrantType

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

TokenBodyParameterContract

Parametro del corpo della richiesta del token di acquisizione di OAuth (www-url-form-codificato).

AuthorizationMethod

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

Nome Tipo Descrizione
DELETE

string

GET

string

HEAD

string

OPTIONS

string

PATCH

string

POST

string

PUT

string

TRACE

string

AuthorizationServerContract

Impostazioni del server di autorizzazione OAuth esterne.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties.authorizationEndpoint

string

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

properties.authorizationMethods

AuthorizationMethod[]

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

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.

properties.clientAuthenticationMethod

ClientAuthenticationMethod[]

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

properties.clientId

string

ID client o app registrato con il server di autorizzazione.

properties.clientRegistrationEndpoint

string

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

properties.clientSecret

string

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

properties.defaultScope

string

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.

properties.description

string

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

properties.displayName

string

Nome del server di autorizzazione descrittivo.

properties.grantTypes

GrantType[]

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

properties.resourceOwnerPassword

string

Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Password del proprietario delle risorse predefinito.

properties.resourceOwnerUsername

string

Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Nome utente del proprietario delle risorse predefinito.

properties.supportState

boolean

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 aumentare la sicurezza del protocollo.

properties.tokenBodyParameters

TokenBodyParameterContract[]

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

properties.tokenEndpoint

string

Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento.

properties.useInApiDocumentation

boolean

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

properties.useInTestConsole

boolean

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

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

AuthorizationServerUpdateContract

Impostazioni del server di autorizzazione OAuth esterne.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties.authorizationEndpoint

string

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

properties.authorizationMethods

AuthorizationMethod[]

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

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.

properties.clientAuthenticationMethod

ClientAuthenticationMethod[]

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

properties.clientId

string

ID client o app registrato con il server di autorizzazione.

properties.clientRegistrationEndpoint

string

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

properties.clientSecret

string

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

properties.defaultScope

string

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.

properties.description

string

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

properties.displayName

string

Nome del server di autorizzazione descrittivo.

properties.grantTypes

GrantType[]

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

properties.resourceOwnerPassword

string

Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Password del proprietario delle risorse predefinito.

properties.resourceOwnerUsername

string

Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Nome utente del proprietario delle risorse predefinito.

properties.supportState

boolean

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 aumentare la sicurezza del protocollo.

properties.tokenBodyParameters

TokenBodyParameterContract[]

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

properties.tokenEndpoint

string

Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento.

properties.useInApiDocumentation

boolean

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

properties.useInTestConsole

boolean

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

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.

Nome Tipo Descrizione
authorizationHeader

string

query

string

ClientAuthenticationMethod

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

Nome Tipo Descrizione
Basic

string

Metodo di autenticazione client di base.

Body

string

Metodo Di autenticazione basato sul corpo.

ErrorFieldContract

Contratto campo errore.

Nome Tipo Descrizione
code

string

Codice di errore a livello di proprietà.

message

string

Rappresentazione leggibile dell'errore a livello di proprietà.

target

string

Nome della proprietà.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
error.code

string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

ErrorFieldContract[]

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message

string

Rappresentazione leggibile dell'errore.

GrantType

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

Nome Tipo Descrizione
authorizationCode

string

Flusso di concessione del codice di autorizzazione come descritto https://tools.ietf.org/html/rfc6749#section-4.1.

clientCredentials

string

Flusso di concessione credenziali client come descritto https://tools.ietf.org/html/rfc6749#section-4.4.

implicit

string

Flusso di concessione del codice implicito come descritto https://tools.ietf.org/html/rfc6749#section-4.2.

resourceOwnerPassword

string

Flusso di concessione password del proprietario della risorsa come descritto https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

Parametro del corpo della richiesta del token di acquisizione di OAuth (www-url-form-codificato).

Nome Tipo Descrizione
name

string

nome del parametro del corpo.

value

string

valore del parametro body.