az grafana
注意
此參考是 Azure CLI 的 amg 延伸模組的一部分(2.61.0 版或更高版本)。 擴充功能會在您第一次執行 az grafana 命令時自動安裝。 深入了解擴充功能。
管理 Azure 受控 Grafana 資源的命令。
命令
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
必要參數
Azure 受控 Grafana 的名稱。
選擇性參數
要備份的 Grafana 成品類型。
要備份 Grafana 成品的目錄。
備份或同步處理中要排除的資料夾。
要包含在備份或同步處理中的資料夾。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az grafana create
建立 Grafana 資源的工作區。 此 API 具有等冪性,因此使用者可以建立新的 grafana 或更新現有的 grafana。
az grafana create --name
--resource-group
[--api-key {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 {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}]
範例
建立已啟用標準 SKU 和公用網路存取的 Azure 受控 Grafana 資源
az grafana create --resource-group myResourceGroup --workspace-name myWorkspace --sku-tier Standard --public-network-access Enabled
必要參數
Azure 受控 Grafana 的工作區名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
Grafana 實例的 API 金鑰設定。
Grafana 實例是否使用具決定性的輸出IP。
要設為目標的主要 Grafana 軟體版本。
grafana 資源所在的地理位置。
請勿等候長時間執行的作業完成。
要做為 Grafana Admins 的使用者、群組等以空格分隔的 Azure AD 物件識別碼。 提供之後,CLI 將不會將目前的登入用戶設為 Grafana 系統管理員支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
指出透過公用介面啟用或停用流量的狀態。
請勿啟用系統指派的身分識別。 如果您想要自行管理身分識別,請使用此選項。
略過為 Grafana 實例和目前 CLI 帳戶的受控識別建立預設角色指派。 如果您想要自行管理角色指派,請使用此選項。
grafana 資源的 SKU。
grafana 資源的標記。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
Grafana 實例的區域備援設定。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az grafana delete
刪除 Grafana 資源的工作區。
az grafana delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
Azure 受控 Grafana 的工作區名稱。
請勿等候長時間執行的作業完成。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
不提示確認。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az grafana list
列出指定訂用帳戶下 Grafana 工作區的所有資源。
az grafana list [--max-items]
[--next-token]
[--resource-group]
選擇性參數
命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值,則會在命令的輸出中提供令牌。 若要繼續分頁,請在後續命令的自變數中 --next-token
提供令牌值。
標記,指定要開始分頁的位置。 這是先前截斷回應中的令牌值。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az grafana list-available-plugin
列出所有可用的外掛程式。
az grafana list-available-plugin [--ids]
[--name]
[--resource-group]
[--subscription]
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
Azure 受控 Grafana 的工作區名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az grafana migrate
此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
將現有的 Grafana 實例移轉至 Azure 受控 Grafana 實例。
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]
範例
將儀錶板和資料夾從本機 Grafana 實例移轉至 Azure 受控 Grafana 實例。
az grafana migrate -g MyResourceGroup -n MyGrafana -s http://localhost:3000 -t YourServiceTokenOrAPIKey
必要參數
Azure 受控 Grafana 的名稱。
要從中移轉的 Grafana 實例端點。
Grafana 實例服務令牌(或 API 金鑰)可取得移轉來源的存取權。
選擇性參數
預覽變更而不認可。 優先於 --overwrite。
備份或同步處理中要排除的資料夾。
要包含在備份或同步處理中的資料夾。
以相同的 uid 或標題覆寫先前的儀錶板、連結庫面板和資料夾。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --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
必要參數
要從中還原 Grafana 成品的封存。
Azure 受控 Grafana 的名稱。
選擇性參數
要備份的 Grafana 成品類型。
在還原期間,透過名稱比對,更新儀錶板以參考目的地工作區所定義的數據源。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az grafana show
取得 Grafana 資源特定工作區的屬性。
az grafana show [--ids]
[--name]
[--resource-group]
[--subscription]
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
Azure 受控 Grafana 的工作區名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az grafana update
更新 Grafana 資源的工作區。
az grafana update [--api-key {Disabled, Enabled}]
[--deterministic-outbound-ip {Disabled, Enabled}]
[--from-address]
[--from-name]
[--grafana-major-version]
[--host]
[--ids]
[--name]
[--password]
[--public-network-access {Disabled, Enabled}]
[--resource-group]
[--skip-verify {0, 1, f, false, n, no, t, true, y, yes}]
[--sku-tier]
[--smtp {0, 1, f, false, n, no, t, true, y, yes}]
[--start-tls-policy {MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS}]
[--subscription]
[--tags]
[--user]
[--zone-redundancy {Disabled, Enabled}]
範例
停用公用網路存取
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
選擇性參數
Grafana 實例的 API 金鑰設定。
Grafana 實例是否使用具決定性的輸出IP。
傳送電子郵件 https://pkg.go.dev/net/mail#Address時所使用的位址。
傳送電子郵件時要使用的名稱。 默認值為 「Azure 受控 Grafana 通知」 https://pkg.go.dev/net/mail#Address。
要設為目標的主要 Grafana 軟體版本。
具有埠的 SMTP 伺服器主機名,例如 test.email.net:587。
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
Azure 受控 Grafana 的工作區名稱。
SMTP 驗證的密碼。如果密碼包含 # 或 ;,則必須以三引弧括住它。
指出透過公用介面啟用或停用流量的狀態。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
確認 SMTP 伺服器的 SSL。 預設值為 false https://pkg.go.dev/crypto/tls#Config。
grafana 資源的 SKU。
啟用此選項可讓 Grafana 傳送電子郵件。
SMTP 組態 https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy的 StartTLSPolicy 設定。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
grafana 資源的標記。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
SMTP 驗證的使用者。
Grafana 實例的區域備援設定。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az grafana wait
將 CLI 置於等候狀態,直到符合條件為止。
az grafana wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
選擇性參數
請等候在 'Succeeded' 使用 'provisioningState' 建立。
等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到刪除為止。
等候資源存在。
一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。
輪詢間隔以秒為單位。
Azure 受控 Grafana 的工作區名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
以秒為單位的等候上限。
等到 provisioningState 更新為 'Succeeded'。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。