Share via

az workloads monitor

  • Preview
  • Reference

Note

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

Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage workloads monitor.

Commands

Name Description Type Status
az workloads monitor create

Create a SAP monitor for the specified subscription, resource group, and resource name.

 Extension Preview
az workloads monitor delete

Delete a SAP monitor with the specified subscription, resource group, and SAP monitor name.

 Extension Preview
az workloads monitor list

List a list of SAP monitors in the specified resource group.

 Extension Preview
az workloads monitor provider-instance

Manage monitor provider instance.

 Extension Preview
az workloads monitor provider-instance create

Create a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

 Extension Preview
az workloads monitor provider-instance delete

Delete a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

 Extension Preview
az workloads monitor provider-instance list

List a list of provider instances in the specified SAP monitor. The operations returns various properties of each provider instances.

 Extension Preview
az workloads monitor provider-instance show

Show properties of a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

 Extension Preview
az workloads monitor provider-instance wait

Place the CLI in a waiting state until a condition is met.

 Extension Preview
az workloads monitor sap-landscape-monitor

Manage monitor sap landscape monitor.

 Extension Preview
az workloads monitor sap-landscape-monitor create

Create a SAP Landscape Monitor Dashboard for the specified subscription, resource group, and resource name.

 Extension Preview
az workloads monitor sap-landscape-monitor delete

Delete a SAP Landscape Monitor Dashboard with the specified subscription, resource group, and SAP monitor name.

 Extension Preview
az workloads monitor sap-landscape-monitor list

List configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name.

 Extension Preview
az workloads monitor sap-landscape-monitor show

Show configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name.

 Extension Preview
az workloads monitor sap-landscape-monitor update

Update a SAP Landscape Monitor Dashboard for the specified subscription, resource group, and resource name.

 Extension Preview
az workloads monitor show

Show properties of a SAP monitor for the specified subscription, resource group, and resource name.

 Extension Preview
az workloads monitor update

Update a SAP monitor for the specified subscription, resource group, and resource name.

 Extension Preview
az workloads monitor wait

Place the CLI in a waiting state until a condition is met.

 Extension Preview

az workloads monitor create

Preview

Command group 'az workloads monitor' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a SAP monitor for the specified subscription, resource group, and resource name.

az workloads monitor create --monitor-name
                            --resource-group
                            [--app-location]
                            [--identity]
                            [--location]
                            [--log-analytics-workspace-arm-id]
                            [--managed-rg-name]
                            [--monitor-subnet]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--routing-preference {Default, RouteAll}]
                            [--tags]
                            [--zone-redundancy-preference]

Examples

Create a SAP monitor for the specified subscription, resource group, and resource name.

az workloads monitor create -g <rg-name> -n <ams-name> -l <location> --app-location <app-location> --managed-rg-name <mrg-name> --monitor-subnet <subnet> --routing-preference <routing-preference>

Required Parameters

--monitor-name --name -n

Name of the SAP monitor resource.

--resource-group -g

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

Optional Parameters

--app-location

The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.

--identity

[currently not in use] Managed service identity(user assigned identities) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--log-analytics-workspace-arm-id

The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.

--managed-rg-name

Managed resource group name.

--monitor-subnet

The subnet which the SAP monitor will be deployed in.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--routing-preference

Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET.

Accepted values: Default, RouteAll
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--zone-redundancy-preference

Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.

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 workloads monitor delete

Preview

Command group 'az workloads monitor' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a SAP monitor with the specified subscription, resource group, and SAP monitor name.

az workloads monitor delete [--ids]
                            [--monitor-name]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]
                            [--yes]

Examples

Delete a SAP monitor with the specified subscription, resource group, and SAP monitor name.

az workloads monitor delete -g <RG-NAME> -n <monitor-name>

Optional Parameters

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

--monitor-name --name -n

Name of the SAP monitor resource.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
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 workloads monitor list

Preview

Command group 'az workloads monitor' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List a list of SAP monitors in the specified resource group.

az workloads monitor list [--max-items]
                          [--next-token]
                          [--resource-group]

Examples

Get a list of SAP monitors in the specified resource group.

az workloads monitor list -g <RG-NAME>

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--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 workloads monitor show

Preview

Command group 'az workloads monitor' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show properties of a SAP monitor for the specified subscription, resource group, and resource name.

az workloads monitor show [--ids]
                          [--monitor-name]
                          [--resource-group]
                          [--subscription]

Examples

Show properties of a SAP monitor for the specified subscription, resource group, and resource name.

az workloads monitor show -g <RG-NAME> -n <monitor-name>

Optional Parameters

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

--monitor-name --name -n

Name of the SAP monitor resource.

--resource-group -g

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

--subscription

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

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 workloads monitor update

Preview

Command group 'az workloads monitor' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a SAP monitor for the specified subscription, resource group, and resource name.

az workloads monitor update [--add]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--identity]
                            [--ids]
                            [--monitor-name]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--subscription]
                            [--tags]

Examples

Add monitor tags

az workloads monitor update -g <Resource-group-name> -n <monitor-name> --tags tag=test tag2=test2

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

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--identity

[currently not in use] Managed service identity(user assigned identities) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--monitor-name --name -n

Name of the SAP monitor resource.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 workloads monitor wait

Preview

Command group 'az workloads monitor' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az workloads monitor wait [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--monitor-name]
                          [--resource-group]
                          [--subscription]
                          [--timeout]
                          [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30
--monitor-name --name -n

Name of the SAP monitor resource.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.