az grafana dashboard

  • Referensi

Catatan

Referensi ini adalah bagian dari ekstensi amg untuk Azure CLI (versi 2.38.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah dasbor az grafana. Pelajari lebih lanjut tentang ekstensi.

Perintah untuk mengelola dasbor instans.

Perintah

Nama Deskripsi Jenis Status
az grafana dashboard create

Buat dasbor baru.

 Ekstensi GA
az grafana dashboard delete

Menghapus dasbor.

 Ekstensi GA
az grafana dashboard import

Mengimpor dasbor.

 Ekstensi GA
az grafana dashboard list

Mencantumkan semua dasbor instans.

 Ekstensi GA
az grafana dashboard show

Dapatkan detail dasbor.

 Ekstensi GA
az grafana dashboard sync

Sinkronkan dasbor Azure Managed Grafana dari satu instans ke instans lain. Catatan, dasbor dengan status "disediakan" akan dilewati karena bersifat baca-saja.

 Ekstensi Pratinjau
az grafana dashboard update

Memperbarui dasbor.

 Ekstensi GA

az grafana dashboard create

Buat dasbor baru.

az grafana dashboard create --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]
                            [--title]

Contoh

Buat dasbor dengan definisi dalam file json. Untuk mulai cepat, kloning dari output "az grafana dashboard show", hapus "id" dan "uid", dan terapkan perubahan.

az grafana dashboard create -g MyResourceGroup -n MyGrafana --title "My dashboard" --folder folder1 --definition '{
  "dashboard": {
    "annotations": {
        ...
    },
    "panels": {
        ...
    }
  },
  "message": "Create a new test dashboard"
}'

Parameter yang Diperlukan

--definition

Model dasbor lengkap dalam string json, jalur atau url ke file dengan konten tersebut.

--name -n

Nama Azure Managed Grafana.

Parameter Opsional

--api-key --token -t

Kunci api atau token akun layanan, string yang dihasilkan secara acak yang digunakan untuk berinteraksi dengan titik akhir Grafana; jika hilang, CLI akan menggunakan kredensial pengguna yang masuk saat ini.

--folder

Id, uid, judul yang dapat mengidentifikasi folder. CLI akan mencari dalam urutan id, uid, dan judul, sampai menemukan kecocokan.

--overwrite

Timpa dasbor dengan uid yang sama.

nilai yang diterima: false, true
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--title

Judul dasbor.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az grafana dashboard delete

Menghapus dasbor.

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

Contoh

Menghapus dasbor yang ditentukan oleh pengidentifikasi unik (gunakan perintah "az grafana dashboard list" untuk mengambil uid)

az grafana dashboard delete -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

Parameter yang Diperlukan

--dashboard

Uid dasbor.

--name -n

Nama Azure Managed Grafana.

Parameter Opsional

--api-key --token -t

Kunci api atau token akun layanan, string yang dihasilkan secara acak yang digunakan untuk berinteraksi dengan titik akhir Grafana; jika hilang, CLI akan menggunakan kredensial pengguna yang masuk saat ini.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az grafana dashboard import

Mengimpor dasbor.

Perintah CLI akan mengisi parameter yang diperlukan untuk sumber data jika dikonfigurasi.

az grafana dashboard import --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

Contoh

impor dasbor "AKS Container Insights" dari galeri Grafana.

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition 12180

impor dasbor dari file.

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

Parameter yang Diperlukan

--definition

Model dasbor lengkap dalam string json, id galeri Grafana, jalur atau url ke file dengan konten tersebut.

--name -n

Nama Azure Managed Grafana.

Parameter Opsional

--api-key --token -t

Kunci api atau token akun layanan, string yang dihasilkan secara acak yang digunakan untuk berinteraksi dengan titik akhir Grafana; jika hilang, CLI akan menggunakan kredensial pengguna yang masuk saat ini.

--folder

Id, uid, judul yang dapat mengidentifikasi folder. CLI akan mencari dalam urutan id, uid, dan judul, sampai menemukan kecocokan.

--overwrite

Timpa dasbor dengan uid yang sama.

nilai yang diterima: false, true
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az grafana dashboard list

