Azure FileShares Client-Bibliothek für JavaScript - Version 1.0.0-beta.1

Dieses Paket enthält ein isomorphes SDK (läuft sowohl in Node.js als auch in Browsern) für Azure FileShares-Client.

Azure File Shares Resource Provider API.

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Details finden Sie in unserer Support-Richtlinie.

Voraussetzungen

Installieren Sie das @azure/arm-fileshares-Paket

Installiere die Azure FileShares-Clientbibliothek für JavaScript mit npm:

npm install @azure/arm-fileshares

Erstellen und Authentifizieren einer FileSharesClient

Um ein Client-Objekt zu erstellen, das auf die Azure FileShares-API zugreift, benötigen Sie die endpoint Ihrer Azure FileShares-Ressource und ein credential. Der Azure FileShares-Client kann Azure Active Directory-Anmeldedaten zur Authentifizierung verwenden. Den Endpunkt für deine Azure FileShares-Ressource findest du im Azure-Portal.

Sie können sich mit Azure Active Directory authentifizieren, indem Sie eine Berechtigung aus der Bibliothek @azure/identity oder einem bestehenden AAD Token authentifizieren.

Um den unten gezeigten Anbieter DefaultAzureCredential oder andere mit dem Azure SDK bereitgestellte Zugangsdatenanbieter zu verwenden, installieren Sie bitte das @azure/identity-Paket:

npm install @azure/identity

Sie müssen außerdem eine neue AAD-Anmeldung registrieren und Zugang zu Azure FileShares gewähren, indem Sie die geeignete Rolle Ihrem Service Principal zuweisen (Hinweis: Rollen wie "Owner" gewähren nicht die erforderlichen Berechtigungen).

Für weitere Informationen darüber, wie man eine Azure AD-Anwendung erstellt, siehe diesen Leitfaden.

Mithilfe von Node.js- und Node-ähnlichen Umgebungen können Sie die DefaultAzureCredential Klasse verwenden, um den Client zu authentifizieren.

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

Für Browserumgebungen verwenden Sie zur Authentifizierung das InteractiveBrowserCredential aus dem @azure/identity-Paket.

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

JavaScript-Bündel

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zuerst einen Bundler verwenden. Für Details dazu, wie to do wird, siehe bitte unsere bündelnde Dokumentation.

Wichtige Konzepte

FileSharesClient

FileSharesClient ist die primäre Schnittstelle für Entwickler, die die Azure FileShares-Client-Bibliothek verwenden. Erkunden Sie die Methoden auf diesem Client-Objekt, um die verschiedenen Funktionen des Azure FileShares-Dienstes zu verstehen, auf die Sie zugreifen können.

Beispiele

Erhalten Sie eine Dateifreigabe

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

Listen Dateianteile nach Abonnement

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

Erstellen oder aktualisieren Sie eine Dateifreigabe

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

Problembehandlung

Logging

Das Aktivieren der Protokollierung kann hilfreiche Informationen zu Fehlern aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die AZURE_LOG_LEVEL Umgebungsvariable auf infofest. Alternativ kann die Protokollierung zur Laufzeit durch Aufrufen von setLogLevel im @azure/loggeraktiviert werden:

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

setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in den @azure/Logger-Paketdokumenten.

Nächste Schritte

Bitte schauen Sie sich das Verzeichnis samples an, um detaillierte Beispiele zur Nutzung dieser Bibliothek zu finden.

Contributing

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den mitwirkenden Leitfaden, um mehr über das Erstellen und Testen des Codes zu erfahren.

  • Last updated on