az grafana api-key

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 api-key command. Learn more about extensions.

Commands to manage api keys.

Commands

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 api-key create

Create a new api key.

az grafana api-key create --key
                          --name
                          [--resource-group]
                          [--role {Admin, Editor, Viewer}]
                          [--time-to-live]

Required Parameters

--key

Api key name.

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

--role

Grafana role name.

accepted values: Admin, Editor, Viewer
default value: Viewer
--time-to-live

The API key life duration. For example, 1d if your key is going to last fr one day. Supported units are: s,m,h,d,w,M,y.

default value: 1d

az grafana api-key delete

Delete an api key.

az grafana api-key delete --key
                          --name
                          [--resource-group]

Required Parameters

--key

Id or name that identify an api-key to delete.

--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 api-key list

List existing api keys.

az grafana api-key list --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>.