Sdílet prostřednictvím

Klientská knihovna Azure SearchManagement pro JavaScript – verze 3.3.0

Tento balíček obsahuje izomorfní sadu SDK (spouští se v Node.js i v prohlížečích) pro klienta Azure SearchManagement.

Klient, který se dá použít ke správě služeb Azure AI Search a klíčů rozhraní API.

Zdrojový kód | Balíček (NPM) | Referenční dokumentace | k rozhraní APIVzorky

Getting started

Aktuálně podporovaná prostředí

Další podrobnosti najdete v zásadách podpory.

Prerequisites

  • Předplatné služby Azure.

Nainstalujte balíček @azure/arm-search.

Nainstalujte klientskou knihovnu Azure SearchManagement pro JavaScript pomocí npm:

npm install @azure/arm-search

Vytvořte a ověřte SearchManagementClient

Pokud chcete vytvořit objekt klienta pro přístup k rozhraní API služby Azure SearchManagement, budete potřebovat endpoint prostředek Azure SearchManagement a credentialprostředek . Klient Služby Azure SearchManagement může k ověření použít přihlašovací údaje Azure Active Directory. Koncový bod pro prostředek Azure SearchManagement najdete na webu Azure Portal.

Ověřování pomocí Azure Active Directory můžete provést pomocí přihlašovacích údajů z knihovny @azure/identity nebo existujícího tokenu AAD.

Pokud chcete použít níže uvedeného poskytovatele DefaultAzureCredential nebo jiné poskytovatele přihlašovacích údajů, kteří jsou součástí sady Azure SDK, nainstalujte @azure/identity balíček:

npm install @azure/identity

Budete také muset zaregistrovat novou aplikaci AAD a udělit přístup ke službě Azure SearchManagement přiřazením vhodné role k instančnímu objektu (poznámka: role, jako "Owner" například neudělí potřebná oprávnění).

Další informace o tom, jak vytvořit aplikaci Azure AD, najdete v této příručce.

Pomocí Node.js a prostředí podobných uzlům můžete k ověření klienta použít třídu DefaultAzureCredential.

import { SearchManagementClient } from "@azure/arm-search";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new SearchManagementClient(new DefaultAzureCredential(), subscriptionId);

Pro prostředí prohlížeče použijte k ověření InteractiveBrowserCredential z balíčku @azure/identity.

import { InteractiveBrowserCredential } from "@azure/identity";
import { SearchManagementClient } from "@azure/arm-search";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new SearchManagementClient(credential, subscriptionId);

JavaScript Bundle

Pokud chcete tuto klientskou knihovnu použít v prohlížeči, musíte nejprve použít bundler. Podrobnosti o tom, jak to provést, naleznete v naší dokumentaci ke sdružování.

Key concepts

SearchManagementClient

SearchManagementClient je primární rozhraní pro vývojáře, kteří používají klientskou knihovnu Azure SearchManagement. Prozkoumejte metody tohoto objektu klienta, abyste porozuměli různým funkcím služby Azure SearchManagement, ke které máte přístup.

Troubleshooting

Logging

Povolení protokolování může pomoct odhalit užitečné informace o chybách. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou prostředí AZURE_LOG_LEVEL na info. Případně můžete protokolování povolit za běhu voláním setLogLevel v @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k @azure/protokolovacímu balíčku.

Next steps

Podívejte se prosím na adresář samples , kde najdete podrobné příklady použití této knihovny.

Contributing

Pokud chcete do této knihovny přispívat, přečtěte si průvodce přispíváním , kde se dozvíte více o tom, jak sestavit a otestovat kód.

  • Last updated on