az grafana

Commands

Name	Description	Type	Status
az grafana api-key	Commands to manage API keys.	Extension	Deprecated
az grafana api-key create	Create a new API key.	Extension	Deprecated
az grafana api-key delete	Delete an API key.	Extension	Deprecated
az grafana api-key list	List existing API keys.	Extension	Deprecated
az grafana backup	Backup an Azure Managed Grafana instance's content to an archive.	Extension	Preview
az grafana create	Create a workspace for Grafana resource. This API is idempotent, so user can either create a new grafana or update an existing grafana.	Extension	GA
az grafana dashboard	Commands to manage dashboards of an instance.	Extension	GA
az grafana dashboard create	Create a new dashboard.	Extension	GA
az grafana dashboard delete	Delete a dashboard.	Extension	GA
az grafana dashboard import	Import a dashboard.	Extension	GA
az grafana dashboard list	List all dashboards of an instance.	Extension	GA
az grafana dashboard show	Get the details of a dashboard.	Extension	GA
az grafana dashboard sync	Sync Azure Managed Grafana dashboards from one instance to another instance. Library panels within the dashboards will be automatically included in the sync. Note, dashboards with "Provisioned" state will be skipped due to being read-only.	Extension	Preview
az grafana dashboard update	Update a dashboard.	Extension	GA
az grafana data-source	Commands to manage data sources of an instance.	Extension	GA
az grafana data-source create	Create a data source.	Extension	GA
az grafana data-source delete	Delete a data source.	Extension	GA
az grafana data-source list	List all data sources of an instance.	Extension	GA
az grafana data-source query	Query a data source having backend implementation.	Extension	GA
az grafana data-source show	Get the details of a data source.	Extension	GA
az grafana data-source update	Update a data source.	Extension	GA
az grafana delete	Delete a workspace for Grafana resource.	Extension	GA
az grafana folder	Commands to manage folders of an instance.	Extension	GA
az grafana folder create	Create a new folder.	Extension	GA
az grafana folder delete	Delete a folder.	Extension	GA
az grafana folder list	List all folders of an instance.	Extension	GA
az grafana folder show	Get the details of a folder.	Extension	GA
az grafana folder update	Update a folder.	Extension	GA
az grafana integrations	Commands to manage integrations of a Grafana instance.	Extension	GA
az grafana integrations monitor	Commands to manage Azure Monitor workspace integrations of a Grafana instance.	Extension	GA
az grafana integrations monitor add	Link an Azure Monitor workspace to a Grafana instance.	Extension	Preview
az grafana integrations monitor delete	Unlink an Azure Monitor workspace from a Grafana instance.	Extension	Preview
az grafana integrations monitor list	List all Azure Monitor workspaces linked to a Grafana instance.	Extension	Preview
az grafana list	List all resources of workspaces for Grafana under the specified subscription.	Extension	GA
az grafana list-available-plugin	List all the available plugins.	Extension	GA
az grafana migrate	Migrate an existing Grafana instance to an Azure Managed Grafana instance.	Extension	Preview
az grafana mpe	Commands to manage managed private endpoints.	Extension	GA
az grafana mpe create	Create a managed private endpoint.	Extension	GA
az grafana mpe delete	Delete a managed private endpoint.	Extension	GA
az grafana mpe list	List all managed private endpoints.	Extension	GA
az grafana mpe refresh	Refresh and sync managed private endpoints to latest state.	Extension	GA
az grafana mpe show	Get a specific managed private endpoint.	Extension	GA
az grafana mpe wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az grafana notification-channel	Commands to manage notification channels of an instance.	Extension	Deprecated
az grafana notification-channel create	Create a notification channel.	Extension	Deprecated
az grafana notification-channel delete	Delete a notification channel.	Extension	Deprecated
az grafana notification-channel list	List all notification channels of an instance.	Extension	Deprecated
az grafana notification-channel show	Get the details of a notification channel.	Extension	Deprecated
az grafana notification-channel test	Test a notification channel.	Extension	Deprecated
az grafana notification-channel update	Update a notification channel.	Extension	Deprecated
az grafana private-endpoint-connection	Commands to manage private endpoint connections.	Extension	GA
az grafana private-endpoint-connection delete	Delete a private endpoint connection.	Extension	GA
az grafana private-endpoint-connection list	List all private endpoint connections.	Extension	GA
az grafana private-endpoint-connection show	Get a specific private endpoint connection.	Extension	GA
az grafana private-endpoint-connection update	Update a private endpoint connection.	Extension	GA
az grafana private-endpoint-connection wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az grafana restore	Restore an Azure Managed Grafana instance from an archive.	Extension	Preview
az grafana service-account	Commands to manage service accounts.	Extension	GA
az grafana service-account create	Create a new service account.	Extension	GA
az grafana service-account delete	Delete a service account.	Extension	GA
az grafana service-account list	List existing service accounts.	Extension	GA
az grafana service-account show	Get the details of a service account.	Extension	GA
az grafana service-account token	Commands to manage service account tokens.	Extension	GA
az grafana service-account token create	Create a new service account token.	Extension	GA
az grafana service-account token delete	Delete a service account token.	Extension	GA
az grafana service-account token list	List existing service account tokens.	Extension	GA
az grafana service-account update	Update a service account.	Extension	GA
az grafana show	Get the properties of a specific workspace for Grafana resource.	Extension	GA
az grafana update	Update a workspace for Grafana resource.	Extension	GA
az grafana user	Commands to manage users of an instance.	Extension	GA
az grafana user actual-user	Get the details of the current user.	Extension	GA
az grafana user list	List users.	Extension	GA
az grafana user show	Get the details of a user.	Extension	GA
az grafana wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az grafana backup --name
                  [--components {annotations, dashboards, datasources, folders, snapshots}]
                  [--directory]
                  [--folders-to-exclude]
                  [--folders-to-include]
                  [--resource-group]
                  [--skip-folder-permissions {false, true}]

