Extension de machine virtuelle de l’agent Log Analytics pour Windows

Les journaux Azure Monitor fournissent des fonctionnalités permettant de superviser les ressources cloud et locales. Microsoft publie et prend en charge l’extension de machine virtuelle de l’agent Log Analytics pour Windows. L’extension installe l’agent Log Analytics sur des machines virtuelles Azure et inscrit des machines virtuelles dans un espace de travail Log Analytics existant. Cet article présente les plateformes, configurations et options de déploiement qui sont prises en charge pour l’extension de machine virtuelle de l’agent Log Analytics pour Windows.

Prérequis

Passez en revue les prérequis suivants relatifs à l’utilisation de l’extension de machine virtuelle de l’agent Log Analytics pour Windows.

Système d’exploitation

Pour plus d’informations sur les systèmes d’exploitation Windows pris en charge, consultez l’article Vue d’ensemble des agents Azure Monitor.

Version de l’agent et de l’extension de machine virtuelle

Le tableau suivant indique la correspondance de la version de l’extension de machine virtuelle Log Analytics Windows avec l’agent Log Analytics pour chaque version.

Microsoft Defender pour le cloud

Microsoft Defender pour le cloud provisionne automatiquement l’agent Log Analytics et le connecte à l’espace de travail Log Analytics par défaut de l’abonnement Azure.

Azure Arc

Vous pouvez utiliser des serveurs avec Azure Arc pour déployer, supprimer et mettre à jour l’extension de machine virtuelle de l’agent Log Analytics sur des machines Windows et Linux non-Azure. Cette approche simplifie la gestion de votre machine hybride tout au long de son cycle de vie. Pour plus d’informations, consultez Gestion des extensions de machine virtuelle avec des serveurs compatibles avec Azure Arc.

Connectivité Internet

L’extension de machine virtuelle de l’agent Log Analytics pour Windows nécessite que la machine virtuelle cible soit connectée à Internet.

Schéma d’extensions

Le JSON suivant montre le schéma de l’extension de machine virtuelle de l’agent Log Analytics pour Windows. L’extension nécessite l’ID et la clé de l’espace de travail Log Analytics cible. Vous trouverez ces éléments dans les paramètres de l’espace de travail dans le portail Azure.

La clé de l’espace de travail devant être traitée comme une donnée sensible, elle est stockée dans une configuration protégée. Les données du paramètre de protection de l’extension de machine virtuelle Azure sont chiffrées et ne sont déchiffrées que sur la machine virtuelle cible.

{
    "type": "extensions",
    "name": "OMSExtension",
    "apiVersion": "[variables('apiVersion')]",
    "location": "[resourceGroup().location]",
    "dependsOn": [
        "[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
    ],
    "properties": {
        "publisher": "Microsoft.EnterpriseCloud.Monitoring",
        "type": "MicrosoftMonitoringAgent",
        "typeHandlerVersion": "1.0",
        "autoUpgradeMinorVersion": true,
        "settings": {
            "workspaceId": "myWorkSpaceId"
        },
        "protectedSettings": {
            "workspaceKey": "myWorkspaceKey"
        }
    }
}

Valeurs de propriétés

Le schéma JSON comprend les propriétés suivantes.

* La propriété de schéma workspaceId est spécifiée en tant que propriété consumerId dans l’API Log Analytics.

Déploiement de modèle

Les extensions de machine virtuelle Azure peuvent être déployées avec des modèles Azure Resource Manager (ARM). Le schéma JSON détaillé dans la section précédente peut être utilisé dans un modèle ARM pour exécuter l’extension de machine virtuelle de l’agent Log Analytics pendant le déploiement d’un modèle ARM. Vous trouverez un exemple de modèle qui inclut l’extension de machine virtuelle d’agent Log Analytics dans la Galerie de démarrage rapide Azure.

Le JSON pour une extension de machine virtuelle peut être imbriqué à l’intérieur de la ressource de machine virtuelle ou placé à la racine ou au niveau supérieur d’un modèle ARM JSON. Le positionnement du JSON affecte la valeur du nom de la ressource et son type. Pour plus d’informations, consultez Définition du nom et du type des ressources enfants.

