Personnalisation des runbooks

Adaptez les runbooks génériques de RealmJoin aux besoins de vos environnements.

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 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 du portail RealmJoin du client. Par défaut, nous essaierons de proposer des valeurs par défaut pertinentes dans les runbooks proposés sur GitHub.

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 du portail RealmJoin, en remplaçant le comportement par défaut du runbook
• Bloc JSON dans l’en-tête d’un runbook

En outre (avec la priorité la plus faible)

• par paramètre dans l’en-tête du runbook
• par paramètre dans le bloc param du runbook (en utilisant le module RJRb Helper)

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 param. Vous pouvez combiner plusieurs types de personnalisation pour obtenir les meilleurs résultats.

Bloc Param du runbook

Le portail RealmJoin analyse le bloc param PowerShell d’un runbook pour déterminer quels champs de saisie afficher. Lorsque c’est possible, il validera également les entrées en fonction du type .NET indiqué pour une variable.

Les types de données suivants sont actuellement reconnus :

• [bool], [booléen] - affichera un interrupteur binaire
• [chaîne] - affichera une zone de texte pour saisir n’importe quelle entrée alphanumérique
• [entier] - affichera une zone de texte n’autorisant que les saisies numériques
• [DateTime], [DateTimeOffset] - affichera un sélecteur de date/heure

Vous pouvez appliquer des 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 exiger que ces paramètres soient renseignés.

Lorsque c’est possible, RealmJoin Portal lira et affichera également dans l’interface utilisateur 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 identifiant d’objet sous forme de chaîne au runbook.

param(
    [ValidateScript( { Use-RJInterface -DisplayName "Attribuer l’appareil à cet utilisateur (facultatif)" -Type Graph -Entity User } )]
    [string] $AssignedUserId = ""
)

Prenons cela morceau par morceau. [ValidateScript...] est un modificateur appliqué au paramètre suivant défini dans le bloc param. Dans ce cas, la variable $AssignedUserId.

Use-RJInterface fait partie de notre RealmJoin Runbook Helper module PowerShell. Il vous permet de spécifier le type d’entrée 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 l’indique -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, les groupes ou les appareils dans l’Entra ID donné.

Le sélecteur inclut une recherche rapide pour identifier facilement la ressource requise.

Exemple de sélecteur

Actuellement, aucune sélection multiple 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 de l’utilisateur, veillez à inclure "name" comme suffixe dans le nom de votre variable. Donc, en gros, 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 pour limiter les objets proposés dans le sélecteur.

L’exemple suivant listera uniquement les groupes d’Entra ID commençant par "LIC_".

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 datastore central. Dans ce cas, faites simplement référence au filtre par nom en utilisant -Filter "ref:LicenseGroup", où ref: indique qu’il faut rechercher un filtre stocké.

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

En-tête du runbook

Le portail peut analyser le aide basée sur les commentaires section, si elle est présente.

Voici un exemple :

<#
  .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, par 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": "Attribuer ou supprimer une licence",
                "SelectSimple": {
                    "Attribuer une licence à l’utilisateur": false,
                    "Supprimer la licence de l’utilisateur": 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 / 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 ni analysé ni rendu. Veuillez utiliser cet espace pour noter les autorisations et exigences de votre runbook.

.EXAMPLE - N’est ni analysé ni rendu. Peut contenir un exemple de personnalisation basée sur JSON à utiliser dans le datastore RealmJoin de votre Tenant. Il peut s’agir d’exemples de création de modèles, par ex. pour différents workflows ou classes d’utilisateurs.

Personnalisation basée sur JSON

Datastore central

Chaque Azure tenant peut héberger un datastore « Runbook Customizations », accessible à l’adresse https://portal.realmjoin.com/settings/runbooks-customizations .

Le format est du JSON avec commentaires, autorisant les virgules terminales. Actuellement, il existe trois sections pertinentes, Paramètres, Modèles, Runbooks.

{
    "Settings": {
    },
    "Templates": {
    },
    "Runbooks": {
    }
}

Section des runbooks

Runbooks est analysée par le portail lors du démarrage d’un runbook. Si une section portant le même nom que le runbook Azure Automation actuel existe, son contenu sera utilisé pour personnaliser l’interface affichée à l’utilisateur.

Prenons comme exemple le runbook de démonstration simple suivant, appelé rjgit-device_demo-runbook-customizing.

<#
  .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
}

Si elle n’est pas personnalisée, elle sera présentée ainsi dans le frontend :

Démo - avant

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 « Extra Workflow » ? Dois-je penser au « Extra Workflow Time » si je désactive « Extra Workflow » ?

Améliorons cela. L’exemple de JSON suivant dans le datastore central modifiera l’interface utilisateur du runbook.

