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

Este paquete contiene un SDK isomorfo (que se ejecuta tanto en Node.js como en navegadores) para Azure cliente CompanionAPI.

Vínculos clave:

Cómo empezar

Entornos admitidos actualmente

Consulte nuestra de directiva de soporte técnico de para obtener más información.

Prerequisites

Instalación del paquete @azure/arm-napsteromniagentapi

Instala la biblioteca cliente Azure CompanionAPI para JavaScript con npm:

npm install @azure/arm-napsteromniagentapi

Creación y autenticación de un CompanionAPIClient

Para crear un objeto cliente que pueda acceder a la API de Azure CompanionAPI, necesitarás el endpoint recurso de tu recurso CompanionAPI de Azure y un credentialarchivo . El cliente CompanionAPI de Azure puede utilizar credenciales de Azure Active Directory para autenticarse. Puedes encontrar el endpoint para tu recurso Azure CompanionAPI en el Azure Portal.

Puede autenticarse con Azure Active Directory mediante una credencial de la biblioteca de de @azure/identidad o un token de AAD existente.

Para usar el proveedor de de DefaultAzureCredential que se muestra a continuación u otros proveedores de credenciales proporcionados con el SDK de Azure, instale el paquete de @azure/identity:

npm install @azure/identity

También tendrás que registrar una nueva aplicación AAD y conceder acceso a Azure CompanionAPI asignando el rol adecuado a tu principal de servicio (nota: roles como no "Owner" concederán los permisos necesarios).

Para más información sobre cómo crear una aplicación de Azure AD, consulte esta guía.

Con Node.js y entornos similares a nodos, puede usar la clase DefaultAzureCredential para autenticar al cliente.

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

En el caso de los entornos del explorador, use el InteractiveBrowserCredential del paquete de @azure/identity para autenticarse.

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

Paquete de JavaScript

Para usar esta biblioteca cliente en el explorador, primero debe usar un agrupador. Para obtener más información sobre cómo hacerlo, consulte nuestra documentación de agrupación de .

Conceptos clave

CompanionAPIClient

CompanionAPIClientes la interfaz principal para desarrolladores que utilizan la biblioteca cliente Azure CompanionAPI. Explora los métodos de este objeto cliente para entender las diferentes características del servicio Azure CompanionAPI a las que puedes acceder.

Solución de problemas

Registro

Habilitar el registro puede ayudar a descubrir información útil sobre errores. Para ver un registro de solicitudes y respuestas HTTP, establezca la variable de entorno AZURE_LOG_LEVEL en info. Como alternativa, el registro se puede habilitar en tiempo de ejecución llamando a setLogLevel en el @azure/logger:

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

setLogLevel("info");

Para obtener instrucciones más detalladas sobre cómo habilitar los registros, puede consultar los documentos del paquete de @azure/registrador.

Pasos siguientes

Eche un vistazo al directorio ejemplos para obtener ejemplos detallados sobre cómo usar esta biblioteca.

Contributing

Si desea contribuir a esta biblioteca, lea la guía de contribución de para obtener más información sobre cómo compilar y probar el código.

  • Last updated on