az grafana

注意

此參考是 Azure CLI 的 amg 延伸模組的一部分（2.38.0 版或更高版本）。 擴充功能會在您第一次執行 az grafana 命令時自動安裝。 深入了解擴充功能。

管理 Azure Grafana 實例的命令。

針對優化的體驗，並非所有記載於 https://grafana.com/docs/grafana/latest/http_api/的數據平面 API 都會公開。 在涵蓋範圍差距上，請連絡 ad4g@microsoft.com。

命令

名稱	Description	類型	狀態
az grafana api-key	管理 API 金鑰的命令。	副檔名	GA
az grafana api-key create	建立新的 API 金鑰。	副檔名	GA
az grafana api-key delete	刪除 API 金鑰。	副檔名	GA
az grafana api-key list	列出現有的 API 金鑰。	副檔名	GA
az grafana backup	將 Azure 受控 Grafana 實例的內容備份至封存。	副檔名	預覽​​
az grafana create	建立 Azure 受控 Grafana 實例。	副檔名	GA
az grafana dashboard	管理實例儀錶板的命令。	副檔名	GA
az grafana dashboard create	建立新的儀錶板。	副檔名	GA
az grafana dashboard delete	刪除儀錶板。	副檔名	GA
az grafana dashboard import	匯入儀錶板。	副檔名	GA
az grafana dashboard list	列出實例的所有儀錶板。	副檔名	GA
az grafana dashboard show	取得儀錶板的詳細數據。	副檔名	GA
az grafana dashboard sync	將 Azure 受控 Grafana 儀錶板從一個實例同步至另一個實例。 請注意，由於只讀，將會略過具有「已布建」狀態的儀錶板。	副檔名	預覽​​
az grafana dashboard update	更新儀錶板。	副檔名	GA
az grafana data-source	管理實例數據源的命令。	副檔名	GA
az grafana data-source create	建立資料來源。	副檔名	GA
az grafana data-source delete	刪除資料來源。	副檔名	GA
az grafana data-source list	列出實例的所有數據源。	副檔名	GA
az grafana data-source query	查詢具有後端實作的數據源。	副檔名	GA
az grafana data-source show	取得數據源的詳細數據。	副檔名	GA
az grafana data-source update	更新數據源。	副檔名	GA
az grafana delete	刪除 Azure 受控 Grafana 實例。	副檔名	GA
az grafana folder	管理實例資料夾的命令。	副檔名	GA
az grafana folder create	建立新資料夾。	副檔名	GA
az grafana folder delete	刪除資料夾。	副檔名	GA
az grafana folder list	列出實例的所有資料夾。	副檔名	GA
az grafana folder show	取得資料夾的詳細資料。	副檔名	GA
az grafana folder update	更新資料夾。	副檔名	GA
az grafana list	列出 Azure 受控 Grafana 實例。	副檔名	GA
az grafana notification-channel	管理實例通知通道的命令。	副檔名	GA
az grafana notification-channel create	建立通知通道。	副檔名	GA
az grafana notification-channel delete	刪除通知通道。	副檔名	GA
az grafana notification-channel list	列出實例的所有通知通道。	副檔名	GA
az grafana notification-channel show	取得通知通道的詳細數據。	副檔名	GA
az grafana notification-channel test	測試通知通道。	副檔名	GA
az grafana notification-channel update	更新通知通道。	副檔名	GA
az grafana restore	從封存還原 Azure 受控 Grafana 實例。	副檔名	預覽​​
az grafana service-account	管理服務帳戶的命令。	副檔名	GA
az grafana service-account create	建立新的服務帳戶。	副檔名	GA
az grafana service-account delete	刪除服務帳戶。	副檔名	GA
az grafana service-account list	列出現有的服務帳戶。	副檔名	GA
az grafana service-account show	取得服務帳戶的詳細數據。	副檔名	GA
az grafana service-account token	管理服務帳戶令牌的命令。	副檔名	GA
az grafana service-account token create	建立新的服務帳戶令牌。	副檔名	GA
az grafana service-account token delete	刪除服務帳戶令牌。	副檔名	GA
az grafana service-account token list	列出現有的服務帳戶令牌。	副檔名	GA
az grafana service-account update	更新服務帳戶。	副檔名	GA
az grafana show	顯示 Azure 受控 Grafana 實例的詳細數據。	副檔名	GA
az grafana update	更新 Azure 受控 Grafana 實例。	副檔名	GA
az grafana user	管理實例使用者的命令。	副檔名	GA
az grafana user actual-user	取得目前用戶的詳細數據。	副檔名	GA
az grafana user list	列出使用者。	副檔名	GA
az grafana user show	取得使用者的詳細數據。	副檔名	GA

az grafana backup

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

將 Azure 受控 Grafana 實例的內容備份至封存。

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

