Sdílet prostřednictvím

Klientská knihovna azure Visual Studio Resource Provider pro JavaScript – verze 4.0.0-beta.2

  • Článek

Tento balíček obsahuje izomorfní sadu SDK (spouští se v Node.js i v prohlížečích) pro klienta azure Visual Studio Resource Provider.

Tato rozhraní API slouží ke správě Visual Studio Team Services prostředků prostřednictvím azure Resource Manager. Všechny operace úloh se řídí specifikací protokolu HTTP/1.1 a všechny operace vrací hlavičku x-ms-request-id, pomocí které je možné získat informace o daném požadavku. Je potřeba zajistit, aby všechny požadavky na tyto prostředky byly zabezpečené. Další informace najdete v tématu /rest/api/index.

Zdrojový kód | Balíček (NPM) | Referenční dokumentace k | rozhraní API Vzorky

Začínáme

Aktuálně podporovaná prostředí

  • LtS verze Node.js
  • Nejnovější verze prohlížečů Safari, Chrome, Edge a Firefox.

Další podrobnosti najdete v našich zásadách podpory .

Požadavky

Nainstalujte balíček @azure/arm-visualstudio.

Nainstalujte klientskou knihovnu Azure Visual Studio Resource Provider pro JavaScript pomocí npm:

npm install @azure/arm-visualstudio

Vytvoření a ověření VisualStudioResourceProviderClient

K vytvoření objektu klienta pro přístup k rozhraní API poskytovatele prostředků sady Azure Visual Studio budete potřebovat endpoint prostředek poskytovatele prostředků Sady Azure Visual Studio a credential. Klient zprostředkovatele prostředků Azure Visual Studio může k ověření použít přihlašovací údaje Azure Active Directory. Koncový bod pro prostředek poskytovatele prostředků sady Azure Visual Studio najdete na webu Azure Portal.

Pomocí Azure Active Directory se můžete ověřit pomocí přihlašovacích údajů z knihovny @azure/identity nebo existujícího tokenu AAD.

Pokud chcete použít zprostředkovatele DefaultAzureCredential uvedeného níže nebo jiné poskytovatele přihlašovacích údajů poskytovaného se sadou Azure SDK, nainstalujte @azure/identity balíček:

npm install @azure/identity

Budete také muset zaregistrovat novou aplikaci AAD a udělit přístup k poskytovateli prostředků sady Azure Visual Studio přiřazením vhodné role k instančnímu objektu (poznámka: role, jako "Owner" jsou, neudělí potřebná oprávnění). Nastavte hodnoty ID klienta, ID tenanta a tajného klíče klienta aplikace AAD jako proměnné prostředí: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

Další informace o tom, jak vytvořit aplikaci Azure AD, najdete v tomto průvodci.

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

Pokud chcete tuto klientskou knihovnu používat v prohlížeči, musíte nejprve použít bundler. Podrobnosti o tom, jak to udělat, najdete v naší dokumentaci k sdružování.

Klíčové koncepty

VisualStudioResourceProviderClient

VisualStudioResourceProviderClient je primární rozhraní pro vývojáře, kteří používají klientskou knihovnu azure Visual Studio Resource Provider. Prozkoumejte metody tohoto klientského objektu a seznamte se s různými funkcemi služby Azure Visual Studio Resource Provider, ke kterým máte přístup.

Řešení potíží

protokolování

Povolení protokolování může pomoct odhalit užitečné informace o selháních. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou AZURE_LOG_LEVEL prostředí na info. Případně je možné protokolování povolit za běhu voláním setLogLevel v :@azure/logger

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

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k balíčkům @azure/protokolovacího nástroje.

Další kroky

Podrobné příklady použití této knihovny najdete v adresáři samples .

Přispívání

Pokud chcete přispívat do této knihovny, přečtěte si prosím průvodce přispívání , kde se dozvíte více o tom, jak sestavit a otestovat kód.

Imprese