Udostępnij za pośrednictwem

Kusto Data ClientRequestProperties, klasa

  • Artykuł

W bibliotece ClientRequestProperties danych Kusto klasa ułatwia zarządzanie interakcją między aplikacją kliencka a usługą. Ta klasa zawiera następujące informacje:

  • Właściwości żądania: mapowanie określonych opcji dostosowywania zachowania żądania.
  • Parametry zapytania: mapowanie parametrów zadeklarowanych przez użytkownika, które umożliwiają bezpieczne dostosowywanie zapytań.
  • Nazwane właściwości: identyfikator żądania klienta, szczegóły aplikacji i dane użytkownika, używane głównie do debugowania i śledzenia.

Właściwości żądania

Właściwości żądania umożliwiają dostosowanie zachowania określonego zapytania. Klasa ClientRequestProperties ma różne metody zarządzania właściwościami żądań, takie jak opcja ustawiania, pobierania i ma opcję. Dokładne nazwy metod różnią się w zależności od biblioteki klienta na konwencje nazewnictwa specyficzne dla języka.

Aby uzyskać listę dostępnych właściwości żądania, zobacz Właściwości żądania.

Na przykład użycie można znaleźć w temacie Dostosowywanie zachowania zapytania za pomocą właściwości żądania klienta.

Parametry zapytań

Instrukcję deklaracji parametrów zapytania można użyć do deklarowania parametrów zapytania język zapytań Kusto (KQL). W usłudze ClientRequestProperties Kusto Data klasa zawiera metody ustawiania, czyszczenia i sprawdzania obecności takich parametrów zapytania.

Metoda parametru set udostępnia przeciążenia typowych typów danych, takich jak string i long. W przypadku wszystkich innych typów należy wyrazić wartość jako literał KQL w string formacie i upewnić się, że declare query_parameters instrukcja deklaruje prawidłowy typ danych skalarnych.

Na przykład użycie można znaleźć w temacie Use query parameters to protect user input (Używanie parametrów zapytania w celu ochrony danych wejściowych użytkownika).

Nazwane właściwości

W poniższej ClientRequestProperties tabeli opisano nazwane właściwości dostępne w klasie. Każda właściwość tłumaczy się na nagłówek HTTP i może być również ustawiana podczas tworzenia żądania interfejsu API REST.

Nazwa właściwości Nagłówek HTTP opis
ClientRequestId lub client_request_id (na podstawie konwencji nazewnictwa specyficznych dla języka) x-ms-client-request-id Identyfikator używany do identyfikowania żądania. Ta specyfikacja jest przydatna do debugowania i może być wymagana w określonych scenariuszach, takich jak anulowanie zapytań.

Zalecamy użycie formatu ClientApplicationName.ActivityType;UniqueId. Jeśli klient nie określi wartości dla tej właściwości, zostanie przypisana losowa wartość.
Application x-ms-app Nazwa aplikacji klienckiej, która wysyła żądanie. Ta wartość jest używana do śledzenia.

Jeśli klient nie określi wartości dla tej właściwości, właściwość zostanie automatycznie ustawiona na nazwę procesu hostowania biblioteki danych Kusto. Aby określić tę właściwość w parametry połączenia Kusto, użyj Application Name for Tracing właściwości .
User x-ms-user Tożsamość użytkownika, który wysyła żądanie. Ta wartość jest używana do śledzenia.

Aby określić tę właściwość w parametry połączenia Kusto, użyj User Name for Tracing właściwości .

Uwaga

Właściwość identyfikatora żądania klienta jest rejestrowana na potrzeby diagnostyki. Unikaj wysyłania poufnych danych, takich jak dane osobowe lub poufne.

Powiązana zawartość