az monitor health-models entity

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

Commands

Name	Description	Type	Status
az monitor health-models entity add-data-annotation	Add a data annotation to an entity.	Extension	Preview
az monitor health-models entity create	Create a Entity.	Extension	Preview
az monitor health-models entity delete	Delete a Entity.	Extension	Preview
az monitor health-models entity get-data-annotations	Retrieve data annotations for an entity.	Extension	Preview
az monitor health-models entity get-history	Retrieve the health state transition history for an entity.	Extension	Preview
az monitor health-models entity get-signal-history	Retrieve the time series history for a signal on an entity.	Extension	Preview
az monitor health-models entity get-signal-recommendations	Get recommended signal configurations for a given Entity (only applicable for Entities representing Azure resources).	Extension	Preview
az monitor health-models entity ingest-health-report	Ingest a health report for a specific signal on an entity (the entity must already exist).	Extension	Preview
az monitor health-models entity list	List Entity resources by HealthModel.	Extension	Preview
az monitor health-models entity show	Get a Entity.	Extension	Preview
az monitor health-models entity update	Update a Entity.	Extension	Preview
az monitor health-models entity wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az monitor health-models entity add-data-annotation

Preview

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

Add a data annotation to an entity.

az monitor health-models entity add-data-annotation --annotation-details
                                                    [--acquire-policy-token]
                                                    [--change-reference]
                                                    [--description]
                                                    [--entity-name]
                                                    [--health-model-name]
                                                    [--ids]
                                                    [--resource-group]
                                                    [--subscription]

Examples

Entities_AddDataAnnotation

az monitor health-models entity add-data-annotation --resource-group rgopenapi --health-model-name myHealthModel --entity-name entity1 --annotation-details "{environment:production,deploymentId:deploy-2026-04-10-001,changedBy:release-pipeline}" --description "Production deployment of v2.4.1"

Required Parameters

--annotation-details

Annotation details as a dynamic key-value pair bag. Service-enforced limits: a maximum of 10 entries per annotation and a maximum value length of 256 characters. Requests exceeding these limits will be rejected with a 400 response. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

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

--description

Optional description of the annotation.

Property	Value
Parameter group:	Body Arguments

--entity-name

Name of the entity. 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 entity create

Preview

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

Create a Entity.

az monitor health-models entity create --entity-name --name
                                       --health-model-name
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--alerts]
                                       [--canvas-position]
                                       [--change-reference]
                                       [--display-name]
                                       [--health-objective]
                                       [--icon]
                                       [--impact {Limited, Standard, Suppressed}]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--signal-groups]
                                       [--tags]

Examples

Entities_CreateOrUpdate

az monitor health-models entity create --resource-group rgopenapi --health-model-name myHealthModel --entity-name uszrxbdkxesdrxhmagmzywebgbjj --display-name "My entity" --canvas-position "{x:14,y:13}" --icon "{icon-name:Custom,custom-data:rcitntvapruccrhtxmkqjphbxunkz}" --health-objective 62 --impact Standard --tags "{key1376:'sample tag'}" --signal-groups "{azure-resource:{authentication-setting:auth123,azure-resource-id:/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1,azure-resource-kind:functionapp,signals:[{signalKind:AzureResourceMetric,name:uniqueSignalName1,signal-definition-name:sigdef1,metric-namespace:microsoft.compute/virtualMachines,metric-name:cpuusage,aggregation-type:None,dimension-filter:'node eq '/node1'/',display-name:'CPU usage',refresh-interval:PT1M,time-grain:PT1M,data-unit:Count,evaluation-rules:{degradedRule:{operator:LowerThan,threshold:10},unhealthyRule:{operator:LowerThan,threshold:1}}}]},azure-log-analytics:{authentication-setting:auth123,log-analytics-workspace-resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.OperationalInsights/workspaces/myworkspace,signals:[{signalKind:LogAnalyticsQuery,name:uniqueSignalName2,signal-definition-name:null,evaluation-rules:{degradedRule:{operator:GreaterThan,threshold:1},unhealthyRule:{operator:GreaterThan,threshold:5}},refresh-interval:PT1M,query-text:'print 1',time-grain:PT30M,value-column-name:result,display-name:'Test LA signal',data-unit:'my unit'}]},azure-monitor-workspace:{authentication-setting:auth123,azure-monitor-workspace-resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.OperationalInsights/workspaces/myworkspace,signals:[{signalKind:PrometheusMetricsQuery,name:pod-cpu-usage,signal-definition-name:PodCpuUsageDefinition,display-name:'Pod CPU Usage',refresh-interval:PT1M,data-unit:Percent,query-text:\'rate(container_cpu_usage_seconds_total{pod=~"my-app-.*"}[5m]) * 100\',time-grain:PT5M,evaluation-rules:{degradedRule:{operator:GreaterThan,threshold:70},unhealthyRule:{operator:GreaterThan,threshold:90}}}]},dependencies:{aggregation-type:MinHealthy,unit:Percentage,degraded-threshold:80,unhealthy-threshold:50}}" --alerts "{unhealthy:{severity:Sev1,description:'Alert description',actionGroupIds:[/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Insights/actionGroups/myactiongroup]},degraded:{severity:Sev4,description:'Alert description',actionGroupIds:[/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Insights/actionGroups/myactiongroup]}}"

