Share via

az healthbot

  • Experimental
  • Reference

Note

This reference is part of the healthbot extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az healthbot command. Learn more about extensions.

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

Manage bot with healthbot.

Commands

Name Description Type Status
az healthbot create

Create a new HealthBot.

 Extension Experimental
az healthbot delete

Delete a HealthBot.

 Extension Experimental
az healthbot list

Returns all the resources of a particular type belonging to a resource group And Returns all the resources of a particular type belonging to a subscription.

 Extension Experimental
az healthbot show

Get a HealthBot.

 Extension Experimental
az healthbot update

Patch a HealthBot.

 Extension Experimental
az healthbot wait

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

 Extension Experimental

az healthbot create

Experimental

Command group 'healthbot' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new HealthBot.

az healthbot create --bot-name
                    --resource-group
                    --sku {C0, F0, S1}
                    [--location]
                    [--no-wait]
                    [--tags]

Examples

BotCreate

az healthbot create --name "samplebotname" --location "East US" --sku "F0" --resource-group "healthbotClient"

Required Parameters

--bot-name --name -n

The name of the Bot resource.

--resource-group -g

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

--sku

The name of the HealthBot SKU.

Accepted values: C0, F0, S1

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Default value: False
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az healthbot delete

Experimental

Command group 'healthbot' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a HealthBot.

az healthbot delete [--bot-name]
                    [--ids]
                    [--no-wait]
                    [--resource-group]
                    [--subscription]
                    [--yes]

Examples

BotDelete

az healthbot delete --name "samplebotname" --resource-group "healthbotClient"

Optional Parameters

--bot-name --name -n

The name of the Bot resource.

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

--no-wait

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

Default value: False
--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az healthbot list

Experimental

Command group 'healthbot' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Returns all the resources of a particular type belonging to a resource group And Returns all the resources of a particular type belonging to a subscription.

az healthbot list [--resource-group]

Examples

List Bots by Resource Group

az healthbot list --resource-group "OneResourceGroupName"

List Bots by Subscription

az healthbot list

Optional Parameters

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az healthbot show

Experimental

Command group 'healthbot' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a HealthBot.

az healthbot show [--bot-name]
                  [--ids]
                  [--resource-group]
                  [--subscription]

Examples

ResourceInfoGet

az healthbot show --name "samplebotname" --resource-group "healthbotClient"

Optional Parameters

--bot-name --name -n

The name of the Bot resource.

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

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az healthbot update

Experimental

Command group 'healthbot' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Patch a HealthBot.

az healthbot update [--bot-name]
                    [--ids]
                    [--resource-group]
                    [--sku {C0, F0, S1}]
                    [--subscription]
                    [--tags]

Examples

BotUpdate

az healthbot update --bot-name "samplebotname" --name "F0" --resource-group "healthbotClient"

Optional Parameters

--bot-name --name -n

The name of the Bot resource.

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

--resource-group -g

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

--sku

The name of the HealthBot SKU.

Accepted values: C0, F0, S1
--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az healthbot wait

Experimental

Command group 'healthbot' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az healthbot wait [--bot-name]
                  [--created]
                  [--custom]
                  [--deleted]
                  [--exists]
                  [--ids]
                  [--interval]
                  [--resource-group]
                  [--subscription]
                  [--timeout]
                  [--updated]

Examples

Pause executing next line of CLI script until the healthbot is successfully created.

az healthbot wait --name "samplebotname" --resource-group "healthbotClient" --created

Pause executing next line of CLI script until the healthbot is successfully deleted.

az healthbot wait --name "samplebotname" --resource-group "healthbotClient" --deleted

Optional Parameters

--bot-name --name -n

The name of the Bot resource.

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.