Azure ApiManagement 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 Azure ApiManagement.

Kluczowe linki:

Rozpoczęcie pracy

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.

Prerequisites

Instalowanie pakietu @azure/arm-aigateway

Zainstaluj bibliotekę klienta Azure ApiManagement dla JavaScript z :npm

npm install @azure/arm-aigateway

Twórz i uwierzytelnij ApiManagementClient

Aby utworzyć obiekt klienta do dostępu do API Azure ApiManagement, będziesz potrzebować zasobu endpoint Azure ApiManagement oraz .credential Klient Azure ApiManagement może używać danych uwierzytelniających Microsoft Entra do uwierzytelniania. Punkt końcowy dla swojego zasobu Azure ApiManagement znajdziesz w Azure Portal.

Możesz uwierzytelnić się za pomocą Microsoft Entra ID, używając poświadczenia z biblioteki @azure/identity lub istniejącego tokena Microsoft Entra.

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

npm install @azure/identity

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

Aby dowiedzieć się więcej o tym, jak stworzyć aplikację Microsoft Entra, sprawdź ten przewodnik.

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

import { ApiManagementClient } from "@azure/arm-aigateway";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { ApiManagementClient } from "@azure/arm-aigateway";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new ApiManagementClient(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 .

Podstawowe pojęcia

ApiManagementClient

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

Troubleshooting

Logging

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 przyczynić się do tej biblioteki, przeczytaj przewodnik wkład aby dowiedzieć się więcej o budowaniu i testowaniu kodu.

  • Ostatnia aktualizacja o