Azure FileShares biblioteka klienta dla JavaScript - wersja 1.0.0-beta.1

Ten pakiet zawiera izomorficzne SDK (działające zarówno w Node.js, jak i w przeglądarkach) dla klienta Azure FileShares.

Azure File Shares Resource Provider API.

Kluczowe linki:

Rozpoczęcie pracy

Obecnie obsługiwane środowiska

  • Wersje LTS systemu Node.js
  • Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.

Zobacz naszą politykę support po więcej szczegółów.

Wymagania wstępne

Instalowanie pakietu @azure/arm-fileshares

Zainstaluj bibliotekę klienta Azure FileShares dla JavaScript z npm:

npm install @azure/arm-fileshares

Twórz i uwierzytelnij FileSharesClient

Aby utworzyć obiekt klienta do dostępu do API Azure FileShares, będziesz potrzebować endpoint zasobu Azure FileShares oraz credential. Klient Azure FileShares może używać poświadczeń Azure Active Directory do uwierzytelniania. Punkt końcowy dla swojego Azure FileShares znajdziesz w Azure Portal.

Możesz uwierzytelnić się Azure Active Directory używając poświadczenia z biblioteki @azure/identity lub istniejącego tokena AAD.

Aby korzystać z dostawcy DefaultAzureCredential pokazanego poniżej lub innych dostawców poświadczonych w Azure SDK, prosimy o zainstalowanie pakietu @azure/identity:

npm install @azure/identity

Będziesz także musiał zarejestrować nową aplikację AAD i przyznać dostęp do Azure FileShares przypisując odpowiednią rolę swojemu podmiotowi usługi (uwaga: role takie jak "Owner" nie przyznają niezbędnych uprawnień).

Aby dowiedzieć się więcej o tym, jak stworzyć aplikację Azure AD, sprawdź ten przewodnik.

Korzystając ze środowisk Node.js i środowisk podobnych do węzłów, możesz użyć klasy DefaultAzureCredential do uwierzytelniania klienta.

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

W środowiskach przeglądarkowych użyj InteractiveBrowserCredential z pakietu @azure/identity do uwierzytelnienia.

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

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów .

Kluczowe pojęcia

FileSharesClient

FileSharesClient to główny interfejs dla programistów korzystających z biblioteki klienta Azure FileShares. Poznaj metody tego obiektu klienta, aby zrozumieć różne funkcje usługi Azure FileShares, do których masz dostęp.

Examples

Pobierz udostępnianie plików

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

List File Shares według subskrypcji

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

Stwórz lub zaktualizuj udostępnienie plików

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

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną środowiskową AZURE_LOG_LEVEL na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel w @azure/logger:

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

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentacją pakietu @azure/logger.

Następne kroki

Proszę zajrzyj do katalogu samples, gdzie znajdziesz szczegółowe przykłady korzystania z tej biblioteki.

Contributing

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.

  • Last updated on