Konvensi sintaks untuk dokumentasi referensi

  • Artikel

Artikel ini menguraikan konvensi sintaks yang diikuti dalam dokumentasi referensi perintah Bahasa Kueri Kusto (KQL) dan manajemen.

Konvensi sintaksis

Konvensi Deskripsi
Block Literal string yang akan dimasukkan persis seperti yang ditunjukkan.
Miring Parameter yang akan diberikan nilai saat menggunakan fungsi atau perintah.
[ ] Menunjukkan bahwa item yang diapit bersifat opsional.
( ) Menunjukkan bahwa setidaknya salah satu item terlampir diperlukan.
| (pipa) Digunakan dalam tanda kurung siku atau bulat untuk menunjukkan bahwa Anda dapat menentukan salah satu item yang dipisahkan oleh karakter pipa. Dalam bentuk ini, pipa setara dengan operator OR logis. Saat berada di blok (|), pipa adalah bagian dari sintaks kueri KQL.
[, ...] Menunjukkan bahwa parameter sebelumnya dapat diulang beberapa kali, dipisahkan dengan koma.
; Terminator pernyataan kueri.

Contoh

Fungsi bernilai skalar

Contoh ini menunjukkan sintaksis dan contoh penggunaan fungsi hash, diikuti dengan penjelasan tentang bagaimana setiap komponen sintaks diterjemahkan ke dalam contoh penggunaan.

Sintaks

hash(source [,mod])

Contoh penggunaan

hash("World")
  • Nama fungsi, hash, dan tanda kurung buka dimasukkan persis seperti yang ditunjukkan.
  • "Dunia" diteruskan sebagai argumen untuk parameter sumber yang diperlukan.
  • Tidak ada argumen yang diteruskan untuk parameter mod , yang bersifat opsional seperti yang ditunjukkan oleh tanda kurung siku.
  • Tanda kurung penutup dimasukkan persis seperti yang ditunjukkan.

Operator tabular

Contoh ini menunjukkan sintaksis dan contoh penggunaan operator pengurutan, diikuti dengan penjelasan tentang bagaimana setiap komponen sintaks diterjemahkan ke dalam penggunaan contoh.

Sintaks

T| sort bycolumn [asc | desc] [nulls first | nulls last] [, ...]

Contoh penggunaan

StormEvents
| sort by State asc, StartTime desc
  • Tabel StormEvents diteruskan sebagai argumen untuk parameter T yang diperlukan.
  • | sort by dimasukkan persis seperti yang ditunjukkan. Dalam hal ini, karakter pipa adalah bagian dari sintaks pernyataan ekspresi tabular , seperti yang diwakili oleh teks blok. Untuk mempelajari selengkapnya, lihat Apa itu pernyataan kueri.
  • Kolom Status diteruskan sebagai argumen untuk parameter kolom yang diperlukan dengan bendera opsional asc .
  • Setelah koma, kumpulan argumen lain diteruskan: kolom StartTime dengan bendera opsional desc . Sintaks [, ...] menunjukkan bahwa lebih banyak set argumen dapat diteruskan tetapi tidak diperlukan.

Bekerja dengan parameter opsional

Untuk memberikan argumen untuk parameter opsional yang muncul setelah parameter opsional lainnya, Anda harus memberikan argumen untuk parameter sebelumnya. Persyaratan ini karena argumen harus mengikuti urutan yang ditentukan dalam sintaks. Jika Anda tidak memiliki nilai tertentu untuk diteruskan untuk parameter, gunakan nilai kosong dengan jenis yang sama.

Contoh parameter opsional berurutan

Pertimbangkan sintaks untuk plugin http_request:

evaluatehttp_request(Uri [,RequestHeaders [,Opsi]] )

RequestHeaders dan Options adalah parameter opsional dari jenis dinamis. Untuk memberikan argumen untuk parameter Opsi , Anda juga harus memberikan argumen untuk parameter RequestHeaders . Contoh berikut menunjukkan cara memberikan nilai kosong untuk parameter opsional pertama, RequestHeaders, agar dapat menentukan nilai untuk parameter opsional kedua, Opsi.

evaluate http_request ( "https://contoso.com/", dynamic({}), dynamic({ EmployeeName: Nicole }) )

Konten terkait