> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/fr/automatisation/runbooks/runbook-customization.md). # Personnalisation du runbook ## Aperçu 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 inutiles
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 montrant comment configurer des modèles spécifiques au client, comme la définition des emplacements de bureau pour l’intégration des utilisateurs. ### Format 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), en remplaçant le comportement par défaut du runbook * Bloc JSON dans l’en-tête d’un runbook En outre (avec la plus faible priorité) * 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’utilisateurs) ne sont disponibles qu’en spécifiant un type de données dans le bloc de paramètres. Vous pouvez combiner plusieurs types de personnalisation pour obtenir les meilleurs résultats. ## Bloc de paramètres du runbook RealmJoin Portal analyse le bloc de paramètres PowerShell d’un runbook afin de déterminer quels champs de saisie afficher. Lorsque c’est possible, il validera également les entrées selon le type .NET donné pour une variable. Les types de données suivants sont actuellement reconnus : * `[bool]`, `[boolean]` - affichera une bascule 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 standard 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 les valeurs par défaut données dans l’interface utilisateur. Sachez que 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’utilisateurs, permettant de choisir un utilisateur Entra ID et transmettra son identifiant d’objet sous forme de chaîne au runbook. ```powershell param( [ValidateScript( { Use-RJInterface -DisplayName "Affecter cet appareil à cet utilisateur (facultatif)" -Type Graph -Entity User } )] [string] $AssignedUserId = "" ) ``` Découpons cela pas à pas. `[ValidateScript...]` est un modificateur du paramètre suivant défini dans le bloc param. Dans ce cas, la variable `$AssignedUserId`. `Use-RJInterface` fait partie de notre [RealmJoin Runbook Helper](https://github.com/realmjoin/RealmJoin.RunbookHelper) module PowerShell. Il vous permet de spécifier le type d’entrée attendu à l’aide de `-Type` et `-Entity`, si cela n’est pas déjà entièrement défini par le type de variable. `-DisplayName` vous permet de fournir à 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 décrit par `-Type Graph`. Pour MS Graph, utilisez `-Entity` pour spécifier quel type de ressource vous attendez. Les entités disponibles sont `User`, `Group`, `Device`. Cela produira un sélecteur pour les utilisateurs, les groupes ou les appareils dans le Entra ID donné. Le sélecteur inclut une recherche rapide, afin d’identifier facilement la ressource requise. ![Exemple de sélecteur](/files/5a3a3234a99853f7ceb7ac920fb5dcb5c6d01c33) Actuellement, aucune sélection multiple n’est possible avec un sélecteur. Par défaut, un sélecteur MS Graph renverra l’identifiant de l’objet. Si vous avez besoin par exemple du nom principal de l’utilisateur à la place, veillez à inclure "name" comme suffixe dans le nom de votre variable. Donc, en gros, pour obtenir l’identifiant 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 n’affichera que les groupes d’Entra ID commençant par "LIC\_". ```powershell param( [Parameter(Mandatory = $true)] [ValidateScript( { Use-RJInterface -Type Graph -Entity Group -Filter "startswith(DisplayName, 'LIC_')" -DisplayName "Groupe de licences" } )] [String] $GroupID_License ) ``` Vous pouvez préparer des filtres et les réutiliser dans plusieurs scripts à l’aide du [magasin de données central](#graph-filters). Dans ce cas, référencez simplement le filtre par son nom à l’aide de `-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 précis `ref:LicenseGroup` est disponible par défaut sans configuration supplémentaire. ![filtre ODATA](/files/bcff9526e60d459a63630fbb24f7eef0c70827f4) ## En-tête du runbook Le portail peut analyser la section [d’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 (Dés)attribuer une licence à un utilisateur via l’appartenance à un groupe. .DESCRIPTION (Dés)attribuer 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. p. 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": "Affecter ou supprimer une licence", "SelectSimple": { "Assign License to User": false, "Remove License from User": true } } } } #> ``` `.SYNOPSIS` - Donnez une description très brève 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étrage des runbooks. `.PARAMETER` - Doit être suivi du nom d’un paramètre. Permet de fournir une explication détaillée de l’entrée attendue pour le paramètre concerné. `.INPUTS` - Peut contenir un bloc de personnalisation de runbook basé sur JSON. `.NOTES` - N’est pas analysé / affiché. Veuillez utiliser cet espace pour noter les autorisations et les exigences qui 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. Il peut s’agir d’exemples de création de 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", accessible à . Le format est du JSON avec commentaires, autorisant les virgules finales. Actuellement, trois sections sont 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 simple runbook de démonstration suivant, appelé `rjgit-device_demo-runbook-customizing`. ```powershell <# .SYNOPSIS Démontrer la personnalisation de runbook .DESCRIPTION Démontrer la personnalisation de 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 ) "## Traitement de l’appareil '$DeviceID'" # Workflow compliqué hautement facultatif if ($ExtraWorkflow) { "## Exécution de la méditation..." Start-Sleep -Seconds $ExtraWorkflowTime } ``` S’il n’est pas personnalisé, il sera présenté ainsi dans le frontend : ![Démo - avant](/files/cdb573623597d7e760cbfbf1d2fa5ddd578773dd) 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 "Workflow supplémentaire" ? Dois-je me préoccuper du "Temps du workflow supplémentaire" si je désactive le "Workflow supplémentaire" ? Améliorons cela. L’exemple JSON 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 workflow 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 l’ [en-tête du runbook](#runbook-header). #### ParameterList Chaque paramètre a sa propre section dans `ParameterList`. [Modificateurs](#modifiers) permettent de modifier le comportement de ce paramètre. Le résultat ressemblera à ceci : ![Démo - après masquage](/files/b30764968714e87b81d08b86a13f13945c82cdae) Le choix du workflow supplémentaire affichera (dévoilera) plus de paramètres : ![Démo - après dévoilement](/files/8a5383b94f7f4eb54256ee7a7735fb18d4cd18bd) Cela montre moins d’encombrement par rapport à avant l’application de la personnalisation. En même temps, davantage d’informations sur les alternatives au "Workflow supplémentaire" sont disponibles pour l’utilisateur. De plus, l’utilisateur ne se souciera désormais du "Temps du workflow supplémentaire" que si cela est pertinent. La modification de la visibilité de ce champ a été effectuée à l’aide d’un `"Customization"` bloc à l’intérieur de l’une des `"Select"` options. Vous pouvez actuellement n’avoir au maximum qu’un seul tel `"Customization"` bloc actif à la fois. Comme vous pouvez le voir, le paramètre `$DeviceId` est complètement masqué. Cela se fait en définissant le `"Hide": true` pour ce paramètre. Les paramètres peuvent avoir un `Nom d’affichage`. Nous avons proposé un libellé lisible par l’humain `Nom d’affichage` pour remplacer `$ExtraWorkflowTime` dans l’interface utilisateur. Voir les autres [modificateurs](#modifiers) pour en savoir plus. Vous pouvez insérer des paramètres "sans nom" (en omettant le `Name` déclaration) comme la section "Exécuter le workflow supplémentaire", si vous souhaitez proposer des éléments d’interface utilisateur sans renvoyer directement une valeur. Cela n’est normalement utilisé qu’en combinaison avec `Select`. #### Select Nous avons utilisé `Select`, pour afficher une liste de `Options` dans une liste déroulante. Chaque option peut `Afficher` du texte, ou déclencher une `Customization`, comme la définition de `Hide` ou d’une `Par défaut` valeur sur d’autres paramètres. Dans notre exemple, nous l’avons utilisé pour (dé)masquer `$ExtraWorkflowTime` et remplacer `$ExtraWorkflow`sa valeur. `$ExtraWorkflowTime` est ainsi affiché uniquement 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 `Select` pour un paramètre nommé, chaque option doit avoir un `"ParameterValue": "..."` à transmettre au runbook. Vous pouvez placer un `"ShowValue: false"` à l’intérieur du `Select` 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 workflow 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 } } ``` Les `Par défaut` / `DefaultValue` déclaration 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 `Nom d’affichage` 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 `Paramètres` à la place de `ParameterList`. Pour un exemple, voir SelectSimple #### SelectSimple Si toute la puissance d’un `Select` 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` ne peut être utilisé qu’avec des paramètres nommés. Exemple : ```json { "Runbooks": { "rjgit-device_demo-runbook-customizing": { "Parameters": { "DeviceId": { "Hide": true }, "ExtraWorkflow": { "Name": "ExtraWorkflow", "DisplayName": "Exécuter le workflow 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 (outre le fait 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": "text"` - Afficher "text" comme nom du paramètre dans l’interface utilisateur * `"Hide": true / false` - Masquer ce paramètre * `"Mandatory": true / false` - Exiger que ce paramètre soit renseigné * `"ReadOnly": true / false` - Protéger ce paramètre contre toute modification par rapport à sa valeur par défaut * `"DefaultValue": "..."` - Définir une valeur par défaut pour ce paramètre. (Vous pouvez aussi utiliser `Par défaut` à la place.) * `"GraphFilter": "startswith(DisplayName, 'LIC_')"` - voir [Filtrage Graph](#graph-filtering) * `"AllowEdit": true / false` - Protéger ce paramètre contre la modification manuelle. (à 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 en un emplacement central, tout en les gardant séparées de vos runbooks. Vous pouvez accéder à des 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 utilisateur. Un JSON possible dans le magasin de données pour ce runbook serait : ```json { "Settings": { "CaPoliciesExport": { "ResourceGroup": "rj-runbooks-01", "StorageAccount": { "Name": "rjrbexports01", "Location": "Europe de l’Ouest", "Sku": "Standard_LRS" } } } } ``` L’élément manquant `Container` ne sera tout simplement pas prérempli dans l’interface utilisateur. ### Modèles `Modèles` utiliser des références JSON pour intégrer des données - par exemple une longue liste d’emplacements de bureau - lors de l’utilisation d’une `Select` déclaration. Cela permet de garder une personnalisation neutre/réutilisable/séparée des données réelles. Prenons l’exemple de l’intégration de nouveaux utilisateurs. Vous pourriez avoir plusieurs options données 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 d’une personnalisation de runbook utilise le `$ref` à l’intérieur du `Runbooks` section à partir de laquelle référencer/importer un sous-arbre de la `Modèles` section. Faites attention aux `$id`/`$values` mots-clés. Sachez que `$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 son `$values`, en remplaçant le `$ref` instruction. Ainsi, le portail affichera un `Select` comme décrit dans la `Runbooks` section, mais en incluant 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 `Customization` instruction pour modifier d'autres paramètres comme `StreetAddress`. Ainsi, nous pouvons avoir une personnalisation spécifique au runbook dans `Runbooks` réutilisable dans 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": "Allemagne" } } }, { "Display": "DE-DEG", "Customization": { "Default": { "StreetAddress": "Lateinschulgassse 24-26", "PostalCode": "94469", "City": "Deggendorf", "Country": "Allemagne" } } }, { "Display": "DE-HH", "Customization": { "Default": { "StreetAddress": "Hans-Henny-Jahnn-Weg 53", "PostalCode": "22085", "City": "Hamburg", "Country": "Allemagne" } } }, { "Display": "FI-HS", "Customization": { "Default": { "StreetAddress": "Quelque part 42", "PostalCode": "12345", "City": "Helsinki", "Country": "Finlande" } } } ] }, { "$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 Office", "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 : ![Démo - ref-location](/files/b0f7f9ee7674861e4a7c0404e28e7fda4a8916a2) ![Démo - ref-address](/files/026485322c9b1cc7e200390ae5d0b1c13db13bf9) ### Filtres de graphe Vous pouvez préparer [Filtres de graphe ODATA](https://docs.microsoft.com/en-us/graph/query-parameters?context=graph%2Fapi%2F1.0\&view=graph-rest-1.0#filter-parameter) pour les utiliser dans plusieurs runbooks. Stockez-les dans une section appelée `GraphFilters`. L'exemple suivant filtre un certain préfixe dans le `Nom d’affichage` d'un groupe, afin d'afficher uniquement les groupes liés à la licence dans un sélecteur de groupe. ```json "GraphFilters": { "LicenseGroup": "startswith(DisplayName, 'LIC_')" // également inclus dans le code RJ par défaut } ``` Voir [Filtrage de graphe](#graph-filtering) sur la façon d'utiliser cela depuis un runbook. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://docs.realmjoin.com/fr/automatisation/runbooks/runbook-customization.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.