@azure/storage-file-share package

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта AccountSASSignatureValues. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Это вспомогательный класс для создания строки, представляющей ресурсы, доступные учетной записью AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит доступ к этому типу ресурса. После установки всех значений его следует сериализовать с помощью toString и задать поле ресурсов в объекте AccountSASSignatureValues. Можно создать строку ресурсов без этого класса, но порядок ресурсов является конкретным, и этот класс гарантирует правильность.

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Это вспомогательный класс для создания строки, представляющей службы, доступные учетной записью AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит этому службе доступ. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля служб в объекте AccountSASSignatureValues. Можно создать строку служб без этого класса, но порядок служб является конкретным, и этот класс гарантирует правильность.

AnonymousCredential предоставляет элемент credentialPolicyCreator, используемый для создания объектов AnonymousCredentialPolicy. AnonymousCredentialPolicy используется с запросами HTTP(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).

AnonymousCredentialPolicy используется с запросами HTTP(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).

Базовый класс, из которого наследуют все политики запросов.

Учетные данные — это абстрактный класс для подписывания HTTP-запросов службы хранилища Azure. Этот класс будет размещать фабрику credentialPolicyCreator, которая создает CredentialPolicy.

Политика учетных данных, используемая для подписывания запросов HTTP(S) перед отправкой. Это абстрактный класс.

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS файлу. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта FileSASSignatureValues. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.

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

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

Класс Конвейера, содержащий политики HTTP-запроса. Конвейер по умолчанию можно создать, вызвав newPipeline. Вы также можете создать конвейер с собственными политиками конструктором Конвейера.

Перед реализацией настраиваемого конвейера обратитесь к newPipeline и предоставленным политикам.

Представляет компоненты, составляющие параметры запроса SAS службы хранилища Azure. Этот тип не создается непосредственно пользователем; он создается только типами AccountSASSignatureValues и FileSASSignatureValues. После создания его можно закодировать в toString() и добавить его непосредственно к URL-адресу (хотя осторожность должна быть предприняна здесь, если существуют существующие параметры запроса, которые могут повлиять на соответствующие средства добавления этих параметров запроса).

ПРИМЕЧАНИЕ. Экземпляры этого класса неизменяемы.

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

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

ShareFileClient представляет URL-адрес файла службы хранилища Azure.

Клиент, который управляет арендой для ShareFileClient или ShareClient.

См. https://learn.microsoft.com/rest/api/storageservices/lease-file и см. https://learn.microsoft.com/rest/api/storageservices/lease-share

Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS для общей папки. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта FileSASSignatureValues. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.

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

StorageBrowserPolicyFactory — это класс фабрики, помогающий создавать объекты StorageBrowserPolicy.

Политика повторных попыток с экспоненциальной повторными попытками и линейной повторными попытками, реализованной.

StorageRetryPolicyFactory — это класс фабрики, помогающий создавать объекты StorageRetryPolicy.

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

StorageSharedKeyCredential для авторизации ключа учетной записи службы хранилища Azure.

StorageSharedKeyCredentialPolicy — это политика, используемая для подписывания HTTP-запроса с общим ключом.

Политика доступа.

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

AccountSASSignatureValues используется для создания подписанного URL-адреса (SAS) для учетной записи хранения Azure. После правильного задания всех значений вызовите generateAccountSASQueryParameters для получения представления SAS, который можно применить к URL-адресам файлов. Обратите внимание: что оба класса и SASQueryParameters существуют, так как первый является изменяемым и логическим представлением, а последний является неизменяемым и используется для создания фактических запросов REST.

Дополнительные концептуальные сведения о SAS https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 см. в https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas описаний параметров, включая необходимые

Закройте сведения о результатах.

Распространенные варианты ShareGenerateSasUrlOptions и FileGenerateSasUrlOptions.

Интерфейс для параметров, распространенных для каждой удаленной операции.

Группа параметров

CORS — это функция HTTP, которая позволяет веб-приложению, работающему под одним доменом, получать доступ к ресурсам в другом домене. Веб-браузеры реализуют ограничение безопасности, известное как политика того же источника, которая запрещает веб-странице вызывать API в другом домене; CORS предоставляет безопасный способ разрешить одному домену (домену-источнику) вызывать API в другом домене.

Дополнительные значения заголовка ответа для запроса закрытия.

