Compartir a través de

Clase Kusto Data ClientRequestProperties

  • Artículo

En la biblioteca de datos de Kusto, la clase ayuda a administrar la ClientRequestProperties interacción entre la aplicación cliente y el servicio. Esta clase contiene la siguiente información:

  • Propiedades de solicitud: asignación de opciones específicas para personalizar el comportamiento de las solicitudes.
  • Parámetros de consulta: asignación de parámetros declarados por el usuario que permiten la personalización segura de consultas.
  • Propiedades con nombre: identificador de solicitud de cliente, detalles de la aplicación y datos de usuario, que se usan principalmente para la depuración y el seguimiento.

Propiedades de solicitud

Las propiedades de solicitud permiten personalizar el comportamiento de una consulta específica. La ClientRequestProperties clase tiene varios métodos para administrar las propiedades de solicitud, como la opción set, la opción get y tiene la opción . Los nombres de método precisos varían según la biblioteca cliente por convenciones de nomenclatura específicas del lenguaje.

Para obtener una lista de las propiedades de solicitud disponibles, consulte Propiedades de solicitud.

Para obtener un ejemplo de uso, consulte Personalización del comportamiento de las consultas con propiedades de solicitud de cliente.

Parámetros de consulta

La instrucción de declaración de parámetros de consulta se puede usar para declarar parámetros para una consulta de Lenguaje de consulta Kusto (KQL). En Kusto Data, la ClientRequestProperties clase contiene métodos para establecer, borrar y comprobar la presencia de estos parámetros de consulta.

El método de parámetro set proporciona sobrecargas para tipos de datos comunes, como string y long. Para todos los demás tipos, exprese el valor como un literal KQL en string formato y asegúrese de que la query_parameters declare instrucción declara el tipo de datos escalar correcto.

Para obtener un ejemplo de uso, consulte Uso de parámetros de consulta para proteger la entrada del usuario.

Propiedades con nombre

En la tabla siguiente se describen las propiedades con nombre disponibles en la ClientRequestProperties clase . Cada propiedad se traduce en un encabezado HTTP y también se puede establecer al realizar una solicitud de API REST.

Nombre de propiedad Encabezado HTTP Descripción
ClientRequestId o client_request_id (basado en convenciones de nomenclatura específicas del lenguaje) x-ms-client-request-id Identificador usado para identificar la solicitud. Esta especificación es útil para la depuración y puede ser necesaria para escenarios específicos, como la cancelación de consultas.

Se recomienda usar el formato ClientApplicationName.ActivityType;UniqueId. Si el cliente no especifica un valor para esta propiedad, se asigna un valor aleatorio.
Application x-ms-app Nombre de la aplicación cliente que realiza la solicitud. Este valor se usa para el seguimiento.

Si el cliente no especifica un valor para esta propiedad, la propiedad se establece automáticamente en el nombre del proceso que hospeda la biblioteca de datos de Kusto. Para especificar esta propiedad en un cadena de conexión de Kusto, use la Application Name for Tracing propiedad .
User x-ms-user Identidad del usuario que realiza la solicitud. Este valor se usa para el seguimiento.

Para especificar esta propiedad en un cadena de conexión de Kusto, use la User Name for Tracing propiedad .

Precaución

La propiedad id. de solicitud de cliente se registra para diagnósticos. Evite enviar datos confidenciales como información confidencial o de identificación personal.

Contenido relacionado