az monitor health-models authentication-setting

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 authentication-setting 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 Authenticationsetting.

Commands

Name	Description	Type	Status
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 authentication-setting create

Preview

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

Create a AuthenticationSetting.

az monitor health-models authentication-setting create --authentication-setting-name --name
                                                       --health-model-name
                                                       --resource-group
                                                       [--acquire-policy-token]
                                                       [--change-reference]
                                                       [--display-name]
                                                       [--managed-identity]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

AuthenticationSettings_CreateOrUpdate

az monitor health-models authentication-setting create --resource-group myResourceGroup --health-model-name myHealthModel --authentication-setting-name myAuthSetting --display-name myDisplayName

Required Parameters

--authentication-setting-name --name -n

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

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

--managed-identity

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

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

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 authentication-setting delete

Preview

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

Delete a AuthenticationSetting.

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

Examples

AuthenticationSettings_Delete

az monitor health-models authentication-setting delete --resource-group my-resource-group --health-model-name my-health-model --authentication-setting-name my-auth-setting

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

--authentication-setting-name --name -n

Name of the authentication setting. Must be unique within a health model.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy 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 authentication-setting list

Preview

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

List AuthenticationSetting resources by HealthModel.

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

Examples

AuthenticationSettings_ListByHealthModel

az monitor health-models authentication-setting 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

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 authentication-setting show

Preview

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

Get a AuthenticationSetting.

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

Examples

AuthenticationSettings_Get

az monitor health-models authentication-setting show --resource-group my-resource-group --health-model-name my-health-model --authentication-setting-name my-auth-setting

Optional Parameters

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

--authentication-setting-name --name -n

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

Preview

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

Update a AuthenticationSetting.

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

Examples

AuthenticationSettings_CreateOrUpdate

az monitor health-models authentication-setting update --resource-group myResourceGroup --health-model-name myHealthModel --authentication-setting-name myAuthSetting --display-name myDisplayName

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

--authentication-setting-name --name -n

Name of the authentication setting. Must be unique within a health model.

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

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

--managed-identity

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

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

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

Property	Value
Default value:	False

az monitor health-models authentication-setting wait

Preview

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

--authentication-setting-name --name -n

Name of the authentication setting. Must be unique within a health model.

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