az monitor health-models

  • 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 command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure Monitor health models.

Commands

Name Description Type Status
az monitor health-models authentication-setting

Manage Authenticationsetting.

 Extension Preview
az monitor health-models authentication-setting create

Create a AuthenticationSetting.

 Extension Preview
az monitor health-models authentication-setting delete

Delete a AuthenticationSetting.

 Extension Preview
az monitor health-models authentication-setting list

List AuthenticationSetting resources by HealthModel.

 Extension Preview
az monitor health-models authentication-setting show

Get a AuthenticationSetting.

 Extension Preview
az monitor health-models authentication-setting update

Update a AuthenticationSetting.

 Extension Preview
az monitor health-models authentication-setting wait

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

 Extension Preview
az monitor health-models create

Create a HealthModel.

 Extension Preview
az monitor health-models delete

Delete a HealthModel.

 Extension Preview
az monitor health-models discovery-rule

Manage Discoveryrule.

 Extension Preview
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 entity

Manage Entity.

 Extension Preview
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 identity

Manage Identity.

 Extension Preview
az monitor health-models identity assign

Assign the user or system managed identities.

 Extension Preview
az monitor health-models identity remove

Remove the user or system managed identities.

 Extension Preview
az monitor health-models identity show

Show the details of managed identities.

 Extension Preview
az monitor health-models identity wait

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

 Extension Preview
az monitor health-models list

List HealthModel resources by subscription ID.

 Extension Preview
az monitor health-models relationship

Manage Relationship.

 Extension Preview
az monitor health-models relationship create

Create a Relationship.

 Extension Preview
az monitor health-models relationship delete

Delete a Relationship.

 Extension Preview
az monitor health-models relationship list

List Relationship resources by HealthModel.

 Extension Preview
az monitor health-models relationship show

Get a Relationship.

 Extension Preview
az monitor health-models relationship update

Update a Relationship.

 Extension Preview
az monitor health-models relationship wait

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

 Extension Preview
az monitor health-models show

Get a HealthModel.

 Extension Preview
az monitor health-models signal-definition

Manage Signaldefinition.

 Extension Preview
az monitor health-models signal-definition create

Create a SignalDefinition.

 Extension Preview
az monitor health-models signal-definition delete

Delete a SignalDefinition.

 Extension Preview
az monitor health-models signal-definition list

List SignalDefinition resources by HealthModel.

 Extension Preview
az monitor health-models signal-definition show

Get a SignalDefinition.

 Extension Preview
az monitor health-models signal-definition update

Update a SignalDefinition.

 Extension Preview
az monitor health-models signal-definition wait

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

 Extension Preview
az monitor health-models update

Update a HealthModel.

 Extension Preview
az monitor health-models wait

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

 Extension Preview

az monitor health-models create

Preview

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

Create a HealthModel.

az monitor health-models create --health-model-name --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--location]
                                [--mi-system-assigned --system-assigned]
                                [--mi-user-assigned --user-assigned]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--tags]

Examples

HealthModels_Create

az monitor health-models create --resource-group rgopenapi --health-model-name model1 --type SystemAssigned, UserAssigned --user-assigned-identities "{/subscriptions/4980D7D5-4E07-47AD-AD34-E76C6BC9F061/resourceGroups/rgopenapi/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ua1:{}}" --tags "{key2961:hbljozzkqrpcthsjtfkyozpwyx}" --location eastus2

Required Parameters

--health-model-name --name -n

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

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--location -l

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

Property Value
Parameter group: Resource Arguments
--mi-system-assigned --system-assigned

Set the system managed identity.

Property Value
Parameter group: Identity Arguments
--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

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

Preview

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

Delete a HealthModel.

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

Examples

HealthModels_Delete

az monitor health-models delete --resource-group rgopenapi --health-model-name model1

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
--health-model-name --name -n

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 list

Preview

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

List HealthModel resources by subscription ID.

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

Examples

HealthModels_ListBySubscription

az monitor health-models list

HealthModels_ListByResourceGroup

az monitor health-models list --resource-group rgopenapi

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
--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

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 show

Preview

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

Get a HealthModel.

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

Examples

HealthModels_Get

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

Optional Parameters

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

--health-model-name --name -n

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 update

Preview

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

Update a HealthModel.

az monitor health-models update [--acquire-policy-token]
                                [--add]
                                [--change-reference]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--health-model-name --name]
                                [--ids]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--subscription]
                                [--tags]

Examples

HealthModels_Create

az monitor health-models update --resource-group rgopenapi --health-model-name model1 --type SystemAssigned, UserAssigned --user-assigned-identities "{/subscriptions/4980D7D5-4E07-47AD-AD34-E76C6BC9F061/resourceGroups/rgopenapi/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ua1:{}}" --tags "{key2961:hbljozzkqrpcthsjtfkyozpwyx}"

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

The related change reference ID for this resource operation.

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

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

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

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

Preview

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

Wait until the resource exists.

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

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