az sapmonitor

  • Reference

Note

This reference is part of the sap-hana extension for the Azure CLI (version 2.0.46 or higher). The extension will automatically install the first time you run an az sapmonitor command. Learn more about extensions.

(PREVIEW) Manage Azure SAP Monitor.

Commands

Name Description Type Status
az sapmonitor create

Create a SAP Monitor.

 Extension GA
az sapmonitor delete

Delete a SAP Monitor.

 Extension GA
az sapmonitor list

List SAP Monitors.

 Extension GA
az sapmonitor provider-instance

Manage the provider instance for the SAP Monitor.

 Extension GA
az sapmonitor provider-instance create

Create a new provider instance for the SAP Monitor.

 Extension GA
az sapmonitor provider-instance delete

Delete a provider instance from the SAP Monitor.

 Extension GA
az sapmonitor provider-instance list

List provider instances for the SAP Monitor.

 Extension GA
az sapmonitor provider-instance show

Get the details of a provider instance for the SAP Monitor.

 Extension GA
az sapmonitor show

Get the details of a SAP Monitor.

 Extension GA
az sapmonitor update

Updates the tags field of a SAP Monitor.

 Extension GA

az sapmonitor create

Create a SAP Monitor.

az sapmonitor create --hana-subnet
                     --monitor-name
                     --region
                     --resource-group
                     [--dca]
                     [--lawsid]
                     [--tags]

Required Parameters

--hana-subnet --hdbsn

ARM ID of an Azure Subnet with access to the HANA instance.

--monitor-name -n

The name of the SAP monitor.

--region

The region to create this SAP monitor on.

--resource-group -g

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

Optional Parameters

--dca --disable_customer_analytics

Disable sending analytics to Microsoft.

default value: False
--lawsid --log-analytics-workspace-arm-id

Existing log analytics workspace id to use for log monitoring.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az sapmonitor delete

Delete a SAP Monitor.

az sapmonitor delete --monitor-name
                     --resource-group

Required Parameters

--monitor-name -n

The name of the SAP monitor.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az sapmonitor list

List SAP Monitors.

az sapmonitor list
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az sapmonitor show

Get the details of a SAP Monitor.

az sapmonitor show --monitor-name
                   --resource-group

Required Parameters

--monitor-name -n

The name of the SAP monitor.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az sapmonitor update

Updates the tags field of a SAP Monitor.

az sapmonitor update --monitor-name
                     --resource-group
                     [--add]
                     [--force-string]
                     [--no-wait]
                     [--remove]
                     [--set]

Required Parameters

--monitor-name -n

The name of the SAP monitor.

--resource-group -g

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

default value: []
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False
--no-wait

Do not wait for the long-running operation to finish.

default value: False
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

default value: []
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

default value: []
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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