# Personnalisation des runbooks
## Overview
L’implémentation du runbook RealmJoin offre des capacités de personnalisation à l’auteur d’un runbook ou à l’administrateur d’un environnement, afin qu’ils puissent :
* Héberger des paramètres et des modèles spécifiques au client/tenant
* Proposer des éléments d’interface utilisateur comme des sélecteurs d’utilisateurs ou des listes déroulantes
* Présenter des explications lisibles par l’humain des paramètres
* Masquer les éléments d’interface utilisateur non nécessaires
Les personnalisations peuvent être incluses dans le runbook lui-même et/ou stockées dans l’instance RealmJoin Portal du client. Par défaut, nous essaierons de proposer des valeurs par défaut pertinentes dans les runbooks proposés sur [GitHub](https://github.com/realmjoin/realmjoin-runbooks).
Certains runbooks seront accompagnés d’exemples expliquant comment configurer des modèles spécifiques au client, comme la spécification des emplacements de bureau pour l’intégration des utilisateurs.
### Formater
La personnalisation peut être définie (par ordre décroissant de priorité)
* Bloc JSON dans [les paramètres de RealmJoin Portal](https://portal.realmjoin.com/settings/runbooks-customizations), remplaçant le comportement par défaut du runbook
* Bloc JSON dans l’en-tête d’un runbook
En plus (avec la priorité la plus faible)
* par paramètre dans l’en-tête du runbook
* par paramètre dans le bloc de paramètres du runbook (en utilisant le module d’aide RJRb)
Certaines fonctionnalités (comme les modèles) ne sont disponibles qu’au format JSON. Certaines fonctionnalités (comme la création d’un sélecteur d’utilisateur) ne sont disponibles qu’en spécifiant un type de données dans le bloc de paramètres. Vous pouvez combiner plusieurs types de personnalisations pour de meilleurs résultats.
## Bloc de paramètres du runbook
RealmJoin Portal analyse le bloc param de PowerShell d’un runbook afin de déterminer quels champs de saisie afficher. Lorsque c’est possible, il validera également les entrées en fonction du type .NET donné pour une variable.
Les types de données suivants sont actuellement pris en charge :
* `[bool]`, `[boolean]` - affichera un interrupteur binaire
* `[string]` - affichera une zone de texte permettant de saisir toute entrée alphanumérique
* `[int]` - affichera une zone de texte, n’autorisant que les saisies numériques
* `[DateTime]`, `[DateTimeOffset]` - affichera un sélecteur de date/heure
Vous pouvez appliquer les modificateurs PowerShell standards aux paramètres. RealmJoin Portal, en particulier, comprendra si vous spécifiez `[Parameter(Mandatory = $true)]` pour indiquer un paramètre obligatoire et imposer que ces paramètres soient renseignés.
Lorsque c’est possible, RealmJoin Portal lira également et affichera dans l’interface les valeurs par défaut fournies.
Attention, les valeurs par défaut du runbook peuvent être remplacées par des personnalisations. De plus, les paramètres peuvent être complètement masqués par des personnalisations.
### Personnalisation des paramètres
Pour pouvoir personnaliser les paramètres, veuillez vous assurer d’inclure le module PS Runbook Helper de RealmJoin dans votre runbook :
`#Requires -Modules @{ModuleName = "RealmJoin.RunbookHelper"; ModuleVersion = "0.6.0" }`
Vous pouvez ensuite inclure `[ValidateScript( { Use-RJInterface ... } )]` des instructions dans les définitions de paramètres. Par exemple, ce qui suit créera un sélecteur d’utilisateur, permettant de choisir un utilisateur Entra ID et transmettra son ID d’objet sous forme de chaîne au runbook.
```powershell
param(
[ValidateScript( { Use-RJInterface -DisplayName "Assign device to this user (optional)" -Type Graph -Entity User } )]
[string] $AssignedUserId = ""
)
```
Découpons cela morceau par morceau. `[ValidateScript...]` est un modificateur pour le paramètre suivant défini dans le bloc param. Dans ce cas, la variable `$AssignedUserId`.
`Use-RJInterface` fait partie de notre [module PowerShell RealmJoin Runbook Helper](https://github.com/realmjoin/RealmJoin.RunbookHelper) . Il vous permet de spécifier le type de saisie attendu en utilisant `-Type` et `-Entity`si cela n’est pas déjà entièrement défini par le type de la variable.
`-DisplayName` vous permet de transmettre à RealmJoin Portal une invite / description lisible par l’humain pour ce paramètre.
#### Ressources Graph
Dans l’exemple ci-dessus, la source d’information est MS Graph, comme indiqué par `-Type Graph`. Pour MS Graph, utilisez `-Entity` pour spécifier le type de ressource attendu. Les entités disponibles sont `Utilisateurs`, `Groupe`, `Appareil`. Cela produira un sélecteur pour les utilisateurs, groupes ou appareils dans l’Entra ID donné.
Le sélecteur inclut une recherche rapide, pour localiser facilement la ressource requise.
Actuellement, aucun multi-sélection n’est possible à l’aide d’un sélecteur.
Par défaut, un sélecteur MS Graph renverra l’ID de l’objet. Si vous avez besoin, par exemple, du nom principal d’utilisateur à la place, veillez à inclure "name" comme suffixe dans le nom de votre variable. Donc, essentiellement, pour obtenir l’ID d’un utilisateur, nommez le paramètre `$userid`. Si vous voulez un UPN, nommez-le `$username`.
#### Filtrage Graph
Si vous utilisez un sélecteur basé sur MS Graph, vous pouvez également spécifier `-Filter` et utiliser un [filtre ODATA](https://docs.microsoft.com/en-us/graph/query-parameters?context=graph%2Fapi%2F1.0\&view=graph-rest-1.0#filter-parameter) pour limiter les objets proposés dans le sélecteur.
L’exemple suivant ne listera que les groupes de l’Entra ID commençant par "LIC\_".
```powershell
param(
[Parameter(Mandatory = $true)]
[ValidateScript( { Use-RJInterface -Type Graph -Entity Group -Filter "startswith(DisplayName, 'LIC_')" -DisplayName "License group" } )]
[String] $GroupID_License
)
```
Vous pouvez préparer des filtres et les réutiliser dans plusieurs scripts en utilisant le [magasin de données central](#graph-filters). Dans ce cas, référencez simplement le filtre par son nom en utilisant `-Filter "ref:LicenseGroup"`, où `ref:` indique qu’il faut rechercher un filtre stocké.
```powershell
param(
[Parameter(Mandatory = $true)]
[ValidateScript( { Use-RJInterface -Type Graph -Entity Group -Filter "ref:LicenseGroup" } )]
[String] $GroupID_License
)
```
Cet exemple spécifique `ref:LicenseGroup` est disponible par défaut sans configuration supplémentaire.
## En-tête du runbook
Le portail peut analyser la section [aide basée sur les commentaires](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-5.1) d’un runbook, si elle est présente.
Voici un exemple :
```powershell
<#
.SYNOPSIS
Attribuer (ou désattribuer) une licence à un utilisateur via l’appartenance à un groupe.
.DESCRIPTION
Attribuer (ou désattribuer) une licence à un utilisateur via l’appartenance à un groupe. Description plus détaillée...
.PARAMETER DefaultGroups
Liste de groupes séparés par des virgules à attribuer. ex. "DL Sales,LIC Internal Product"
.NOTES
Autorisations :
MS Graph (API) :
- User.Read.All
- GroupMember.ReadWrite.All
- Group.ReadWrite.All
.INPUTS
RunbookCustomization: {
"Parameters" : {
"UserName": {
"Hide": true
},
"Remove": {
"DisplayName": "Assign or Remove License",
"SelectSimple": {
"Assign License to User": false,
"Remove License from User": true
}
}
}
}
#>
```
`.SYNOPSIS` - Donnez une très brève description de la fonction de votre runbook. Elle sera affichée dans la liste des runbooks disponibles.
`.DESCRIPTION` - Donnez une description de la fonction de votre runbook. Peut contenir un peu plus de détails, car elle sera affichée dans la boîte de dialogue d’exécution / de paramètres du runbook.
`.PARAMETER` - Doit être suivi du nom d’un paramètre. Vous permet de donner une explication détaillée de l’entrée attendue pour le paramètre en question.
`.INPUTS` - Peut contenir un bloc de personnalisation de runbook basé sur JSON.
`.NOTES` - N’est pas analysé / affiché. Veuillez utiliser cet espace pour noter quelles autorisations et quelles exigences existent pour votre runbook.
`.EXAMPLE` - N’est pas analysé / affiché. Peut contenir un exemple de personnalisation basée sur JSON à utiliser dans le magasin de données RealmJoin de votre tenant. Cela peut être des exemples montrant comment créer des modèles, par exemple pour différents flux de travail ou classes d’utilisateurs.
## Personnalisation basée sur JSON
### Magasin de données central
Chaque tenant Azure peut héberger un magasin de données "Runbook Customizations", disponible à .
Le format est du JSON avec commentaires, autorisant les virgules finales. Actuellement, il existe trois sections pertinentes, `Paramètres`, `Modèles`, `Runbooks`.
```json
{
"Settings": {
},
"Templates": {
},
"Runbooks" : {
}
}
```
### section Runbooks
`Runbooks` est analysée par le portail au démarrage d’un runbook. Si une section portant le nom du runbook Azure Automation actuel existe, son contenu sera utilisé pour personnaliser l’interface affichée à l’utilisateur.
Supposons le runbook de démonstration simple suivant, appelé `rjgit-device_demo-runbook-customizing`.
```powershell
<#
.SYNOPSIS
Démontrer la personnalisation du runbook
.DESCRIPTION
Démontrer la personnalisation du runbook, comme une liste déroulante/sélection
#>
#Requires -Modules @{ModuleName = "RealmJoin.RunbookHelper"; ModuleVersion = "0.6.0" }
param(
[string] $DeviceId,
[bool] $ExtraWorkflow = $true,
[int] $ExtraWorkflowTime = 15
)
"## Faire des actions sur l’appareil '$DeviceID'"
# Flux de travail très optionnel et complexe
if ($ExtraWorkflow) {
"## Exécution de la méditation..."
Start-Sleep -Seconds $ExtraWorkflowTime
}
```
S’il n’est pas personnalisé, il sera présenté ainsi dans l’interface :
Réflexions :
* Comme ce runbook est lancé depuis le contexte d’un appareil dans le portail, le `$DeviceId` est une information redondante pour un utilisateur. Je sais déjà sur quel appareil je travaille.
* Que se passe-t-il si j’active ou désactive le "Flux de travail supplémentaire" ? Dois-je me préoccuper du "Temps du flux de travail supplémentaire" si je désactive le "Flux de travail supplémentaire" ?
Améliorons cela. Le JSON d’exemple suivant dans le magasin de données central modifiera l’interface utilisateur du runbook.
```json
{
"Runbooks" : {
"rjgit-device_demo-runbook-customizing": {
"ParameterList": [
{
"Name": "DeviceId",
"Hide": true
},
{
"Name": "ExtraWorkflow",
"Hide": true
},
{
"Name": "ExtraWorkflowTime",
"DisplayName": "Combien de temps méditer ?",
},
{
"DisplayName": "Exécuter le flux de travail supplémentaire",
"DisplayBefore": "ExtraWorkflowTime",
"Select": {
"Options": [
{
"Display": "Exécuter la méditation (facultatif)",
"Customization": {
"Default": {
"ExtraWorkflow": true
}
}
},
{
"Display": "Ignorer la pleine conscience de l’appareil",
"Customization": {
"Default": {
"ExtraWorkflow": false
},
"Hide": [
"ExtraWorkflowTime"
]
}
}
],
},
"Default": "Ignorer la pleine conscience de l’appareil"
}
]
}
}
}
```
Vous pouvez utiliser la même notation / les mêmes fonctionnalités dans votre [en-tête du runbook](#runbook-header).
#### ParameterList
Chaque paramètre a sa propre section dans `ParameterList`. [Modificateurs](#modifiers) permet de modifier le comportement de ce paramètre.
Le résultat ressemblera à ceci :
Le choix du flux de travail supplémentaire affichera (fera réapparaître) davantage de paramètres :
Cela montre moins d’encombrement par rapport à avant l’application de la personnalisation. En même temps, davantage d’informations sur les alternatives de "Flux de travail supplémentaire" sont disponibles pour l’utilisateur. De plus, l’utilisateur ne se souciera désormais du "Temps du flux de travail supplémentaire" que si cela est pertinent.
Modifier la visibilité de ce champ a été fait à l’aide d’un `"Customization"` bloc dans l’une des options `"Select"` . Vous pouvez actuellement avoir au maximum un tel `"Customization"` bloc actif à la fois.
Comme vous pouvez le voir, le paramètre `$DeviceId` est complètement masqué. Cela est fait en définissant le `"Hide": true` pour ce paramètre.
Les paramètres peuvent avoir un `DisplayName`. Nous avons proposé un `DisplayName` adapté à l’humain pour remplacer `$ExtraWorkflowTime` dans l’interface. Voir les autres [modificateurs](#modifiers) pour en savoir plus.
Vous pouvez insérer des paramètres "sans nom" (il manque l’instruction `Nom` comme la section "Exécuter le flux de travail supplémentaire", si vous souhaitez proposer des éléments d’interface sans renvoyer directement une valeur. Cela n’est normalement utilisé qu’en combinaison avec `Sélectionnez`.
#### Sélectionnez
Nous avons utilisé `Sélectionnez`, pour afficher une liste de `Options` dans une liste déroulante. Chaque option peut `Affichage` texte, ou déclencher un `Personnalisation`, comme définir `Masquer` ou une `valeur par défaut` sur d’autres paramètres. Dans notre exemple, nous l’avons utilisé pour (dé)masquer `$ExtraWorkflowTime` et remplacer `$ExtraWorkflow`sa valeur.
`$ExtraWorkflowTime` n’est donc affiché que lorsque cela est pertinent et l’interrupteur binaire `$ExtraWorkflow` est désormais remplacé par des alternatives porteuses de sens du point de vue de l’utilisateur.
Dans le cas d’un `Sélectionnez` pour un paramètre nommé, chaque option devrait avoir un `"ParameterValue": "..."` à transmettre au runbook. Vous pouvez placer un `"ShowValue: false"` à l’intérieur du `Sélectionnez` bloc pour n’afficher que la liste déroulante et pas un champ pour la valeur du paramètre résultant.
Exemple de paramètre nommé :
```json
{
"Name": "ExtraWorkflow",
"DefaultValue": true,
"DisplayName": "Exécuter le flux de travail supplémentaire",
"DisplayBefore": "ExtraWorkflowTime",
"Select": {
"Options": [
{
"Display": "Exécuter la méditation (facultatif)",
"ParameterValue": true
},
{
"Display": "Ignorer la pleine conscience de l’appareil",
"ParameterValue": false,
"Customization": {
"Hide": [
"ExtraWorkflowTime"
]
}
}
],
"ShowValue": false
}
}
```
Le `valeur par défaut` / `DefaultValue` instruction dans le paramètre spécifie également l’état initial de la liste déroulante. Dans le cas d’un paramètre sans nom, utilisez le `DisplayName` de l’option souhaitée, sinon donnez une valeur de retour par défaut, comme "true" ou "false" ou une chaîne quelconque.
#### Paramètres
Si vous n’avez que des paramètres nommés, vous pouvez utiliser le format légèrement plus court suivant `Paramètres` à la place de `ParameterList`.
Pour un exemple, voir SelectSimple
#### SelectSimple
Si toute la puissance d’un `Sélectionnez` n’est pas nécessaire et que vous souhaitez simplement proposer une liste de valeurs possibles dans une liste déroulante (sans appliquer de personnalisation supplémentaire), vous pouvez utiliser `SelectSimple`.
`SelectSimple` n’est utilisable que pour les paramètres nommés.
Exemple :
```json
{
"Runbooks" : {
"rjgit-device_demo-runbook-customizing": {
"Parameters" : {
"DeviceId": {
"Hide": true
},
"ExtraWorkflow": {
"Name": "ExtraWorkflow",
"DisplayName": "Exécuter le flux de travail supplémentaire",
"Default": false,
"SelectSimple": {
"Execute Meditation (optional)": true,
"Skip Device Mindfulness": false
}
},
"ExtraWorkflowTime": {
"DisplayName": "Combien de temps méditer ?"
}
}
}
}
}
```
La plus grande différence (en dehors d’être beaucoup plus court) par rapport à notre exemple précédent est que `$ExtraWorkflowTime` est toujours visible.
#### Modificateurs
Chaque paramètre peut avoir un ou plusieurs des modificateurs suivants :
* `"DisplayName": "texte"` - Afficher "texte" comme nom du paramètre dans l’interface
* `"Hide": true / false` - Masquer ce paramètre
* `"Mandatory": true / false` - Exiger que ce paramètre soit renseigné
* `"ReadOnly": true / false` - Empêcher ce paramètre d’être modifié par rapport à sa valeur par défaut
* `"DefaultValue": "..."` - Définir une valeur par défaut pour ce paramètre. (Vous pouvez aussi utiliser `valeur par défaut` à la place.)
* `"GraphFilter": "startswith(DisplayName, 'LIC_')"` - voir [Filtrage Graph](#graph-filtering)
* `"AllowEdit": true / false` - Empêcher la modification manuelle de ce paramètre. (à combiner avec les modèles)
### Paramètres
`Paramètres` vous permet de stocker des données de configuration comme les noms de Storage Account Azure dans un emplacement central, tout en les gardant séparées de vos runbooks.
Vous pouvez accéder aux valeurs individuelles d’un bloc de paramètres de runbook en utilisant `Use-RJInterface`.
Prenons cet exemple de bloc de paramètres d’un runbook :
```powershell
param(
[ValidateScript( { Use-RJInterface -Type Setting -Attribute "CaPoliciesExport.Container" } )]
[string] $ContainerName,
[ValidateScript( { Use-RJInterface -Type Setting -Attribute "CaPoliciesExport.ResourceGroup" } )]
[string] $ResourceGroupName,
[ValidateScript( { Use-RJInterface -Type Setting -Attribute "CaPoliciesExport.StorageAccount.Name" } )]
[string] $StorageAccountName,
[ValidateScript( { Use-RJInterface -Type Setting -Attribute "CaPoliciesExport.StorageAccount.Location" } )]
[string] $StorageAccountLocation,
[ValidateScript( { Use-RJInterface -Type Setting -Attribute "CaPoliciesExport.StorageAccount.Sku" } )]
[string] $StorageAccountSku
)
```
Le portail essaiera de préremplir chaque paramètre avec les valeurs du magasin de données central - si elles sont présentes. Cela fonctionne également si le paramètre a été masqué dans l’interface.
Un JSON possible dans le magasin de données pour ce runbook serait :
```json
{
"Settings": {
"CaPoliciesExport": {
"ResourceGroup": "rj-runbooks-01",
"StorageAccount": {
"Name": "rjrbexports01",
"Location": "West Europe",
"Sku": "Standard_LRS"
}
}
}
}
```
L’élément manquant `Container` ne sera tout simplement pas prérempli dans l’interface.
### Modèles
`Modèles` utilisez des références JSON pour importer des données - par exemple une longue liste d’emplacements de bureau - lors de l’utilisation d’une `Sélectionnez` instruction.
Cela permet de conserver une personnalisation neutre/réutilisable/séparée des données réelles.
Prenons l’exemple de l’intégration de nouveaux utilisateurs. Vous pouvez avoir plusieurs options pour les départements ou les emplacements de bureau, où l’attribution d’un emplacement de bureau impose également une certaine adresse, un pays, un État, etc.
L’exemple suivant de personnalisation de runbook utilise la section `$ref` à l’intérieur du `Runbooks` pour référencer/importer un sous-arbre depuis la section `Modèles` . Recherchez les mots-clés `$id`/`$values` . Attention, `$id`/`$values` doivent être définis avant d’être référencés à l’aide de `$ref`. C’est pourquoi `Modèles` est défini avant `Runbooks` dans cet exemple.
Dans cet exemple, nous indiquons au portail de récupérer le sous-arbre avec le `$id` appelé `LocationOptions` et d’inclure ses `$values`en remplaçant l’instruction `$ref` . Ainsi, le portail rendra un `Sélectionnez` comme décrit dans la section `Runbooks` mais inclura les options réelles de `Modèles`.
Un modèle peut contenir toute instruction prise en charge à l’emplacement de référence. Dans cet exemple, nous utilisons une instruction `Personnalisation` pour modifier d’autres paramètres comme `StreetAddress`.
Ainsi, nous pouvons avoir une personnalisation spécifique au runbook dans `Runbooks` réutilisable sur plusieurs environnements, tout en gardant les données réelles séparées.
```json
{
"Templates": {
"Options": [
{
"$id": "LocationOptions",
"$values": [
{
"Display": "DE-OF",
"Customization": {
"Default": {
"StreetAddress": "Kaiserstraße 39",
"PostalCode": "63065",
"City": "Offenbach",
"Country": "Germany"
}
}
},
{
"Display": "DE-DEG",
"Customization": {
"Default": {
"StreetAddress": "Lateinschulgassse 24-26",
"PostalCode": "94469",
"City": "Deggendorf",
"Country": "Germany"
}
}
},
{
"Display": "DE-HH",
"Customization": {
"Default": {
"StreetAddress": "Hans-Henny-Jahnn-Weg 53",
"PostalCode": "22085",
"City": "Hamburg",
"Country": "Germany"
}
}
},
{
"Display": "FI-HS",
"Customization": {
"Default": {
"StreetAddress": "Somewhere 42",
"PostalCode": "12345",
"City": "Helsinki",
"Country": "Finland"
}
}
}
]
},
{
"$id": "CompanyOptions",
"$values": [
{
"Id": "gkg",
"Display": "glueckkanja",
"Value": "glueckkanja AG"
},
{
"Id": "pp",
"Display": "PRIMEPULSE",
"Value": "PRIMEPULSE SE"
}
]
}
]
},
"Runbooks" : {
"rjgit-org_general_add-user": {
"ParameterList": [
{
"DisplayName": "Emplacement du bureau",
"DisplayAfter": "CompanyName",
"Select": {
"Options": {
"$ref": "LocationOptions"
}
}
},
{
"Name": "CompanyName",
"Select": {
"Options": {
"$ref": "CompanyOptions"
},
"AllowEdit": false
}
}
],
"ReadOnly": [
"StreetAddress",
"PostalCode",
"City",
"Country"
]
}
}
}
```
Cela créera l’interface utilisateur suivante :
### Filtres Graph
Vous pouvez préparer des [filtres ODATA Graph](https://docs.microsoft.com/en-us/graph/query-parameters?context=graph%2Fapi%2F1.0\&view=graph-rest-1.0#filter-parameter) à utiliser dans plusieurs runbooks. Stockez-les dans une section appelée `GraphFilters`.
L’exemple suivant filtre selon un certain préfixe dans le `DisplayName` d’un groupe, afin de n’afficher que les groupes liés aux licences dans un sélecteur de groupe.
```json
"GraphFilters": {
"LicenseGroup": "startswith(DisplayName, 'LIC_')" // également inclus dans le code RJ par défaut
}
```
Voir [filtrage Graph](#graph-filtering) sur la manière d’utiliser cela depuis un runbook.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.realmjoin.com/fr/automatisation/runbooks/runbook-customization.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.