Required Parameters

--entity-name --name -n

Name of the entity. 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

--alerts

Alert configuration for this entity Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--canvas-position

Positioning of the entity on the model canvas Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--display-name

Display name.

Property	Value
Parameter group:	Properties Arguments

--health-objective

Health objective as a percentage of time the entity should be healthy.

Property	Value
Parameter group:	Properties Arguments

--icon

Visual icon definition. If not set, a default icon is used. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--impact

Impact of the entity in health state propagation.

Property	Value
Parameter group:	Properties Arguments
Default value:	Standard
Accepted values:	Limited, Standard, Suppressed

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

--signal-groups

Signal groups which are assigned to this entity Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--tags

Optional set of tags (key-value pairs) 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 entity delete

Preview

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

Delete a Entity.

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

Examples

Entities_Delete

az monitor health-models entity delete --resource-group rgopenapi --health-model-name model1 --entity-name U4VTRFlUkm9kR6H23-c-6U-XHq7n

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

--entity-name --name -n

Name of the entity. 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 entity get-data-annotations

Preview

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

Retrieve data annotations for an entity.

az monitor health-models entity get-data-annotations [--acquire-policy-token]
                                                     [--change-reference]
                                                     [--end-at]
                                                     [--entity-name]
                                                     [--health-model-name]
                                                     [--ids]
                                                     [--next-marker]
                                                     [--resource-group]
                                                     [--start-at]
                                                     [--subscription]
                                                     [--top]

Examples

Entities_GetDataAnnotations

az monitor health-models entity get-data-annotations --resource-group rgopenapi --health-model-name myHealthModel --entity-name entity1 --start-at 2026-04-09T00:00:00Z --end-at 2026-04-10T23:59:59Z

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

--end-at

End of UTC time range. Defaults to now if not specified.

Property	Value
Parameter group:	Body Arguments

--entity-name

Name of the entity. 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

--next-marker

An opaque string value that identifies the portion of the result set to be returned with the next operation. Must not be combined with startAt or endAt.

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

--start-at

Start of UTC time range. Defaults to 24 hours ago if not specified.

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

--top

Maximum number of annotations to return per page. Defaults to 100.

Property	Value
Parameter group:	Body Arguments
Default value:	100

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 entity get-history

Preview

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

Retrieve the health state transition history for an entity.

az monitor health-models entity get-history [--acquire-policy-token]
                                            [--change-reference]
                                            [--end-at]
                                            [--entity-name]
                                            [--health-model-name]
                                            [--ids]
                                            [--next-marker]
                                            [--resource-group]
                                            [--start-at]
                                            [--subscription]
                                            [--top]

Examples

Entities_GetHistory

az monitor health-models entity get-history --resource-group rgopenapi --health-model-name myHealthModel --entity-name entity1 --start-at 2025-12-11T10:00:00Z --end-at 2025-12-12T10:00:00Z --top 4

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

--end-at

End time for the history query. Defaults to now if not specified.

Property	Value
Parameter group:	Body Arguments

--entity-name

Name of the entity. 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

--next-marker

An opaque string value that identifies the portion of the result set to be returned with the next operation. Must not be combined with startAt or endAt.

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

--start-at

Start time for the history query. Defaults to 24 hours ago if not specified.

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

--top

Maximum number of health state transitions to return per page. Defaults to 1000.

