Share via

az vm aem

Note

This reference is part of the aem extension for the Azure CLI (version 2.19.1 or higher). The extension will automatically install the first time you run an az vm aem command. Learn more about extensions.

Manage Azure Enhanced Monitoring Extension for SAP.

Commands

Name Description Type Status
az vm aem delete

Remove Azure Enhanced Monitoring Extension.

 Extension GA
az vm aem set

Configure Azure Enhanced Monitoring Extension.

 Extension GA
az vm aem verify

Verify Azure Enhanced Monitoring Extensions configured correctly.

 Extension GA

az vm aem delete

Remove Azure Enhanced Monitoring Extension.

az vm aem delete [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the Virtual Machine. You can configure the default using az configure --defaults vm=<name>.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az vm aem set

Configure Azure Enhanced Monitoring Extension.

It can take up to 15 minutes for the monitoring data to appear in the SAP system.

az vm aem set [--debug-extension]
              [--ids]
              [--install-new-extension]
              [--name]
              [--proxy-uri]
              [--resource-group]
              [--set-access-to-individual-resources]
              [--skip-storage-analytics]
              [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--debug-extension

Enable debug mode on the VM Extension for SAP.

Property Value
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--install-new-extension -i

Install the new VM Extension for SAP.

Property Value
Default value: False
--name -n

The name of the Virtual Machine. You can configure the default using az configure --defaults vm=<name>.

Property Value
Parameter group: Resource Id Arguments
--proxy-uri -p

Set the proxy URI that should be used to access external resources e.g. the Azure API. Example: http://proxyhost:8080.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--set-access-to-individual-resources -s

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

Property Value
Default value: False
--skip-storage-analytics

Skip enabling analytics on storage accounts.

Property Value
Default value: False
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az vm aem verify

Verify Azure Enhanced Monitoring Extensions configured correctly.

az vm aem verify [--ids]
                 [--name]
                 [--resource-group]
                 [--skip-storage-check]
                 [--subscription]
                 [--wait-time-in-minutes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the Virtual Machine. You can configure the default using az configure --defaults vm=<name>.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--skip-storage-check

Disables the test for table content.

Property Value
Default value: False
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--wait-time-in-minutes

Maximum minutes to wait for the storage metrics to be available.

Property Value
Default value: 15
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False