如何在Kusto Explorer、WebUX、Fabric QuerySets中设置client request properties？

Kusto Explorer #

• 全局连接级设置：
  1. 打开Kusto Explorer，右键点击目标集群连接节点，选择「属性」
  2. 切换到「高级」标签页，在「客户端请求属性」输入框中按key=value;key2=value2格式填写属性，比如ApplicationName=MyCustomKustoApp;UserTag=AnalyticsTeam
  3. 点击「确定」保存，后续该连接下的所有查询都会自动应用这些属性
• 临时会话级设置：
  在查询语句开头添加set request_properties命令，示例：

  set request_properties = '{"ApplicationName": "TempQuerySession"}';
  StormEvents | take 5
  

Web界面（WebUX） #

• 全局查询设置：
  1. 打开WebUX查询页面，点击右上角的设置图标（齿轮形状），选择「查询设置」
  2. 在「客户端请求属性」栏填写键值对（格式同Kusto Explorer），保存后所有查询生效
• 临时单查询设置：
  和Kusto Explorer一致，在查询开头添加set request_properties语句覆盖全局设置

原生环境（SDK/REST API） #

.NET SDK #

创建查询客户端时，通过ClientRequestProperties对象设置属性：

var connectionString = new KustoConnectionStringBuilder("https://your-cluster.kusto.windows.net/your-db")
    .WithAadDefaultAuthentication();
using var queryClient = KustoClientFactory.CreateCslQueryProvider(connectionString);

var requestProps = new ClientRequestProperties();
requestProps.SetOption("ApplicationName", "MyDotNetAnalyticsApp");
requestProps.SetOption("Timeout", TimeSpan.FromMinutes(5));

var results = queryClient.ExecuteQuery("MyTable | summarize count() by Category", requestProps);

REST API #

在请求中通过两种方式传递：

• 请求头：添加x-ms-client-request-properties，值为JSON格式字符串，比如{"ApplicationName": "MyRestClient"}
• 查询参数：在URL中追加request_properties参数，值为URL编码的JSON字符串，比如request_properties=%7B%22ApplicationName%22%3A%22MyRestClient%22%7D

Fabric QuerySets #

• 全局QuerySet设置：
  1. 打开目标QuerySet，点击顶部导航栏的设置图标
  2. 在「查询设置」中找到「客户端请求属性」，按key=value格式填写（多属性用分号分隔），保存后该QuerySet内所有查询自动应用
• 临时单查询设置：
  在具体查询语句开头添加set request_properties命令，示例：

  set request_properties = '{"QueryPriority": "Low"}';
  SalesData | summarize Total=sum(Revenue) by Region
  

内容的提问来源于stack exchange，提问作者Daniel Dror