Property	Value
Parameter group:	Body Arguments
Default value:	1000

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 entity get-signal-history

Preview

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

Retrieve the time series history for a signal on an entity.

az monitor health-models entity get-signal-history --signal-name
                                                   [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--end-at]
                                                   [--entity-name]
                                                   [--health-model-name]
                                                   [--ids]
                                                   [--next-marker]
                                                   [--resource-group]
                                                   [--start-at]
                                                   [--subscription]
                                                   [--top]

Examples

Entities_GetSignalHistory

az monitor health-models entity get-signal-history --resource-group rgopenapi --health-model-name myHealthModel --entity-name entity1 --signal-name uniqueSignalName1 --start-at 2025-12-11T10:00:00Z --end-at 2025-12-12T10:00:00Z --top 7

Required Parameters

--signal-name

Name of the signal to get history for.

Property	Value
Parameter group:	Body Arguments

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

--end-at

End time for the history query. Defaults to now if not specified.

Property	Value
Parameter group:	Body Arguments

--entity-name

Name of the entity. 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

--next-marker

An opaque string value that identifies the portion of the result set to be returned with the next operation. Must not be combined with startAt or endAt.

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

--start-at

Start time for the history query. Defaults to 24 hours ago if not specified.

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

--top

Maximum number of data points to return per page. Defaults to 1000.

Property	Value
Parameter group:	Body Arguments
Default value:	1000

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 entity get-signal-recommendations

Preview

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

Get recommended signal configurations for a given Entity (only applicable for Entities representing Azure resources).

az monitor health-models entity get-signal-recommendations [--acquire-policy-token]
                                                           [--change-reference]
                                                           [--entity-name]
                                                           [--health-model-name]
                                                           [--ids]
                                                           [--resource-group]
                                                           [--subscription]

Examples

Entities_GetSignalRecommendations

az monitor health-models entity get-signal-recommendations --resource-group rgopenapi --health-model-name myHealthModel --entity-name entity1

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

--entity-name

Name of the entity. 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 entity ingest-health-report

Preview

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

Ingest a health report for a specific signal on an entity (the entity must already exist).

az monitor health-models entity ingest-health-report --health-state {Degraded, Deleted, Healthy, Unhealthy, Unknown}
                                                     --signal-name
                                                     [--acquire-policy-token]
                                                     [--additional-context]
                                                     [--change-reference]
                                                     [--entity-name]
                                                     [--evaluation-rules]
                                                     [--expires-in-minutes]
                                                     [--health-model-name]
                                                     [--ids]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--value]

Examples

Entities_IngestHealthReport

az monitor health-models entity ingest-health-report --resource-group rgopenapi --health-model-name myHealthModel --entity-name entity1 --signal-name uniqueSignalName1 --value 85.5 --health-state Degraded --evaluation-rules "{degraded-rule:{operator:GreaterThan,threshold:70},unhealthy-rule:{operator:GreaterThan,threshold:90}}" --expires-in-minutes 60 --additional-context "CPU usage elevated due to batch processing job"

Required Parameters

--health-state

Health state to report for the signal.

Property	Value
Parameter group:	Body Arguments
Accepted values:	Degraded, Deleted, Healthy, Unhealthy, Unknown

--signal-name

Name of the entity signal to report health for.

Property	Value
Parameter group:	Body Arguments

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

--additional-context

Optional additional context or description for the health report.

Property	Value
Parameter group:	Body Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--entity-name

Name of the entity. Must be unique within a health model.

Property	Value
Parameter group:	Resource Id Arguments

--evaluation-rules

Evaluation rules that were used to determine the reported health state Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

--expires-in-minutes

Number of minutes until the health report expires. Defaults to 60 (1 hour) if not specified.

Property	Value
Parameter group:	Body Arguments
Default value:	60

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

--value

Reported value of the signal.

Property	Value
Parameter group:	Body 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 entity list

Preview

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

List Entity resources by HealthModel.

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

Examples

Entities_ListByHealthModel

az monitor health-models entity list --resource-group rgopenapi --health-model-name gPWT6GP85xRV248L7LhNRTD--2Yc73wu-5Qk-0tS

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 entity show

Preview

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

Get a Entity.

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

Examples

Entities_Get

az monitor health-models entity show --resource-group rgopenapi --health-model-name myHealthModel --entity-name entity1

