Azure CompanionAPI client library for JavaScript - version 1.0.0-beta.1

Tento balíček obsahuje izomorfní SDK (běží jak v Node.js, tak v prohlížečích) pro klienta CompanionAPI Azure.

Klíčové odkazy:

Začínáme

Aktuálně podporovaná prostředí

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

Předpoklady

  • Předplatné služby Azure.

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

Nainstalujte klientskou knihovnu Azure CompanionAPI pro JavaScript s npm:

npm install @azure/arm-napsteromniagentapi

Vytvořte a ověřte CompanionAPIClient

Pro vytvoření klientského objektu pro přístup k Azure CompanionAPI API budete potřebovat zdroj endpoint Azure CompanionAPI a .credential Klient Azure CompanionAPI může použít přihlašovací údaje Azure Active Directory k autentizaci. Endpoint pro váš Azure CompanionAPI zdroj najdete v 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 Azure CompanionAPI přiřazením vhodné role vašemu principálovi služby (poznámka: role jako například neudělí "Owner" potřebná oprávnění).

Další informace o tom, jak vytvořit aplikaci Azure AD, najdete této příručce.

Pomocí Node.js a prostředí podobných uzlům můžete k ověření klienta použít třídu DefaultAzureCredential.

import { CompanionAPIClient } from "@azure/arm-napsteromniagentapi";
import { DefaultAzureCredential } from "@azure/identity";

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

Pro prostředí prohlížeče použijte k ověření InteractiveBrowserCredential z balíčku @azure/identity.

import { InteractiveBrowserCredential } from "@azure/identity";
import { CompanionAPIClient } from "@azure/arm-napsteromniagentapi";

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

JavaScriptový balíček

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

CompanionAPIClient

CompanionAPIClientje hlavní rozhraní pro vývojáře využívající klientskou knihovnu Azure CompanionAPI. Prozkoumejte metody na tomto klientském objektu, abyste pochopili různé funkce služby Azure CompanionAPI, ke kterým máte přístup.

Řešení problémů

Logging

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:

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

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k @azure/protokolovacímu balíčku.

Další kroky

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

Contributing

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.

  • Last updated on