Kusto Data ClientRequestProperties 类

  • 项目

在 Kusto 数据库中，ClientRequestProperties 类可帮助管理客户端应用程序和服务之间的交互。 此类包含以下信息：

  • 请求属性：自定义请求行为的特定选项的映射。
  • 查询参数：用户声明的参数的映射，允许安全查询自定义。
  • 命名属性：客户端请求 ID、应用程序详细信息和用户数据，主要用于调试和跟踪。

请求属性

使用请求属性可以自定义特定查询的行为。 ClientRequestProperties 类具有用于管理请求属性的各种方法，例如设置选项、获取选项和具有选项。 精确的方法名称因特定于语言的命名约定的客户端库而异。

有关可用请求属性的列表，请参阅请求属性。

有关示例用法，请参阅用客户端请求属性自定义查询行为。

查询参数

查询参数声明语句可用于声明 Kusto 查询语言 (KQL) 查询的参数。 在 Kusto Data 中，ClientRequestProperties 类包含设置、清除和检查此类查询参数是否存在的方法。

set 参数方法为常见数据类型（如 string 和 long）提供重载。 对于所有其他类型，以 string 格式将值表示为 KQL 文本，并确保 declarequery_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 发出请求的用户的标识。 此值用于跟踪。

若要在 Kusto 连接字符串中指定此属性，请使用 User Name for Tracing 属性。

注意

为诊断记录客户端请求 ID 属性。 避免发送敏感数据，例如个人身份或机密信息。

相关内容