Share via

az portal dashboard

  • Experimental
  • Reference

Note

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

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

Manage portal dashboards.

Commands

Name Description Type Status
az portal dashboard create

Creates or updates a dashboard.

 Extension Experimental
az portal dashboard delete

Deletes a dashboard.

 Extension Experimental
az portal dashboard import

Imports a dashboard from a JSON file.

 Extension Experimental
az portal dashboard list

Lists the dashboards within a subscription or resource group.

 Extension Experimental
az portal dashboard show

Gets details for a single dashboard.

 Extension Experimental
az portal dashboard update

Updates an existing dashboard.

 Extension Experimental

az portal dashboard create

Experimental

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

Creates or updates a dashboard.

az portal dashboard create --input-path
                           --name
                           --resource-group
                           [--location]
                           [--tags]

Examples

Create or update a Dashboard

az portal dashboard create --location "eastus" --name "testDashboard" \
--resource-group "testRG" --input-path "/src/json/properties.json" \
--tags aKey=aValue anotherKey=anotherValue

Required Parameters

--input-path

The path to the dashboard properties JSON file.

--name -n

The name of the dashboard.

--resource-group -g

The name of the resource group.

Optional Parameters

--location -l

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

--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 portal dashboard delete

Experimental

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

Deletes a dashboard.

az portal dashboard delete --name
                           --resource-group
                           [--yes]

Examples

Delete a Dashboard

az portal dashboard delete --name "testDashboard" --resource-group "testRG"

Required Parameters

--name -n

The name of the dashboard.

--resource-group -g

The name of the resource group.

Optional Parameters

--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 portal dashboard import

Experimental

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

Imports a dashboard from a JSON file.

az portal dashboard import --input-path
                           --resource-group
                           [--name]

Examples

Import a Dashboard

az portal dashboard import --name "testDashboard" --resource-group "testRG" \
--input-path "/src/json/dashboard.json"

Required Parameters

--input-path

The path to the dashboard json file.

--resource-group -g

The name of the resource group.

Optional Parameters

--name -n

The name of the dashboard.

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 portal dashboard list

Experimental

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

Lists the dashboards within a subscription or resource group.

az portal dashboard list [--resource-group]

Examples

List all dashboards in a resourceGroup

az portal dashboard list --resource-group "testRG"

List all dashboards in a subscription

az portal dashboard list

Optional Parameters

--resource-group -g

The name of the resource group.

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 portal dashboard show

Experimental

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

Gets details for a single dashboard.

az portal dashboard show --name
                         --resource-group

Examples

Get a Dashboard

az portal dashboard show --name "testDashboard" --resource-group "testRG"

Required Parameters

--name -n

The name of the dashboard.

--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 portal dashboard update

Experimental

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

Updates an existing dashboard.

az portal dashboard update --input-path
                           --name
                           --resource-group

Examples

Update a Dashboard

az portal dashboard update --name "testDashboard" --resource-group "testRG" \
--input-path "/src/json/properties.json"

Required Parameters

--input-path

The path to the dashboard properties JSON file.

--name -n

The name of the dashboard.

--resource-group -g

The name of the resource group.

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.