az monitor health-models discovery-rule

  • Preview

Note

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

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

Manage Discoveryrule.

Commands

Name Description Type Status
az monitor health-models discovery-rule create

Create a DiscoveryRule.

 Extension Preview
az monitor health-models discovery-rule delete

Delete a DiscoveryRule.

 Extension Preview
az monitor health-models discovery-rule list

List DiscoveryRule resources by HealthModel.

 Extension Preview
az monitor health-models discovery-rule show

Get a DiscoveryRule.

 Extension Preview
az monitor health-models discovery-rule update

Update a DiscoveryRule.

 Extension Preview
az monitor health-models discovery-rule wait

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

 Extension Preview

az monitor health-models discovery-rule create

Preview

Command group 'az monitor health-models discovery-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a DiscoveryRule.

az monitor health-models discovery-rule create --discovery-rule-name --name
                                               --health-model-name
                                               --resource-group
                                               [--acquire-policy-token]
                                               [--add-recommended-signals {Disabled, Enabled}]
                                               [--add-resource-health-signal {Disabled, Enabled}]
                                               [--authentication-setting]
                                               [--change-reference]
                                               [--discover-relationships {Disabled, Enabled}]
                                               [--display-name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--specification]

Examples

DiscoveryRules_CreateOrUpdate

az monitor health-models discovery-rule create --resource-group myResourceGroup --health-model-name myHealthModel --discovery-rule-name myDiscoveryRule --authentication-setting authSetting1 --display-name myDisplayName --discover-relationships Enabled --add-recommended-signals Enabled --specification "{resourceGraphQuery:'resources | where subscriptionId == '/7ddfffd7-9b32-40df-1234-828cbd55d6f4'/ | where resourceGroup == '/my-rg'/',resource-graph-query:{resource-graph-query:'resources | where subscriptionId == '/7ddfffd7-9b32-40df-1234-828cbd55d6f4'/ | where resourceGroup == '/my-rg'/'}}" --add-resource-health-signal Enabled

Required Parameters

--discovery-rule-name --name -n

Name of the discovery rule. Must be unique within a health model.

--health-model-name

Name of health model resource.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--add-recommended-signals

Whether to add all recommended signals to the discovered entities.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--add-resource-health-signal

Whether to automatically add a signal for the Azure resource's availability state from Azure Resource Health to the discovered entities. Defaults to Enabled: discovery rules updated via this API version without setting this field will begin emitting a Resource Health availability signal. Pass Disabled to preserve pre-2026-05-01-preview behavior.

Property Value
Parameter group: Properties Arguments
Default value: Enabled
Accepted values: Disabled, Enabled
--authentication-setting

Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities.

Property Value
Parameter group: Properties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--discover-relationships

Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--display-name

Display name.

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

Specification of the discovery rule defining how entities are discovered. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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 monitor health-models discovery-rule delete

Preview

Command group 'az monitor health-models discovery-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a DiscoveryRule.

az monitor health-models discovery-rule delete [--acquire-policy-token]
                                               [--change-reference]
                                               [--discovery-rule-name --name]
                                               [--health-model-name]
                                               [--ids]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]
                                               [--yes]

Examples

DiscoveryRules_Delete

az monitor health-models discovery-rule delete --resource-group my-resource-group --health-model-name my-health-model --discovery-rule-name my-discovery-rule

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--discovery-rule-name --name -n

Name of the discovery rule. Must be unique within a health model.

Property Value
Parameter group: Resource Id Arguments
--health-model-name

Name of health model resource.

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
--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 monitor health-models discovery-rule list

Preview

Command group 'az monitor health-models discovery-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List DiscoveryRule resources by HealthModel.

az monitor health-models discovery-rule list --health-model-name
                                             --resource-group
                                             [--max-items]
                                             [--next-token]
                                             [--timestamp]

Examples

DiscoveryRules_ListByHealthModel

az monitor health-models discovery-rule list --resource-group my-resource-group --health-model-name my-health-model

Required Parameters

--health-model-name

Name of health model resource.

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

Timestamp to use for the operation. When specified, the version of the resource at this point in time is retrieved. If not specified, the latest version is used.

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 monitor health-models discovery-rule show

Preview

Command group 'az monitor health-models discovery-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a DiscoveryRule.

az monitor health-models discovery-rule show [--discovery-rule-name --name]
                                             [--health-model-name]
                                             [--ids]
                                             [--resource-group]
                                             [--subscription]

Examples

DiscoveryRules_Get

az monitor health-models discovery-rule show --resource-group myResourceGroup --health-model-name myHealthModel --discovery-rule-name myDiscoveryRule

Optional Parameters

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

--discovery-rule-name --name -n

Name of the discovery rule. Must be unique within a health model.

Property Value
Parameter group: Resource Id Arguments
--health-model-name

Name of health model resource.

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
--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 monitor health-models discovery-rule update

Preview

Command group 'az monitor health-models discovery-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a DiscoveryRule.

az monitor health-models discovery-rule update [--acquire-policy-token]
                                               [--add]
                                               [--add-recommended-signals {Disabled, Enabled}]
                                               [--add-resource-health-signal {Disabled, Enabled}]
                                               [--authentication-setting]
                                               [--change-reference]
                                               [--discover-relationships {Disabled, Enabled}]
                                               [--discovery-rule-name --name]
                                               [--display-name]
                                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--health-model-name]
                                               [--ids]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--remove]
                                               [--resource-group]
                                               [--set]
                                               [--specification]
                                               [--subscription]

Examples

DiscoveryRules_CreateOrUpdate

az monitor health-models discovery-rule update --resource-group myResourceGroup --health-model-name myHealthModel --discovery-rule-name myDiscoveryRule --authentication-setting authSetting1 --display-name myDisplayName --discover-relationships Enabled --add-recommended-signals Enabled --specification "{kind:ResourceGraphQuery,resourceGraphQuery:'resources | where subscriptionId == '/7ddfffd7-9b32-40df-1234-828cbd55d6f4'/ | where resourceGroup == '/my-rg'/'}" --add-resource-health-signal Enabled

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--add-recommended-signals

Whether to add all recommended signals to the discovered entities.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--add-resource-health-signal

Whether to automatically add a signal for the Azure resource's availability state from Azure Resource Health to the discovered entities. Defaults to Enabled: discovery rules updated via this API version without setting this field will begin emitting a Resource Health availability signal. Pass Disabled to preserve pre-2026-05-01-preview behavior.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--authentication-setting

Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities.

Property Value
Parameter group: Properties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--discover-relationships

Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--discovery-rule-name --name -n

Name of the discovery rule. Must be unique within a health model.

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

Display name.

Property Value
Parameter group: Properties 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
--health-model-name

Name of health model resource.

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

Specification of the discovery rule defining how entities are discovered. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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 monitor health-models discovery-rule wait

Preview

Command group 'az monitor health-models discovery-rule' 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 monitor health-models discovery-rule wait [--acquire-policy-token]
                                             [--change-reference]
                                             [--created]
                                             [--custom]
                                             [--deleted]
                                             [--discovery-rule-name --name]
                                             [--exists]
                                             [--health-model-name]
                                             [--ids]
                                             [--interval]
                                             [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
--discovery-rule-name --name -n

Name of the discovery rule. Must be unique within a health model.

Property Value
Parameter group: Resource Id Arguments
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--health-model-name

Name of health model resource.

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

Polling interval in seconds.

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