Sdílet prostřednictvím

Kusto Data ClientRequestProperties – třída

Přepněte služby pomocí rozevíracího seznamu Verze . Přečtěte si další informace o navigaci.
Platí pro: ✅ Microsoft Fabric ✅ Azure Data Explorer

V knihovně ClientRequestProperties pomáhá třída spravovat interakci mezi klientskou aplikací a službou. Tato třída obsahuje následující informace:

  • Vlastnosti požadavku: Mapování konkrétních možností pro přizpůsobení chování požadavků.
  • Parametry dotazu: Mapování uživatelem deklarovaných parametrů, které umožňují zabezpečené přizpůsobení dotazů.
  • Pojmenované vlastnosti: ID požadavku klienta, podrobnosti aplikace a uživatelská data, které se primárně používají k ladění a trasování.

Vlastnosti požadavku

Vlastnosti požadavku umožňují přizpůsobit chování konkrétního dotazu. Třída ClientRequestProperties má různé metody pro správu vlastností požadavku, jako je například set option, get option a has option. Přesné názvy metod se liší podle klientských knihoven podle zásad vytváření názvů specifických pro jednotlivé jazyky.

Seznam dostupných vlastností požadavku najdete v tématu Vlastnosti požadavku.

Příklad použití najdete v tématu Přizpůsobení chování dotazu pomocí vlastností požadavku klienta.

Parametry dotazu

Příkaz deklarace parametrů dotazu lze použít k deklarování parametrů dotazu jazyka Kusto Query Language (KQL). V Kusto Data ClientRequestProperties třída obsahuje metody pro nastavení, vymazání a kontrolu přítomnosti těchto parametrů dotazu.

Metoda set parametru poskytuje přetížení pro běžné datové typy, například string a long. Pro všechny ostatní typy vyjádřete hodnotu jako literál KQL ve string formátu a ujistěte se, že declarequery_parameters příkaz deklaruje správný skalární datový typ.

Příklad použití najdete v tématu Použití parametrů dotazu k ochraně vstupu uživatele.

Pojmenované vlastnosti

Následující tabulka popisuje pojmenované vlastnosti dostupné ve ClientRequestProperties třídě. Každá vlastnost se přeloží na hlavičku HTTP a dá se také nastavit při vytváření požadavku rozhraní REST API .

Název vlastnosti Hlavička HTTP Description
ClientRequestId nebo client_request_id (na základě konvencí vytváření názvů specifických pro jazyk) x-ms-client-request-id ID použité k identifikaci požadavku. Tato specifikace je užitečná pro ladění a může být vyžadována pro konkrétní scénáře, jako je zrušení dotazu.

Doporučujeme použít formát ClientApplicationName.ActivityType;UniqueId. Pokud klient neurčí hodnotu pro tuto vlastnost, je přiřazena náhodná hodnota.
Application x-ms-app Název klientské aplikace, která požadavek provede. Tato hodnota se používá pro trasování.

Pokud klient nezadá hodnotu pro tuto vlastnost, vlastnost se automaticky nastaví na název procesu hostujícího knihovnu Dat Kusto. Chcete-li zadat tuto vlastnost v připojovacím řetězci Kusto, použijte Application Name for Tracing tuto vlastnost.
User x-ms-user Identita uživatele, který požadavek provede. Tato hodnota se používá pro trasování.

Chcete-li zadat tuto vlastnost v připojovacím řetězci Kusto, použijte User Name for Tracing tuto vlastnost.

Upozornění

Vlastnost ID požadavku klienta se zaznamenává pro diagnostiku. Vyhněte se odesílání citlivých dat, jako jsou identifikovatelné osobní údaje nebo důvěrné informace.

Související obsah

  • Last updated on