Share via


az grafana folder

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

Commands to manage folders of an instance.

Commands

Name Description Type Status
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 folder create

Create a new folder.

az grafana folder create --name
                         --title
                         [--api-key]
                         [--resource-group]

Required Parameters

--name -n

Name of the Azure Managed Grafana.

--title

Title of the folder.

Optional Parameters

--api-key --token -t

Api key or service account token, a randomly generated string used to interact with Grafana endpoint; if missing, CLI will use current logged-in user's credentials.

--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 grafana folder delete

Delete a folder.

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

Required Parameters

--folder

Id, uid, title which can identify a folder. CLI will search in the order of id, uid, and title, till finds a match.

--name -n

Name of the Azure Managed Grafana.

Optional Parameters

--api-key --token -t

Api key or service account token, a randomly generated string used to interact with Grafana endpoint; if missing, CLI will use current logged-in user's credentials.

--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 grafana folder list

List all folders of an instance.

az grafana folder list --name
                       [--api-key]
                       [--resource-group]

Required Parameters

--name -n

Name of the Azure Managed Grafana.

Optional Parameters

--api-key --token -t

Api key or service account token, a randomly generated string used to interact with Grafana endpoint; if missing, CLI will use current logged-in user's credentials.

--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 grafana folder show

Get the details of a folder.

az grafana folder show --folder
                       --name
                       [--api-key]
                       [--resource-group]

Required Parameters

--folder

Id, uid, title which can identify a folder. CLI will search in the order of id, uid, and title, till finds a match.

--name -n

Name of the Azure Managed Grafana.

Optional Parameters

--api-key --token -t

Api key or service account token, a randomly generated string used to interact with Grafana endpoint; if missing, CLI will use current logged-in user's credentials.

--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 grafana folder update

Update a folder.

az grafana folder update --folder
                         --name
                         --title
                         [--api-key]
                         [--resource-group]

Required Parameters

--folder

Id, uid, title which can identify a folder. CLI will search in the order of id, uid, and title, till finds a match.

--name -n

Name of the Azure Managed Grafana.

--title

Title of the folder.

Optional Parameters

--api-key --token -t

Api key or service account token, a randomly generated string used to interact with Grafana endpoint; if missing, CLI will use current logged-in user's credentials.

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