Condividi tramite

Servizio Microsoft.ApiManagement/authorizationServers 2023-05-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/authorizationServers può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/authorizationServers, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Valori delle proprietà

service/authorizationServers

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatorio)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
padre In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
properties Proprietà del contratto del server di autorizzazione OAuth esterno. AuthorizationServerContractProperties

AuthorizationServerContractProperties

Nome Descrizione Valore
authorizationEndpoint Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2. stringa (obbligatorio)
authorizationMethods Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo. Matrice di stringhe contenente uno dei seguenti elementi:
'DELETE'
'GET'
'HEAD'
'OPTIONS'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API. Matrice di stringhe contenente uno dei seguenti elementi:
'authorizationHeader'
'query'
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. Matrice di stringhe contenente uno dei seguenti elementi:
'Basic'
'Corpo'
clientId ID client o app registrato con il server di autorizzazione. stringa (obbligatorio)
clientRegistrationEndpoint 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. stringa (obbligatorio)
clientSecret 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. 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. string
description Descrizione del server autorizzazione. Può contenere tag di formattazione HTML. string
displayName Nome del server di autorizzazione descrittivo. stringa (obbligatorio)
grantTypes Forma di concessione di autorizzazione usata dal client per richiedere il token di accesso. Matrice di stringhe contenente uno dei seguenti elementi:
'authorizationCode'
'clientCredentials'
'implicit'
'resourceOwnerPassword' (obbligatorio)
resourceOwnerPassword 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. string
resourceOwnerUsername 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. string
supportState Se true, il server di autorizzazione includerà il parametro di stato della richiesta di autorizzazione alla risposta. Il client può usare il parametro di stato per aumentare la sicurezza del protocollo. bool
tokenBodyParameters Parametri aggiuntivi richiesti dall'endpoint del token di questo server di autorizzazione rappresentato come matrice di oggetti JSON con proprietà della stringa nome e valore, ad esempio {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento. 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. bool
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. bool

TokenBodyParameterContract

Nome Descrizione valore
name nome del parametro body. stringa (obbligatorio)
Valore valore del parametro body. stringa (obbligatorio)

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/authorizationServers può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/authorizationServers, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Valori delle proprietà

service/authorizationServers

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.ApiManagement/service/authorizationServers'
apiVersion Versione dell'API della risorsa '2023-05-01-preview'
name Nome della risorsa

Informazioni su come impostare nomi e tipi per le risorse figlio nei modelli di Resource Manager JSON.		 stringa (obbligatorio)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
properties Proprietà del contratto del server di autorizzazione OAuth esterno. AuthorizationServerContractProperties

AuthorizationServerContractProperties

Nome Descrizione Valore
authorizationEndpoint Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2. stringa (obbligatorio)
authorizationMethods Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo. Matrice di stringhe contenente uno dei seguenti elementi:
'DELETE'
'GET'
'HEAD'
'OPTIONS'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API. Matrice di stringhe contenente uno dei seguenti elementi:
'authorizationHeader'
'query'
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. Matrice di stringhe contenente uno dei seguenti elementi:
'Basic'
'Corpo'
clientId ID client o app registrato con il server di autorizzazione. stringa (obbligatorio)
clientRegistrationEndpoint 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. stringa (obbligatorio)
clientSecret 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. 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. string
description Descrizione del server autorizzazione. Può contenere tag di formattazione HTML. string
displayName Nome del server di autorizzazione descrittivo. stringa (obbligatorio)
grantTypes Forma di concessione di autorizzazione usata dal client per richiedere il token di accesso. Matrice di stringhe contenente uno dei seguenti elementi:
'authorizationCode'
'clientCredentials'
'implicit'
'resourceOwnerPassword' (obbligatorio)
resourceOwnerPassword 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. string
resourceOwnerUsername 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. string
supportState Se true, il server di autorizzazione includerà il parametro di stato della richiesta di autorizzazione alla risposta. Il client può usare il parametro di stato per aumentare la sicurezza del protocollo. bool
tokenBodyParameters Parametri aggiuntivi richiesti dall'endpoint del token di questo server di autorizzazione rappresentato come matrice di oggetti JSON con proprietà della stringa nome e valore, ad esempio {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento. 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. bool
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. bool

TokenBodyParameterContract

Nome Descrizione valore
name nome del parametro body. stringa (obbligatorio)
Valore valore del parametro body. stringa (obbligatorio)

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/authorizationServers può essere distribuito con operazioni destinate a:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/authorizationServers, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Valori delle proprietà

service/authorizationServers

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.ApiManagement/service/authorizationServers@2023-05-01-preview"
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
properties Proprietà del contratto del server di autorizzazione OAuth esterno. AuthorizationServerContractProperties

AuthorizationServerContractProperties

Nome Descrizione Valore
authorizationEndpoint Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2. stringa (obbligatoria)
authorizationMethods Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo. Matrice di stringhe contenente uno qualsiasi di:
"DELETE"
"GET"
"HEAD"
"OPZIONI"
"PATCH"
"POST"
"PUT"
"TRACE"
bearerTokenSendingMethods Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API. Matrice di stringhe contenente uno qualsiasi di:
"authorizationHeader"
"query"
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. Matrice di stringhe contenente uno qualsiasi di:
"Basic"
"Body"
clientId ID client o app registrato con il server di autorizzazione. stringa (obbligatoria)
clientRegistrationEndpoint 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. stringa (obbligatoria)
clientSecret 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. 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. string
description Descrizione del server autorizzazione. Può contenere tag di formattazione HTML. string
displayName Nome del server di autorizzazione descrittivo. stringa (obbligatoria)
grantTypes Forma di concessione di autorizzazione, utilizzata dal client per richiedere il token di accesso. Matrice di stringhe contenente uno qualsiasi di:
"authorizationCode"
"clientCredentials"
"implicito"
"resourceOwnerPassword" (obbligatorio)
resourceOwnerPassword 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. string
resourceOwnerUsername 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. 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 aumentare la sicurezza del protocollo. bool
tokenBodyParameters 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"}. TokenBodyParameterContract[]
tokenEndpoint Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento. 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 fornito alcun valore. bool
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 fornito alcun valore. bool

TokenBodyParameterContract

Nome Descrizione valore
name nome del parametro del corpo. stringa (obbligatoria)
Valore valore del parametro body. stringa (obbligatoria)