Pustaka klien Azure FileShares untuk JavaScript - versi 1.0.0-beta.1

Paket ini berisi SDK isomorfik (berjalan di Node.js dan di browser) untuk klien FileShares Azure.

API Penyedia Sumber Daya Berbagi File Azure.

Tautan kunci:

Memulai Langkah Pertama

Lingkungan yang didukung saat ini

Lihat kebijakan dukungan kami untuk detail selengkapnya.

Prerequisites

  • Sebuah langganan Azure.

Pasang paket @azure/arm-fileshares

Instal pustaka klien FileShares Azure untuk JavaScript dengan npm:

npm install @azure/arm-fileshares

Membuat dan mengautentikasi FileSharesClient

Untuk membuat objek klien untuk mengakses Azure FileShares API, Anda memerlukan endpoint dari sumber daya FileShares Azure Anda dan credential. Klien Azure FileShares dapat menggunakan kredensial Azure Active Directory untuk mengautentikasi. Anda dapat menemukan titik akhir untuk sumber daya FileShares Azure Anda di portal Azure.

Anda dapat mengautentikasi dengan Azure Active Directory menggunakan kredensial dari pustaka @azure/identity atau Token AAD yang ada.

Untuk menggunakan penyedia DefaultAzureCredential yang ditunjukkan di bawah ini, atau penyedia kredensial lain yang disediakan dengan Azure SDK, instal paket @azure/identity:

npm install @azure/identity

Anda juga harus mendaftarkan aplikasi AAD baru dan memberikan akses ke Azure FileShares dengan menetapkan peran yang sesuai ke perwakilan layanan Anda (catatan: peran seperti "Owner" tidak akan memberikan izin yang diperlukan).

Untuk informasi selengkapnya tentang cara membuat Aplikasi AD Azure, lihat panduan ini.

Dengan menggunakan lingkungan Node.js dan seperti Node, Anda dapat menggunakan kelas DefaultAzureCredential untuk mengautentikasi klien.

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

Untuk lingkungan browser, gunakan InteractiveBrowserCredential dari paket @azure/identity untuk mengautentikasi.

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

Bundel JavaScript

Untuk menggunakan pustaka klien ini di browser, pertama-tama Anda perlu menggunakan bunder. Untuk detail tentang cara melakukan ini, silakan lihat dokumentasi bundling kami.

Konsep Utama

FileSharesKlien

FileSharesClient adalah antarmuka utama untuk pengembang yang menggunakan pustaka klien FileShares Azure. Jelajahi metode pada objek klien ini untuk memahami berbagai fitur layanan Azure FileShares yang dapat Anda akses.

Contoh

Mendapatkan Berbagi File

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

Mencantumkan Berbagi File berdasarkan Langganan

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

Membuat atau memperbarui Berbagi File

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

Mengaktifkan pengelogan dapat membantu menemukan informasi yang berguna tentang kegagalan. Untuk melihat log permintaan dan respons HTTP, atur variabel lingkungan AZURE_LOG_LEVEL ke info. Atau, pengelogan dapat diaktifkan saat runtime dengan memanggil setLogLevel di @azure/logger:

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

setLogLevel("info");

Untuk instruksi lebih rinci tentang cara mengaktifkan log, Anda dapat melihat dokumen paket @azure/logger.

Langkah berikutnya

Silakan lihat direktori samples untuk contoh terperinci tentang cara menggunakan library ini.

Contributing

Jika Anda ingin berkontribusi pada pustaka ini, baca panduan berkontribusi untuk mempelajari selengkapnya tentang cara membuat dan menguji kode.