Поделиться через

Класс Kusto Data ClientRequestProperties

  • Статья

В библиотеке ClientRequestProperties данных Kusto класс помогает управлять взаимодействием между клиентским приложением и службой. Этот класс содержит следующие сведения:

  • Свойства запроса: сопоставление определенных параметров для настройки поведения запроса.
  • Параметры запроса: сопоставление объявленных пользователем параметров, позволяющих настроить безопасный запрос.
  • Именованные свойства: идентификатор запроса клиента, сведения о приложении и данные пользователя, в основном используемые для отладки и трассировки.

Свойства запроса

Свойства запроса позволяют настроить поведение определенного запроса. Класс ClientRequestProperties имеет различные методы для управления свойствами запроса, такими как параметр set, get option и имеет параметр. Точные имена методов зависят от клиентской библиотеки на соглашения об именовании на языке.

Список доступных свойств запроса см. в разделе "Свойства запроса".

Например, использование см. в разделе "Настройка поведения запроса с помощью свойств запроса клиента".

Параметры запроса

Оператор объявления параметров запроса можно использовать для объявления параметров для запроса язык запросов Kusto (KQL). В Kusto Data ClientRequestProperties класс содержит методы для задания, очистки и проверки наличия таких параметров запроса.

Метод параметра set предоставляет перегрузки для распространенных типов данных, таких как string и long. Для всех остальных типов следует выразить значение в виде литерала KQL в string формате и убедиться, что declare query_parameters инструкция объявляет правильный скалярный тип данных.

Например, использование см. в разделе "Использование параметров запроса для защиты входных данных пользователя".

Именованные свойства

В следующей таблице описаны именованные свойства, доступные ClientRequestProperties в классе. Каждое свойство преобразуется в заголовок HTTP и может быть задано при выполнении запроса REST API .

Имя свойства Заголовок HTTP Description
ClientRequestId или client_request_id (на основе соглашений об именовании на языке) x-ms-client-request-id Идентификатор, используемый для идентификации запроса. Эта спецификация полезна для отладки и может потребоваться для определенных сценариев, таких как отмена запросов.

Рекомендуется использовать формат ClientApplicationName.ActivityType;UniqueId. Если клиент не задает значение для этого свойства, назначается случайное значение.
Application x-ms-app Имя клиентского приложения, которое делает запрос. Это значение используется для трассировки.

Если клиент не задает значение для этого свойства, свойство автоматически присваивается имени процесса, в котором размещена библиотека данных Kusto. Чтобы указать это свойство в строка подключения Kusto, используйте Application Name for Tracing это свойство.
User x-ms-user Удостоверение пользователя, который выполняет запрос. Это значение используется для трассировки.

Чтобы указать это свойство в строка подключения Kusto, используйте User Name for Tracing это свойство.

Внимание

Свойство идентификатора запроса клиента записывается для диагностика. Избегайте отправки конфиденциальных данных, таких как личная или конфиденциальная информация.

Связанный контент