{
    "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 votre en-tête de runbook.

ParameterList

Chaque paramètre a sa propre section dans ParameterList. Modificateurs permettent de modifier le comportement de ce paramètre.

Le résultat ressemblera à ceci :

Démo - après masquage

Le choix du workflow supplémentaire affichera (fera réapparaître) davantage de paramètres :

Démo - après réaffichage

Cela montre moins d’encombrement qu’avant l’application de la personnalisation. En même temps, davantage d’informations sur les alternatives de « Extra Workflow » sont disponibles pour l’utilisateur. De plus, l’utilisateur ne se souciera désormais du « Extra Workflow Time » 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 ne pouvez actuellement avoir 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 DisplayName. Nous avons proposé un DisplayName pour remplacer $ExtraWorkflowTime dans l’interface utilisateur. Voir les autres modificateurs pour en savoir plus.

Vous pouvez insérer des paramètres « sans nom » (sans la Nom instruction) comme la section « Execute Extra Workflow », si vous souhaitez proposer des éléments d’interface utilisateur sans renvoyer directement de 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 une Masquer ou un Défaut valeur sur d’autres paramètres. Dans notre exemple, nous l’avons utilisé pour (dé)masquer $ExtraWorkflowTime et remplacer $ExtraWorkflowla valeur de

$ExtraWorkflowTime est ainsi affiché uniquement lorsque cela est pertinent et l’interrupteur binaire $ExtraWorkflow est désormais remplacé par des alternatives significatives du point de vue de l’utilisateur.

Dans le cas d’un Sélectionnez pour un paramètre nommé, chaque option doit avoir un "ParameterValue": "..." à transmettre au runbook. Vous pouvez placer un "ShowValue: false" dans le Sélectionnez bloc pour n’afficher que la liste déroulante et pas de champ pour la valeur résultante du paramètre.

Exemple de paramètre nommé :

{
    "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
    }
}

Le Défaut / DefaultValue L’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.

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 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 des paramètres nommés.

Exemple :

{
    "Runbooks": {
        "rjgit-device_demo-runbook-customizing": {
            "Parameters": {
                "DeviceId": {
                    "Hide": true
                }, 
                "ExtraWorkflow": {
                    "Name": "ExtraWorkflow",
                    "DisplayName": "Exécuter le workflow supplémentaire",
                    "Default": false,
                    "SelectSimple": {
                        "Exécuter la méditation (facultatif)": true,
                        "Ignorer la pleine conscience de l’appareil": false
                    }
                },
                "ExtraWorkflowTime": {
                    "DisplayName": "Combien de temps méditer ?"
                }
            }
        }
    }
}

La plus grande différence avec notre exemple précédent (en plus d’être beaucoup plus court) 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 - 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 également utiliser Défaut à la place.)
• "GraphFilter": "startswith(DisplayName, 'LIC_')" - voir Filtrage Graph
• "AllowEdit": true / false - Protéger ce paramètre de l’édition manuelle. (combinez cela avec des 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 à des valeurs individuelles depuis le bloc param d’un runbook en utilisant Use-RJInterface.

Prenons cet exemple de bloc param d’un runbook :

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 tentera de préremplir chaque paramètre avec les valeurs du datastore 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 datastore pour ce runbook serait :

{
    "Settings": {
        "CaPoliciesExport": {
            "ResourceGroup": "rj-runbooks-01",
            "StorageAccount": {
                "Name": "rjrbexports01",
                "Location": "West Europe",
                "Sku": "Standard_LRS"
            }
        }
    }
}

L’élément manquant conteneur ne sera tout simplement pas prérempli dans l’interface utilisateur.

Modèles

Modèles utiliser des références JSON pour récupérer 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 le $ref dans le Runbooks section pour référencer/importer une sous-arborescence depuis la Modèles section. Recherchez les mots-clés $id/$values . Soyez conscient 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 la sous-arborescence avec le $id appelé LocationOptions et d’inclure son $values, en remplaçant l’ $ref instruction. Ainsi, le portail affichera une Sélectionnez comme décrit dans la Runbooks section, 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 Personnalisation instruction pour modifier d’autres paramètres comme Adresse postale.

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.

{
    "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": "Somewhere 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

Démo - ref-address

Filtres de graphe

Vous pouvez préparer Filtres de graphe ODATA à utiliser dans plusieurs runbooks. Stockez-les dans une section appelée GraphFilters.

L’exemple suivant filtre pour un certain préfixe dans le DisplayName d’un groupe, afin de n’afficher que les groupes liés à la licence dans un sélecteur de groupes.

"GraphFilters": {
    "LicenseGroup": "startswith(DisplayName, 'LIC_')" // également inclus dans le code RJ par défaut
  }

Voir Filtrage du graphe sur la manière de l’utiliser depuis un runbook.