AzureTerraformResourceProvider-klientbibliotek för JavaScript

Det här paketet innehåller en isomorf SDK (körs både i Node.js och i webbläsare) för AzureTerraformResourceProvider-klienten.

Azure Terraform-hanterings-API:et tillhandahåller en RESTful-uppsättning webbtjänster som används för att hantera dina Azure Terraform-resurser.

Nyckellänkar:

Komma igång

Miljöer som stöds för närvarande

Mer information finns i vår supportprincip.

Förutsättningar

Installera @azure/arm-terraform-paketet

Installera AzureTerraformResourceProvider-klientbiblioteket för JavaScript med npm:

npm install @azure/arm-terraform

Skapa och autentisera en AzureTerraformClient

Om du vill skapa ett klientobjekt för att komma åt API:et AzureTerraformResourceProvider behöver du endpoint för din AzureTerraformResourceProvider-resurs och en credential. AzureTerraformResourceProvider-klienten kan använda Azure Active Directory-autentiseringsuppgifter för att autentisera. Du hittar slutpunkten för din AzureTerraformResourceProvider-resurs i Azure-portalen.

Du kan autentisera med Azure Active Directory med hjälp av en autentiseringsuppgift från biblioteket @azure/identitet eller en befintlig AAD-token.

Installera -paketet om du vill använda @azure/identity som visas nedan eller andra leverantörer av autentiseringsuppgifter som tillhandahålls med Azure SDKs:

npm install @azure/identity

Du måste också registrera ett nytt AAD-program och bevilja åtkomst till AzureTerraformResourceProvider genom att tilldela lämplig roll till tjänstens huvudnamn (obs! roller som "Owner" beviljar inte nödvändiga behörigheter). Ange värdena för klient-ID, klient-ID och klienthemlighet för AAD-programmet som miljövariabler: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

Mer information om hur du skapar ett Azure AD-program finns i den här guiden.

Med hjälp av Node.js- och Node-liknande miljöer kan du använda klassen DefaultAzureCredential för att autentisera klienten.

import { AzureTerraformClient } from "@azure/arm-terraform";
import { DefaultAzureCredential } from "@azure/identity";

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

För webbläsarmiljöer använder du InteractiveBrowserCredential från @azure/identity-paketet för att autentisera.

import { InteractiveBrowserCredential } from "@azure/identity";
import { AzureTerraformClient } from "@azure/arm-terraform";

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

JavaScript-paket

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

Viktiga begrepp

AzureTerraformClient

AzureTerraformClient är det primära gränssnittet för utvecklare som använder klientbiblioteket AzureTerraformResourceProvider. Utforska metoderna i det här klientobjektet för att förstå de olika funktionerna i tjänsten AzureTerraformResourceProvider som du kan komma åt.

Felsökning

Skogsavverkning

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg med HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i @azure/logger-paketdokumenten.

Bidragande

Om du vill bidra till det här biblioteket kan du läsa bidragsguide för att lära dig mer om hur du skapar och testar koden.

  • Last updated on