ShareClient class

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

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

Параметры

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

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

Параметры

new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)

Параметры

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

string name

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

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

Новый объект ShareDirectoryClient для корневого каталога.

ShareDirectoryClient rootDirectoryClient

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

accountName: string

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

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

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

url: string

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

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

Создает новую общую папку под указанной учетной записью. Если общий ресурс с тем же именем уже существует, операция завершается ошибкой.

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

function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>

Параметры

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

Ответные данные для операции создания общего ресурса.

Создает подкаталог в этой общей папке.

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

function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Параметры

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

Данные ответа на создание каталога и соответствующий клиент каталога.

Создает новый файл или заменяет файл в корневом каталоге этой общей папки. Обратите внимание, что файл инициализируется только без содержимого.

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

function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Параметры

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

Данные ответа на создание файла и соответствующий клиент файла.

Создает новую общую папку под указанной учетной записью. Если общий ресурс с тем же именем уже существует, он не изменяется.

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

function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>

Параметры

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

Создает разрешение файла (дескриптор безопасности) на уровне общего ресурса. Созданный дескриптор безопасности можно использовать для файлов и каталогов в общей папке.

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

function createPermission(filePermission: string | SharePermission, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>

Параметры

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

Создает моментальный снимок общего ресурса только для чтения.

function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>

Параметры

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

Ответные данные для операции создания моментального снимка общего ресурса.

Помечает указанную общую папку для удаления. Общая папка и все каталоги или файлы, содержащиеся в ней, позже удаляются во время сборки мусора.

См. https://learn.microsoft.com/rest/api/storageservices/delete-share

function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

Параметры

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

Ответные данные для операции удаления общего ресурса.

Удаляет указанный пустой вложенный каталог в этой общей папке. Обратите внимание, что каталог должен быть пустым, прежде чем его можно удалить.

См. https://learn.microsoft.com/rest/api/storageservices/delete-directory

function deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

Параметры

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

Данные ответа на удаление каталога.

Удаляет файл под корневым каталогом этой общей папки из учетной записи хранения. При успешном удалении файла он немедленно удаляется из индекса учетной записи хранения и больше недоступен клиентам. Данные файла позже удаляются из службы во время сборки мусора.

Удаление файла завершится ошибкой с кодом состояния 409 (конфликт) и кодом ошибки SharingViolation, если файл открыт на клиенте SMB.

Удаление файла не поддерживается в моментальном снимке общего ресурса, который является копией общего ресурса только для чтения. Попытка выполнить эту операцию на моментальном снимке общего ресурса завершится ошибкой 400 (InvalidQueryParameterValue)

См. https://learn.microsoft.com/rest/api/storageservices/delete-file2

function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

Параметры

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

Promise<FileDeleteResponse> File Удалить данные ответа.

Помечает указанную общую папку для удаления, если она существует. Общая папка и все каталоги или файлы, содержащиеся в ней, позже удаляются во время сборки мусора.

См. https://learn.microsoft.com/rest/api/storageservices/delete-share

function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>

Параметры

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

Возвращает значение true, если ресурс Azrue share, представленный этим клиентом; False в противном случае.

ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующая общая папка может быть удалена другими клиентами или приложениями. Наоборот, новые общие папки могут быть добавлены другими клиентами или приложениями после завершения этой функции.

function exists(options?: ShareExistsOptions): Promise<boolean>

Параметры

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

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

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

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: ShareGenerateSasUrlOptions): string

Параметры

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

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

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

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

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Параметры

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

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

Получает разрешения для указанной общей папки. Разрешения указывают, могут ли общедоступные доступ к данным общего доступа.

ПРЕДУПРЕЖДЕНИЕ. Дата JavaScript может потерять точность при анализе строки начала и истечения срока действия. Например, new Date("2018-12-31T03:44:23.8827891Z").toISOString() получит "2018-12-31T03:44:23.882Z".

См. https://learn.microsoft.com/rest/api/storageservices/get-share-acl

function getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>

Параметры

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

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

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

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Параметры

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

Объект ShareDirectoryClient для заданного имени каталога.

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

См. https://learn.microsoft.com/rest/api/storageservices/get-permission

function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>

Параметры

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

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

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

ПРЕДУПРЕЖДЕНИЕ. Объект metadata, возвращенный в ответе, будет иметь свои ключи в нижнем регистре, даже если они первоначально содержали прописные символы. Это отличается от ключей метаданных, возвращаемых методом listSharesShareServiceClient с помощью параметра includeMetadata, который будет хранить исходный регистр.

function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>

Параметры

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

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

Получите ShareLeaseClient, которая управляет арендой файла.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Параметры

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

Новый объект ShareLeaseClient для управления арендами файла.

Извлекает статистику, связанную с общим ресурсом.

function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>

Параметры

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

Ответные данные для операции получения статистики общего доступа.

Задает разрешения для указанной общей папки. Разрешения указывают, доступны ли каталоги или файлы в общей папке общедоступным образом.

При установке разрешений для общей папки заменяются существующие разрешения. Если общий доступ не указан, то существующий список ACL общего ресурса будет удален.

При установке хранимой политики доступа в общей папке может потребоваться до 30 секунд. В течение этого интервала подписанный URL-адрес, связанный с хранимой политикой доступа, завершится ошибкой с кодом состояния 403 (запрещено), пока политика доступа не станет активной.

См. https://learn.microsoft.com/rest/api/storageservices/set-share-acl

function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>

Параметры

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

Ответные данные для операции политики общего доступа.

Задает одну или несколько определяемых пользователем пар name-value для указанной общей папки.

Если параметр не указан или метаданные, определенные в параметре параметра, то метаданные общего ресурса будут удалены.

См. https://learn.microsoft.com/rest/api/storageservices/set-share-metadata

function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>

Параметры

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

Ответные данные для операции общего набора метаданных.

Задает свойства общей папки.

function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>

Параметры

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

Ответные данные для операции "Свойства набора общих ресурсов".

Задает квоту для указанной общей папки.

function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>

Параметры

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

Ответные данные для операции получения квоты общего ресурса.

Создает новый объект ShareClient, идентичный источнику, но с указанной меткой времени моментального снимка. Укажите "" приведет к удалению моментального снимка и возврату URL-адреса базовой общей папки.

function withSnapshot(snapshot: string): ShareClient

Параметры

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

Новый объект ShareClient, идентичный источнику, но с указанной меткой времени моментального снимка