Démarrage rapide : Créer un tableau de bord dans le portail Azure avec PowerShell

Dans le portail Azure, un tableau de bord est une vue ciblée et organisée de vos ressources cloud. Cet article est consacré au processus d’utilisation du module PowerShell Az.Portal pour créer un tableau de bord. Le tableau de bord affiche les performances d’une machine virtuelle que vous créez, ainsi que des liens et des informations statiques.

Un tableau de bord dans le Portail Microsoft Azure est une vue ciblée et organisée de vos ressources cloud. Ce guide de démarrage rapide montre comment utiliser PowerShell Az.Portal pour créer un tableau de bord. L'exemple de tableau de bord montre les performances d'une machine virtuelle (VM), ainsi que des informations statiques et des liens.

Prérequis

  • Compte Azure avec un abonnement actif. Créez un compte gratuitement.

  • Si vous choisissez d’utiliser PowerShell localement, cet article vous demande d’installer le module Az PowerShell et de vous connecter à votre compte Azure avec l’applet de commande Connect-AzAccount. Pour en savoir plus sur l’installation du module Az PowerShell, consultez Installer Azure PowerShell.

Azure Cloud Shell

Azure héberge Azure Cloud Shell, un environnement d’interpréteur de commandes interactif que vous pouvez utiliser dans votre navigateur. Vous pouvez utiliser Bash ou PowerShell avec Cloud Shell pour utiliser les services Azure. Vous pouvez utiliser les commandes préinstallées Cloud Shell pour exécuter le code de cet article sans avoir à installer quoi que ce soit dans votre environnement local.

Pour démarrer Azure Cloud Shell :

Option Exemple/Lien
Sélectionnez Essayer dans le coin supérieur droite d’un bloc de codes ou de commandes. La sélection de Essayer ne copie pas automatiquement le code ni la commande dans Cloud Shell. Screenshot that shows an example of Try It for Azure Cloud Shell.
Accédez à https://shell.azure.com ou sélectionnez le bouton Lancer Cloud Shell pour ouvrir Cloud Shell dans votre navigateur. Button to launch Azure Cloud Shell.
Sélectionnez le bouton Cloud Shell dans la barre de menus en haut à droite du portail Azure. Screenshot that shows the Cloud Shell button in the Azure portal

Pour utiliser Azure Cloud Shell :

  1. Démarrez Cloud Shell.

  2. Sélectionnez le bouton Copier sur un bloc de codes (ou un bloc de commandes) pour copier le code ou la commande.

  3. Collez le code ou la commande dans la session Cloud Shell en sélectionnant Ctrl+Maj+V sur Windows et Linux ou en sélectionnant Cmd+Maj+V sur macOS.

  4. Sélectionnez Entrer pour exécuter le code ou la commande.

Choisir un abonnement Azure spécifique

Si vous avez plusieurs abonnements Azure, sélectionnez l’abonnement approprié dans lequel les ressources doivent être facturées. Sélectionnez un abonnement spécifique avec l’applet de commande Set-AzContext.

Set-AzContext -SubscriptionId 00000000-0000-0000-0000-000000000000

Définir des variables

Vous utiliserez plusieurs types d’informations de façon répétée. Créez des variables pour stocker les informations.

# Name of resource group used throughout this article
$resourceGroupName = 'myResourceGroup'

# Azure region
$location = 'centralus'

# Dashboard Title
$dashboardTitle = 'Simple VM Dashboard'

# Dashboard Name
$dashboardName = $dashboardTitle -replace '\s'

# Your Azure Subscription ID
$subscriptionID = (Get-AzContext).Subscription.Id

# Name of test VM
$vmName = 'myVM1'

Créer un groupe de ressources

Créez un groupe de ressources Azure avec l’applet de commande New-AzResourceGroup. Un groupe de ressources est un conteneur logique dans lequel les ressources Azure sont déployées et gérées en tant que groupe.

L’exemple suivant crée un groupe de ressources en fonction du nom de la variable $resourceGroupName dans la région spécifiée de la variable $location.

New-AzResourceGroup -Name $resourceGroupName -Location $location

Création d'une machine virtuelle

Le tableau de bord que vous créez dans la prochaine partie de ce guide de démarrage rapide nécessite une machine virtuelle existante. Créez une machine virtuelle en effectuant les étapes suivantes.

