Compartir a través de

Biblioteca cliente helpRP de Azure para JavaScript: versión 1.0.0

  • Artículo

Este paquete contiene un SDK isomórfico (se ejecuta tanto en Node.js como en exploradores) para el cliente helpRP de Azure.

Proveedor de rp de ayuda

Código | fuentePaquete (NPM) | Documentación | de referencia de APIMuestras

Introducción

Entornos admitidos actualmente

Para más información, consulte la directiva de compatibilidad.

Requisitos previos

Instalar el paquete @azure/arm-selfhelp

Instale la biblioteca cliente helpRP de Azure para JavaScript con npm:

npm install @azure/arm-selfhelp

Crear y autenticar una HelpRP

Para crear un objeto de cliente para acceder a la API HelpRP de Azure, necesitará el endpoint del recurso HelpRP de Azure y un credential. El cliente helpRP de Azure puede usar credenciales de Azure Active Directory para autenticarse. Puede encontrar el punto de conexión del recurso HelpRP de Azure en Azure Portal.

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

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

npm install @azure/identity

También deberá registrar una nueva aplicación de AAD y conceder acceso a Azure HelpRP mediante la asignación del rol adecuado a la entidad de servicio (nota: los roles como "Owner" no concederán los permisos necesarios). Establezca los valores del identificador de cliente, el identificador de inquilino y el secreto de cliente de la aplicación de AAD como variables de entorno: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

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

const { HelpRP } = require("@azure/arm-selfhelp");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const client = new HelpRP(new DefaultAzureCredential());

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new HelpRP(credential, subscriptionId);

Paquete de JavaScript

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

Conceptos clave

HelpRP

HelpRP es la interfaz principal para los desarrolladores que usan la biblioteca cliente de Azure HelpRP. Explore los métodos de este objeto de cliente para comprender las diferentes características del servicio HelpRP de Azure al que puede acceder.

Solución de problemas

Registro

La habilitación del registro puede ayudar a descubrir información útil sobre los 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 @azure/logger:

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

Para obtener instrucciones más detalladas sobre cómo habilitar los registros, consulte los documentos del paquete @azure/logger.

Pasos siguientes

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

Contribuciones

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

Impresiones