az grafana

Note

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

Commands to manage Azure Grafana instanced.

For optimized experience, not all data plane Apis, documented at https://grafana.com/docs/grafana/latest/http_api/, are exposed. On coverage gap, please reach out to ad4g@microsoft.com.

Commands

az grafana api-key

Commands to manage api keys.

az grafana api-key create

Create a new api key.

az grafana api-key delete

Delete an api key.

az grafana api-key list

List existing api keys.

az grafana create

Create a Azure Managed Grafana instance.

az grafana dashboard

Commands to manage dashboards of an instance.

az grafana dashboard create

Create a new dashboard.

az grafana dashboard delete

Delete a dashboard.

az grafana dashboard import

Import a dashboard.

az grafana dashboard list

List all dashboards of an instance.

az grafana dashboard show

Show the detail of a dashboard.

az grafana dashboard update

Update a dashboard.

az grafana data-source

Commands to manage data sources of an instance.

az grafana data-source create

Create a data source.

az grafana data-source delete

Delete a data source.

az grafana data-source list

List all data sources of an instance.

az grafana data-source query

Query a data source having backend implementation.

az grafana data-source show

Get details of a data source.

az grafana data-source update

Update a data source.

az grafana delete

Delete a Azure Managed Grafana instance.

az grafana folder

Commands to manage folders of an instance.

az grafana folder create

Create a new folder.

az grafana folder delete

Delete a folder.

az grafana folder list

List all folders of an instance.

az grafana folder show

Show the details of a folder.

az grafana folder update

Update a folder.

az grafana list

List Azure Managed Grafana instances.

az grafana notification-channel

Commands to manage notification channels of an instance.

az grafana notification-channel create

Create a notification channel.

az grafana notification-channel delete

Delete a notification channel.

az grafana notification-channel list

List all notification channels of an instance.

az grafana notification-channel show

Get details of a notification channel.

az grafana notification-channel test

Tests a notification channels.

az grafana notification-channel update

Update a notification channel.

az grafana show

Show details of a Azure Managed Grafana instance.

az grafana update

Update a Azure Managed Grafana instance.

az grafana user

Commands to manage users of an instance.

az grafana user actual-user

Show details of current user.

az grafana user list

List users.

az grafana user show

Show detail of a user.

az grafana create

Create a Azure Managed Grafana instance.

az grafana create --name
                  --resource-group
                  [--location]
                  [--principal-ids]
                  [--skip-role-assignments {false, true}]
                  [--skip-system-assigned-identity {false, true}]
                  [--tags]
                  [--zone-redundancy {Disabled, Enabled}]

Required Parameters

--name -n

Name of the Azure Managed Dashboard for Grafana.

--resource-group -g

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

Optional Parameters

--location -l

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

--principal-ids

Space-separated Azure AD object ids for users, groups, etc to be made as Grafana Admins. Once provided, CLI won't make the current logon user as Grafana Admin.

--skip-role-assignments

Do not create role assignments for managed identity and the current login user.

accepted values: false, true
--skip-system-assigned-identity -s

Do not enable system assigned identity.

accepted values: false, true
--tags

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

--zone-redundancy

Indicates whether or not zone redundancy should be enabled. Default: Disabled.

accepted values: Disabled, Enabled

az grafana delete

Delete a Azure Managed Grafana instance.

az grafana delete --name
                  [--resource-group]
                  [--yes]

Required Parameters

--name -n

Name of the Azure Managed Dashboard for Grafana.

Optional Parameters

--resource-group -g

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

--yes -y

Do not prompt for confirmation.

az grafana list

List Azure Managed Grafana instances.

az grafana list [--resource-group]

Optional Parameters

--resource-group -g

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

az grafana show

Show details of a Azure Managed Grafana instance.

az grafana show --name
                [--resource-group]

Required Parameters

--name -n

Name of the Azure Managed Dashboard for Grafana.

Optional Parameters

--resource-group -g

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

az grafana update

Update a Azure Managed Grafana instance.

az grafana update --name
                  [--api-key {Disabled, Enabled}]
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--resource-group]
                  [--tags]

Required Parameters

--name -n

Name of the Azure Managed Dashboard for Grafana.

Optional Parameters

--api-key

If enabled, you will be able to configur Grafana api keys.

accepted values: Disabled, Enabled
--deterministic-outbound-ip -i

If enabled, the Grafana workspace will have fixed egress IPs you can use them in the firewall of datasources.

accepted values: Disabled, Enabled
--resource-group -g

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

--tags

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