Bagikan melalui

Kelas Kusto Data ClientRequestProperties

  • Artikel

Di pustaka Data Kusto, ClientRequestProperties kelas membantu mengelola interaksi antara aplikasi klien Anda dan layanan. Kelas ini berisi informasi berikut:

  • Properti permintaan: Pemetaan opsi tertentu untuk menyesuaikan perilaku permintaan.
  • Parameter kueri: Pemetaan parameter yang dideklarasikan pengguna yang memungkinkan penyesuaian kueri yang aman.
  • Properti bernama: ID permintaan klien, detail aplikasi, dan data pengguna, terutama digunakan untuk penelusuran kesalahan dan pelacakan.

Properti permintaan

Properti permintaan memungkinkan Anda mengkustomisasi perilaku kueri tertentu. Kelas ClientRequestProperties ini memiliki berbagai metode untuk mengelola properti permintaan, seperti opsi atur, opsi dapatkan, dan memiliki opsi. Nama metode yang tepat bervariasi menurut pustaka klien per konvensi penamaan khusus bahasa.

Untuk daftar properti permintaan yang tersedia, lihat Properti permintaan.

Misalnya penggunaan, lihat Menyesuaikan perilaku kueri dengan properti permintaan klien.

Parameter kueri

Pernyataan deklarasi parameter kueri dapat digunakan untuk mendeklarasikan parameter untuk kueri Bahasa Kueri Kusto (KQL). Di Data Kusto, ClientRequestProperties kelas berisi metode untuk mengatur, menghapus, dan memeriksa keberadaan parameter kueri tersebut.

Metode parameter yang ditetapkan menyediakan kelebihan beban untuk jenis data umum, seperti string dan long. Untuk semua jenis lainnya, ekspresikan nilai sebagai literal KQL dalam string format, dan pastikan bahwa pernyataan tersebut mendeklarasikan jenis data skalar yang declare query_parameters benar.

Misalnya penggunaan, lihat Menggunakan parameter kueri untuk melindungi input pengguna.

Properti bernama

Tabel berikut ini menjelaskan properti bernama yang tersedia di ClientRequestProperties kelas . Setiap properti diterjemahkan ke header HTTP dan juga dapat diatur saat membuat permintaan REST API .

Nama properti Header HTTP Deskripsi
ClientRequestId atau client_request_id (berdasarkan konvensi penamaan khusus bahasa) x-ms-client-request-id ID yang digunakan untuk mengidentifikasi permintaan. Spesifikasi ini berguna untuk penelusuran kesalahan dan mungkin diperlukan untuk skenario tertentu seperti pembatalan kueri.

Sebaiknya gunakan format ClientApplicationName.ActivityType;UniqueId. Jika klien tidak menentukan nilai untuk properti ini, nilai acak akan ditetapkan.
Application x-ms-app Nama aplikasi klien yang membuat permintaan. Nilai ini digunakan untuk pelacakan.

Jika klien tidak menentukan nilai untuk properti ini, properti secara otomatis diatur ke nama proses yang menghosting pustaka Data Kusto. Untuk menentukan properti ini dalam string koneksi Kusto, gunakan Application Name for Tracing properti .
User x-ms-user Identitas pengguna yang membuat permintaan. Nilai ini digunakan untuk pelacakan.

Untuk menentukan properti ini dalam string koneksi Kusto, gunakan User Name for Tracing properti .

Perhatian

Properti ID permintaan klien dicatat untuk diagnostik. Hindari mengirim data sensitif seperti informasi yang dapat diidentifikasi secara pribadi atau rahasia.

Konten terkait