Optional Parameters

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

--entity-name --name -n

Name of the entity. 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 entity update

Preview

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

Update a Entity.

az monitor health-models entity update [--acquire-policy-token]
                                       [--add]
                                       [--alerts]
                                       [--canvas-position]
                                       [--change-reference]
                                       [--display-name]
                                       [--entity-name --name]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--health-model-name]
                                       [--health-objective]
                                       [--icon]
                                       [--ids]
                                       [--impact {Limited, Standard, Suppressed}]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--signal-groups]
                                       [--subscription]
                                       [--tags]

Examples

Entities_CreateOrUpdate

az monitor health-models entity update --resource-group rgopenapi --health-model-name myHealthModel --entity-name uszrxbdkxesdrxhmagmzywebgbjj --display-name "My entity" --canvas-position "{x:14,y:13}" --icon "{icon-name:Custom,custom-data:rcitntvapruccrhtxmkqjphbxunkz}" --health-objective 62 --impact Standard --tags "{key1376:'sample tag'}" --signal-groups "{azure-resource:{authentication-setting:auth123,azure-resource-id:/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1,azure-resource-kind:functionapp,signals:[{signalKind:AzureResourceMetric,name:uniqueSignalName1,signal-definition-name:sigdef1,metric-namespace:microsoft.compute/virtualMachines,metric-name:cpuusage,aggregation-type:None,dimension-filter:'node eq '/node1'/',display-name:'CPU usage',refresh-interval:PT1M,time-grain:PT1M,data-unit:Count,evaluation-rules:{degradedRule:{operator:LowerThan,threshold:10},unhealthyRule:{operator:LowerThan,threshold:1}}}]},azure-log-analytics:{authentication-setting:auth123,log-analytics-workspace-resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.OperationalInsights/workspaces/myworkspace,signals:[{signalKind:LogAnalyticsQuery,name:uniqueSignalName2,signal-definition-name:null,evaluation-rules:{degradedRule:{operator:GreaterThan,threshold:1},unhealthyRule:{operator:GreaterThan,threshold:5}},refresh-interval:PT1M,query-text:'print 1',time-grain:PT30M,value-column-name:result,display-name:'Test LA signal',data-unit:'my unit'}]},azure-monitor-workspace:{authentication-setting:auth123,azure-monitor-workspace-resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.OperationalInsights/workspaces/myworkspace,signals:[{signalKind:PrometheusMetricsQuery,name:pod-cpu-usage,signal-definition-name:PodCpuUsageDefinition,display-name:'Pod CPU Usage',refresh-interval:PT1M,data-unit:Percent,query-text:\'rate(container_cpu_usage_seconds_total{pod=~"my-app-.*"}[5m]) * 100\',time-grain:PT5M,evaluation-rules:{degradedRule:{operator:GreaterThan,threshold:70},unhealthyRule:{operator:GreaterThan,threshold:90}}}]},dependencies:{aggregation-type:MinHealthy,unit:Percentage,degraded-threshold:80,unhealthy-threshold:50}}" --alerts "{unhealthy:{severity:Sev1,description:'Alert description',actionGroupIds:[/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Insights/actionGroups/myactiongroup]},degraded:{severity:Sev4,description:'Alert description',actionGroupIds:[/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Insights/actionGroups/myactiongroup]}}"

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

--alerts

Alert configuration for this entity Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--canvas-position

Positioning of the entity on the model canvas Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--display-name

Display name.

Property	Value
Parameter group:	Properties Arguments

--entity-name --name -n

Name of the entity. Must be unique within a health model.

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

--health-model-name

Name of health model resource.

Property	Value
Parameter group:	Resource Id Arguments

--health-objective

Health objective as a percentage of time the entity should be healthy.

Property	Value
Parameter group:	Properties Arguments

--icon

Visual icon definition. If not set, a default icon is used. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--impact

Impact of the entity in health state propagation.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Limited, Standard, Suppressed

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

--signal-groups

Signal groups which are assigned to this entity 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

--tags

Optional set of tags (key-value pairs) 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.

--verbose

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

Property	Value
Default value:	False

az monitor health-models entity wait

Preview

Command group 'az monitor health-models entity' 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 entity wait [--acquire-policy-token]
                                     [--change-reference]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--entity-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

--entity-name --name -n

Name of the entity. 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