az grafana api-key

Note

このリファレンスは、Azure CLI (バージョン 2.61.0 以降) の amg 拡張機能の一部です。 az grafana api-key コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

このコマンド グループは非推奨となり、今後のリリースで削除される予定です。

API キーを管理するコマンド。

API キーは Grafana Labs によって非推奨となり、Grafana 12 以降ではサポートされません。 代わりにサービス アカウントを使用してください。

コマンド

名前 説明 状態
az grafana api-key create

新しい API キーを作成します。

Extension 推奨されない
az grafana api-key delete

API キーを削除します。

Extension 推奨されない
az grafana api-key list

既存の API キーを一覧表示します。

Extension 推奨されない

az grafana api-key create

非推奨

コマンド グループ 'grafana api-key' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。

新しい API キーを作成します。

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

新しい API キーを作成します。

az grafana api-key create -g myResourceGroup -n myGrafana --key myKey

必須のパラメーター

--key

API キー名。

--name -n

Azure Managed Grafana の名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--role -r

Grafana ロール名。

プロパティ
規定値: Viewer
指定可能な値: Admin, Editor, Viewer
--time-to-live

API キーの有効期間。 たとえば、キーが 1 日続く場合は 1d です。 サポートされる単位は、s、m、h、d、w、M、y です。

プロパティ
規定値: 1d
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az grafana api-key delete

非推奨

コマンド グループ 'grafana api-key' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。

API キーを削除します。

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

必須のパラメーター

--key

削除する API キーを識別する ID または名前。

--name -n

Azure Managed Grafana の名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az grafana api-key list

非推奨

コマンド グループ 'grafana api-key' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。

既存の API キーを一覧表示します。

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

必須のパラメーター

--name -n

Azure Managed Grafana の名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False