Sdílet prostřednictvím

Klientská knihovna AzureTerraformResourceProvider pro JavaScript

  • Článek

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

Rozhraní API pro správu Azure Terraformu poskytuje sadu webových služeb RESTful, které slouží ke správě prostředků Azure Terraformu.

Klíčové odkazy:

  • balíčku (NPM)
  • Referenční dokumentace k rozhraní API

Začínáme

Aktuálně podporovaná prostředí

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

Požadavky

Instalace balíčku @azure/arm-terraform

Nainstalujte klientskou knihovnu AzureTerraformResourceProvider pro JavaScript pomocí npm:

npm install @azure/arm-terraform

Vytvoření a ověření AzureTerraformClient

Pokud chcete vytvořit objekt klienta pro přístup k rozhraní API AzureTerraformResourceProvider, budete potřebovat endpoint prostředku AzureTerraformResourceProvider a credential. Klient AzureTerraformResourceProvider může k ověření použít přihlašovací údaje Azure Active Directory. Koncový bod prostředku AzureTerraformResourceProvider 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 poskytovatele DefaultAzureCredential zobrazené níže nebo jiné zprostředkovatele přihlašovacích údajů poskytnuté sadou Azure SDK, nainstalujte balíček @azure/identity:

npm install @azure/identity

Budete také muset zaregistrovat novou aplikaci AAD a udělit přístup k azureTerraformResourceProvider přiřazením vhodné role k instančnímu objektu (poznámka: role, jako je například "Owner" 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 této příručce.

const { AzureTerraformClient } = require("@azure/arm-terraform");
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 AzureTerraformClient(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 AzureTerraformClient(credential, subscriptionId);

JavaScript Bundle

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

Klíčové koncepty

AzureTerraformClient

AzureTerraformClient je primárním rozhraním pro vývojáře, kteří používají klientskou knihovnu AzureTerraformResourceProvider. Prozkoumejte metody tohoto objektu klienta, abyste porozuměli různým funkcím služby AzureTerraformResourceProvider, ke které máte přístup.

Řešení problémů

Protokolování

Povolení protokolování může pomoct odhalit užitečné informace o chybách. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou prostředí AZURE_LOG_LEVEL na info. Případně můžete 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 @azure/protokolovacímu balíčku.

Přispívající

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.