Skip to content

Latest commit

 

History

History
150 lines (113 loc) · 3.7 KB

Test-AzVMAEMExtension.md

File metadata and controls

150 lines (113 loc) · 3.7 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml
Az.Compute
67AED9B8-AE3D-47E5-813C-9B46E11AE46C
2.0.0

Test-AzVMAEMExtension

SYNOPSIS

Checks the configuration of the AEM extension.

SYNTAX

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.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SkipStorageCheck

Indicates that this cmdlet skips the check of storage configuration.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
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: System.String
Parameter Sets: (All)
Aliases: ResourceName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WaitTimeInMinutes

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

Type: System.Int32
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Commands.Compute.Extension.AEM.AEMTestResult

NOTES

RELATED LINKS

Get-AzVMAEMExtension

Remove-AzVMAEMExtension

Set-AzVMAEMExtension