Share via

az elastic monitor monitored-subscription

Note

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

Manage subscriptions monitored by the Elastic monitor resource, ensuring optimal observability and performance.

Commands

Name Description Type Status
az elastic monitor monitored-subscription create

Create subscriptions to be monitored by the Elastic monitor resource, enabling observability and monitoring.

 Extension GA
az elastic monitor monitored-subscription delete

Delete subscriptions being monitored by the Elastic monitor resource, removing their observability and monitoring capabilities.

 Extension GA
az elastic monitor monitored-subscription list

List all subscriptions currently being monitored by the Elastic monitor resource, helping you manage observability.

 Extension GA
az elastic monitor monitored-subscription show

Get detailed information about all subscriptions currently being monitored by the Elastic monitor resource.

 Extension GA
az elastic monitor monitored-subscription update

Update subscriptions to be monitored by the Elastic monitor resource, ensuring optimal observability and performance.

 Extension GA
az elastic monitor monitored-subscription wait

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

 Extension GA

az elastic monitor monitored-subscription create

Create subscriptions to be monitored by the Elastic monitor resource, enabling observability and monitoring.

az elastic monitor monitored-subscription create --configuration-name --name
                                                 --monitor-name
                                                 --resource-group
                                                 [--monitored-subscription-list]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--operation {Active, AddBegin, AddComplete, DeleteBegin, DeleteComplete}]

Examples

Monitors_AddMonitoredSubscriptions

az elastic monitor monitored-subscription create --resource-group myResourceGroup --monitor-name myMonitor --configuration-name default

Required Parameters

--configuration-name --name -n

The configuration name. Only 'default' value is supported.

--monitor-name

Monitor resource name.

--resource-group -g

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

Optional Parameters

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

--monitored-subscription-list -m

List of subscriptions and the state of the monitoring. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--operation

The operation for the patch on the resource.

Property Value
Parameter group: Properties Arguments
Accepted values: Active, AddBegin, AddComplete, DeleteBegin, DeleteComplete
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.

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

Property Value
Default value: False

az elastic monitor monitored-subscription delete

Delete subscriptions being monitored by the Elastic monitor resource, removing their observability and monitoring capabilities.

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

Examples

Monitors_DeleteMonitoredSubscriptions

az elastic monitor monitored-subscription delete --resource-group myResourceGroup --monitor-name myMonitor --configuration-name default

Optional Parameters

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

--configuration-name --name -n

The configuration name. Only 'default' value is supported.

Property Value
Parameter group: Resource Id Arguments
--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
--monitor-name

Monitor resource name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

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
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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 elastic monitor monitored-subscription list

List all subscriptions currently being monitored by the Elastic monitor resource, helping you manage observability.

az elastic monitor monitored-subscription list --monitor-name
                                               --resource-group
                                               [--max-items]
                                               [--next-token]

Examples

Monitors_GetMonitoredSubscriptions

az elastic monitor monitored-subscription list --resource-group myResourceGroup --monitor-name myMonitor

Required Parameters

--monitor-name

Monitor resource name.

--resource-group -g

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

Optional Parameters

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

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination 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.

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

Property Value
Default value: False

az elastic monitor monitored-subscription show

Get detailed information about all subscriptions currently being monitored by the Elastic monitor resource.

az elastic monitor monitored-subscription show [--configuration-name --name]
                                               [--ids]
                                               [--monitor-name]
                                               [--resource-group]
                                               [--subscription]

Examples

Monitors_GetMonitoredSubscriptions

az elastic monitor monitored-subscription show --resource-group myResourceGroup --monitor-name myMonitor --configuration-name default

Optional Parameters

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

--configuration-name --name -n

The configuration name. Only 'default' value is supported.

Property Value
Parameter group: Resource Id Arguments
--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
--monitor-name

Monitor resource 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 elastic monitor monitored-subscription update

Update subscriptions to be monitored by the Elastic monitor resource, ensuring optimal observability and performance.

az elastic monitor monitored-subscription update [--add]
                                                 [--configuration-name --name]
                                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--ids]
                                                 [--monitor-name]
                                                 [--monitored-subscription-list]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--operation {Active, AddBegin, AddComplete, DeleteBegin, DeleteComplete}]
                                                 [--remove]
                                                 [--resource-group]
                                                 [--set]
                                                 [--subscription]

Examples

Monitors_UpdateMonitoredSubscriptions

az elastic monitor monitored-subscription update --resource-group myResourceGroup --monitor-name myMonitor --configuration-name default

Optional Parameters

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

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

Property Value
Parameter group: Generic Update Arguments
--configuration-name --name -n

The configuration name. Only 'default' value is supported.

Property Value
Parameter group: Resource Id Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--monitor-name

Monitor resource name.

Property Value
Parameter group: Resource Id Arguments
--monitored-subscription-list -m

List of subscriptions and the state of the monitoring. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--operation

The operation for the patch on the resource.

Property Value
Parameter group: Properties Arguments
Accepted values: Active, AddBegin, AddComplete, DeleteBegin, DeleteComplete
--remove

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

Property Value
Parameter group: Generic Update 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
--set

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

Property Value
Parameter group: Generic Update 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 elastic monitor monitored-subscription wait

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

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

Optional Parameters

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

--configuration-name --name -n

The configuration name. Only 'default' value is supported.

Property Value
Parameter group: Resource Id Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--monitor-name

Monitor resource 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
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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