Azure RelayAPI client library for JavaScript - version 4.0.0

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

Korzystaj z tych API do zarządzania zasobami Azure Relay za pomocą Azure Resource Manager.

Kluczowe linki:

Rozpoczęcie pracy

Obecnie obsługiwane środowiska

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

Zobacz naszą politykę support po więcej szczegółów.

Wymagania wstępne

Instalowanie pakietu @azure/arm-relay

Zainstaluj bibliotekę klienta Azure RelayAPI dla JavaScript z :npm

npm install @azure/arm-relay

Twórz i uwierzytelnij RelayAPI

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

Możesz uwierzytelnić się Azure Active Directory używając poświadczenia z biblioteki @azure/identity lub istniejącego tokena AAD.

Aby korzystać z dostawcy DefaultAzureCredential pokazanego poniżej lub innych dostawców poświadczonych w Azure SDK, prosimy o zainstalowanie pakietu @azure/identity:

npm install @azure/identity

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

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

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

import { RelayAPI } from "@azure/arm-relay";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { RelayAPI } from "@azure/arm-relay";

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

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje na temat tego, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą sprzedaży wiązanej.

Kluczowe pojęcia

RelayAPI

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

Troubleshooting

Wyrąb

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

Proszę zajrzyj do katalogu samples, gdzie znajdziesz szczegółowe przykłady 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.

  • Last updated on