Определяет заголовки для операции Directory_create.

Содержит данные ответа для операции createIfNotExists(DirectoryCreateOptions).

Параметры настройки создания операции.

Определяет заголовки для операции Directory_delete.

Содержит данные ответа для операции deleteIfExists(DirectoryDeleteOptions).

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

Параметры настройки существуют операции.

Определяет заголовки для операции Directory_forceCloseHandles.

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

Параметры настройки каталога — принудительное закрытие операций сегмента.

See:

• <xref:ShareDirectoryClient.forceCloseHandlesSegment>
• forceCloseAllHandles

Определяет заголовки для операции Directory_getProperties.

Параметры настройки операции getProperties.

Указанный элемент каталога.

Параметры настройки операции listFilesAndDirectory.

Определяет заголовки для операции Directory_listFilesAndDirectoriesSegment.

Определяет заголовки для операции Directory_listHandles.

Параметры настройки операции listHandles.

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

See:

• <xref:ShareDirectoryClient.listHandlesSegment>
• <xref:ShareDirectoryClient.iterateHandleSegments>
• <xref:ShareDirectoryClient.listHandleItems>

Интерфейс для параметров, распространенных для каждой удаленной операции.

Определяет заголовки для операции Directory_rename.

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

Определяет заголовки для операции Directory_setMetadata.

Параметры настройки операции setMetadata.

Определяет заголовки для операции Directory_setProperties.

Параметры настройки операции abortCopyFromURL.

Определяет заголовки для операции File_abortCopy.

Параметры настройки операции clearRange.

Дополнительные значения заголовка ответа для запроса закрытия.

Определяет заголовки для операции File_createHardLink.

Параметры настройки файла — создание операций жесткого канала.

See:

• createHardLink

Определяет заголовки для операции File_create.

Параметры настройки операции создания.

Определяет заголовки для File_createSymbolicLink операции.

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

See:

• createSymbolicLink

Определяет заголовки для операции File_delete.

Содержит данные ответа для операции deleteIfExists.

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

Определяет заголовки для операции File_download.

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

Параметры настройки файлов — операции загрузки.

See:

• download
• downloadToFile

Интерфейс параметра для операции downloadToBuffer.

Параметры настройки существуют операции.

Определяет заголовки для операции File_forceCloseHandles.

Параметры настройки файла — принудительное закрытие операций.

See:

• <xref:ShareFileClient.forceCloseHandlesSegment>
• forceCloseAllHandles
• forceCloseHandle

Параметры настройки создайте операцию SasUrl.

Определяет заголовки для операции File_getProperties.

Параметры настройки операции getProperties.

Определяет заголовки для операции File_getRangeList.

Параметры настройки операции getRangeList.

Определяет заголовки для File_getSymbolicLink операции.

Опции для настройки операций Файл - Получить символическую ссылку.

See:

• getSymbolicLink

Указанный элемент файла.

Определяет заголовки для операции File_listHandles.

Интерфейс для параметров, распространенных для каждой удаленной операции.

Параметры настройки файлов — операции сегментов списка.

See:

• <xref:ShareFileClient.listHandlesSegment>
• <xref:ShareFileClient.iterateHandleSegments>
• <xref:ShareFileClient.listHandleItems>

Интерфейс параметра для файлов — операции отправки

See:

• uploadFile
• <xref:ShareFileClient.uploadSeekableStream>

Свойства NFS. Обратите внимание, что эти свойства применяются только к файлам или каталогам в учетных записях файлов premium NFS.

Интерфейс для параметров, распространенных для каждой удаленной операции.

Свойства файла.

Определяет заголовки для операции File_rename.

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

Параметры настройки изменения размера операции.

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

FileSASSignatureValues используется для создания маркеров SAS службы файлов для общих папок или файлов.

Свойства службы хранилища.

Определяет заголовки для операции File_setHttpHeaders.

Параметры настройки операции setHttpHeaders.

Определяет заголовки для операции File_setMetadata.

Параметры настройки операции setMetadata.

Определяет заголовки для операции File_startCopy.

Параметры настройки операции startCopyFromURL.

Определяет заголовки для операции File_uploadRangeFromURL.

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

Параметры настройки операции uploadRangeFromURL.

Определяет заголовки для операции File_uploadRange.

Параметры настройки операции uploadRange.

