For the complete documentation index, see llms.txt. This page is also available as Markdown.

Paramètres du rapport Runbook

Configurer les paramètres centralisés de livraison par e-mail et de stockage pour les runbooks de reporting.

Aperçu

Plusieurs runbooks RealmJoin incluent des capacités de reporting automatisé pour fournir des rapports, des notifications et des alertes directement aux administrateurs. Selon la configuration, les rapports peuvent être :

  • envoyés par e-mail — en utilisant l'API Microsoft Graph au nom d'une adresse d'expéditeur configurée

  • téléversés vers un Azure Storage Account — et rendus disponibles sous forme de lien de téléchargement SAS à durée limitée

La prise en charge des deux canaux de livraison est la norme visée pour tous les runbooks de reporting à l'avenir. Tous les runbooks de reporting ne prennent peut-être pas encore en charge les deux canaux, mais l'ensemble des runbooks pris en charge s'agrandit continuellement. Les deux canaux peuvent être activés indépendamment ou en combinaison.

Tous les paramètres partagés sont configurés une seule fois dans le RealmJoin Runbook Customization et s'appliquent automatiquement à tous les runbooks qui utilisent la fonctionnalité correspondante. Les paramètres qui diffèrent selon le runbook (comme le nom du conteneur cible) ne font pas partie de cette configuration centrale et sont définis directement dans le runbook concerné.

Les fonctions qui utilisent ces paramètres — Send-RjRbReportEmail et Publish-RjRbFilesToStorageContainer — sont fournies par le RealmJoin.RunbookHelper module PowerShell. Voir Fonctions de rapport pour une documentation détaillée d'utilisation.

Livraison par e-mail

Prérequis

Nous recommandons d'utiliser une boîte aux lettres partagée dédiée, comme realmjoin-report@contoso.com. Cette boîte aux lettres sera utilisée comme adresse d'expéditeur pour tous les rapports. Vous pouvez utiliser une adresse no-reply, car il n'est pas attendu que les destinataires répondent aux rapports automatisés.

Remarque : L'adresse d'expéditeur doit être une boîte aux lettres d'utilisateur ou partagée — un groupe Microsoft 365 ne peut pas envoyer de courriers via l'API Graph. Les adresses de groupe comme destinataires de rapport destinataires fonctionnent techniquement, mais ne sont pas recommandées : la réception effective de l'e-mail par les membres dépend des paramètres d'abonnement/suivi du groupe, et les échecs de livraison ne sont visibles que sous forme de rapports de non-remise dans la boîte aux lettres de l'expéditeur.

Configuration

Comme décrit en détail dans la Personnalisation basée sur JSON documentation, accédez à RealmJoin Runbook Customization dans le portail RealmJoin (Settings > Runbook Customizations).

Dans le Paramètres bloc, ajoutez ou modifiez la RJReport section pour inclure la EmailSender propriété avec l'adresse e-mail d'expéditeur souhaitée :

Remplacez realmjoin-report@contoso.com par l'adresse réelle de votre boîte aux lettres partagée.

Informations de contact du Service Desk (facultatif)

Cette configuration centrale ne fournit que les valeurs unifiées du Service Desk pour tous les runbooks. L'inclusion effective des informations de contact dans un e-mail de notification est déterminée par le runbook lui-même — seuls les runbooks qui implémentent les paramètres Service Desk correspondants (p. ex. ServiceDeskDisplayName, ServiceDeskPortalUrl) lisent ces valeurs et les affichent dans leurs e-mails.

Pour fournir les informations de contact du Service Desk pour ces runbooks, ajoutez les propriétés suivantes à la RJReport section :

Paramètres :

  • ServiceDesk_DisplayName — Nom d'affichage de votre Service Desk (par ex. « Support informatique », « Service d'assistance »)

  • ServiceDesk_EMail — Adresse e-mail du Service Desk (affichée sous forme de mailto: lien cliquable)

  • ServiceDesk_Phone — Numéro de téléphone du Service Desk au format international (affiché sous forme de tel: lien cliquable)

  • ServiceDesk_PortalUrl — URL de votre portail ou site web du Service Desk (affichée sous forme de lien cliquable)

Tous les paramètres sont facultatifs. S'ils sont configurés, ils apparaîtront dans le pied de page de l'e-mail sous forme de liens cliquables.

Remarque : Certains runbooks acceptent en plus un lien de ticket par exécution (p. ex. ServiceDeskTicketUrl) pour référencer le ticket spécifique qui a déclenché la demande. Il s'agit d'un paramètre du runbook, et non d'une partie de cette configuration centrale.

Branding des e-mails (facultatif)

Les e-mails de rapport peuvent intégrer un branding spécifique au Tenant : les visuels d'en-tête et de pied de page par défaut de RealmJoin peuvent être remplacés par vos propres images, l'image du pied de page peut pointer vers une cible personnalisée — par exemple votre intranet ou portail IT — et les couleurs du modèle peuvent être adaptées à votre charte graphique.

Pour configurer le branding, ajoutez une Branding sous-section au RJReport bloc (imbriquée comme StorageAccount):

Paramètres :

Paramètre
Requis
Défaut
Description

HeaderImageUrl

non

