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

Questo pacchetto contiene un SDK isomorfo (che funziona sia in Node.js che nei browser) per Azure client ApiManagement.

Collegamenti chiave:

Come iniziare

Ambienti attualmente supportati

Per altri dettagli, vedere i criteri di supporto .

Prerequisites

Installare il pacchetto @azure/arm-aigateway

Installa la libreria client Azure ApiManagement per JavaScript con npm:

npm install @azure/arm-aigateway

Creare ed autenticare un ApiManagementClient

Per creare un oggetto client per accedere all'API Azure ApiManagement, avrai bisogno della endpoint tua risorsa Azure ApiManagement e di un credentialfile . Il client Azure ApiManagement può utilizzare le credenziali Microsoft Entra per autenticarsi. Puoi trovare l'endpoint per la tua risorsa Azure ApiManagement nell'portale di Azure.

Puoi autenticarti con Microsoft Entra ID usando una credenziale dalla libreria @azure/identity o da un token Microsoft Entra esistente.

Per usare il provider DefaultAzureCredential illustrato di seguito o altri provider di credenziali forniti con Azure SDK, installare il pacchetto :

npm install @azure/identity

Dovrai inoltre registrare una nuova applicazione Microsoft Entra e concedere l'accesso ad Azure ApiManagement assegnando il ruolo appropriato al tuo responsabile di servizio (nota: ruoli come non "Owner" concederanno i permessi necessari).

Per maggiori informazioni su come creare un'applicazione Microsoft Entra, consulta questa guida.

Usando Node.js e ambienti simili a Node, è possibile usare la classe DefaultAzureCredential per autenticare il client.

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

Per gli ambienti del browser, usare il InteractiveBrowserCredential dal pacchetto di @azure/identity per l'autenticazione.

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

Pacchetto JavaScript

Per usare questa libreria client nel browser, è prima necessario usare un bundler. Per informazioni dettagliate su come eseguire questa operazione, vedere la documentazione di creazione di bundle .

Concetti chiave

ApiManagementClient

ApiManagementClientè l'interfaccia principale per gli sviluppatori che utilizzano la libreria client Azure ApiManagement. Esplora i metodi su questo oggetto client per comprendere le diverse funzionalità del servizio Azure ApiManagement a cui puoi accedere.

Troubleshooting

Logging

L'abilitazione della registrazione può aiutare a individuare informazioni utili sugli errori. Per visualizzare un log di richieste e risposte HTTP, impostare la variabile di ambiente AZURE_LOG_LEVEL su info. In alternativa, la registrazione può essere abilitata in fase di esecuzione chiamando setLogLevel nel @azure/logger:

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

setLogLevel("info");

Per istruzioni più dettagliate su come abilitare i log, è possibile esaminare la documentazione del pacchetto @azure/logger.

Passaggi successivi

Per esempi dettagliati su come usare questa libreria, vedere gli esempi di directory.

Contributing

Se desideri contribuire a questa libreria, leggi la guida contributi per saperne di più su come costruire e testare il codice.