Stockez les informations d’identification de connexion pour la machine virtuelle dans une variable. Le mot de passe doit être complexe. Il s’agit d’un nouveau nom d’utilisateur et d’un nouveau mot de passe. Ce n’est pas, par exemple, le compte que vous utilisez pour vous connecter à Azure. Pour plus d’informations, consultez les exigences relatives aux noms d’utilisateur et les exigences relatives aux mots de passe.

$Cred = Get-Credential

Créez la machine virtuelle.

$AzVmParams = @{
  ResourceGroupName = $resourceGroupName
  Name = $vmName
  Location = $location
  Credential = $Cred
}
New-AzVm @AzVmParams

Le déploiement de la machine virtuelle commence alors et prend quelques minutes. Une fois le déploiement terminé, passez à la section suivante.

Télécharger le modèle de tableau de bord

Étant donné que les tableaux de bord Azure sont des ressources, ils peuvent être représentés au format JSON. Le code suivant télécharge la représentation JSON d’un exemple de tableau de bord. Pour plus d’informations, consultez Structure des tableaux de bord Azure.

$myPortalDashboardTemplateUrl = 'https://raw.githubusercontent.com/Azure/azure-docs-powershell-samples/master/azure-portal/portal-dashboard-template-testvm.json'

$myPortalDashboardTemplatePath = "$HOME\portal-dashboard-template-testvm.json"

Invoke-WebRequest -Uri $myPortalDashboardTemplateUrl -OutFile $myPortalDashboardTemplatePath -UseBasicParsing

Personnaliser le modèle

Personnalisez le modèle téléchargé en exécutant le code suivant.

$Content = Get-Content -Path $myPortalDashboardTemplatePath -Raw
$Content = $Content -replace '<subscriptionID>', $subscriptionID
$Content = $Content -replace '<rgName>', $resourceGroupName
$Content = $Content -replace '<vmName>', $vmName
$Content = $Content -replace '<dashboardTitle>', $dashboardTitle
$Content = $Content -replace '<location>', $location
$Content | Out-File -FilePath $myPortalDashboardTemplatePath -Force

Pour plus d’informations sur la structure du modèle de tableau de bord, consultez Informations de référence sur le modèle de tableaux de bord du portail Microsoft.

Déployer le modèle de tableau de bord

Vous pouvez utiliser la cmdlet New-AzPortalDashboard qui fait partie du module Az.Portal pour déployer le modèle directement à partir de PowerShell.

$DashboardParams = @{
  DashboardPath = $myPortalDashboardTemplatePath
  ResourceGroupName = $resourceGroupName
  DashboardName = $dashboardName
}
New-AzPortalDashboard @DashboardParams

Vérifier les ressources déployées

Vérifiez que le tableau de bord a été correctement créé.

Get-AzPortalDashboard -Name $dashboardName -ResourceGroupName $resourceGroupName

Vérifiez que vous pouvez voir les données concernant votre machine virtuelle dans le tableau de bord du portail Azure.

  1. Dans le menu du portail Azure, sélectionnez Tableau de bord.

    Screenshot of the Dashboard item on the Azure portal menu.

  2. Dans la page Tableau de bord, sélectionnez Tableau de bord Machine virtuelle simple.

    Screenshot of the dashboard selection option in the Azure portal.

  3. Examinez le tableau de bord, qui doit ressembler à celui illustré ici. Même si une partie du contenu est statique, il y a également des graphiques qui indiquent les performances de la machine virtuelle que vous avez créée au début.

    Screenshot of an example dashboard in the Azure portal.

Nettoyer les ressources

Pour supprimer la machine virtuelle et le tableau de bord associé, supprimez le groupe de ressources qui les contient.

Attention

La suppression du groupe de ressources entraîne la suppression de toutes les ressources qu’il contient. Si le groupe de ressources contient des ressources supplémentaires, hormis votre machine virtuelle et votre tableau de bord, ces ressources sont également supprimées.

Remove-AzResourceGroup -Name $resourceGroupName
Remove-Item -Path "$HOME\portal-dashboard-template-testvm.json"

Étapes suivantes

Pour plus d’informations sur les applets de commande du module PowerShell Az.Portal, consultez :