Service Microsoft.ApiManagement/authorizationServers 2022-08-01

• La plus récente
• 2023-05-01-preview
• Préversion du 01/03/2023
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview

Définition de ressource Bicep

Le type de ressource service/authorizationServers peut être déployé avec des opérations qui ciblent :

• Groupes de ressources - Voir commandes de déploiement de groupe de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/authorizationServers, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2022-08-01' = {
  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
  }
}

Valeurs de propriétés

service/authorizationServers

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent	Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.	Nom symbolique de la ressource de type : service
properties	Propriétés du contrat du serveur d’autorisation OAuth externe.	AuthorizationServerContractProperties

AuthorizationServerContractProperties

Nom	Description	Valeur
authorizationEndpoint	Point de terminaison d'autorisation OAuth. Voir http://tools.ietf.org/html/rfc6749#section-3.2.	string (obligatoire)
authorizationMethods	Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.	Tableau de chaînes contenant l’un des éléments suivants : 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'PATCH' 'POST' 'PUT' 'TRACE'
bearerTokenSendingMethods	Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.	Tableau de chaînes contenant l’un des éléments suivants : 'authorizationHeader' 'query'
clientAuthenticationMethod	Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont passées dans le corps de la demande au format application/x-www-form-urlencoded.	Tableau de chaînes contenant l’un des éléments suivants : 'De base' 'Corps'
clientId	Id de client ou d'application inscrit auprès du serveur d'autorisation.	string (obligatoire)
clientRegistrationEndpoint	Référence facultative à une page où l'inscription du client ou de l'application pour ce serveur d'autorisation est effectuée. Contient l'URL absolue de l'entité référencée.	string (obligatoire)
clientSecret	Clé secrète de client ou d'application inscrite auprès du serveur d'autorisation. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.	string
defaultScope	Étendue de jeton d'accès à demander par défaut. Peut être remplacée au niveau de l'API. Doit être fournie sous la forme d'une chaîne contenant des valeurs délimitées par des espaces.	string
description	Description du serveur d'autorisation. Peut contenir des balises au format HTML.	string
displayName	Nom du serveur d’autorisation convivial.	string (obligatoire)
grantTypes	Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.	Tableau de chaînes contenant l’un des éléments suivants : 'authorizationCode' 'clientCredentials' 'implicite' 'resourceOwnerPassword' (obligatoire)
resourceOwnerPassword	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Mot de passe du propriétaire de ressource par défaut.	string
resourceOwnerUsername	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Nom d'utilisateur du propriétaire de ressource par défaut.	string
supportState	Si la valeur est true, le serveur d’autorisation inclut le paramètre d’état de la demande d’autorisation à sa réponse. Le client peut utiliser le paramètre d'état pour augmenter la sécurité du protocole.	bool
tokenBodyParameters	Paramètres supplémentaires requis par le point de terminaison de jeton de ce serveur d’autorisation représenté sous la forme d’un tableau d’objets JSON avec des propriétés de nom et de chaîne de valeur, à savoir {"name » : « name value », « value » : « a value"}.	TokenBodyParameterContract[]
tokenEndpoint	Point de terminaison du jeton OAuth. Contient l'URI absolu de l'entité référencée.	string
useInApiDocumentation	Si la valeur est true, le serveur d’autorisation sera utilisé dans la documentation de l’API du portail des développeurs. False par défaut si aucune valeur n’est fournie.	bool
useInTestConsole	Si la valeur est true, le serveur d’autorisation peut être utilisé dans la console de test du portail des développeurs. True par défaut si aucune valeur n’est fournie.	bool

TokenBodyParameterContract

Nom	Description	Valeur
name	nom du paramètre body.	chaîne (obligatoire)
value	valeur du paramètre body.	chaîne (obligatoire)

Définition de ressources de modèle ARM

Le type de ressource service/authorizationServers peut être déployé avec des opérations qui ciblent :

• Groupes de ressources - Voir commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/authorizationServers, ajoutez le CODE JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2022-08-01",
  "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"
  }
}

Valeurs de propriétés