範例

2 個資料夾下的備份儀錶板（資料來源包含在內，以在將儀錶板還原至另一個工作區時啟用名稱重新對應）

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

備份儀錶板並略過幾個資料夾

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

必要參數

--name -n

Azure 受控 Grafana 的名稱。

選擇性參數

--components -c

要備份的 Grafana 成品類型。

接受的值: annotations, dashboards, datasources, folders, snapshots

--directory -d

要備份 Grafana 成品的目錄。

--folders-to-exclude -e

備份或同步處理中要排除的資料夾。

--folders-to-include -i

要包含在備份或同步處理中的資料夾。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az grafana create

建立 Azure 受控 Grafana 實例。

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

必要參數

--name -n

Azure 受控 Grafana 的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--deterministic-outbound-ip -i

如果啟用，Grafana 工作區將會有固定的輸出IP，您可以在數據源的防火牆中使用它們。 預設：已停用。

接受的值: Disabled, Enabled

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--principal-ids

要做為 Grafana 管理員 的使用者、群組等空間分隔 Azure AD 物件識別碼。 提供之後，CLI 將不會將目前的登入用戶設為 Grafana 管理員。

--principal-types

要與 --principal-ids 配對的空間分隔 Azure AD 主體類型。

接受的值: Group, ServicePrincipal, User

--skip-role-assignments

請勿為受控識別和目前的登入使用者建立角色指派。

接受的值: false, true

預設值: False

--skip-system-assigned-identity -s

請勿啟用系統指派的身分識別。

接受的值: false, true

預設值: False

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。

--zone-redundancy

指出是否應該啟用區域備援。 預設：已停用。

接受的值: Disabled, Enabled

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az grafana delete

刪除 Azure 受控 Grafana 實例。

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

必要參數

--name -n

Azure 受控 Grafana 的名稱。

選擇性參數

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--yes -y

不提示確認。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az grafana list

列出 Azure 受控 Grafana 實例。

az grafana list [--resource-group]

選擇性參數

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az grafana restore

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

從封存還原 Azure 受控 Grafana 實例。

az grafana restore --archive-file
                   --name
                   [--components {annotations, dashboards, datasources, folders, snapshots}]
                   [--remap-data-sources {false, true}]
                   [--resource-group]

範例

還原儀錶板。 如果它們位於資料夾下，請在元件清單中包含「資料夾」;使用 「--remap-data-sources」，因此 CLI 會更新儀錶板以指向目標工作區的相同數據源

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

必要參數

--archive-file -a

要從中還原 Grafana 成品的封存。

--name -n

Azure 受控 Grafana 的名稱。

選擇性參數

--components -c

要備份的 Grafana 成品類型。

接受的值: annotations, dashboards, datasources, folders, snapshots

--remap-data-sources -r

在還原期間，透過名稱比對，更新儀錶板以參考目的地工作區所定義的數據源。

接受的值: false, true

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az grafana show

顯示 Azure 受控 Grafana 實例的詳細數據。

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

必要參數

--name -n

Azure 受控 Grafana 的名稱。

選擇性參數

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az grafana update

更新 Azure 受控 Grafana 實例。

az grafana update --name
                  [--api-key {Disabled, Enabled}]
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--from-address]
                  [--from-name]
                  [--host]
                  [--major-version]
                  [--password]
                  [--public-network-access {Disabled, Enabled}]
                  [--resource-group]
                  [--skip-verify {false, true}]
                  [--smtp {Disabled, Enabled}]
                  [--start-tls-policy {MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS}]
                  [--tags]
                  [--user]

範例

停用公用網路存取

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

透過 MAILgun 的 SMTP 轉送裝置啟用郵件通知

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

必要參數

--name -n

Azure 受控 Grafana 的名稱。

選擇性參數

--api-key --service-account

如果已啟用，您將能夠設定 Grafana API 金鑰和服務帳戶。

接受的值: Disabled, Enabled

--deterministic-outbound-ip -i

如果啟用，Grafana 工作區將會有固定的輸出IP，您可以在數據源的防火牆中使用它們。

接受的值: Disabled, Enabled

--from-address

傳送電子郵件時所使用的位址。

--from-name

傳送電子郵件時要使用的名稱。

--host

SMTP 伺服器 URL（包含埠）。

--major-version

Grafana 主要版本號碼。

--password

SMTP 伺服器用戶密碼。

--public-network-access -p

允許公用網路存取。

接受的值: Disabled, Enabled

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--skip-verify

略過 SMTP 伺服器的 SSL 驗證。

接受的值: false, true

--smtp

允許 Grafana 傳送電子郵件。

接受的值: Disabled, Enabled

--start-tls-policy

TLS 原則。

接受的值: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。

--user

SMTP 伺服器用戶名稱。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。