Azure FileShares client libreria per 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 FileShares.

API del provider di risorse Azure File Sharing.

Collegamenti chiave:

Come iniziare

Ambienti attualmente supportati

Consulta la nostra politica support per maggiori dettagli.

Prerequisiti

Installare il pacchetto @azure/arm-fileshares

Installa la libreria client Azure FileShares per JavaScript con npm:

npm install @azure/arm-fileshares

Creare ed autenticare un FileSharesClient

Per creare un oggetto client per accedere all'API Azure FileShares, avrai bisogno del endpoint della tua risorsa Azure FileShares e di un credential. Il client Azure FileShares può utilizzare le credenziali di Azure Active Directory per autenticarsi. Puoi trovare l'endpoint per la tua risorsa Azure FileShares nel portale di Azure.

Puoi autenticarti con Azure Active Directory usando una credenziale della libreria @azure/identity oppure un token AAD esistente.

Per utilizzare il provider DefaultAzureCredential mostrato qui sotto, o altri fornitori di credenziali forniti con il Azure SDK, si prega di installare il pacchetto @azure/identity:

npm install @azure/identity

Dovrai inoltre registrare una nuova domanda AAD e concedere l'accesso a Azure FileShares assegnando il ruolo appropriato al tuo principale di servizio (nota: ruoli come "Owner" non concederanno i permessi necessari).

Per maggiori informazioni su come creare una Azure applicazione AD, consulta questa guida.

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

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

Per gli ambienti browser, usa il InteractiveBrowserCredential dal pacchetto @azure/identity per autenticarti.

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

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

FileSharesClient

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

Examples

Ottieni una condivisione file

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

Condivisioni di file di lista tramite abbonamento

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

Crea o aggiorna una condivisione file

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

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

Dai un'occhiata alla directory samples per esempi dettagliati su come usare questa libreria.

Contributing

Per contribuire a questa libreria, leggere la guida contribuire per altre informazioni su come compilare e testare il codice.