Udostępnij za pośrednictwem

Biblioteka klienta dostawcy zasobów programu Azure Visual Studio dla języka JavaScript — wersja 4.0.0-beta.2

  • Artykuł

Ten pakiet zawiera zestaw SDK izomorficzny (uruchamiany zarówno w Node.js, jak i w przeglądarkach) dla klienta dostawcy zasobów programu Azure Visual Studio.

Te interfejsy API umożliwiają zarządzanie zasobami Visual Studio Team Services za pośrednictwem usługi Azure Resource Manager. Wszystkie operacje zadań są zgodne ze specyfikacją protokołu HTTP/1.1 i każda operacja zwraca nagłówek x-ms-request-id, którego można użyć do uzyskania informacji o żądaniu. Musisz się upewnić, że żądania wysyłane do tych zasobów są bezpieczne. Aby uzyskać więcej informacji, zobacz /rest/api/index.

Kod | źródłowy Pakiet (NPM) | Dokumentacja referencyjna interfejsu | API Próbki

Wprowadzenie

Obecnie obsługiwane środowiska

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

Wymagania wstępne

Instalowanie pakietu @azure/arm-visualstudio

Zainstaluj bibliotekę klienta dostawcy zasobów programu Azure Visual Studio dla języka JavaScript za pomocą polecenia npm:

npm install @azure/arm-visualstudio

Tworzenie i uwierzytelnianie VisualStudioResourceProviderClient

Aby utworzyć obiekt klienta w celu uzyskania dostępu do interfejsu API dostawcy zasobów programu Azure Visual Studio, musisz mieć endpoint zasób dostawcy zasobów programu Azure Visual Studio i element credential. Klient dostawcy zasobów programu Azure Visual Studio może uwierzytelniać się przy użyciu poświadczeń usługi Azure Active Directory. Punkt końcowy zasobu dostawcy zasobów programu Azure Visual Studio można znaleźć w witrynie 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ć podanego poniżej dostawcy DefaultAzureCredential lub innych dostawców poświadczeń dostarczanych z zestawem Azure SDK, zainstaluj @azure/identity pakiet:

npm install @azure/identity

Należy również zarejestrować nową aplikację usługi AAD i udzielić dostępu do dostawcy zasobów programu Azure Visual Studio , przypisując odpowiednią rolę do jednostki usługi (uwaga: role, takie jak "Owner" nie będą udzielać niezbędnych uprawnień). Ustaw wartości identyfikatora klienta, identyfikatora dzierżawy i klucza tajnego klienta aplikacji usługi AAD jako zmienne środowiskowe: AZURE_CLIENT_ID, , AZURE_CLIENT_SECRETAZURE_TENANT_ID.

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

const { VisualStudioResourceProviderClient } = require("@azure/arm-visualstudio");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

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

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new VisualStudioResourceProviderClient(credential, subscriptionId);

Pakiet JavaScript

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

Kluczowe pojęcia

VisualStudioResourceProviderClient

VisualStudioResourceProviderClient jest podstawowym interfejsem dla deweloperów korzystających z biblioteki klienta dostawcy zasobów programu Azure Visual Studio. Zapoznaj się z metodami w tym obiekcie klienta, aby zrozumieć różne funkcje usługi Dostawcy zasobów programu Azure Visual Studio, do których można uzyskać dostęp.

Rozwiązywanie problemów

Rejestrowanie

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

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentami dotyczącymi pakietów @azure/rejestratora.

Następne kroki

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

Współtworzenie

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

Wrażenia