L’exemple suivant suppose que l’extension de machine virtuelle de l’agent Log Analytics est imbriquée dans la ressource de machine virtuelle. Lors de l’imbrication de la ressource d’extension, le JSON est placé dans l’objet "resources": [] de la machine virtuelle.

{
    "type": "extensions",
    "name": "OMSExtension",
    "apiVersion": "[variables('apiVersion')]",
    "location": "[resourceGroup().location]",
    "dependsOn": [
        "[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
    ],
    "properties": {
        "publisher": "Microsoft.EnterpriseCloud.Monitoring",
        "type": "MicrosoftMonitoringAgent",
        "typeHandlerVersion": "1.0",
        "autoUpgradeMinorVersion": true,
        "settings": {
            "workspaceId": "myWorkSpaceId"
        },
        "protectedSettings": {
            "workspaceKey": "myWorkspaceKey"
        }
    }
}

Lorsque vous placez le JSON de l’extension à la racine du modèle ARM, la ressource name inclut une référence à la machine virtuelle parente, et le type reflète la configuration imbriquée.

{
    "type": "Microsoft.Compute/virtualMachines/extensions",
    "name": "<parentVmResource>/OMSExtension",
    "apiVersion": "[variables('apiVersion')]",
    "location": "[resourceGroup().location]",
    "dependsOn": [
        "[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
    ],
    "properties": {
        "publisher": "Microsoft.EnterpriseCloud.Monitoring",
        "type": "MicrosoftMonitoringAgent",
        "typeHandlerVersion": "1.0",
        "autoUpgradeMinorVersion": true,
        "settings": {
            "workspaceId": "myWorkSpaceId"
        },
        "protectedSettings": {
            "workspaceKey": "myWorkspaceKey"
        }
    }
}

Déploiement PowerShell

La commande Set-AzVMExtension peut être utilisée pour déployer l’extension de machine virtuelle de l’agent Log Analytics sur une machine virtuelle existante. Avant d’exécuter la commande, stockez les configurations publique et privée dans une table de hachage PowerShell.

$PublicSettings = @{"workspaceId" = "myWorkspaceId"}
$ProtectedSettings = @{"workspaceKey" = "myWorkspaceKey"}

Set-AzVMExtension -ExtensionName "MicrosoftMonitoringAgent" `
    -ResourceGroupName "myResourceGroup" `
    -VMName "myVM" `
    -Publisher "Microsoft.EnterpriseCloud.Monitoring" `
    -ExtensionType "MicrosoftMonitoringAgent" `
    -TypeHandlerVersion 1.0 `
    -Settings $PublicSettings `
    -ProtectedSettings $ProtectedSettings `
    -Location WestUS 

Problèmes de dépannage

Voici quelques suggestions pour résoudre les problèmes de déploiement.

Afficher l’état de l’extension

Vérifiez le statut de votre déploiement d’extension dans le Portail Azure ou à l’aide de PowerShell ou d’Azure CLI.

Pour voir l’état du déploiement des extensions pour une machine virtuelle donnée, exécutez les commandes suivantes.

• Azure PowerShell :

  Get-AzVMExtension -ResourceGroupName <myResourceGroup> -VMName <myVM> -Name <myExtensionName>
  

• L’interface de ligne de commande Azure CLI :

  az vm get-instance-view --resource-group <myResourceGroup> --name <myVM> --query "instanceView.extensions"
  

Consulter les journaux de sortie

Consultez les journaux de sortie de l’extension de machine virtuelle de l’agent Log Analytics pour Windows sous C:\WindowsAzure\Logs\Plugins\Microsoft.EnterpriseCloud.Monitoring.MicrosoftMonitoringAgent\.

Obtenir de l’aide

Voici quelques autres options pour vous aider à résoudre les problèmes de déploiement :

• Pour obtenir de l’aide, contactez les experts Azure sur les forums Q&A et Stack Overflow.

• Vous pouvez aussi contacter le Support Microsoft. Pour plus d’informations sur l’utilisation du support Azure, lisez les Questions fréquentes (FAQ) sur le support Azure.