{"id":390359,"date":"2024-12-11T07:39:39","date_gmt":"2024-12-11T07:39:39","guid":{"rendered":"https:\/\/www.ninjaone.com\/?post_type=script_hub&p=390359"},"modified":"2024-12-11T07:39:39","modified_gmt":"2024-12-11T07:39:39","slug":"message-contextuel-image-powershell","status":"publish","type":"script_hub","link":"https:\/\/www.ninjaone.com\/fr\/script-hub\/message-contextuel-image-powershell\/","title":{"rendered":"Cr\u00e9er un message contextuel avec image \u00e0 l’aide de PowerShell pour les notifications Windows\u00a0"},"content":{"rendered":"

Une communication efficace avec les utilisateurs est essentielle pour les professionnels de l’informatique, en particulier dans les environnements de fournisseurs de services g\u00e9r\u00e9s (MSP)<\/a>. Les notifications syst\u00e8me constituent un moyen pratique d’interagir avec les utilisateurs finaux. Ce script PowerShell<\/a> permet aux administrateurs informatiques d’envoyer un message contextuel avec des images optionnelles, proposant ainsi une m\u00e9thode conviviale pour diffuser des mises \u00e0 jour importantes, des rappels ou des alertes. Voici un aper\u00e7u d\u00e9taill\u00e9 de ce script, de ses fonctionnalit\u00e9s et de ses applications potentielles.<\/p>\n

Contexte et importance<\/h2>\n

Les notifications syst\u00e8me servent de ligne de communication directe entre les administrateurs informatiques et les utilisateurs, en particulier dans les environnements o\u00f9 les notifications par e-mail ou par chat risquent d’\u00eatre manqu\u00e9es ou ignor\u00e9es. Ce script se distingue par le fait qu’il ne se contente pas de fournir des notifications toast personnalisables, mais qu’il permet \u00e9galement d’inclure des images, ce qui rend les notifications visuellement attrayantes.<\/p>\n

Les MSP et les services informatiques utilisent souvent des outils de ce type pour am\u00e9liorer la communication avec les utilisateurs, qu’il s’agisse d’annoncer une maintenance programm\u00e9e, d’alerter les utilisateurs en cas de probl\u00e8mes critiques ou de fournir des conseils \u00e9tape par \u00e9tape. En tirant parti du syst\u00e8me de notification natif de Windows\u00a010, ce script s’int\u00e8gre de mani\u00e8re transparente dans le flux de travail de l’utilisateur sans n\u00e9cessiter l’installation de logiciels suppl\u00e9mentaires.<\/p>\n

Le script\u00a0:<\/h2>\n
#Requires -Version 5.1\r\n\r\n<#\r\n.SYNOPSIS\r\n    Sends a toast message\/notification with a hero image to the currently signed in user. Please run as the Current Logged-on User. The script defaults to not using an image if none is provided.\r\n.DESCRIPTION\r\n    Sends a toast message\/notification with a hero image to the currently signed in user. Please run as 'Current Logged on User'.\r\n    This defaults to no image in the Toast Message, but you can specify any png formatted image from a url.\r\n    You can also specify the \"ApplicationId\" to any string.\r\n    The default ApplicationId is your company name found in the NINJA_COMPANY_NAME environment variable, but will fallback to \"NinjaOne RMM\" if it happens to not be set.\r\n\r\n    The URL image should be less than 2MB in size or less than 1MB on a metered connection.\r\n\r\n    By using this script, you indicate your acceptance of the following legal terms as well as our Terms of Use at https:\/\/www.ninjaone.com\/terms-of-use.\r\n    Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms. \r\n    Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party. \r\n    Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library or website belonging to or under the control of any other software provider. \r\n    Warranty Disclaimer: The script is provided \u201cas is\u201d and \u201cas available\u201d, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations. \r\n    Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks. \r\n    Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script. \r\n    EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).\r\n\r\n.EXAMPLE\r\n    -Title \"My Title Here\" -Message \"My Message Here\"\r\n    Sends the title \"My Title Here\" and message \"My Message Here\" as a Toast message\/notification to the currently signed in user.\r\n.EXAMPLE\r\n    -Title \"My Title Here\" -Message \"My Message Here\" -ApplicationId \"MyCompany\"\r\n    Sends the title \"My Title Here\" and message \"My Message Here\" as a Toast message\/notification to the currently signed in user.\r\n        ApplicationId: Creates a registry entry for your toasts called \"MyCompany\".\r\n        PathToImageFile: Downloads a png image for the icon in the toast message\/notification.\r\n.OUTPUTS\r\n    None\r\n.NOTES\r\n    If you want to change the defaults then with in the param block.\r\n    ImagePath uses C:\\Users\\Public\\ as that is accessible by all users.\r\n    If you want to customize the application name to show your company name,\r\n        then look for $ApplicationId and change the content between the double quotes.\r\n\r\n    Minimum OS Architecture Supported: Windows 10 (IoT editions are not supported due to lack of shell)\r\n    Release Notes: Initial Release\r\n#>\r\n\r\n[CmdletBinding()]\r\nparam\r\n(\r\n    [string]$Title,\r\n    [string]$Message,\r\n    [string]$ApplicationId,\r\n    [string]$PathToImageFile\r\n)\r\n\r\nbegin {\r\n    [string]$ImagePath = \"$($env:SystemDrive)\\Users\\Public\\PowerShellToastHeroImage.png\"\r\n\r\n    # Set the default ApplicationId if it's not provided. Use the Company Name if available, otherwise use the default.\r\n    $ApplicationId = if ($env:NINJA_COMPANY_NAME) { $env:NINJA_COMPANY_NAME } else { \"NinjaOne RMM\" }\r\n\r\n    Write-Host \"[Info] Using ApplicationId: $($ApplicationId -replace '\\s+','.')\"\r\n\r\n    if ($env:title -and $env:title -notlike \"null\") { $Title = $env:title }\r\n    if ($env:message -and $env:message -notlike \"null\") { $Message = $env:message }\r\n    if ($env:applicationId -and $env:applicationId -notlike \"null\") { $ApplicationId = $env:applicationId }\r\n    if ($env:pathToImageFile -and $env:pathToImageFile -notlike \"null\") { $PathToImageFile = $env:pathToImageFile }\r\n\r\n    if ([String]::IsNullOrWhiteSpace($Title)) {\r\n        Write-Host \"[Error] A Title is required.\"\r\n        exit 1\r\n    }\r\n    if ([String]::IsNullOrWhiteSpace($Message)) {\r\n        Write-Host \"[Error] A Message is required.\"\r\n        exit 1\r\n    }\r\n\r\n    if ($Title.Length -gt 64) {\r\n        Write-Host \"[Warn] The Title is longer than 64 characters. The title will be truncated by the Windows API to 64 characters.\"\r\n    }\r\n    if ($Message.Length -gt 200) {\r\n        Write-Host \"[Warn] The Message is longer than 200 characters. The message might get truncated by the Windows API.\"\r\n    }\r\n\r\n    function Test-IsSystem {\r\n        $id = [System.Security.Principal.WindowsIdentity]::GetCurrent()\r\n        return $id.Name -like \"NT AUTHORITY*\" -or $id.IsSystem\r\n    }\r\n\r\n    if (Test-IsSystem) {\r\n        Write-Host \"[Error] Please run this script as 'Current Logged on User'.\"\r\n        Exit 1\r\n    }\r\n\r\n    function Set-RegKey {\r\n        param (\r\n            $Path,\r\n            $Name,\r\n            $Value,\r\n            [ValidateSet(\"DWord\", \"QWord\", \"String\", \"ExpandedString\", \"Binary\", \"MultiString\", \"Unknown\")]\r\n            $PropertyType = \"DWord\"\r\n        )\r\n        if (-not $(Test-Path -Path $Path)) {\r\n            # Check if path does not exist and create the path\r\n            New-Item -Path $Path -Force | Out-Null\r\n        }\r\n        if ((Get-ItemProperty -Path $Path -Name $Name -ErrorAction Ignore)) {\r\n            # Update property and print out what it was changed from and changed to\r\n            $CurrentValue = (Get-ItemProperty -Path $Path -Name $Name -ErrorAction Ignore).$Name\r\n            try {\r\n                Set-ItemProperty -Path $Path -Name $Name -Value $Value -Force -Confirm:$false -ErrorAction Stop | Out-Null\r\n            }\r\n            catch {\r\n                Write-Host \"[Error] Unable to Set registry key for $Name please see below error!\"\r\n                Write-Host \"$($_.Exception.Message)\"\r\n                exit 1\r\n            }\r\n            Write-Host \"[Info] $Path\\$Name changed from:\"\r\n            Write-Host \" $CurrentValue to:\"\r\n            Write-Host \" $($(Get-ItemProperty -Path $Path -Name $Name -ErrorAction Ignore).$Name)\"\r\n        }\r\n        else {\r\n            # Create property with value\r\n            try {\r\n                New-ItemProperty -Path $Path -Name $Name -Value $Value -PropertyType $PropertyType -Force -Confirm:$false -ErrorAction Stop | Out-Null\r\n            }\r\n            catch {\r\n                Write-Host \"[Error] Unable to Set registry key for $Name please see below error!\"\r\n                Write-Host \"$($_.Exception.Message)\"\r\n                exit 1\r\n            }\r\n            Write-Host \"[Info] Set $Path\\$Name to:\"\r\n            Write-Host \" $($(Get-ItemProperty -Path $Path -Name $Name -ErrorAction Ignore).$Name)\"\r\n        }\r\n    }\r\n\r\n    # Utility function for downloading files.\r\n    function Invoke-Download {\r\n        param(\r\n            [Parameter()]\r\n            [String]$URL,\r\n            [Parameter()]\r\n            [String]$Path,\r\n            [Parameter()]\r\n            [int]$Attempts = 3,\r\n            [Parameter()]\r\n            [Switch]$SkipSleep\r\n        )\r\n        Write-Host \"[Info] Used $PathToImageFile for the image and saving to $ImagePath\"\r\n    \r\n        $SupportedTLSversions = [enum]::GetValues('Net.SecurityProtocolType')\r\n        if ( ($SupportedTLSversions -contains 'Tls13') -and ($SupportedTLSversions -contains 'Tls12') ) {\r\n            [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol::Tls13 -bor [System.Net.SecurityProtocolType]::Tls12\r\n        }\r\n        elseif ( $SupportedTLSversions -contains 'Tls12' ) {\r\n            [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12\r\n        }\r\n        else {\r\n            # Not everything requires TLS 1.2, but we'll try anyways.\r\n            Write-Host \"[Warn] TLS 1.2 and or TLS 1.3 isn't supported on this system. This download may fail!\"\r\n            if ($PSVersionTable.PSVersion.Major -lt 3) {\r\n                Write-Host \"[Warn] PowerShell 2 \/ .NET 2.0 doesn't support TLS 1.2.\"\r\n            }\r\n        }\r\n    \r\n        $i = 1\r\n        While ($i -le $Attempts) {\r\n            # Some cloud services have rate-limiting\r\n            if (-not ($SkipSleep)) {\r\n                $SleepTime = Get-Random -Minimum 1 -Maximum 7\r\n                Write-Host \"[Info] Waiting for $SleepTime seconds.\"\r\n                Start-Sleep -Seconds $SleepTime\r\n            }\r\n            if ($i -ne 1) { Write-Host \"\" }\r\n            Write-Host \"[Info] Download Attempt $i\"\r\n    \r\n            $PreviousProgressPreference = $ProgressPreference\r\n            $ProgressPreference = 'SilentlyContinue'\r\n            try {\r\n                # Invoke-WebRequest is preferred because it supports links that redirect, e.g., https:\/\/t.ly\r\n                # Standard options\r\n                $WebRequestArgs = @{\r\n                    Uri                = $URL\r\n                    MaximumRedirection = 10\r\n                    UseBasicParsing    = $true\r\n                    OutFile            = $Path\r\n                }\r\n    \r\n                # Download The File\r\n                Invoke-WebRequest @WebRequestArgs\r\n    \r\n                $ProgressPreference = $PreviousProgressPreference\r\n                $File = Test-Path -Path $Path -ErrorAction SilentlyContinue\r\n            }\r\n            catch {\r\n                Write-Host \"[Error] An error has occurred while downloading!\"\r\n                Write-Warning $_.Exception.Message\r\n    \r\n                if (Test-Path -Path $Path -ErrorAction SilentlyContinue) {\r\n                    Remove-Item $Path -Force -Confirm:$false -ErrorAction SilentlyContinue\r\n                }\r\n    \r\n                $File = $False\r\n            }\r\n    \r\n            if ($File) {\r\n                $i = $Attempts\r\n            }\r\n            else {\r\n                Write-Host \"[Error] File failed to download.\"\r\n                Write-Host \"\"\r\n            }\r\n    \r\n            $i++\r\n        }\r\n    \r\n        if (-not (Test-Path $Path)) {\r\n            Write-Host \"[Error] Failed to download file!\"\r\n            exit 1\r\n        }\r\n        else {\r\n            return $Path\r\n        }\r\n    }\r\n\r\n    function Show-Notification {\r\n        [CmdletBinding()]\r\n        Param (\r\n            [string]\r\n            $ApplicationId,\r\n            [string]\r\n            $ToastTitle,\r\n            [string]\r\n            [Parameter(ValueFromPipeline)]\r\n            $ToastText\r\n        )\r\n\r\n        # Import all the needed libraries\r\n        [Windows.UI.Notifications.ToastNotificationManager, Windows.UI.Notifications, ContentType = WindowsRuntime] > $null\r\n        [Windows.UI.Notifications.ToastNotification, Windows.UI.Notifications, ContentType = WindowsRuntime] > $null\r\n        [Windows.System.User, Windows.System, ContentType = WindowsRuntime] > $null\r\n        [Windows.System.UserType, Windows.System, ContentType = WindowsRuntime] > $null\r\n        [Windows.System.UserAuthenticationStatus, Windows.System, ContentType = WindowsRuntime] > $null\r\n        [Windows.Storage.ApplicationData, Windows.Storage, ContentType = WindowsRuntime] > $null\r\n\r\n        # Make sure that we can use the toast manager, also checks if the service is running and responding\r\n        try {\r\n            $ToastNotifier = [Windows.UI.Notifications.ToastNotificationManager]::CreateToastNotifier(\"$ApplicationId\")\r\n        }\r\n        catch {\r\n            Write-Host \"$($_.Exception.Message)\"\r\n            Write-Host \"[Error] Failed to create notification.\"\r\n        }\r\n\r\n        # Create a new toast notification\r\n        $RawXml = [xml] @\"\r\n<toast>\r\n    <visual>\r\n    <binding template='ToastGeneric'>\r\n        <text id='1'>$ToastTitle<\/text>\r\n        <text id='2'>$ToastText<\/text>\r\n        $(if($PathToImageFile){\"<image placement='hero' src='$ImagePath' \/>\"})\r\n    <\/binding>\r\n    <\/visual>\r\n<\/toast>\r\n\"@\r\n\r\n        # Serialized Xml for later consumption\r\n        $SerializedXml = New-Object Windows.Data.Xml.Dom.XmlDocument\r\n        $SerializedXml.LoadXml($RawXml.OuterXml)\r\n\r\n        # Setup how are toast will act, such as expiration time\r\n        $Toast = $null\r\n        $Toast = [Windows.UI.Notifications.ToastNotification]::new($SerializedXml)\r\n        $Toast.Tag = \"PowerShell\"\r\n        $Toast.Group = \"PowerShell\"\r\n        $Toast.ExpirationTime = [DateTimeOffset]::Now.AddMinutes(1)\r\n\r\n        # Show our message to the user\r\n        $ToastNotifier.Show($Toast)\r\n    }\r\n}\r\nprocess {\r\n    Write-Host \"ApplicationID: $ApplicationId\"\r\n\r\n    if (-not $(Split-Path -Path $ImagePath -Parent | Test-Path -ErrorAction SilentlyContinue)) {\r\n        try {\r\n            New-Item \"$(Split-Path -Path $ImagePath -Parent)\" -ItemType Directory -ErrorAction Stop\r\n            Write-Host \"[Info] Created folder: $(Split-Path -Path $ImagePath -Parent)\"\r\n        }\r\n        catch {\r\n            Write-Host \"[Error] Failed to create folder: $(Split-Path -Path $ImagePath -Parent)\"\r\n            exit 1\r\n        }\r\n    }\r\n\r\n    $DownloadArguments = @{\r\n        URL  = $PathToImageFile\r\n        Path = $ImagePath\r\n    }\r\n\r\n    Set-RegKey -Path \"HKCU:\\SOFTWARE\\Classes\\AppUserModelId\\$($ApplicationId -replace '\\s+','.')\" -Name \"DisplayName\" -Value $ApplicationId -PropertyType String\r\n    if ($PathToImageFile -like \"http*\") {\r\n        Invoke-Download @DownloadArguments\r\n    }\r\n    elseif ($PathToImageFile -match \"^[a-zA-Z]:\\\\\" -and $(Test-Path -Path $PathToImageFile -ErrorAction SilentlyContinue)) {\r\n        Write-Host \"[Info] Image is a local file, copying to $ImagePath\"\r\n        try {\r\n            Copy-Item -Path $PathToImageFile -Destination $ImagePath -Force -ErrorAction Stop\r\n            Set-RegKey -Path \"HKCU:\\SOFTWARE\\Classes\\AppUserModelId\\$($ApplicationId -replace '\\s+','.')\" -Name \"IconUri\" -Value \"$ImagePath\" -PropertyType String\r\n            Write-Host \"[Info] System is ready to send Toast Messages to the currently logged on user.\"\r\n        }\r\n        catch {\r\n            Write-Host \"[Error] Failed to copy image file: $PathToImageFile\"\r\n            exit 1\r\n        }\r\n    }\r\n    elseif ($PathToImageFile -match \"^[a-zA-Z]:\\\\\" -and -not $(Test-Path -Path $PathToImageFile -ErrorAction SilentlyContinue)) {\r\n        Write-Host \"[Error] Image does not exist at $PathToImageFile\"\r\n        exit 1\r\n    }\r\n    else {\r\n        if ($PathToImageFile) {\r\n            Write-Host \"[Warn] Provided image is not a local file or a valid URL.\"\r\n        }\r\n        Write-Host \"[Info] No image will be used.\"\r\n    }\r\n\r\n    try {\r\n        Write-Host \"[Info] Attempting to send message to user...\"\r\n        $NotificationParams = @{\r\n            ToastTitle    = $Title\r\n            ToastText     = $Message\r\n            ApplicationId = \"$($ApplicationId -replace '\\s+','.')\"\r\n        }\r\n        Show-Notification @NotificationParams -ErrorAction Stop\r\n        Write-Host \"[Info] Message sent to user.\"\r\n    }\r\n    catch {\r\n        Write-Host \"[Error] Failed to send message to user.\"\r\n        Write-Host \"$($_.Exception.Message)\"\r\n        exit 1\r\n    }\r\n    exit 0\r\n}\r\nend {\r\n    \r\n    \r\n    \r\n}<\/pre>\n
 <\/p>\n\n
Gagnez du temps gr\u00e2ce \u00e0 plus de 300 scripts du Dojo NinjaOne.<\/p>\n
\u2192 Obtenir l’acc\u00e8s<\/a><\/p>\n<\/div>\n
Description d\u00e9taill\u00e9e du script<\/h2>\n
Ce script PowerShell est con\u00e7u pour \u00eatre ex\u00e9cut\u00e9 par l’utilisateur actuellement connect\u00e9. Voici une explication \u00e9tape par \u00e9tape de son d\u00e9roulement\u00a0:<\/p>\n
1. Param\u00e8tres et r\u00e9glages par d\u00e9faut<\/h3>\n
a. Le script accepte des param\u00e8tres pour le titre, le message, l’ID de l’application et un chemin d’acc\u00e8s facultatif \u00e0 un fichier image.<\/p>\n
b. Si l’ID de l’application n’est pas sp\u00e9cifi\u00e9, le script prend par d\u00e9faut le nom de la soci\u00e9t\u00e9 stock\u00e9 dans la variable d’environnement NINJA_COMPANY_NAME ou revient \u00e0 \u00ab\u00a0NinjaOne RMM.\u00a0\u00bb<\/p>\n
c. Si aucune image n’est fournie, la notification s’affichera sans image.<\/p>\n
2. Validation de l’environnement<\/h3>\n
a. Le script v\u00e9rifie s’il est ex\u00e9cut\u00e9 en tant qu’utilisateur connect\u00e9. Si ce n’est pas le cas, il se termine avec une erreur.<\/p>\n
3. Gestion du registre<\/h3>\n
a. Le script utilise une fonction d’aide pour cr\u00e9er ou mettre \u00e0 jour les cl\u00e9s de registre pour le nom d’affichage de l’application et l’ic\u00f4ne optionnelle. Cela permet de garantir une attribution et une personnalisation correctes pour les notifications.<\/p>\n
4. Traitement des images<\/h3>\n
a. Le script peut t\u00e9l\u00e9charger une image \u00e0 partir d’une URL ou utiliser un fichier local. Il garantit que l’image est sauvegard\u00e9e dans un dossier public pour en faciliter l’acc\u00e8s.<\/p>\n
b. Si aucune image valide n’est fournie, le script se poursuit sans image.<\/p>\n
5. Cr\u00e9ation d’une notification<\/h3>\n
a. En utilisant les API de Windows, le script construit et affiche une notification toast.<\/p>\n
b. La notification comprend le titre et le message sp\u00e9cifi\u00e9s et inclut l’image si elle est fournie.<\/p>\n
6. Gestion des erreurs<\/h3>\n
a. Le script comporte une gestion efficace des erreurs, y compris des avertissements pour les configurations non prises en charge, les \u00e9checs de t\u00e9l\u00e9chargement et les param\u00e8tres manquants.<\/p>\n
Cas d’utilisation potentiels<\/h2>\n
\u00c9tude de cas\u00a0: Annonce de maintenance informatique<\/h3>\n
Un administrateur informatique g\u00e9rant un r\u00e9seau d’entreprise doit informer les utilisateurs de la maintenance pr\u00e9vue. \u00c0 l’aide de ce script, l’administrateur envoie une notification toast avec les d\u00e9tails suivants\u00a0:<\/p>\n