Compartir a través de

Biblioteca cliente de plantillas de Azure para JavaScript: versión 1.0.0-beta.1

  • Artículo

Este proyecto se usa como paquete de plantilla para el SDK de Azure para JavaScript. Está pensado para ayudar a los desarrolladores de Azure SDK a arrancar nuevos paquetes y proporciona un ejemplo de cómo organizar el código y la documentación de una biblioteca cliente para un servicio de Azure.

Introducción

Entornos admitidos actualmente

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

Requisitos previos

Normalmente, colocaría un comando de shell para aprovisionar los servicios de Azure necesarios aquí.

Instalar el paquete @azure/template

Instale la biblioteca cliente de plantilla para JavaScript con npm:

npm install @azure/template

Compatibilidad con exploradores

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.

CORS

Debe configurar reglas de uso compartido de recursos entre orígenes (CORS) para la cuenta de almacenamiento si necesita desarrollar para exploradores. Vaya a Azure Portal y Explorador de Azure Storage, busque la cuenta de almacenamiento, cree nuevas reglas de CORS para blob/queue/file/table service(s).

Por ejemplo, puede crear la siguiente configuración de CORS para la depuración. Pero personalice cuidadosamente la configuración según sus requisitos en un entorno de producción.

  • Orígenes permitidos: *
  • Verbos permitidos: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • Encabezados permitidos: *
  • Encabezados expuestos: *
  • Antigüedad máxima (segundos): 86400

Ejemplos adicionales

Los ejemplos de nivel superior suelen incluir cosas como crear y autenticar el cliente principal. Si el servicio admite varios medios de autenticación (por ejemplo, basados en claves y Azure Active Directory), puede proporcionar un ejemplo independiente de cada uno.

Conceptos clave

ConfigurationClient

Describa el cliente principal aquí. Hable sobre las operaciones que puede hacer y cuándo un desarrollador desea usarla.

Otros ejemplos

Cree una sección para cada concepto de servicio de nivel superior que quiera explicar.

Ejemplos

Primer ejemplo

Cree varios ejemplos de código para cómo alguien usaría la biblioteca para realizar una tarea común con el servicio.

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 que muestran cómo usar las bibliotecas cliente.

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