Visuel d'en-tête RealmJoin

URL HTTPS publique d'une image d'en-tête personnalisée qui remplace le visuel d'en-tête RealmJoin par défaut

FooterImageUrl

non

Visuel de pied de page RealmJoin

URL HTTPS publique d'une image de pied de page personnalisée qui remplace le visuel de pied de page RealmJoin par défaut

FooterLink

non

https://www.realmjoin.com

URL vers laquelle pointe l'image de pied de page

AccentColor

non

#f8842c (orange RealmJoin)

Couleur d'accent du modèle d'e-mail : lignes d'en-tête des tableaux, boutons d'action, bordures accentuées des encadrés d'information

TextColor

non

#011e33 (bleu marine RealmJoin)

Couleur de texte principale du modèle d'e-mail : texte principal, titres, éléments de liste, code

Exigences relatives aux images :

  • L'image doit être accessible via une URL HTTPS publique — par exemple un conteneur Azure Blob Storage avec accès en lecture anonyme, un CDN ou le site web de l'entreprise. Une URL contenant un SAS Token fonctionne également et conserve le conteneur privé.

  • Formats pris en charge : PNG, JPEG ou GIF. Le format est détecté à partir de la signature du fichier, et non de l'extension du fichier.

  • Les images sont rendues à 750 px de largeur. Les dimensions recommandées sont 750×200 px (correspondant aux bannières par défaut) ou 1500×400 px pour les écrans haute résolution.

  • Maximum 200 KB par image ; 100 KB ou moins est recommandé. Les images de branding partagent la limite totale de taille de 4 Mo de l'e-mail avec les pièces jointes du rapport (à titre de comparaison, les visuels par défaut de RealmJoin font 52 KB et 15 KB).

Exigences relatives aux couleurs :

  • Les valeurs doivent être des couleurs hexadécimales à 6 chiffres, y compris le signe initial # — par exemple #0052cc. Les formes courtes (#05c) et les noms de couleur (rouge) ne sont pas pris en charge.

  • Les e-mails et leurs pièces jointes sont lus en mode clair et mode sombre : choisissez une couleur de texte qui reste lisible sur une carte de contenu blanche, et une couleur d'accent avec un contraste suffisant avec le texte blanc des boutons.

  • Les couleurs d'état (vert/rouge/ambre pour les états de succès, d'erreur et d'avertissement) et les gris neutres ne sont délibérément pas configurables — elles portent une signification qui ne doit pas changer selon le Tenant.

Les images sont téléchargées et validées par le runbook à chaque exécution. Si un paramètre est laissé vide, le visuel, la couleur et le lien de pied de page par défaut de RealmJoin sont utilisés. Si un téléchargement échoue, qu'une image n'est pas valide ou qu'une couleur n'est pas une valeur hexadécimale valide, un avertissement est consigné et la valeur par défaut correspondante est utilisée à la place — une configuration de branding défectueuse n'empêche jamais l'envoi d'un e-mail de rapport.

Tous les paramètres sont facultatifs et prennent effet pour tous les runbooks qui envoient des e-mails de rapport.

Remarque : Les paramètres de couleur nécessitent RealmJoin.RunbookHelper 0.8.9 ou une version ultérieure dans le compte d'automatisation. Avec des versions plus anciennes du module, les paramètres d'image s'appliquent toujours et les couleurs sont ignorées.

Livraison vers Storage Account

Les runbooks de reporting qui prennent en charge ce canal de livraison peuvent téléverser leur sortie vers un conteneur Azure Blob Storage. Après un téléversement réussi, le runbook renvoie un lien SAS à durée limitée qui peut être utilisé pour télécharger le fichier directement. Ce canal peut être utilisé indépendamment de la livraison par e-mail ou en complément de celle-ci.

Prérequis

Un Azure Storage Account existant est requis. L'identité managée du compte d'automatisation (ou le Service Principal utilisé par les runbooks) nécessite au minimum Storage Blob Data Contributor des autorisations sur le Storage Account ou son groupe de ressources.

Configuration

Accédez à RealmJoin Runbook Customization et ajoutez un StorageAccount sous-section au RJReport bloc :

Paramètres :

Paramètre
Requis
Défaut
Description

ResourceGroup

oui

—

Groupe de ressources qui contient le Storage Account

StorageAccountName

oui

—

Nom du Azure Storage Account

LinkExpiryDays

non

6

Nombre de jours avant l'expiration du lien de téléchargement SAS généré

Remarque : Les paramètres spécifiques à un runbook individuel — comme le nom du conteneur cible ou un nom de blob personnalisé — sont configurés directement sur ce runbook et ne font volontairement pas partie de cette configuration centrale. Il en va de même pour le préfixage du nom de blob : l'ajout ou non d'un préfixe d'horodatage (yyyyMMdd-HHmmss) au nom du blob afin d'éviter les écrasements est contrôlé par le AddBlobNamePrefix paramètre de Publish-RjRbFilesToStorageContainer (par défaut $false), que chaque runbook transmet explicitement.

Exemple combiné

L'extrait suivant montre une RJReport configuration complète avec toutes les fonctionnalités activées :

Mis à jour

Ce contenu vous a-t-il été utile ?