service/authorizationServers

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/authorizationServers »
apiVersion	Version de l’API de ressource	'2022-08-01'
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.	chaîne (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
properties	Propriétés du contrat du serveur d’autorisation OAuth externe.	AuthorizationServerContractProperties

AuthorizationServerContractProperties

Nom	Description	Valeur
authorizationEndpoint	Point de terminaison d'autorisation OAuth. Voir http://tools.ietf.org/html/rfc6749#section-3.2.	chaîne (obligatoire)
authorizationMethods	Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.	Tableau de chaînes contenant l’un des éléments suivants : 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'PATCH' 'POST' 'PUT' 'TRACE'
bearerTokenSendingMethods	Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.	Tableau de chaînes contenant l’un des éléments suivants : 'authorizationHeader' 'query'
clientAuthenticationMethod	Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la demande au format application/x-www-form-urlencoded.	Tableau de chaînes contenant l’un des éléments suivants : 'De base' 'Corps'
clientId	Id de client ou d'application inscrit auprès du serveur d'autorisation.	chaîne (obligatoire)
clientRegistrationEndpoint	Référence facultative à une page où l'inscription du client ou de l'application pour ce serveur d'autorisation est effectuée. Contient l'URL absolue de l'entité référencée.	chaîne (obligatoire)
clientSecret	Clé secrète de client ou d'application inscrite auprès du serveur d'autorisation. Cette propriété n’est pas renseignée sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.	string
defaultScope	Étendue de jeton d'accès à demander par défaut. Peut être remplacée au niveau de l'API. Doit être fournie sous la forme d'une chaîne contenant des valeurs délimitées par des espaces.	string
description	Description du serveur d'autorisation. Peut contenir des balises au format HTML.	string
displayName	Nom du serveur d’autorisation convivial.	chaîne (obligatoire)
grantTypes	Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.	Tableau de chaînes contenant l’un des éléments suivants : 'authorizationCode' 'clientCredentials' 'implicite' 'resourceOwnerPassword' (obligatoire)
resourceOwnerPassword	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Mot de passe du propriétaire de ressource par défaut.	string
resourceOwnerUsername	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Nom d'utilisateur du propriétaire de ressource par défaut.	string
supportState	Si la valeur est true, le serveur d’autorisation inclut le paramètre d’état de la demande d’autorisation à sa réponse. Le client peut utiliser le paramètre d'état pour augmenter la sécurité du protocole.	bool
tokenBodyParameters	Paramètres supplémentaires requis par le point de terminaison de jeton de ce serveur d’autorisation représenté sous la forme d’un tableau d’objets JSON avec des propriétés de nom et de chaîne de valeur, à savoir {"name » : « name value », « value » : « a value"}.	TokenBodyParameterContract[]
tokenEndpoint	Point de terminaison du jeton OAuth. Contient l'URI absolu de l'entité référencée.	string
useInApiDocumentation	Si la valeur est true, le serveur d’autorisation sera utilisé dans la documentation de l’API du portail des développeurs. False par défaut si aucune valeur n’est fournie.	bool
useInTestConsole	Si la valeur est true, le serveur d’autorisation peut être utilisé dans la console de test du portail des développeurs. True par défaut si aucune valeur n’est fournie.	bool

TokenBodyParameterContract

Nom	Description	Valeur
name	nom du paramètre body.	chaîne (obligatoire)
value	valeur du paramètre body.	chaîne (obligatoire)

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/authorizationServers peut être déployé avec des opérations qui ciblent :

• Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/authorizationServers, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2022-08-01"
  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
    }
  })
}

Valeurs de propriétés

service/authorizationServers

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/authorizationServers@2022-08-01 »
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent_id	ID de la ressource qui est le parent de cette ressource.	ID pour la ressource de type : service
properties	Propriétés du contrat du serveur d’autorisation OAuth externe.	AuthorizationServerContractProperties

AuthorizationServerContractProperties

Nom	Description	Valeur
authorizationEndpoint	Point de terminaison d'autorisation OAuth. Voir http://tools.ietf.org/html/rfc6749#section-3.2.	chaîne (obligatoire)
authorizationMethods	Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.	Tableau de chaînes contenant l’un des éléments suivants : « SUPPRIMER » « OBTERNIR » « HEAD » « OPTIONS » « PATCH » « POST » « PUT » « TRACE »
bearerTokenSendingMethods	Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.	Tableau de chaînes contenant l’un des éléments suivants : « authorizationHeader » "query"
clientAuthenticationMethod	Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la demande au format application/x-www-form-urlencoded.	Tableau de chaînes contenant l’un des éléments suivants : "Basic" « Corps »
clientId	Id de client ou d'application inscrit auprès du serveur d'autorisation.	chaîne (obligatoire)
clientRegistrationEndpoint	Référence facultative à une page où l'inscription du client ou de l'application pour ce serveur d'autorisation est effectuée. Contient l'URL absolue de l'entité référencée.	chaîne (obligatoire)
clientSecret	Clé secrète de client ou d'application inscrite auprès du serveur d'autorisation. Cette propriété n’est pas renseignée sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.	string
defaultScope	Étendue de jeton d'accès à demander par défaut. Peut être remplacée au niveau de l'API. Doit être fournie sous la forme d'une chaîne contenant des valeurs délimitées par des espaces.	string
description	Description du serveur d'autorisation. Peut contenir des balises au format HTML.	string
displayName	Nom du serveur d’autorisation convivial.	chaîne (obligatoire)
grantTypes	Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.	Tableau de chaînes contenant l’un des éléments suivants : « authorizationCode » « clientCredentials » « implicite » « resourceOwnerPassword » (obligatoire)
resourceOwnerPassword	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Mot de passe du propriétaire de ressource par défaut.	string
resourceOwnerUsername	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Nom d'utilisateur du propriétaire de ressource par défaut.	string
supportState	Si la valeur est true, le serveur d’autorisation inclut le paramètre d’état de la demande d’autorisation à sa réponse. Le client peut utiliser le paramètre d'état pour augmenter la sécurité du protocole.	bool
tokenBodyParameters	Paramètres supplémentaires requis par le point de terminaison de jeton de ce serveur d’autorisation représenté sous la forme d’un tableau d’objets JSON avec des propriétés de nom et de chaîne de valeur, à savoir {"name » : « name value », « value » : « a value"}.	TokenBodyParameterContract[]
tokenEndpoint	Point de terminaison du jeton OAuth. Contient l'URI absolu de l'entité référencée.	string
useInApiDocumentation	Si la valeur est true, le serveur d’autorisation sera utilisé dans la documentation de l’API du portail des développeurs. False par défaut si aucune valeur n’est fournie.	bool
useInTestConsole	Si la valeur est true, le serveur d’autorisation peut être utilisé dans la console de test du portail des développeurs. True par défaut si aucune valeur n’est fournie.	bool

TokenBodyParameterContract

Nom	Description	Valeur
name	nom du paramètre body.	chaîne (obligatoire)
value	valeur du paramètre body.	chaîne (obligatoire)