Biblioteca de clientes do Azure SearchManagement para JavaScript – versão 3.3.0

Esse pacote contém um SDK isomórfico (executado em Node.js e em navegadores) para o cliente do Azure SearchManagement.

Cliente que pode ser usado para gerenciar serviços e chaves de API do Azure AI Search.

Código-fonte | Pacote (NPM) | Documentação | de referência da APIAmostras

Getting started

Ambientes com suporte no momento

• Versões LTS do Node.js
• Versões mais recentes do Safari, Chrome, Edge e Firefox.

Consulte nossa política de suporte para obter mais detalhes.

Prerequisites

• Uma assinatura do Azure.

Instalar o pacote @azure/arm-search

Instale a biblioteca de clientes do Azure SearchManagement para JavaScript com npm:

npm install @azure/arm-search

Criar e autenticar um SearchManagementClient

Para criar um objeto cliente para acessar a API do Azure SearchManagement, você precisará do endpoint recurso do Azure SearchManagement e de um credential. O cliente do Azure SearchManagement pode usar as credenciais do Azure Active Directory para autenticar. Você pode encontrar o ponto de extremidade do recurso Azure SearchManagement no Portal do Azure.

Você pode autenticar com o Azure Active Directory usando uma credencial da biblioteca de @azure/identidade ou um token do AAD existente.

Para usar o provedor DefaultAzureCredential mostrado abaixo ou outros provedores de credenciais fornecidos com o SDK do Azure, instale o @azure/identity pacote:

npm install @azure/identity

Você também precisará registrar um novo aplicativo do AAD e conceder acesso ao Azure SearchManagement atribuindo a função adequada à entidade de serviço (observação: funções como "Owner" não concederão as permissões necessárias).

Para obter mais informações sobre como criar um aplicativo do Azure AD, confira este guia.

Usando ambientes semelhantes a Node.js e nó, você pode usar a classe DefaultAzureCredential para autenticar o cliente.

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

Para ambientes de navegador, use o InteractiveBrowserCredential do pacote @azure/identity para autenticar.

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

Para usar essa biblioteca de clientes no navegador, primeiro você precisa usar um empacotador. Para obter detalhes sobre como fazer isso, consulte nossa documentação de agrupamento.

Key concepts

SearchManagementClient

SearchManagementClient é a interface primária para desenvolvedores que usam a biblioteca de clientes do Azure SearchManagement. Explore os métodos neste objeto cliente para entender os diferentes recursos do serviço Azure SearchManagement que você pode acessar.

Troubleshooting

Logging

Habilitar o registro em log pode ajudar a descobrir informações úteis sobre falhas. Para ver um log de solicitações e respostas HTTP, defina a variável de ambiente AZURE_LOG_LEVEL como info. Como alternativa, o registro em log pode ser habilitado em runtime chamando setLogLevel no @azure/logger:

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

setLogLevel("info");

Para obter instruções mais detalhadas sobre como habilitar logs, você pode examinar os documentos do pacote de @azure/agente.

Next steps

Por favor, dê uma olhada no diretório de exemplos para obter exemplos detalhados sobre como usar esta biblioteca.

Contributing

Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber mais sobre como criar e testar o código.

Related projects

• do SDK do Microsoft Azure para JavaScript