Azure ApiManagement client library for JavaScript - versie 1.0.0-beta.1

Dit pakket bevat een isomorf SDK (draait zowel in Node.js als in browsers) voor Azure ApiManagement-client.

Sleutelkoppelingen:

Aan de slag

Momenteel ondersteunde omgevingen

Zie ons ondersteuningsbeleid voor meer informatie.

Prerequisites

Het @azure/arm-aigateway-pakket installeren

Installeer de Azure ApiManagement clientbibliotheek voor JavaScript met npm:

npm install @azure/arm-aigateway

Een ApiManagementClient maken en verifiëren

Om een clientobject te maken dat toegang krijgt tot de Azure ApiManagement API, heb je de endpoint van je Azure ApiManagement-resource en een credential. De Azure ApiManagement-client kan Microsoft Entra-credentials gebruiken om te authenticeren. Je kunt het eindpunt voor je Azure ApiManagement-resource vinden in de Azure Portal.

Je kunt authenticeren met Microsoft Entra ID met een inloggegevens uit de @azure/identity-bibliotheek of een bestaand Microsoft Entra-token.

Als u de DefaultAzureCredential- provider wilt gebruiken die hieronder wordt weergegeven, of andere referentieproviders die zijn opgegeven bij de Azure SDK, installeert u het @azure/identity-pakket:

npm install @azure/identity

Je moet ook een nieuwe Microsoft Entra-applicatie registreren en toegang verlenen tot Azure ApiManagement door de geschikte rol toe te wijzen aan je serviceprincipe (let op: rollen geven "Owner" niet de benodigde rechten).

Voor meer informatie over hoe je een Microsoft Entra-applicatie maakt, bekijk deze gids.

Met Node.js- en Node-achtige omgevingen kunt u de DefaultAzureCredential-klasse gebruiken om de client te verifiëren.

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);

Gebruik voor browseromgevingen de InteractiveBrowserCredential uit het @azure/identity-pakket om te verifiëren.

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);

JavaScript-bundel

Als u deze clientbibliotheek in de browser wilt gebruiken, moet u eerst een bundelaar gebruiken. Raadpleeg onze bundeldocumentatievoor meer informatie over hoe u dit doet.

Belangrijke concepten

ApiManagementClient

ApiManagementClientis de primaire interface voor ontwikkelaars die de Azure ApiManagement-clientbibliotheek gebruiken. Verken de methoden op dit clientobject om de verschillende functies van de Azure ApiManagement-service te begrijpen waar je toegang toe hebt.

Troubleshooting

Logging

Het inschakelen van logboekregistratie kan helpen nuttige informatie over fouten te ontdekken. Als u een logboek met HTTP-aanvragen en -antwoorden wilt zien, stelt u de omgevingsvariabele AZURE_LOG_LEVEL in op info. U kunt logboekregistratie ook tijdens runtime inschakelen door setLogLevel aan te roepen in de @azure/logger:

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

setLogLevel("info");

Voor meer gedetailleerde instructies over het inschakelen van logboeken, kunt u de @azure/logger pakketdocumentenbekijken.

Volgende stappen 

Bekijk de voorbeelden map voor gedetailleerde voorbeelden over het gebruik van deze bibliotheek.

Contributing

Als je wilt bijdragen aan deze bibliotheek, lees dan de bijdragende gids om meer te weten te komen over hoe je de code bouwt en test.