Azure FileShares klientská knihovna pro JavaScript - verze 1.0.0-beta.1

Tento balíček obsahuje izomorfní SDK (běží jak v Node.js, tak v prohlížečích) pro klienta Azure FileShares.

Azure File Shares Resource Provider API.

Klíčové odkazy:

Začínáme

Aktuálně podporovaná prostředí

Další podrobnosti najdete v zásadách podpory.

Předpoklady

  • Předplatné služby Azure.

Nainstalujte balíček @azure/arm-fileshares.

Nainstalujte klientskou knihovnu Azure FileShares pro JavaScript s npm:

npm install @azure/arm-fileshares

Vytvořte a ověřte FileSharesClient

Pro vytvoření klientského objektu pro přístup k API Azure FileShares budete potřebovat endpoint vašeho Azure FileShares zdroje a credential. Klient Azure FileShare může použít přihlašovací údaje Azure Active Directory k autentizaci. Endpoint pro váš Azure FileShare zdroj najdete v Azure Portal.

Můžete se autentizovat pomocí Azure Active Directory pomocí přihlašovacích údajů z knihovny @azure/identity nebo existujícího AAD tokenu.

Pro použití poskytovatele DefaultAzureCredential uvedeného níže nebo jiných poskytovatelů přihlašovacích údajů přiložených k Azure SDK, prosím nainstalujte balíček @azure/identity:

npm install @azure/identity

Budete také muset registrovat novou aplikaci AAD a udělit přístup k Azure FileShares přiřazením vhodné role vašemu zástupci služby (poznámka: role jako "Owner" neudělí potřebná oprávnění).

Pro více informací o tom, jak vytvořit Azure AD aplikaci, navštivte tento průvodce.

Pomocí Node.js a prostředí podobných uzlům můžete k ověření klienta použít třídu DefaultAzureCredential.

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

Pro prohlížečová prostředí použijte InteractiveBrowserCredential z balíčku @azure/identity k ověření.

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

JavaScriptový balíček

Pokud chcete tuto klientskou knihovnu použít v prohlížeči, musíte nejprve použít bundler. Podrobnosti o tom, jak to udělat, najdete v naší dokumentaci sdružování.

Klíčové koncepty

FileSharesClient

FileSharesClient je hlavní rozhraní pro vývojáře využívající klientskou knihovnu Azure FileShares. Prozkoumejte metody na tomto klientském objektu, abyste pochopili různé funkce služby Azure FileShares, ke kterým máte přístup.

Příklady

Získejte sdílení souborů

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

Seznam sdílených akcií podle předplatného

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

Vytvořte nebo aktualizujte sdílený soubor

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

Povolení protokolování může pomoct odhalit užitečné informace o chybách. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou prostředí AZURE_LOG_LEVEL na info. Případně můžete protokolování povolit za běhu voláním setLogLevel v @azure/logger:

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

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k @azure/protokolovacímu balíčku.

Další kroky

Podívejte se prosím do adresáře samples pro podrobné příklady, jak tuto knihovnu používat.

Contributing

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.