Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzVMAEMExtension
- Module:
- Az.Compute Module
Enables support for monitoring for SAP systems.
Syntax
Default (Default)
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-EnableWAD
If this parameter is provided, the cmdlet will enable Windows Azure Diagnostics for this virtual machine.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InstallNewExtension
Install the new VM Extension for SAP.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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/ContosoResourceGroup/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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyURI
Configures the proxy URI that should be used by the VM Extension for SAP.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Specifies the name of the resource group of the virtual machine that this cmdlet modifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SetAccessToIndividualResources
Sets the access of the VM identity to the individual resources, e.g. data disks instead of the complete resource group.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkipIdentity
Bypass the VM identity configuration. The VM must already have either system or user identity assigned.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkipStorage
Indicates that this cmdlet skips configuration of storage.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VMName
Specifies the name of a virtual machine. This cmdlet adds 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
-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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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
PSAzureOperationResponse
Related Links
Azure PowerShell
Feedback
Was this page helpful?