Azure FileShares klientbibliotek för JavaScript - version 1.0.0-beta.1

Detta paket innehåller ett isomorft SDK (körs både i Node.js och i webbläsare) för Azure FileShares-klient.

Azure File Shares Resource Provider API.

Nyckellänkar:

Komma igång

Miljöer som stöds för närvarande

Se vår supportpolicy för mer information.

Förutsättningar

Installera @azure/arm-fileshares-paketet

Installera Azure FileShares-klientbiblioteket för JavaScript med npm:

npm install @azure/arm-fileshares

Skapa och autentisera en FileSharesClient

För att skapa ett klientobjekt för att komma åt Azure FileShares API behöver du endpoint från din Azure FileShares-resurs och en credential. Azure FileShares-klienten kan använda Azure Active Directory-uppgifter för att autentisera. Du kan hitta slutpunkten för din Azure FileShares-resurs i Azure Portal.

Du kan autentisera dig med Azure Active Directory med en legitimation från biblioteket @azure/identity eller en befintlig AAD Token.

För att använda leverantören DefaultAzureCredential som visas nedan, eller andra inloggningsuppgifter som tillhandahålls med Azure SDKs, vänligen installera paketet @azure/identity:

npm install @azure/identity

Du måste också registrera en ny AAD-ansökan och ge tillgång till Azure FileShares genom att tilldela lämplig roll till din tjänsteansvarig (obs: roller som "Owner" ger inte nödvändiga behörigheter).

För mer information om hur man skapar en Azure AD-applikation, kolla in denna guide.

Med hjälp av Node.js- och Node-liknande miljöer kan du använda klassen DefaultAzureCredential för att autentisera klienten.

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 webbläsarmiljöer, använd InteractiveBrowserCredential från paketet @azure/identity för autentisering.

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

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

Viktiga begrepp

FileSharesClient

FileSharesClient är det primära gränssnittet för utvecklare som använder klientbiblioteket Azure FileShares. Utforska metoderna på detta klientobjekt för att förstå de olika funktionerna i Azure FileShares-tjänsten som du kan komma åt.

Exempel

Skaffa en fildelning

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

Listfildelningar per prenumeration

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

Skapa eller uppdatera en fildelning

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

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg med HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

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

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i dokument för @azure/logger-paket.

Nästa steg

Ta gärna en titt på katalogen samples för detaljerade exempel på hur man använder detta bibliotek.

Contributing

Om du vill bidra till det här biblioteket kan du läsa bidragsguide för att lära dig mer om hur du skapar och testar koden.

  • Last updated on