Service Microsoft.ApiManagement/identityProviders 2022-08-01

Article
07/24/2024

Définition de ressource Bicep

Le type de ressource service/identityProviders 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/identityProviders, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowedTenants: [
      'string'
    ]
    authority: 'string'
    clientId: 'string'
    clientLibrary: 'string'
    clientSecret: 'string'
    passwordResetPolicyName: 'string'
    profileEditingPolicyName: 'string'
    signinPolicyName: 'string'
    signinTenant: 'string'
    signupPolicyName: 'string'
    type: 'string'
  }
}

Valeurs de propriété

service/identityProviders

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 fournisseur d’identité.	IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Nom	Description	Valeur
allowedTenants	Liste des locataires autorisés lors de la configuration de la connexion Azure Active Directory.	string[] Contraintes: Longueur maximale = 32
autorité	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.	corde
clientId	ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour la connexion Facebook, l’ID client pour la connexion Google, l’ID d’application pour Microsoft.	chaîne (obligatoire) Contraintes: Longueur minimale = 1
clientLibrary	Bibliothèque cliente à utiliser dans le portail des développeurs. S’applique uniquement au fournisseur d’identité AAD et AAD B2C.	corde Contraintes: Longueur maximale = 16
clientSecret	Clé secrète client de l’application dans le fournisseur d’identité externe, utilisée pour authentifier la demande de connexion. Par exemple, il s’agit du secret d’application pour la connexion Facebook, de la clé API pour la connexion Google, de la clé publique pour Microsoft. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé.
passwordResetPolicyName	Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
profileEditingPolicyName	Nom de la stratégie d’édition de profil. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
signinPolicyName	Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
signinTenant	TenantId à utiliser au lieu de Common lors de la connexion à Active Directory	corde
signupPolicyName	Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
type	Identificateur de type de fournisseur d’identité.	'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter'

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Créer une instance Gestion des API et toutes les sous-ressources à l’aide d’un modèle	Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités

Définition de ressource de modèle ARM

Le type de ressource service/identityProviders 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/identityProviders, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "allowedTenants": [ "string" ],
    "authority": "string",
    "clientId": "string",
    "clientLibrary": "string",
    "clientSecret": "string",
    "passwordResetPolicyName": "string",
    "profileEditingPolicyName": "string",
    "signinPolicyName": "string",
    "signinTenant": "string",
    "signupPolicyName": "string",
    "type": "string"
  }
}

Valeurs de propriété

service/identityProviders

Nom	Description	Valeur
type	Type de ressource	'Microsoft.ApiManagement/service/identityProviders'
apiVersion	Version de l’API de ressource	'2022-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 fournisseur d’identité.	IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Nom	Description	Valeur
allowedTenants	Liste des locataires autorisés lors de la configuration de la connexion Azure Active Directory.	string[] Contraintes: Longueur maximale = 32
autorité	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.	corde
clientId	ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour la connexion Facebook, l’ID client pour la connexion Google, l’ID d’application pour Microsoft.	chaîne (obligatoire) Contraintes: Longueur minimale = 1
clientLibrary	Bibliothèque cliente à utiliser dans le portail des développeurs. S’applique uniquement au fournisseur d’identité AAD et AAD B2C.	corde Contraintes: Longueur maximale = 16
clientSecret	Clé secrète client de l’application dans le fournisseur d’identité externe, utilisée pour authentifier la demande de connexion. Par exemple, il s’agit du secret d’application pour la connexion Facebook, de la clé API pour la connexion Google, de la clé publique pour Microsoft. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé.
passwordResetPolicyName	Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
profileEditingPolicyName	Nom de la stratégie d’édition de profil. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
signinPolicyName	Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
signinTenant	TenantId à utiliser au lieu de Common lors de la connexion à Active Directory	corde
signupPolicyName	Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
type	Identificateur de type de fournisseur d’identité.	'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter'

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Créer une instance Gestion des API et toutes les sous-ressources à l’aide d’un modèle	Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/identityProviders 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/identityProviders, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowedTenants = [
        "string"
      ]
      authority = "string"
      clientId = "string"
      clientLibrary = "string"
      clientSecret = "string"
      passwordResetPolicyName = "string"
      profileEditingPolicyName = "string"
      signinPolicyName = "string"
      signinTenant = "string"
      signupPolicyName = "string"
      type = "string"
    }
  })
}

Valeurs de propriété

service/identityProviders

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/identityProviders@2022-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 fournisseur d’identité.	IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Nom	Description	Valeur
allowedTenants	Liste des locataires autorisés lors de la configuration de la connexion Azure Active Directory.	string[] Contraintes: Longueur maximale = 32
autorité	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.	corde
clientId	ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour la connexion Facebook, l’ID client pour la connexion Google, l’ID d’application pour Microsoft.	chaîne (obligatoire) Contraintes: Longueur minimale = 1
clientLibrary	Bibliothèque cliente à utiliser dans le portail des développeurs. S’applique uniquement au fournisseur d’identité AAD et AAD B2C.	corde Contraintes: Longueur maximale = 16
clientSecret	Clé secrète client de l’application dans le fournisseur d’identité externe, utilisée pour authentifier la demande de connexion. Par exemple, il s’agit du secret d’application pour la connexion Facebook, de la clé API pour la connexion Google, de la clé publique pour Microsoft. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé.
passwordResetPolicyName	Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
profileEditingPolicyName	Nom de la stratégie d’édition de profil. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
signinPolicyName	Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
signinTenant	TenantId à utiliser au lieu de Common lors de la connexion à Active Directory	corde
signupPolicyName	Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C.	corde Contraintes: Longueur minimale = 1
type	Identificateur de type de fournisseur d’identité.	« aad » « aadB2C » « facebook » « google » « microsoft » « twitter »

Partager via

Service Microsoft.ApiManagement/identityProviders 2022-08-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

service/identityProviders

IdentityProviderCreateContractPropertiesOrIdentityPr...

Modèles de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

service/identityProviders

IdentityProviderCreateContractPropertiesOrIdentityPr...

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

service/identityProviders

IdentityProviderCreateContractPropertiesOrIdentityPr...

Commentaires

Ressources supplémentaires