Интерфейс параметра для ShareFileClient.uploadStream().

Абстрактная для записей, которые можно перечислить из каталога.

Указанный элемент дескриптора службы хранилища Azure.

Представляет сведения о проверке подлинности в параметрах authorization, ProxyAuthorization, WWW-Authentication и Proxy-Authenticate значениях заголовков.

Коллекция пар ключей и значений заголовка HTTP.

Http Response, совместимый с core-v1(core-http).

Представление HTTP-ответа, включающее ссылку на запрос, который он был создан.

Группа параметров

Параметры операций аренды.

Сведения о ответе для конкретной операции аренды.

Перечисление каталогов и файлов.

Перечисление дескрипторов.

Перечисление общих папок.

Перечисление общих папок.

Метрики аналитики хранилища для файловой службы.

Разрешения режима файла или каталога.

Интерфейс для класса Pipeline, содержащего политики HTTP-запроса. Конвейер по умолчанию можно создать, вызвав newPipeline. Вы также можете создать конвейер с собственными политиками конструктором Конвейера.

Перед реализацией настраиваемого конвейера обратитесь к newPipeline и предоставленным политикам.

Интерфейс параметра для конструктора конвейера.

Представляет разрешения файла для определенной роли.

Диапазон операций службы.

См. https://learn.microsoft.com/rest/api/storageservices/specifying-the-range-header-for-file-service-operations

Диапазон файлов службы хранилища Azure.

Совместимый интерфейс для политик запросов core-http

Интерфейс для совместимости с requestPolicyFactory core-http

Интерфейс для совместимости с RequestPolicy

Объект с простым свойством _response.

Объект с свойством _response с текстом и заголовками, которые уже проанализированы в известные типы.

Объект с свойством _response, который уже анализирует заголовки в типизированный объект.

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

Политика хранения.

Допустимый диапазон IP-адресов для SAS.

Подмножество @azure/core-http ServiceClientOptions

Параметры настройки операции generateAccountSasUrl.

Определяет заголовки для операции Service_getProperties.

Параметры настройки операции getProperties.

Параметры настройки операции listShares.

Определяет заголовки для операции Service_listSharesSegment.

Определяет заголовки для операции Service_setProperties.

Параметры настройки операции setProperties.

Параметры настройки операции <xref:ShareServiceClient.undelete>.

Содержит данные ответа для операции setHttpHeaders.

Определяет заголовки для операции Share_create.

Содержит данные ответа для операции createIfNotExists.

Параметры настройки операции создания.

Определяет заголовки для операции Share_createPermission.

Параметры настройки операции createPermission.

Определяет заголовки для операции Share_createSnapshot.

Параметры настройки операции createSnapshot.

Определяет заголовки для операции Share_delete.

Содержит данные ответа для операции deleteIfExists.

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

Параметры настройки существуют операции.

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

Параметры настройки создайте операцию SasUrl.

Определяет заголовки для операции Share_getAccessPolicy.

Параметры настройки операции getAccessPolicy.

Определяет заголовки для операции Share_getPermission.

Параметры настройки операции getPermission.

Определяет заголовки для операции Share_getProperties.

Параметры настройки операции getProperties.

Определяет заголовки для операции Share_getStatistics.

Параметры настройки операции getStatistics.

Указанный элемент общего ресурса службы хранилища Azure.

Указанный элемент общего ресурса службы хранилища Azure.

Разрешение (дескриптор безопасности) на уровне общего ресурса.

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

Настройки протокола

Протоколы для включения в общей папке. Сейчас поддерживается только SMB или NFS.

Определяет заголовки для операции Share_setAccessPolicy.

Параметры настройки операции setAccessPolicy.

Определяет заголовки для операции Share_setMetadata.

Параметры настройки операции setMetadata.

Определяет заголовки для операции Share_setProperties.

Параметры настройки операции setProperties.

Параметры настройки операции setQuota.

Параметры протокола SMB.

Статистика для общей папки.

Подписанный идентификатор

Подписанный идентификатор.

Параметры для многоканальных модулей SMB

Группа параметров

Интерфейс параметров для функции newPipeline.

Интерфейс параметров повторных попыток хранилища BLOB-объектов.

Описание HTTP-запроса, который необходимо выполнить на удаленном сервере.

Определяет значения для CopyStatusType.

