Sdílet prostřednictvím


Klientská knihovna Azure Open Energy Platform Management pro JavaScript – verze 1.0.0-beta.3

Tento balíček obsahuje izomorfní sadu SDK (běží v Node.js i v prohlížečích) pro klienta azure Open Energy Platform Management.

Open Energy Platform Management Service API

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-oep.

Nainstalujte klientskou knihovnu Azure Open Energy Platform Management pro JavaScript pomocí npmpříkazu :

npm install @azure/arm-oep

Vytvoření a ověření OpenEnergyPlatformManagementServiceAPIs

Pokud chcete vytvořit objekt klienta pro přístup k rozhraní API pro správu platformy Azure Open Energy Platform, budete potřebovat endpoint prostředek azure Open Energy Platform Management a credential. Klient azure Open Energy Platform Management může k ověření použít přihlašovací údaje Azure Active Directory. Koncový bod pro prostředek správy platformy Azure Open Energy Platform najdete na webu Azure Portal.

K ověření můžete použít Azure Active Directory přihlašovací údaje z knihovny @azure/identity nebo existujícího tokenu AAD.

Pokud chcete použít zprostředkovatele DefaultAzureCredential uvedeného níže nebo jiné zprostředkovatele přihlašovacích údajů poskytnuté 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 ke správě platformy Azure Open Energy Platform tím, že k instančnímu objektu přiřadíte vhodnou roli (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 { OpenEnergyPlatformManagementServiceAPIs } = require("@azure/arm-oep");
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 OpenEnergyPlatformManagementServiceAPIs(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 OpenEnergyPlatformManagementServiceAPIs(credential, subscriptionId);

JavaScript Bundle

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

Klíčové koncepty

OpenEnergyPlatformManagementServiceAPIs

OpenEnergyPlatformManagementServiceAPIs je primární rozhraní pro vývojáře, kteří používají klientskou knihovnu Azure Open Energy Platform Management. Prozkoumejte metody tohoto objektu klienta a seznamte se s různými funkcemi služby Azure Open Energy Platform Management, 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 ukázek .

Přispívání

Pokud chcete přispívat do této knihovny, přečtěte si příručku pro přispívání , kde najdete další informace o tom, jak sestavit a otestovat kód.

Imprese