Azure CompanionAPI client library for JavaScript - version 1.0.0-beta.1

Ten pakiet zawiera izomorficzne SDK (działające zarówno w Node.js, jak i w przeglądarkach) dla klienta CompanionAPI Azure.

Kluczowe linki:

Wprowadzenie

Obecnie obsługiwane środowiska

  • Wersje LTS systemu Node.js
  • Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.

Aby uzyskać więcej informacji, zobacz nasze zasad pomocy technicznej.

Wymagania wstępne

Instalowanie pakietu @azure/arm-napsteromniagentapi

Zainstaluj bibliotekę klienta Azure CompanionAPI dla JavaScript za pomocą npm:

npm install @azure/arm-napsteromniagentapi

Twórz i uwierzytelnij CompanionAPIClient

Aby utworzyć obiekt klienta do dostępu do API Azure CompanionAPI, będziesz potrzebować zasobu endpoint Azure CompanionAPI oraz .credential Klient Azure CompanionAPI może używać poświadczeń Azure Active Directory do uwierzytelniania. Punkt końcowy dla swojego zasobu Azure CompanionAPI znajdziesz w Azure Portal.

Możesz uwierzytelnić się w usłudze Azure Active Directory przy użyciu poświadczeń z biblioteki @azure/tożsamości lub istniejącego tokenu usługi AAD.

Aby użyć domyślnego dostawcyAzureCredential pokazanego poniżej lub innych dostawców poświadczeń dostarczonych z zestawem Azure SDK, zainstaluj @azure/identity pakiet:

npm install @azure/identity

Będziesz także musiał zarejestrować nową aplikację AAD i przyznać dostęp do Azure CompanionAPI, przypisując odpowiednią rolę swojemu podmiotowi usługowemu (uwaga: role takie jak A. "Owner" nie przydzielą niezbędnych uprawnień).

Aby uzyskać więcej informacji na temat tworzenia aplikacji usługi Azure AD, zapoznaj się z tym przewodnikiem.

Korzystając ze środowisk Node.js i środowisk podobnych do węzłów, możesz użyć klasy DefaultAzureCredential do uwierzytelniania klienta.

import { CompanionAPIClient } from "@azure/arm-napsteromniagentapi";
import { DefaultAzureCredential } from "@azure/identity";

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

W przypadku środowisk przeglądarki użyj InteractiveBrowserCredential z pakietu @azure/identity do uwierzytelniania.

import { InteractiveBrowserCredential } from "@azure/identity";
import { CompanionAPIClient } from "@azure/arm-napsteromniagentapi";

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

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów .

Kluczowe pojęcia

CompanionAPIClient

CompanionAPIClientjest głównym interfejsem dla programistów korzystających z biblioteki klienta Azure CompanionAPI. Poznaj metody tego obiektu klienta, aby zrozumieć różne funkcje usługi Azure CompanionAPI, do których masz dostęp.

Rozwiązywanie problemów

Przemysł drzewny

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną środowiskową AZURE_LOG_LEVEL na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel w @azure/logger:

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

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentacją pakietu @azure/logger.

Następne kroki

Zapoznaj się z przykładami katalogu, aby zapoznać się ze szczegółowymi przykładami dotyczącymi korzystania z tej biblioteki.

Contributing

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.

  • Last updated on