Определяет значения для DeleteSnapshotsOptionType.

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

Содержит данные ответа для операции удаления.

Тип ответа для forceCloseHandle.

Содержит данные ответа для операции getProperties.

Содержит данные ответа для операции listFilesAndDirectorySegment.

Содержит данные ответа для операции listHandles.

Содержит данные ответа для операции переименования.

Содержит данные ответа для операции setMetadata.

Содержит данные ответа для операции setProperties.

Содержит данные ответа для операции abortCopy.

Указывает, что существующие атрибуты файла не изменяются.

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

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

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

Содержит данные ответа для операции удаления.

Содержит данные ответа для операции скачивания.

Тип ответа для forceCloseHandle.

Содержит данные ответа для операции getProperties.

Содержит данные ответа для операции getRangeList.

Содержит данные ответа для операции getRangeList.

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

Определяет значения для FileLastWrittenMode.

Содержит данные ответа для операции listHandles.

Определяет значения filePermissionFormat.

Указывает наследование разрешения файла от родительского каталога.

Указывает, что существующее значение разрешения файла не изменяется.

Содержит данные ответа для операции переименования.

Содержит данные ответа для операции setHttpHeaders.

Содержит данные ответа для операции setMetadata.

Содержит данные ответа для операции startCopy.

Содержит данные ответа для операции uploadRangeFromURL.

Содержит данные ответа для операции uploadRange.

Типы тел, поддерживаемые в запросе. NodeJS.ReadableStream и () => NodeJS.ReadableStream — только узел. Blob, ReadableStream<Uint8Array> и () => ReadableStream<Uint8Array> предназначены только для браузера.

Определяет значения для LeaseDurationType.

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

Смотрите ShareLeaseClient.

Определяет значения для LeaseStateType.

Определяет значения для LeaseStatusType.

Определяет значения для ListSharesIncludeType.

Определяет значения для ModeCopyMode.

Определяет значения для NfsFileType.
<xref:KnownNfsFileType> можно использовать взаимозаменяемо с NfsFileType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Regular
Directory
SymLink

Определяет значения для OwnerCopyMode.

Определяет значения для PermissionCopyModeType.

Содержит данные ответа для операции скачивания.

Содержит данные ответа для операции getProperties.

Содержит данные ответа для операции listShares.

Содержит данные ответа для операции setProperties.

Определяет значения для ShareAccessTier.

Содержит данные ответа для операции createPermission.

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

Содержит данные ответа для операции createSnapshot.

Содержит данные ответа для операции удаления.

Определяет значения для AccessRight.

Содержит данные ответа для операции getPermission.

Содержит данные ответа для операции getProperties.

Содержит данные ответа для операции getProperties.

Данные ответа для операции getStatistics.

Содержит данные ответа для операции getStatistics.

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

Определяет значения для ShareRootSquash.

Содержит данные ответа для операции setAccessPolicy.

Содержит данные ответа для операции setMetadata.

Содержит данные ответа для операции setProperties.

Определяет заголовки для операции setQuota.

Содержит данные ответа для операции setQuota.

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

Известные значения, поддерживаемые службой

backup

Указывает параметр в качестве времени запроса.

Указывает, что существующее значение времени не изменяется.

Тип, представляющий результат операции с известным свойством _response.

Известные значения ShareTokenIntent, которые служба принимает.

Протоколы для созданного SAS.

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

Типы RetryPolicy.

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Создает объект SASQueryParameters, содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST.

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

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

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

ПРЕДУПРЕЖДЕНИЕ. Если идентификатор не указан, требуются разрешения и истекает срок действия. Необходимо назначить значение идентификатору или истекает срок действия разрешений & вручную, если вы инициалы с помощью этого конструктора.

Чтобы получить аудиторию OAuth для учетной записи хранения для файловой службы.

Помощник, который решает, соответствует ли заданный аргумент контракту конвейера

Создает новый объект Pipeline с предоставленными учетными данными.

Анализ 4-цифрного восьмеричных строковых представлений режима файла в структуре NfsFileMode.

Анализ 9-символьного символьного строкового представления режима файла в структуре NfsFileMode.

Преобразуйте структуру NfsFileMode в 4-разрядную осьмерию перепрезентации строк.

Преобразуйте NfsFileMode в строку символьной нотации.