Azure FileShares biblioteca cliente para JavaScript - versión 1.0.0-beta.1

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

API del proveedor de recursos de Azure File Sharing.

Vínculos clave:

Cómo empezar

Entornos admitidos actualmente

Consulta nuestra política soporte para más detalles.

Prerrequisitos

Instalación del paquete @azure/arm-fileshares

Instala la biblioteca cliente Azure FileShares para JavaScript con npm:

npm install @azure/arm-fileshares

Creación y autenticación de un FileSharesClient

Para crear un objeto cliente que acceda a la API de Azure FileShares, necesitarás el endpoint de tu recurso Azure FileShares y un credential. El cliente de Azure FileShares puede usar credenciales de Azure Active Directory para autenticarse. Puedes encontrar el endpoint para tu recurso Azure FileShares en el Azure Portal.

Puedes autenticarte con Azure Active Directory usando una credencial de la biblioteca @azure/identity o un token AAD existente.

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

npm install @azure/identity

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

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

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

import { FileSharesClient } from "@azure/arm-fileshares";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(new DefaultAzureCredential(), subscriptionId);

Para entornos de navegador, utiliza el InteractiveBrowserCredential del paquete @azure/identity para autenticarte.

import { InteractiveBrowserCredential } from "@azure/identity";
import { FileSharesClient } from "@azure/arm-fileshares";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(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

FileSharesClient

FileSharesClient es la interfaz principal para desarrolladores que utilizan la biblioteca cliente Azure FileShares. Explora los métodos en este objeto cliente para entender las diferentes características del servicio Azure FileShares al que puedes acceder.

Examples

Consigue un archivo compartido

import { FileSharesClient } from "@azure/arm-fileshares";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(new DefaultAzureCredential(), subscriptionId);
const result = await client.fileShares.get("myResourceGroup", "myFileShare");
console.log(result);

Comparte archivos de lista por suscripción

import { FileSharesClient } from "@azure/arm-fileshares";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(new DefaultAzureCredential(), subscriptionId);
const shares = [];
for await (const item of client.fileShares.listBySubscription()) {
  shares.push(item);
}
console.log(shares);

Crear o actualizar un archivo compartido

import { FileSharesClient } from "@azure/arm-fileshares";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(new DefaultAzureCredential(), subscriptionId);
const result = await client.fileShares.createOrUpdate("myResourceGroup", "myFileShare", {
  properties: {
    mountName: "myfileshare",
    mediaTier: "SSD",
    redundancy: "Local",
    protocol: "NFS",
    provisionedStorageGiB: 8,
  },
  location: "westus",
});
console.log(result);

Solución de problemas

Logging

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

Por favor, echa un vistazo al directorio samples para encontrar 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