Condividi tramite

Servizio Microsoft.ApiManagement/authorizationServers

  • Articolo

Definizione di risorsa Bicep

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2023-09-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
nome 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.
genitore 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 all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
proprietà 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 in base al quale viene passato il token di accesso all'API. Matrice di stringhe contenente uno dei seguenti elementi:
'authorizationHeader'
'query'
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. Matrice di stringhe contenente uno dei seguenti elementi:
'Basic'
'Corpo'
clientId ID client o app registrato con questo 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 di autorizzazione. Contiene l'URL assoluto a cui viene fatto riferimento all'entità. stringa (obbligatorio)
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. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.
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. corda
descrizione Descrizione del server di autorizzazione. Può contenere tag di formattazione HTML. corda
displayName Nome del server di autorizzazione descrittivo. stringa (obbligatorio)

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 50
grantTypes Forma di una 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 password del proprietario della risorsa è supportato da questo server di autorizzazione. Password predefinita del proprietario della risorsa. corda
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. corda
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. Bool
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"}. TokenBodyParameterContract[]
tokenEndpoint Endpoint del token OAuth. Contiene l'URI assoluto a cui viene fatto riferimento all'entità. corda
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
nome 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:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

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

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2023-09-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
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/authorizationServers'
apiVersion Versione dell'API della risorsa '2023-09-01-preview'
nome Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in 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.
proprietà 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 in base al quale viene passato il token di accesso all'API. Matrice di stringhe contenente uno dei seguenti elementi:
'authorizationHeader'
'query'
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. Matrice di stringhe contenente uno dei seguenti elementi:
'Basic'
'Corpo'
clientId ID client o app registrato con questo 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 di autorizzazione. Contiene l'URL assoluto a cui viene fatto riferimento all'entità. stringa (obbligatorio)
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. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.
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. corda
descrizione Descrizione del server di autorizzazione. Può contenere tag di formattazione HTML. corda
displayName Nome del server di autorizzazione descrittivo. stringa (obbligatorio)

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 50
grantTypes Forma di una 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 password del proprietario della risorsa è supportato da questo server di autorizzazione. Password predefinita del proprietario della risorsa. corda
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. corda
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. Bool
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"}. TokenBodyParameterContract[]
tokenEndpoint Endpoint del token OAuth. Contiene l'URI assoluto a cui viene fatto riferimento all'entità. corda
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
nome nome del parametro body. stringa (obbligatorio)
valore valore del parametro body. stringa (obbligatorio)

Definizione di 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 risorsa

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2023-09-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
digitare Tipo di risorsa "Microsoft.ApiManagement/service/authorizationServers@2023-09-01-preview"
nome 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
proprietà 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"
"OPZIONI"
"PATCH"
"POST"
"PUT"
"TRACE"
bearerTokenSendingMethods Specifica il meccanismo in base al quale viene passato il token di accesso all'API. Matrice di stringhe contenente uno dei seguenti elementi:
"authorizationHeader"
"query"
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. Matrice di stringhe contenente uno dei seguenti elementi:
"Basic"
"Corpo"
clientId ID client o app registrato con questo 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 di autorizzazione. Contiene l'URL assoluto a cui viene fatto riferimento all'entità. stringa (obbligatorio)
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. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.
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. corda
descrizione Descrizione del server di autorizzazione. Può contenere tag di formattazione HTML. corda
displayName Nome del server di autorizzazione descrittivo. stringa (obbligatorio)

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 50
grantTypes Forma di una 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 password del proprietario della risorsa è supportato da questo server di autorizzazione. Password predefinita del proprietario della risorsa. corda
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. corda
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. Bool
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"}. TokenBodyParameterContract[]
tokenEndpoint Endpoint del token OAuth. Contiene l'URI assoluto a cui viene fatto riferimento all'entità. corda
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
nome nome del parametro body. stringa (obbligatorio)
valore valore del parametro body. stringa (obbligatorio)