Поделиться через

ShareServiceClient class

Пакет:
@azure/storage-file-share

ShareServiceClient представляет URL-адрес службы файлов службы хранилища Azure, которая позволяет управлять общими папками.

Extends

StorageClient

Конструкторы

ShareServiceClient(string, Credential | TokenCredential, ShareClientOptions)

Создает экземпляр ShareServiceClient.
ShareServiceClient(string, Pipeline, ShareClientConfig)

Создает экземпляр ShareServiceClient.

Унаследованные свойства

accountName
url

Значение строки URL-адреса.

Методы

createShare(string, ShareCreateOptions)

Создает общую папку.
deleteShare(string, ShareDeleteMethodOptions)

Удаляет общую папку.
fromConnectionString(string, ShareClientOptions)

Создает экземпляр ShareServiceClient из строки подключения.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Доступно только для ShareServiceClient, созданного с помощью учетных данных общего ключа.

Создает URI подписанного URL-адреса учетной записи (SAS) на основе свойств клиента и параметров, переданных в. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Доступно только для ShareServiceClient, созданного с помощью учетных данных общего ключа.

Создает строку для входа для URI подписанного URL-адреса учетной записи (SAS) на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

Возвращает свойства файловой службы учетной записи хранения, включая свойства для правил аналитики хранилища и CORS (совместного использования ресурсов между источниками).

См. https://learn.microsoft.com/rest/api/storageservices/get-file-service-properties
getShareClient(string)

Создает объект ShareClient.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ДОСТУПНО ТОЛЬКО ПРИ ИСПОЛЬЗОВАНИИ АУТЕНТИФИКАЦИИ ТОКЕНА НОСИТЕЛЯ (TokenCredential).

Получает ключ для делегирования пользователя для файлового сервиса. Это допустимая операция только при использовании аутентификации с токеном носителя.

См. https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key
listShares(ServiceListSharesOptions)

Возвращает асинхронный итератор для перечисления всех общих папок в указанной учетной записи.

.byPage() возвращает асинхронный итератор для перечисления общих папок на страницах.

Пример использования синтаксиса for await:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const share of serviceClient.listShares()) {
  console.log(`Share${i++}: ${share.name}`);
}

Пример использования iter.next():

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareIter = serviceClient.listShares();
let i = 1;
let { value, done } = await shareIter.next();
while (!done) {
  console.log(`Share ${i++}: ${value.name}`);
  ({ value, done } = await shareIter.next());
}

Пример использования byPage():

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
  console.log(`Page ${i++}:`);
  for (const share of response.shareItems || []) {
    console.log(`\tShare: ${share.name}`);
  }
}

Пример использования разбиения по страницам с маркером:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken
iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}
setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Задает свойства для конечной точки службы файловой службы учетной записи хранения, включая свойства для правил аналитики хранилища, CORS (совместное использование ресурсов между источниками) и параметры обратимого удаления.

См. https://learn.microsoft.com/rest/api/storageservices/set-file-service-properties
undeleteShare(string, string, ServiceUndeleteShareOptions)

Восстанавливает ранее удаленную общую папку. Этот API работает только в том случае, если для учетной записи хранения, связанной с общей папкой, включен обратимое удаление общего ресурса.

Сведения о конструкторе

ShareServiceClient(string, Credential | TokenCredential, ShareClientOptions)

Создает экземпляр ShareServiceClient.

new ShareServiceClient(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions)

Параметры

url

string

Строка URL-адреса, указывающая на службу файлов службы хранилища Azure, например "https://myaccount.file.core.windows.net". Можно добавить SAS, если используется AnonymousCredential, например "https://myaccount.file.core.windows.net?sasString".

credential

Credential | TokenCredential

Например, AnonymousCredential, StorageSharedKeyCredential или TokenCredential, если не указано, используется AnonymousCredential.

options
ShareClientOptions

Optional. Параметры настройки конвейера HTTP.

ShareServiceClient(string, Pipeline, ShareClientConfig)

Создает экземпляр ShareServiceClient.

new ShareServiceClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

Параметры

url

string

Строка URL-адреса, указывающая на службу файлов службы хранилища Azure, например "https://myaccount.file.core.windows.net". Можно добавить SAS, если используется AnonymousCredential, например "https://myaccount.file.core.windows.net?sasString".

pipeline
Pipeline

Вызовите newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.

options
ShareClientConfig

Optional. Параметры настройки конвейера HTTP.

Сведения об унаследованном свойстве

accountName 

accountName: string

Значение свойства

string

наследуется от storageClient.accountName

url

Значение строки URL-адреса.

url: string

Значение свойства

string

наследуется от StorageClient.url

Сведения о методе

createShare(string, ShareCreateOptions)

Создает общую папку.

function createShare(shareName: string, options?: ShareCreateOptions): Promise<{ shareClient: ShareClient, shareCreateResponse: ShareCreateResponse }>

Параметры

shareName

string

options
ShareCreateOptions

Возвращаемое значение

Promise<{ shareClient: ShareClient, shareCreateResponse: ShareCreateResponse }>

Общий доступ к ответу на создание и соответствующему клиенту общего ресурса.

deleteShare(string, ShareDeleteMethodOptions)

Удаляет общую папку.

