az portal dashboard

Manage portal dashboards.

Commands

az portal dashboard create

Creates or updates a dashboard.

az portal dashboard delete

Deletes a dashboard.

az portal dashboard import

Imports a dashboard from a JSON file.

az portal dashboard list

Lists the dashboards within a subscription or resource group.

az portal dashboard show

Gets details for a single dashboard.

az portal dashboard update

Updates an existing dashboard.

az portal dashboard create

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.

az portal dashboard delete

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.

az portal dashboard import

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.

az portal dashboard list

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.

az portal dashboard show

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

az portal dashboard update

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.