Mencantumkan semua dasbor instans.

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

Contoh

Temukan dasbor untuk K8s API Server dan ambil pengidentifikasi unik (untuk memanggil perintah "az grafana dashboard show"))

az grafana dashboard list -g MyResourceGroup -n MyGrafana --query "[?contains(@.title, 'API server')].uid"

Parameter yang Diperlukan

--name -n

Nama Azure Managed Grafana.

Parameter Opsional

--api-key --token -t

Kunci api atau token akun layanan, string yang dihasilkan secara acak yang digunakan untuk berinteraksi dengan titik akhir Grafana; jika hilang, CLI akan menggunakan kredensial pengguna yang masuk saat ini.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az grafana dashboard show

Dapatkan detail dasbor.

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

Contoh

Dapatkan detail dasbor yang ditentukan oleh pengidentifikasi unik (gunakan perintah "az grafana dashboard list" untuk mengambil uid)

az grafana dashboard show -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

Parameter yang Diperlukan

--dashboard

Uid dasbor.

--name -n

Nama Azure Managed Grafana.

Parameter Opsional

--api-key --token -t

Kunci api atau token akun layanan, string yang dihasilkan secara acak yang digunakan untuk berinteraksi dengan titik akhir Grafana; jika hilang, CLI akan menggunakan kredensial pengguna yang masuk saat ini.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az grafana dashboard sync

Pratinjau

Perintah ini sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Sinkronkan dasbor Azure Managed Grafana dari satu instans ke instans lain. Catatan, dasbor dengan status "disediakan" akan dilewati karena bersifat baca-saja.

az grafana dashboard sync --destination
                          --source
                          [--dashboards-to-exclude]
                          [--dashboards-to-include]
                          [--dry-run {false, true}]
                          [--folders-to-exclude]
                          [--folders-to-include]

Contoh

Sinkronkan hanya dasbor di bawah beberapa folder

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "Azure Monitor Container Insights" "Azure Monitor"

Menyinkronkan satu dasbor

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "MyFolder" --dashboards-to-include "My Service Health"

Pratinjau sinkronisasi

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --dry-run

Parameter yang Diperlukan

--destination -d

Id sumber daya ruang kerja tujuan.

--source -s

Id sumber daya ruang kerja sumber.

Parameter Opsional

--dashboards-to-exclude

Spasi judul dasbor yang dipisahkan untuk dikecualikan dalam sinkronisasi. Pasangkan dengan --folders-to-exclude untuk folder tertentu.

--dashboards-to-include

Judul dasbor yang dipisahkan spasi untuk disertakan dalam sinkronisasi. Pasangkan dengan --folders-to-include untuk folder tertentu.

--dry-run

Pratinjau perubahan dengan penerapan.

nilai yang diterima: false, true
--folders-to-exclude -e

Folder yang akan dikecualikan dalam pencadangan atau sinkronisasi.

--folders-to-include -i

Folder yang akan disertakan dalam pencadangan atau sinkronisasi.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az grafana dashboard update

Memperbarui dasbor.

az grafana dashboard update --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

Contoh

Perbarui dasbor dengan definisi dalam file json. Untuk mulai cepat, dapatkan konfigurasi yang ada dari "az grafana dashboard show", dan terapkan perubahan. Bidang "versi" perlu diperbarui, dan bidang "timpa" harus benar.

az grafana dashboard update -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

Parameter yang Diperlukan

--definition

Model dasbor lengkap dalam string json, jalur atau url ke file dengan konten tersebut.

--name -n

Nama Azure Managed Grafana.

Parameter Opsional

--api-key --token -t

Kunci api atau token akun layanan, string yang dihasilkan secara acak yang digunakan untuk berinteraksi dengan titik akhir Grafana; jika hilang, CLI akan menggunakan kredensial pengguna yang masuk saat ini.

--folder

Id, uid, judul yang dapat mengidentifikasi folder. CLI akan mencari dalam urutan id, uid, dan judul, sampai menemukan kecocokan.

--overwrite

Timpa dasbor dengan uid yang sama.

nilai yang diterima: false, true
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.