Azure ApiManagement 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 Azure ApiManagement.

Klíčové odkazy:

Začínáme

Aktuálně podporovaná prostředí

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

Prerequisites

  • Předplatné služby Azure.

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

Nainstalujte klientskou knihovnu Azure ApiManagement pro JavaScript s npm:

npm install @azure/arm-aigateway

Vytvořte a ověřte ApiManagementClient

Pro vytvoření klientského objektu pro přístup k Azure ApiManagement API budete potřebovat svůj endpoint Azure ApiManagement zdroj a .credential Klient Azure ApiManagement může k autentizaci použít přihlašovací údaje Microsoft Entra. Endpoint pro váš Azure ApiManagement zdroj najdete v Azure Portal.

Můžete se autentizovat pomocí Microsoft Entra ID pomocí přihlašovacích údajů z knihovny @azure/identity nebo existujícího Microsoft Entra tokenu.

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 Microsoft Entra a udělit přístup k Azure ApiManagement přiřazením příslušné role vašemu principálovi služby (poznámka: role jako například neudělí "Owner" potřebná oprávnění).

Pro více informací o tom, jak vytvořit aplikaci Microsoft Entra, si přečtěte tento průvodce.

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

import { ApiManagementClient } from "@azure/arm-aigateway";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new ApiManagementClient(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 { ApiManagementClient } from "@azure/arm-aigateway";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new ApiManagementClient(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

ApiManagementClient

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

Troubleshooting

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 byste chtěli přispět 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 kód sestavit a testovat.

  • Poslední aktualizace v