Freigeben über

Azure Visual Studio-Ressourcenanbieter-Clientbibliothek für JavaScript – Version 4.0.0-beta.2

  • Artikel

Dieses Paket enthält ein isomorphes SDK (wird sowohl in Node.js als auch in Browsern) für den Azure Visual Studio-Ressourcenanbieterclient ausgeführt.

Verwenden Sie diese APIs, um Visual Studio Team Services Ressourcen über die Azure-Resource Manager zu verwalten. Alle Taskvorgänge entsprechen der HTTP/1.1-Protokollspezifikation, und jeder Vorgang gibt einen x-ms-request-id-Header zurück, der zum Abrufen von Informationen zu der Anforderung verwendet werden kann. Sie müssen sicherstellen, dass Anforderungen, die an diese Ressourcen gesendet werden, sicher sind. Weitere Informationen finden Sie unter /rest/api/index.

Quellcode | Paket (NPM) | API-Referenzdokumentation | Proben

Erste Schritte

Die derzeitig unterstützten Umgebungen

Ausführlichere Informationen finden Sie in der Supportrichtlinie.

Voraussetzungen

Installieren Sie das Paket @azure/arm-visualstudio.

Installieren Sie die Azure Visual Studio-Ressourcenanbieter-Clientbibliothek für JavaScript mit npm:

npm install @azure/arm-visualstudio

Erstellen und Authentifizieren eines VisualStudioResourceProviderClient

Um ein Clientobjekt für den Zugriff auf die Azure Visual Studio-Ressourcenanbieter-API zu erstellen, benötigen Sie die endpoint ihrer Azure Visual Studio-Ressourcenanbieterressource und eine credential. Der Azure Visual Studio-Ressourcenanbieterclient kann Azure Active Directory-Anmeldeinformationen zur Authentifizierung verwenden. Sie finden den Endpunkt für Ihre Azure Visual Studio-Ressourcenanbieterressource im Azure-Portal.

Sie können sich mit Azure Active Directory mithilfe von Anmeldeinformationen aus der @azure-/Identitätsbibliothek oder einem vorhandenen AAD-Token authentifizieren.

Um den unten gezeigten Anbieter DefaultAzureCredential oder andere anbieter von Anmeldeinformationen zu verwenden, die mit dem Azure SDK bereitgestellt werden, installieren Sie das @azure/identity Paket:

npm install @azure/identity

Außerdem müssen Sie eine neue AAD-Anwendung registrieren und den Zugriff auf den Azure Visual Studio-Ressourcenanbieter gewähren , indem Sie Ihrem Dienstprinzipal die geeignete Rolle zuweisen (Hinweis: Rollen wie "Owner" erteilen nicht die erforderlichen Berechtigungen). Legen Sie die Werte der Client-ID, Mandanten-ID und geheimen Clientschlüssel der AAD-Anwendung als Umgebungsvariablen fest: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

Weitere Informationen zum Erstellen einer Azure AD-Anwendung finden Sie in diesem Leitfaden.

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

JavaScript-Bundle

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zunächst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.

Wichtige Begriffe

VisualStudioResourceProviderClient

VisualStudioResourceProviderClient ist die primäre Schnittstelle für Entwickler, die die Azure Visual Studio-Ressourcenanbieter-Clientbibliothek verwenden. Erkunden Sie die Methoden für dieses Clientobjekt, um die verschiedenen Features des Azure Visual Studio-Ressourcenanbieterdiensts zu verstehen, auf den Sie zugreifen können.

Problembehandlung

Protokollierung

Die Aktivierung der Protokollierung kann hilfreiche Informationen über Fehler aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die Umgebungsvariable AZURE_LOG_LEVEL auf info fest. Alternativ kann die Protokollierung zur Laufzeit aktiviert werden, indem Sie setLogLevel in @azure/logger aufrufen:

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

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in der Paketdokumentation zu @azure/logger.

Nächste Schritte

Ausführliche Beispiele zur Verwendung dieser Bibliothek finden Sie im Beispielverzeichnis .

Mitwirken

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie die Anleitung für Mitwirkende, um mehr darüber zu erfahren, wie Sie den Code erstellen und testen können.

Aufrufe