Service Microsoft.ApiManagement/authorizationServers 2021-08-01

Article
07/24/2024

Définition de ressource Bicep

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

groupes de ressources - Consultez 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 de ressource

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2021-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'
  }
}

Valeurs de propriété

service/authorizationServers

Nom	Description	Valeur
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep.	chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique.
parent	Dans Bicep, vous pouvez spécifier la ressource parente d’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
Propriétés	Propriétés du contrat de 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 passé à 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 De base et/ou Corps. Lorsque le corps est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la requête dans le format application/x-www-form-urlencoded.	Tableau de chaînes contenant l’un des éléments suivants : 'De base' 'Body'
clientId	ID de client ou d’application inscrit auprès de ce serveur d’autorisation.	chaîne (obligatoire)
clientRegistrationEndpoint	Référence facultative à une page dans laquelle 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 client ou application inscrite auprès de ce 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.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
defaultScope	Étendue du jeton d’accès qui sera demandée par défaut. Peut être substitué au niveau de l’API. Doit être fourni sous la forme d’une chaîne contenant des valeurs délimitées par un espace.	corde
description	Description du serveur d’autorisation. Peut contenir des balises de mise en forme HTML.	corde
displayName	Nom du serveur d’autorisation convivial.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 50
grantTypes	Forme d’une 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é éventuellement lorsque le type d’octroi de mot de passe du propriétaire de la ressource est pris en charge par ce serveur d’autorisation. Mot de passe du propriétaire de la ressource par défaut.	corde
resourceOwnerUsername	Peut être spécifié éventuellement lorsque le type d’octroi de mot de passe du propriétaire de la ressource est pris en charge par ce serveur d’autorisation. Nom d’utilisateur du propriétaire de la ressource par défaut.	corde
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 déclencher 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 chaîne de nom et de valeur, par exemple {"name » : « name value », « value » : « a value"}.	TokenBodyParameterContract[]
tokenEndpoint	Point de terminaison de jeton OAuth. Contient l’URI absolu pour l’entité référencée.	corde

TokenBodyParameterContract

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

Définition de ressource de modèle ARM

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

groupes de ressources - Consultez 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 de ressource

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

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

Valeurs de propriété

service/authorizationServers

Nom	Description	Valeur
type	Type de ressource	'Microsoft.ApiManagement/service/authorizationServers'
apiVersion	Version de l’API de ressource	'2021-08-01'
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON.	chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique.
Propriétés	Propriétés du contrat de 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 passé à 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 De base et/ou Corps. Lorsque le corps est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la requête dans le format application/x-www-form-urlencoded.	Tableau de chaînes contenant l’un des éléments suivants : 'De base' 'Body'
clientId	ID de client ou d’application inscrit auprès de ce serveur d’autorisation.	chaîne (obligatoire)
clientRegistrationEndpoint	Référence facultative à une page dans laquelle 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 client ou application inscrite auprès de ce 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.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
defaultScope	Étendue du jeton d’accès qui sera demandée par défaut. Peut être substitué au niveau de l’API. Doit être fourni sous la forme d’une chaîne contenant des valeurs délimitées par un espace.	corde
description	Description du serveur d’autorisation. Peut contenir des balises de mise en forme HTML.	corde
displayName	Nom du serveur d’autorisation convivial.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 50
grantTypes	Forme d’une 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é éventuellement lorsque le type d’octroi de mot de passe du propriétaire de la ressource est pris en charge par ce serveur d’autorisation. Mot de passe du propriétaire de la ressource par défaut.	corde
resourceOwnerUsername	Peut être spécifié éventuellement lorsque le type d’octroi de mot de passe du propriétaire de la ressource est pris en charge par ce serveur d’autorisation. Nom d’utilisateur du propriétaire de la ressource par défaut.	corde
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 déclencher 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 chaîne de nom et de valeur, par exemple {"name » : « name value », « value » : « a value"}.	TokenBodyParameterContract[]
tokenEndpoint	Point de terminaison de jeton OAuth. Contient l’URI absolu pour l’entité référencée.	corde

TokenBodyParameterContract

Nom	Description	Valeur
nom	nom du paramètre body.	chaîne (obligatoire)
valeur	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 de ressource

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@2021-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"
    }
  })
}

Valeurs de propriété

service/authorizationServers

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/authorizationServers@2021-08-01 »
nom	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique.
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : de service
Propriétés	Propriétés du contrat de 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 passé à 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 De base et/ou Corps. Lorsque le corps est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la requête dans le 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 de ce serveur d’autorisation.	chaîne (obligatoire)
clientRegistrationEndpoint	Référence facultative à une page dans laquelle 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 client ou application inscrite auprès de ce 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.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
defaultScope	Étendue du jeton d’accès qui sera demandée par défaut. Peut être substitué au niveau de l’API. Doit être fourni sous la forme d’une chaîne contenant des valeurs délimitées par un espace.	corde
description	Description du serveur d’autorisation. Peut contenir des balises de mise en forme HTML.	corde
displayName	Nom du serveur d’autorisation convivial.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 50
grantTypes	Forme d’une 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é éventuellement lorsque le type d’octroi de mot de passe du propriétaire de la ressource est pris en charge par ce serveur d’autorisation. Mot de passe du propriétaire de la ressource par défaut.	corde
resourceOwnerUsername	Peut être spécifié éventuellement lorsque le type d’octroi de mot de passe du propriétaire de la ressource est pris en charge par ce serveur d’autorisation. Nom d’utilisateur du propriétaire de la ressource par défaut.	corde
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 déclencher 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 chaîne de nom et de valeur, par exemple {"name » : « name value », « value » : « a value"}.	TokenBodyParameterContract[]
tokenEndpoint	Point de terminaison de jeton OAuth. Contient l’URI absolu pour l’entité référencée.	corde

TokenBodyParameterContract

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

Partager via

Service Microsoft.ApiManagement/authorizationServers 2021-08-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

Commentaires

Ressources supplémentaires