Edit

Share via

Test-AzureRmVMAEMExtension

  • Reference
Module:
AzureRM.Compute

Checks the configuration of the AEM extension.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Test-AzureRmVMAEMExtension
    [-ResourceGroupName] <String>
    [-VMName] <String>
    [[-OSType] <String>]
    [[-WaitTimeInMinutes] <Int32>]
    [-SkipStorageCheck]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Test-AzureRmVMAEMExtension cmdlet checks the configuration of the Azure Enhanced Monitoring (AEM) extension. The AEM extension collects the performance data. This cmdlet checks whether performance data is available.

Examples

Example 1: Check the configuration of the AEM extension

PS C:\> Test-AzureRmVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server"

This command checks the configuration of the AEM extension for the virtual machine named contoso-server.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OSType

Specifies the type of the operating system of the operating system disk. If the operating system disk does not have a type, you must specify this parameter. The acceptable values for this parameter are: Windows and Linux.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group of the virtual machine that this cmdlet checks.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SkipStorageCheck

Indicates that this cmdlet skips the check of storage configuration.

Type:SwitchParameter
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMName

Specifies the name of a virtual machine. This cmdlet tests the AEM extension for the virtual machine that this parameter specifies.

Type:String
Aliases:ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WaitTimeInMinutes

Specifies a time-out period, in minutes, for the storage configuration check.

Type:Int32
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

AEMTestResult