Kusto Data ClientRequestProperties クラス

Kusto データ ライブラリでは、ClientRequestProperties クラスは、クライアント アプリケーションとサービス間の相互作用を管理するのに役立ちます。 このクラスには、次の情報が含まれています。

• 要求プロパティ: 要求の動作をカスタマイズするための特定のオプションのマッピング。
• クエリ パラメーター: セキュリティで保護されたクエリのカスタマイズを可能にするユーザー宣言パラメーターのマッピング。
• 名前付きプロパティ: クライアント要求 ID、アプリケーションの詳細、ユーザー データ。主にデバッグとトレースに使用されます。

要求のプロパティ

要求プロパティを使用すると、特定のクエリの動作をカスタマイズできます。 ClientRequestProperties クラスには、set オプション、get オプション、オプションなど、要求プロパティを管理するためのさまざまなメソッドがあります。 正確なメソッド名は、言語固有の名前付け規則ごとにクライアント ライブラリによって異なります。

使用可能な要求プロパティの一覧については、「 Request プロパティ」を参照してください。

使用例については、「 クライアント要求プロパティを使用してクエリの動作をカスタマイズするを参照してください。

クエリ パラメーター

query パラメーター宣言ステートメントを使用して、Kusto 照会言語 (KQL) クエリのパラメーターを宣言できます。 Kusto Data では、 ClientRequestProperties クラスには、このようなクエリ パラメーターの設定、クリア、およびチェックを行うメソッドが含まれています。

set パラメーター メソッドは、 string や longなどの一般的なデータ型のオーバーロードを提供します。 その他のすべての型では、値を KQL リテラルとして string 形式で表し、 declare query_parameters ステートメントで正しい のデータ型が宣言されていることを確認します。

使用例については、「 クエリ パラメーターを使用してユーザー入力を保護するを参照してください。

名前付きプロパティ

次の表では、 ClientRequestProperties クラスで使用できる名前付きプロパティについて説明します。 各プロパティは HTTP ヘッダーに変換されREST API 要求を行うときに設定することもできます。

プロパティ名	HTTP ヘッダー	説明
ClientRequestId または client_request_id (言語固有の名前付け規則に基づく)	x-ms-client-request-id	要求を識別するために使用される ID。 この仕様はデバッグに役立ち、クエリの取り消しなどの特定のシナリオで必要になる場合があります。 ClientApplicationName .ActivityType;UniqueId の形式を使用することをお勧めします。 クライアントがこのプロパティの値を指定しない場合は、ランダムな値が割り当てられます。
Application	x-ms-app	要求を行うクライアント アプリケーションの名前。 この値はトレースに使用されます。 クライアントがこのプロパティの値を指定しない場合、プロパティは Kusto データ ライブラリをホストするプロセスの名前に自動的に設定されます。 Kusto 接続文字列でこのプロパティを指定するには、Application Name for Tracing プロパティを使用します。
User	x-ms-user	要求を行うユーザーの ID。 この値は tracing. に使用されますKusto 接続文字列でこのプロパティを指定するには、User Name for Tracing プロパティを使用します。

注意事項

クライアント要求 ID プロパティは、診断用に記録されます。 個人を特定できる情報や機密情報などの機密データを送信しないようにします。

関連するコンテンツ

• Kusto データの概要
• 基本的なクエリを実行するアプリを作成する
• 要求プロパティ