Partager via

Service/utilisateurs Microsoft.ApiManagement

  • Article

Définition de ressource Bicep

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

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/users, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/users@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    appType: 'string'
    confirmation: 'string'
    email: 'string'
    firstName: 'string'
    identities: [
      {
        id: 'string'
        provider: 'string'
      }
    ]
    lastName: 'string'
    note: 'string'
    password: 'string'
    state: 'string'
  }
}

Valeurs de propriété

service/utilisateurs

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 L’entité utilisateur crée des propriétés de contrat. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nom Description Valeur
appType Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité. 'developerPortal'
'portal'
confirmation Détermine le type de courrier électronique de confirmation qui sera envoyé à l’utilisateur nouvellement créé. 'invite'
'inscription'
Messagerie électronique Adresse courriel. Ne doit pas être vide et doit être unique dans l’instance de service. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 254
firstName Prénom. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 100
Identités Collection d’identités utilisateur. UserIdentityContract[]
lastName Nom. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 100
note Remarque facultative sur un utilisateur défini par l’administrateur. corde
mot de passe Mot de passe de l’utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré. corde
état État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif. 'actif'
'bloqué'
'supprimé'
'en attente'

UserIdentityContract

Nom Description Valeur
id Valeur d’identificateur au sein du fournisseur. corde
fournisseur Nom du fournisseur d’identité. corde

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

Déployer sur Azure 		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/utilisateurs peut être déployé avec des opérations qui ciblent :

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/users, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "appType": "string",
    "confirmation": "string",
    "email": "string",
    "firstName": "string",
    "identities": [
      {
        "id": "string",
        "provider": "string"
      }
    ],
    "lastName": "string",
    "note": "string",
    "password": "string",
    "state": "string"
  }
}

Valeurs de propriété

service/utilisateurs

Nom Description Valeur
type Type de ressource 'Microsoft.ApiManagement/service/users'
apiVersion Version de l’API de ressource '2023-09-01-preview'
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 L’entité utilisateur crée des propriétés de contrat. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nom Description Valeur
appType Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité. 'developerPortal'
'portal'
confirmation Détermine le type de courrier électronique de confirmation qui sera envoyé à l’utilisateur nouvellement créé. 'invite'
'inscription'
Messagerie électronique Adresse courriel. Ne doit pas être vide et doit être unique dans l’instance de service. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 254
firstName Prénom. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 100
Identités Collection d’identités utilisateur. UserIdentityContract[]
lastName Nom. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 100
note Remarque facultative sur un utilisateur défini par l’administrateur. corde
mot de passe Mot de passe de l’utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré. corde
état État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif. 'actif'
'bloqué'
'supprimé'
'en attente'

UserIdentityContract

Nom Description Valeur
id Valeur d’identificateur au sein du fournisseur. corde
fournisseur Nom du fournisseur d’identité. corde

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

Déployer sur Azure 		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/utilisateurs 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/users, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appType = "string"
      confirmation = "string"
      email = "string"
      firstName = "string"
      identities = [
        {
          id = "string"
          provider = "string"
        }
      ]
      lastName = "string"
      note = "string"
      password = "string"
      state = "string"
    }
  })
}

Valeurs de propriété

service/utilisateurs

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/users@2023-09-01-preview »
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 L’entité utilisateur crée des propriétés de contrat. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nom Description Valeur
appType Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité. « developerPortal »
« portail »
confirmation Détermine le type de courrier électronique de confirmation qui sera envoyé à l’utilisateur nouvellement créé. « inviter »
« inscription »
Messagerie électronique Adresse courriel. Ne doit pas être vide et doit être unique dans l’instance de service. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 254
firstName Prénom. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 100
Identités Collection d’identités utilisateur. UserIdentityContract[]
lastName Nom. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 100
note Remarque facultative sur un utilisateur défini par l’administrateur. corde
mot de passe Mot de passe de l’utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré. corde
état État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif. « actif »
« bloqué »
« supprimé »
« en attente »

UserIdentityContract

Nom Description Valeur
id Valeur d’identificateur au sein du fournisseur. corde
fournisseur Nom du fournisseur d’identité. corde