Клиентская библиотека Azure FileShares для JavaScript — версия 1.0.0-beta.1

Этот пакет содержит изоморфный SDK (работает как в Node.js, так и в браузерах) для Azure клиента FileShares.

Azure File Shares Resource Provider API.

Ключевые ссылки:

Начало работы

Поддерживаемые в настоящее время среды

Чтобы получить дополнительные сведения, ознакомьтесь с нашей политикой поддержки.

Необходимые условия

Установите пакет @azure/arm-fileshares.

Установите клиентскую библиотеку Azure FileShares для JavaScript с помощью npm:

npm install @azure/arm-fileshares

Создание и проверка подлинности FileSharesClient

Чтобы создать клиентский объект для доступа к API Azure FileShares, вам понадобится endpoint вашего ресурса Azure FileShares и credential. Клиент Azure FileShares может использовать Azure Active Directory credentials для аутентификации. Вы можете найти конечную точку для вашего ресурса Azure FileShares в портал Azure.

Вы можете аутентифицироваться с помощью Azure Active Directory, используя учетные данные из библиотеки @azure/identity или существующий токен AAD.

Чтобы воспользоваться провайдером DefaultAzureCredential, показанным ниже, или другими поставщиками учетных данных, предоставленными с Azure SDK, пожалуйста, установите пакет @azure/identity:

npm install @azure/identity

Вам также нужно будет зарегистрировать приложение AAD и предоставить доступ к Azure FileShares назначив соответствующую роль вашему руководителю службы (примечание: такие роли, как "Owner", не предоставляют необходимые права).

Для получения дополнительной информации о том, как создать заявку Azure AD, ознакомьтесь с этим руководством.

Используя среды Node.js и node-like, можно использовать класс 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);

Для браузерных сред используйте InteractiveBrowserCredential из пакета @azure/identity для аутентификации.

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

Чтобы использовать эту клиентную библиотеку в браузере, сначала необходимо использовать пакет. Подробнее о том, как to do это, пожалуйста, обратитесь к нашей документации по bundling.

Основные понятия

FileSharesClient

FileSharesClient является основным интерфейсом для разработчиков, использующих клиентскую библиотеку Azure FileShares. Изучите методы на этом клиентском объекте, чтобы понять различные функции сервиса Azure FileShares, к которым вы можете получить доступ.

Examples

Получите общий доступ к файлам

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

Список файлов по подписке

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

Создать или обновить общий файл

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

Включение ведения журнала может помочь выявить полезные сведения о сбоях. Чтобы просмотреть журнал HTTP-запросов и ответов, задайте для переменной среды AZURE_LOG_LEVEL значение info. В альтернативном порядке, логирование можно включить во время выполнения, вызвав setLogLevel в @azure/logger:

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

setLogLevel("info");

Дополнительные инструкции по включению журналов см. в документации по пакету @azure/loger.

Дальнейшие действия

Пожалуйста, ознакомьтесь с каталогом samples для подробных примеров использования этой библиотеки.

Contributing

Если вы хотите внести вклад в эту библиотеку, пожалуйста, ознакомьтесь с руководством contributing guide чтобы узнать больше о том, как создавать и тестировать код.

  • Last updated on