Service/users Microsoft.ApiManagement 2021-12-01-preview
Définition de ressource Bicep
Le type de ressource service/utilisateurs 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/users, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/users@2021-12-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és
service/users
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 | 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 d’e-mail de confirmation qui sera envoyé à l’utilisateur nouvellement créé. | 'invite' 'inscription' |
Adresse e-mail. Ne doit pas être vide et doit être unique au sein de l’instance de service. | chaîne (obligatoire) | |
firstName | Prénom. | chaîne (obligatoire) |
Identités | Collection d’identités d’utilisateur. | UserIdentityContract[] |
lastName | Nom. | chaîne (obligatoire) |
remarque | Remarque facultative sur un utilisateur définie par l'administrateur. | string |
mot de passe | Mot de passe utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré. | string |
state | É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 ni appeler des API de produits auxquels ils sont abonnés. L’état par défaut est Actif. | 'active' 'bloqué' 'supprimé' 'en attente' |
UserIdentityContract
Nom | Description | Valeur |
---|---|---|
id | Valeur d’identificateur dans le fournisseur. | string |
provider | Nom du fournisseur d’identité. | string |
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/utilisateurs 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/users, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/service/users",
"apiVersion": "2021-12-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és
service/users
Nom | Description | Valeur |
---|---|---|
type | Type de ressource | « Microsoft.ApiManagement/service/users » |
apiVersion | Version de l’API de ressource | « 2021-12-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. |
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. |
properties | 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 d’e-mail de confirmation qui sera envoyé à l’utilisateur nouvellement créé. | 'invite' 'inscription' |
Adresse e-mail. Ne doit pas être vide et doit être unique au sein de l’instance de service. | chaîne (obligatoire) | |
firstName | Prénom. | chaîne (obligatoire) |
Identités | Collection d’identités d’utilisateur. | UserIdentityContract[] |
lastName | Nom. | chaîne (obligatoire) |
remarque | Remarque facultative sur un utilisateur définie par l'administrateur. | string |
mot de passe | Mot de passe utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré. | string |
state | É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 ni appeler des API de produits auxquels ils sont abonnés. L’état par défaut est Actif. | 'active' 'bloqué' 'supprimé' 'en attente' |
UserIdentityContract
Nom | Description | Valeur |
---|---|---|
id | Valeur d’identificateur dans le fournisseur. | string |
provider | Nom du fournisseur d’identité. | string |
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/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 des ressources
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@2021-12-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és
service/users
Nom | Description | Valeur |
---|---|---|
type | Type de ressource | « Microsoft.ApiManagement/service/users@2021-12-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 | 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 de création d’utilisateur. La valeur par défaut est le portail hérité. | « developerPortal » « portal » |
confirmation | Détermine le type d’e-mail de confirmation qui sera envoyé à l’utilisateur nouvellement créé. | « invite » « s’inscrire » |
Adresse e-mail. Ne doit pas être vide et doit être unique au sein de l’instance de service. | string (obligatoire) | |
firstName | Prénom. | string (obligatoire) |
Identités | Collection d’identités utilisateur. | UserIdentityContract[] |
lastName | Nom. | string (obligatoire) |
remarque | Remarque facultative sur un utilisateur définie par l'administrateur. | string |
mot de passe | Mot de passe utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré. | string |
state | É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 ni appeler des API de produits auxquels ils sont abonnés. L’état par défaut est Actif. | « active » « bloqué » « supprimé » « en attente » |
UserIdentityContract
Nom | Description | Valeur |
---|---|---|
id | Valeur d’identificateur dans le fournisseur. | string |
provider | Nom du fournisseur d’identité. | string |