Dela via

Azure SearchManagement-klientbibliotek för JavaScript – version 3.3.0

Det här paketet innehåller en isomorf SDK (körs både i Node.js och i webbläsare) för Azure SearchManagement-klienten.

Klient som kan användas för att hantera Azure AI Search-tjänster och API-nycklar.

Källkod | Paket (NPM) | Referensdokumentation för | APIProver

Getting started

Miljöer som stöds för närvarande

Mer information finns i vår supportpolicy .

Prerequisites

Installera @azure/arm-search-paketet

Installera Azure SearchManagement-klientbiblioteket för JavaScript med npm:

npm install @azure/arm-search

Skapa och autentisera en SearchManagementClient

Om du vill skapa ett klientobjekt för att få åtkomst till Azure SearchManagement-API:et endpoint behöver du din Azure SearchManagement-resurs och en credential. Azure SearchManagement-klienten kan använda Azure Active Directory-autentiseringsuppgifter för att autentisera. Du hittar slutpunkten för din Azure SearchManagement-resurs i Azure-portalen.

Du kan autentisera med Azure Active Directory med hjälp av autentiseringsuppgifter från @azure/identity-biblioteket eller en befintlig AAD-token.

Om du vill använda providern DefaultAzureCredential som visas nedan, eller andra leverantörer av autentiseringsuppgifter som medföljer Azure SDK, installerar @azure/identity du paketet:

npm install @azure/identity

Du måste också registrera ett nytt AAD-program och bevilja åtkomst till Azure SearchManagement genom att tilldela lämplig roll till tjänstens huvudnamn (obs! roller som "Owner" inte beviljar nödvändiga behörigheter).

Mer information om hur du skapar ett Azure AD-program finns i den här guiden.

Med hjälp av Node.js- och Node-liknande miljöer kan du använda klassen DefaultAzureCredential för att autentisera klienten.

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);

För webbläsarmiljöer använder du InteractiveBrowserCredential från @azure/identity-paketet för att autentisera.

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

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

Key concepts

SearchManagementClient

SearchManagementClient är det primära gränssnittet för utvecklare som använder Azure SearchManagement-klientbiblioteket. Utforska metoderna för det här klientobjektet för att förstå de olika funktionerna i Azure SearchManagement-tjänsten som du kan komma åt.

Troubleshooting

Logging

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg med HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

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

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i dokument för @azure/logger-paket.

Next steps

Ta en titt på exempelkatalogen för detaljerade exempel på hur du använder det här biblioteket.

Contributing

Om du vill bidra till det här biblioteket kan du läsa bidragsguiden för att lära dig mer om hur du skapar och testar koden.