Azure FileShares client library voor JavaScript - versie 1.0.0-beta.1

Dit pakket bevat een isomorfe SDK (draait zowel in Node.js als in browsers) voor Azure FileShares-client.

Azure File Shares Resource Provider API.

Sleutelkoppelingen:

Aan de slag

Momenteel ondersteunde omgevingen

Zie ons supportbeleid voor meer details.

Prerequisites

Het @azure/arm-fileshares-pakket installeren

Installeer de Azure FileShares-clientbibliotheek voor JavaScript met npm:

npm install @azure/arm-fileshares

Een FileSharesClient maken en verifiëren

Om een clientobject te maken dat toegang krijgt tot de Azure FileShares API, heb je de endpoint van je Azure FileShares-resource en een credential nodig. De Azure FileShares-client kan Azure Active Directory-credentials gebruiken om te authenticeren. Je kunt het eindpunt voor je Azure FileShares-bron vinden in de Azure Portal.

Je kunt je authenticeren bij Azure Active Directory met een inloggegevens uit de bibliotheek @azure/identity of een bestaande AAD Token.

Om de hieronder getoonde DefaultAzureCredential provider te gebruiken, of andere inlogproviders die bij de Azure SDK zijn geleverd, installeer dan het pakket @azure/identity:

npm install @azure/identity

Je zult ook een nieuwe AAD-aanvraag moeten registreren en toegang verlenen tot Azure FileShares door de geschikte rol toe te wijzen aan je diensthoofd (let op: rollen zoals "Owner" geven niet de benodigde rechten).

Voor meer informatie over hoe je een Azure AD-applicatie maakt, kijk dan op deze gids.

Met Node.js- en Node-achtige omgevingen kunt u de DefaultAzureCredential-klasse gebruiken om de client te verifiëren.

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

Voor browseromgevingen gebruik je de InteractiveBrowserCredential uit het @azure/identity-pakket om te authenticeren.

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-bundel

Als u deze clientbibliotheek in de browser wilt gebruiken, moet u eerst een bundelaar gebruiken. Raadpleeg onze bundeldocumentatie voor meer informatie over hoe u dit doet.

belangrijke concepten

FileSharesClient

FileSharesClient is de primaire interface voor ontwikkelaars die de Azure FileShares clientbibliotheek gebruiken. Verken de methoden op dit clientobject om de verschillende functies van de Azure FileShares-dienst te begrijpen die je kunt gebruiken.

Voorbeelden

Download een File Share

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

Lijst Bestandsdelen per 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);

Maak een bestandsdeling aan of werk het bij

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

Het inschakelen van logboekregistratie kan helpen nuttige informatie over fouten te ontdekken. Als u een logboek met HTTP-aanvragen en -antwoorden wilt zien, stelt u de omgevingsvariabele AZURE_LOG_LEVEL in op info. U kunt logboekregistratie ook tijdens runtime inschakelen door setLogLevel aan te roepen in de @azure/logger:

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

setLogLevel("info");

Voor meer gedetailleerde instructies over het inschakelen van logboeken, kunt u de @azure/logger pakketdocumentenbekijken.

Volgende stappen 

Bekijk alsjeblieft de directory samples voor gedetailleerde voorbeelden van hoe je deze bibliotheek kunt gebruiken.

Contributing

Als u een bijdrage wilt leveren aan deze bibliotheek, leest u de gids voor bijdragen voor meer informatie over het bouwen en testen van de code.