Microsoft.ApiManagement service/identityProviders 2023-03-01-preview

Article
01/18/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 - 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/identityProviders, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2023-03-01-preview' = {
  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és

service/identityProviders

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	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	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 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[]
authority	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.	string
clientId	ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour Facebook connexion, de l’ID client pour la connexion Google, de l’ID d’application pour Microsoft.	chaîne (obligatoire)
clientLibrary	Bibliothèque cliente à utiliser dans le portail des développeurs. S’applique uniquement au fournisseur d’identité AAD et AAD B2C.	string
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 Facebook connexion, de la clé API pour la connexion Google, de la clé publique pour Microsoft. Cette propriété n’est pas renseignée sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.	chaîne (obligatoire)
passwordResetPolicyName	Nom de la stratégie de réinitialisation du mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C.	string
profileEditingPolicyName	Nom de la stratégie de modification du profil. S’applique uniquement au fournisseur d’identité AAD B2C.	string
signinPolicyName	Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C.	string
signinTenant	TenantId à utiliser au lieu de Common lors de la connexion à Active Directory	string
signupPolicyName	Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C.	string
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 de 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 ressources de modèle ARM

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

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2023-03-01-preview",
  "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és

service/identityProviders

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/identityProviders »
apiVersion	Version de l’API de ressource	'2023-03-01-preview'
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.	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.
properties	Propriétés du contrat du 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[]
authority	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.	string
clientId	ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour Facebook connexion, de l’ID client pour la connexion Google, de l’ID d’application pour Microsoft.	string (obligatoire)
clientLibrary	Bibliothèque cliente à utiliser dans le portail des développeurs. S’applique uniquement au fournisseur d’identité AAD et AAD B2C.	string
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 Facebook connexion, 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.	string (obligatoire)
passwordResetPolicyName	Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C.	string
profileEditingPolicyName	Nom de la stratégie de modification de profil. S’applique uniquement au fournisseur d’identité AAD B2C.	string
signinPolicyName	Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C.	string
signinTenant	TenantId à utiliser au lieu de Commun lors de la connexion à Active Directory	string
signupPolicyName	Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C.	string
type	Identificateur du 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 de 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 d’API, consultez journal des modifications.

Format des ressources

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@2023-03-01-preview"
  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és

service/identityProviders

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/identityProviders@2023-03-01-preview »
name	Nom de la ressource	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_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : service
properties	Propriétés du contrat du 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[]
authority	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.	string
clientId	ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour Facebook connexion, de l’ID client pour la connexion Google, de l’ID d’application pour Microsoft.	string (obligatoire)
clientLibrary	Bibliothèque cliente à utiliser dans le portail des développeurs. S’applique uniquement au fournisseur d’identité AAD et AAD B2C.	string
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 Facebook connexion, 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.	string (obligatoire)
passwordResetPolicyName	Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C.	string
profileEditingPolicyName	Nom de la stratégie de modification de profil. S’applique uniquement au fournisseur d’identité AAD B2C.	string
signinPolicyName	Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C.	string
signinTenant	TenantId à utiliser au lieu de Commun lors de la connexion à Active Directory	string
signupPolicyName	Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C.	string
type	Identificateur du type de fournisseur d’identité.	"aad" « aadB2C » "facebook" "google" « microsoft » "twitter"

Partager via

Microsoft.ApiManagement service/identityProviders 2023-03-01-preview

Définition de ressource Bicep

Format des ressources

Valeurs de propriétés

service/identityProviders

IdentityProviderCreateContractPropertiesOrIdentityPr...

Modèles de démarrage rapide

Définition de ressources de modèle ARM

Format des ressources

Valeurs de propriétés

service/identityProviders

IdentityProviderCreateContractPropertiesOrIdentityPr...

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

service/identityProviders

IdentityProviderCreateContractPropertiesOrIdentityPr...

Ressources supplémentaires