Examples

backup dashboards under 2 folders (data sources are included to enable name remapping when restore dashboards to another workspace)

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp --folders-to-include "Prod" "Compute Gateway" --components datasources dashboards folders

backup dashboards and skip a few folders

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp  --folders-to-exclude General "Azure Monitor" --components datasources dashboards folders

Required Parameters

Optional Parameters

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

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 grafana create --name --workspace-name
                  --resource-group
                  [--api-key --service-account {Disabled, Enabled}]
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--grafana-major-version]
                  [--___location]
                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                  [--principal-ids]
                  [--public-network-access {Disabled, Enabled}]
                  [--skip-identity --skip-system-assigned-identity {0, 1, f, false, n, no, t, true, y, yes}]
                  [--skip-role-assignments {0, 1, f, false, n, no, t, true, y, yes}]
                  [--sku-tier]
                  [--tags]
                  [--zone-redundancy {Disabled, Enabled}]

Examples

create Azure Managed Grafana resource with Standard Sku and public network access enabled

az grafana create --resource-group myResourceGroup --workspace-name myWorkspace --sku-tier Standard --public-network-access Enabled

Required Parameters

Optional Parameters

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

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 grafana delete [--ids]
                  [--name --workspace-name]
                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                  [--resource-group]
                  [--subscription]
                  [--yes]

Optional Parameters

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

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 grafana list [--max-items]
                [--next-token]
                [--resource-group]

Optional Parameters

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

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 grafana list-available-plugin [--ids]
                                 [--name --workspace-name]
                                 [--resource-group]
                                 [--subscription]

Optional Parameters

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

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 grafana migrate --name
                   --src-endpoint
                   --src-token-or-key
                   [--dry-run {false, true}]
                   [--folders-to-exclude]
                   [--folders-to-include]
                   [--overwrite {false, true}]
                   [--resource-group]

Examples

Migrate dashboards and folders from a local Grafana instance to an Azure Managed Grafana instance.

az grafana migrate -g MyResourceGroup -n MyGrafana -s http://localhost:3000 -t YourServiceTokenOrAPIKey

Required Parameters

Optional Parameters

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

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 grafana restore --archive-file
                   --name
                   [--components {annotations, dashboards, datasources, folders, snapshots}]
                   [--remap-data-sources {false, true}]
                   [--resource-group]

Examples

Restore dashboards. If they are under folders, include "folders" in the components list; use "--remap-data-sources" so CLI will update dashboards to point to same data sources at target workspace

az grafana restore -g MyResourceGroup -n MyGrafana --archive-file backup\dashboards\ServiceHealth-202307051036.tar.gz --components dashboards folders --remap-data-sources

Required Parameters

Optional Parameters

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

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 grafana show [--ids]
                [--name --workspace-name]
                [--resource-group]
                [--subscription]

Optional Parameters

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

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 grafana update [--api-key --service-account {Disabled, Enabled}]
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--from-address]
                  [--from-name]
                  [--grafana-major-version --major-version]
                  [--host]
                  [--ids]
                  [--name --workspace-name]
                  [--password]
                  [--public-network-access {Disabled, Enabled}]
                  [--resource-group]
                  [--skip-verify {0, 1, f, false, n, no, t, true, y, yes}]
                  [--sku-tier]
                  [--smtp --smtp-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                  [--start-tls-policy {MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS}]
                  [--subscription]
                  [--tags]
                  [--user]
                  [--zone-redundancy {Disabled, Enabled}]

Examples

disable the public network access

az grafana update -g MyResourceGroup -n MyGrafana --public-network-access disabled

enable mail notification through SMTP relay sevice of mailgun

az grafana update -g MyResourceGroup -n MyGrafana --smtp enabled --from-address johndoe@outlook.com --from-name john --host "smtp.mailgun.org:587" --user "postmaster@sandbox12345.mailgun.org" --password "password" --start-tls-policy OpportunisticStartTLS --skip-verify true

Optional Parameters

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

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 grafana wait [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--ids]
                [--interval]
                [--name --workspace-name]
                [--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.

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