Edit

Share via

Test-AzVMAEMExtension

Module:
Az.Compute Module

Checks the configuration of the AEM extension.

Syntax

Default (Default) 

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

Description

The Test-AzVMAEMExtension 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

Test-AzVMAEMExtension -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.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SkipStorageCheck

Indicates that this cmdlet skips the check of storage configuration.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ResourceName

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WaitTimeInMinutes

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

AEMTestResult