Service Microsoft.ApiManagement/identityProviders 2024-06-01-preview

• dernière
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

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@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowedTenants: [
      'string'
    ]
    authority: 'string'
    certificateId: 'string'
    clientId: 'string'
    clientLibrary: 'string'
    clientSecret: 'string'
    passwordResetPolicyName: 'string'
    profileEditingPolicyName: 'string'
    signinPolicyName: 'string'
    signinTenant: 'string'
    signupPolicyName: 'string'
    type: 'string'
  }
}

Valeurs de propriété

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Nom	Description	Valeur
allowedTenants	Liste des locataires autorisés lors de la configuration de la connexion Azure Active Directory.	string[]
autorité	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.	corde
certificateId	ID de ressource complet du certificat utilisé dans le fournisseur d’identité externe	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.	corde Contraintes: Longueur minimale = 1 (obligatoire)
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 =
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.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
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'

Microsoft.ApiManagement/service/identityProviders

Nom	Description	Valeur
nom	Nom de la ressource	'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' (obligatoire)
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é.	IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

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": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "allowedTenants": [ "string" ],
    "authority": "string",
    "certificateId": "string",
    "clientId": "string",
    "clientLibrary": "string",
    "clientSecret": "string",
    "passwordResetPolicyName": "string",
    "profileEditingPolicyName": "string",
    "signinPolicyName": "string",
    "signinTenant": "string",
    "signupPolicyName": "string",
    "type": "string"
  }
}

Valeurs de propriété

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Nom	Description	Valeur
allowedTenants	Liste des locataires autorisés lors de la configuration de la connexion Azure Active Directory.	string[]
autorité	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.	corde
certificateId	ID de ressource complet du certificat utilisé dans le fournisseur d’identité externe	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.	corde Contraintes: Longueur minimale = 1 (obligatoire)
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 =
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.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
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'

Microsoft.ApiManagement/service/identityProviders

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-06-01-preview'
nom	Nom de la ressource	'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' (obligatoire)
Propriétés	Propriétés du contrat fournisseur d’identité.	IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
type	Type de ressource	'Microsoft.ApiManagement/service/identityProviders'

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@2024-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      allowedTenants = [
        "string"
      ]
      authority = "string"
      certificateId = "string"
      clientId = "string"
      clientLibrary = "string"
      clientSecret = "string"
      passwordResetPolicyName = "string"
      profileEditingPolicyName = "string"
      signinPolicyName = "string"
      signinTenant = "string"
      signupPolicyName = "string"
      type = "string"
    }
  })
}

Valeurs de propriété

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Nom	Description	Valeur
allowedTenants	Liste des locataires autorisés lors de la configuration de la connexion Azure Active Directory.	string[]
autorité	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.	corde
certificateId	ID de ressource complet du certificat utilisé dans le fournisseur d’identité externe	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.	corde Contraintes: Longueur minimale = 1 (obligatoire)
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 =
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.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
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'

Microsoft.ApiManagement/service/identityProviders

Nom	Description	Valeur
nom	Nom de la ressource	'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' (obligatoire)
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é.	IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
type	Type de ressource	« Microsoft.ApiManagement/service/identityProviders@2024-06-01-preview »