Set-AzVMAEMExtension

  • Reference
Module:
Az.Compute

Enables support for monitoring for SAP systems.

Syntax

Set-AzVMAEMExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-EnableWAD]
   [[-WADStorageAccountName] <String>]
   [[-OSType] <String>]
   [-SkipStorage]
   [-NoWait]
   [-SetAccessToIndividualResources]
   [-InstallNewExtension]
   [[-ProxyURI] <String>]
   [-DebugExtension]
   [-PathUserIdentity <String>]
   [-SkipIdentity]
   [-IsTest]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzVMAEMExtension cmdlet updates the configuration of a virtual machine to enable or update the support for monitoring for SAP systems that are installed on the virtual machine. The cmdlet installs the Azure Enhanced Monitoring (AEM) extension that collects the performance data and makes it discoverable for the SAP system.

Examples

Example 1: Use AEM extension

Set-AzVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -WADStorageAccountName "stdstorage"

This command configures the virtual machine named contoso-server to use the AEM extension. The command specifies the storage account named stdstorage.

Parameters

-DebugExtension

Enable debug mode for the VM Extension.

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

-DefaultProfile

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

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

-EnableWAD

If this parameter is provided, the commandlet will enable Windows Azure Diagnostics for this virtual machine.

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

-InstallNewExtension

Install the new VM Extension for SAP.

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

-IsTest

Use test version of the extension. The parameter is meant for earlybird and private builds. Please use it only if advised by the product support. Not for production.

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

-NoWait

Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism.

Type:SwitchParameter
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:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PathUserIdentity

Assures user assigned identity on the VM and configures the extension to authenticate with the user assigned identity. For example: -PathUserIdentity "/subscriptions/272eae8b-75b3-41e5-88b4-782d16d0d97e/resourcegroups/ContosoRresourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ContosoUserAssignedIdentity" You can use the -PathUserIdentity parameter along with -SkipIdentity, in this case the script will only configure the extension and the VM must already has a valid user identity assigned.

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

-ProxyURI

Configures the proxy URI that should be used by the VM Extension for SAP.

Type:String
Position:7
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 modifies.

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

-SetAccessToIndividualResources

Sets the access of the VM identity to the individual resources, e.g. data disks instead of the complete resource group.

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

-SkipIdentity

Bypas the VM identity configuration. The VM must already have either system or user identity assigned.

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

-SkipStorage

Indicates that this cmdlet skips configuration of storage.

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 adds 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

-WADStorageAccountName

Specifies the name of the storage account that this cmdlet uses to configure the LinuxDiagnostics or IaaSDiagnostics extension. If the virtual machine does not use a standard storage account, you must specify a value for this parameter.

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

Inputs

String

Outputs

PSAzureOperationResponse