function deleteShare(shareName: string, options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

Параметры

shareName

string

options
ShareDeleteMethodOptions

Возвращаемое значение

Promise<ShareDeleteResponse>

Общий доступ к ответу на удаление и соответствующему клиенту общего ресурса.

fromConnectionString(string, ShareClientOptions)

Создает экземпляр ShareServiceClient из строки подключения.

static function fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient

Параметры

connectionString

string

Строка подключения учетной записи или строка подключения SAS учетной записи хранения Azure. [ Примечание. Строка подключения учетной записи может использоваться только в среде выполнения NODE.JS. ] Пример строки подключения учетной записи — пример строки подключения SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net — BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

options
ShareClientOptions

Параметры настройки конвейера HTTP.

Возвращаемое значение

ShareServiceClient

Новый ShareServiceClient из заданной строки подключения.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Доступно только для ShareServiceClient, созданного с помощью учетных данных общего ключа.

Создает URI подписанного URL-адреса учетной записи (SAS) на основе свойств клиента и параметров, переданных в. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/rest/api/storageservices/create-account-sas

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Параметры

expiresOn

Date

Optional. Время, в течение которого подписанный URL-адрес становится недействительным. Значение по умолчанию — час спустя, если не указано.

permissions
AccountSASPermissions

Указывает список разрешений, связанных с SAS.

resourceTypes

string

Указывает типы ресурсов, связанные с сигнатурой общего доступа.

options
ServiceGenerateAccountSasUrlOptions

Необязательные параметры.

Возвращаемое значение

string

URI SAS учетной записи, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Доступно только для ShareServiceClient, созданного с помощью учетных данных общего ключа.

Создает строку для входа для URI подписанного URL-адреса учетной записи (SAS) на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/rest/api/storageservices/create-account-sas

function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Параметры

expiresOn

Date

Optional. Время, в течение которого подписанный URL-адрес становится недействительным. Значение по умолчанию — час спустя, если не указано.

permissions
AccountSASPermissions

Указывает список разрешений, связанных с SAS.

resourceTypes

string

Указывает типы ресурсов, связанные с сигнатурой общего доступа.

options
ServiceGenerateAccountSasUrlOptions

Необязательные параметры.

Возвращаемое значение

string

URI SAS учетной записи, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

getProperties(ServiceGetPropertiesOptions)

Возвращает свойства файловой службы учетной записи хранения, включая свойства для правил аналитики хранилища и CORS (совместного использования ресурсов между источниками).

См. https://learn.microsoft.com/rest/api/storageservices/get-file-service-properties

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

Параметры

options
ServiceGetPropertiesOptions

Параметры операции получения свойств.

Возвращаемое значение

Promise<ServiceGetPropertiesResponse>

Ответные данные для операции получения свойств.

getShareClient(string)

Создает объект ShareClient.

function getShareClient(shareName: string): ShareClient

Параметры

shareName

string

Имя общей папки.

Возвращаемое значение

ShareClient

Объект ShareClient для заданного имени общей папки.

Пример использования:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const shareClient = serviceClient.getShareClient(shareName);
await shareClient.create();

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ДОСТУПНО ТОЛЬКО ПРИ ИСПОЛЬЗОВАНИИ АУТЕНТИФИКАЦИИ ТОКЕНА НОСИТЕЛЯ (TokenCredential).

Получает ключ для делегирования пользователя для файлового сервиса. Это допустимая операция только при использовании аутентификации с токеном носителя.

См. https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Параметры

startsOn

Date

Время начала делегирования пользовательского SAS. Должно быть в течение 7 дней от текущего времени

expiresOn

Date

Время окончания для SAS для делегирования пользователей. Должно быть в течение 7 дней от текущего времени

options
ServiceGetUserDelegationKeyOptions

Возвращаемое значение

Promise<ServiceGetUserDelegationKeyResponse>

listShares(ServiceListSharesOptions)

Возвращает асинхронный итератор для перечисления всех общих папок в указанной учетной записи.

.byPage() возвращает асинхронный итератор для перечисления общих папок на страницах.

Пример использования синтаксиса for await:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const share of serviceClient.listShares()) {
  console.log(`Share${i++}: ${share.name}`);
}

Пример использования iter.next():

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareIter = serviceClient.listShares();
let i = 1;
let { value, done } = await shareIter.next();
while (!done) {
  console.log(`Share ${i++}: ${value.name}`);
  ({ value, done } = await shareIter.next());
}

Пример использования byPage():

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
  console.log(`Page ${i++}:`);
  for (const share of response.shareItems || []) {
    console.log(`\tShare: ${share.name}`);
  }
}

Пример использования разбиения по страницам с маркером:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken
iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

function listShares(options?: ServiceListSharesOptions): PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

Параметры

options
ServiceListSharesOptions

Параметры для перечисления операций общих папок.

AsyncIterableIterator, поддерживающий разбиение по страницам.

Возвращаемое значение

PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Задает свойства для конечной точки службы файловой службы учетной записи хранения, включая свойства для правил аналитики хранилища, CORS (совместное использование ресурсов между источниками) и параметры обратимого удаления.

См. https://learn.microsoft.com/rest/api/storageservices/set-file-service-properties

function setProperties(properties: FileServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

Параметры

properties
FileServiceProperties
options
ServiceSetPropertiesOptions

Параметры для задания операции "Свойства".

Возвращаемое значение

Promise<ServiceSetPropertiesResponse>

Ответные данные для операции задания свойств.

undeleteShare(string, string, ServiceUndeleteShareOptions)

Восстанавливает ранее удаленную общую папку. Этот API работает только в том случае, если для учетной записи хранения, связанной с общей папкой, включен обратимое удаление общего ресурса.

function undeleteShare(deletedShareName: string, deletedShareVersion: string, options?: ServiceUndeleteShareOptions): Promise<ShareClient>

Параметры

deletedShareName

string

Имя ранее удаленной общей папки.

deletedShareVersion

string

Версия ранее удаленной общей папки.

options
ServiceUndeleteShareOptions

Параметры для общей операции отмены действия.

Возвращаемое значение

Promise<ShareClient>

Восстановлена шара.