@azure/storage-file-datalake package

Ссылка

Классы

AccountSASPermissions	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта AccountSASSignatureValues. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
AccountSASResourceTypes	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей ресурсы, доступные учетной записью AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит доступ к этому типу ресурса. После установки всех значений его следует сериализовать с помощью toString и задать поле ресурсов в объекте AccountSASSignatureValues. Можно создать строку ресурсов без этого класса, но порядок ресурсов является конкретным, и этот класс гарантирует правильность.
AccountSASServices	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей службы, доступные учетной записью AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит этому службе доступ. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля служб в объекте AccountSASSignatureValues. Можно создать строку служб без этого класса, но порядок служб является конкретным, и этот класс гарантирует правильность.
AnonymousCredential	AnonymousCredential предоставляет элемент credentialPolicyCreator, используемый для создания объектов AnonymousCredentialPolicy. AnonymousCredentialPolicy используется с запросами HTTP(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).
AnonymousCredentialPolicy	AnonymousCredentialPolicy используется с запросами HTTP(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).
BaseRequestPolicy	Базовый класс, из которого наследуют все политики запросов.
Credential	Учетные данные — это абстрактный класс для подписывания HTTP-запросов службы хранилища Azure. Этот класс будет размещать фабрику credentialPolicyCreator, которая создает CredentialPolicy.
CredentialPolicy	Политика учетных данных, используемая для подписывания запросов HTTP(S) перед отправкой. Это абстрактный класс.
DataLakeAclChangeFailedError	Ошибка, возникаемая при прерывании операции и может быть продолжена позже.
DataLakeDirectoryClient	DataLakeDirectoryClient представляет URL-адрес каталога службы хранилища Azure.
DataLakeFileClient	DataLakeFileClient представляет URL-адрес файла службы хранилища Azure.
DataLakeFileSystemClient	DataLakeFileSystemClient представляет URL-адрес файловой системы службы хранилища Azure, позволяя управлять каталогами и файлами.
DataLakeLeaseClient
DataLakePathClient	DataLakePathClient представляет URL-адрес пути хранилища Azure (каталог или файл).
DataLakeSASPermissions	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта DataLakeSASSignatureValues. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
DataLakeServiceClient	DataLakeServiceClient позволяет управлять ресурсами и файловыми системами службы Azure Data Lake. Учетная запись хранения предоставляет пространство имен верхнего уровня для службы Data Lake.
DirectorySASPermissions	Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS каталогу. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта DataLakeSASSignatureValues. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
FileSystemSASPermissions	Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS контейнеру. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта DataLakeSASSignatureValues. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
Pipeline	Класс Конвейера, содержащий политики HTTP-запроса. Конвейер по умолчанию можно создать, вызвав newPipeline. Вы также можете создать конвейер с собственными политиками конструктором Конвейера. Перед реализацией настраиваемого конвейера обратитесь к newPipeline и предоставленным политикам.
RestError	Настраиваемый тип ошибки для неудачных запросов конвейера.
SASQueryParameters	Представляет компоненты, составляющие параметры запроса SAS службы хранилища Azure. Этот тип не создается непосредственно пользователем; он создается только типами AccountSASSignatureValues и <xref:BlobSASSignatureValues>. После создания его можно закодировать в toString() и добавить его непосредственно к URL-адресу (хотя осторожность должна быть предприняна здесь, если существуют существующие параметры запроса, которые могут повлиять на соответствующие средства добавления этих параметров запроса). ПРИМЕЧАНИЕ. Экземпляры этого класса неизменяемы.
StorageBrowserPolicy	StorageBrowserPolicy будет обрабатывать различия между Node.js и средой выполнения браузера, включая: Браузеры кэшируют запросы GET/HEAD, добавляя условные заголовки, такие как "IF_MODIFIED_SINCE". StorageBrowserPolicy — это политика, используемая для добавления запроса метки времени в URL-адрес запроса GET/HEAD, поэтому избежать кэша браузера. Удаление заголовка cookie для безопасности Удаление заголовка длины содержимого, чтобы избежать предупреждения браузеров
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory — это класс фабрики, помогающий создавать объекты StorageBrowserPolicy.
StorageRetryPolicy	Политика повторных попыток с экспоненциальной повторными попытками и линейной повторными попытками, реализованной.
StorageRetryPolicyFactory	StorageRetryPolicyFactory — это класс фабрики, помогающий создавать объекты StorageRetryPolicy.
StorageSharedKeyCredential	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. StorageSharedKeyCredential для авторизации ключа учетной записи службы хранилища Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy — это политика, используемая для подписывания HTTP-запроса с общим ключом.

Интерфейсы

AccessControlChangeCounters	AccessControlChangeCounters содержит количество операций, которые изменяют списки управления доступом рекурсивно.
AccessControlChangeError	Представляет запись, которая не смогла обновить список управления доступом во время `setAccessControlRecursive`, `updateAccessControlRecursive` и `removeAccessControlRecursive`.
AccessControlChanges	AccessControlChanges содержит пакетное и накопительное количество операций, которые изменяют списки управления доступом рекурсивно. Кроме того, он предоставляет записи пути, которые не удалось обновить во время выполнения этих операций.
AccessPolicy
AccountSASSignatureValues	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. AccountSASSignatureValues используется для создания подписанного URL-адреса (SAS) для учетной записи хранения Azure. После правильного задания всех значений вызовите generateAccountSASQueryParameters, чтобы получить представление SAS, который можно применить к URL-адресам озера данных. Обратите внимание: что оба класса и SASQueryParameters существуют, так как первый является изменяемым и логическим представлением, а последний является неизменяемым и используется для создания фактических запросов REST. Дополнительные концептуальные сведения о SAS https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas см. в https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 описаний параметров, включая необходимые
BlobHierarchyListSegment
BlobItemModel	Большой двоичный объект службы хранилища Azure
BlobPrefix
BlobPropertiesModel	Свойства большого двоичного объекта
CommonGenerateSasUrlOptions	Общие параметры fileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions и FileGenerateSasUrlOptions.
CommonOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
CpkInfo	Группа параметров
DataLakeRequestConditions	Группа параметров
DataLakeSASSignatureValues	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. DataLakeSASSignatureValues используется для создания маркеров SAS службы BLOB-объектов и DataLake для контейнеров, BLOB-объектов, файловой системы, каталогов и файлов.
DataLakeServiceProperties	Свойства службы хранилища.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
DirectoryCreateIfNotExistsResponse	Содержит данные ответа для операции createIfNotExists.
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions	Параметры настройки создайте операцию SasUrl.
FileAppendOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
FileCreateIfNotExistsOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
FileCreateIfNotExistsResponse	Содержит данные ответа для операции createIfNotExists.
FileCreateOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
FileCreateResponse
FileFlushOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
FileGenerateSasUrlOptions	Параметры настройки создайте операцию SasUrl.
FileParallelUploadOptions	Интерфейс параметра для файла Data Lake — операции отправки Видеть: отправки uploadFile uploadStream
FileQueryCsvTextConfiguration	Параметры запроса файла с форматом CSV.
FileQueryError	Тип ошибки запроса файла.
FileQueryJsonTextConfiguration	Параметры запроса к файлу с форматом JSON.
FileQueryOptions	Интерфейс параметра для файла Data Lake — операции запроса Видеть: запроса
FileQueryParquetConfiguration	Параметры запроса к файлу с форматом Parquet.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions	Интерфейс параметра для файла Data Lake — операции readToBuffer Видеть: readToBuffer
FileSetExpiryHeaders	Определяет заголовки для операции Path_setExpiry.
FileSetExpiryOptions	Интерфейс параметра для операции setExpiry.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse	Содержит данные ответа для операции createIfNotExists.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse	Содержит данные ответа для операции deleteIfExists.
FileSystemDeleteOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
FileSystemEncryptionScope	Параметры для указания области шифрования в файловой системе.
FileSystemExistsOptions	Интерфейс параметров для файловой системы Data Lake существует Видеть: существует
FileSystemGenerateSasUrlOptions	Параметры настройки создайте операцию SasUrl.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders	Определяет заголовки для операции FileSystem_listBlobHierarchySegment.
FileSystemListPathsHeaders	Определяет заголовки для операции FileSystem_listPaths.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
FileSystemUndeletePathOption	Интерфейс для параметров, распространенных для каждой удаленной операции.
HttpHeaders	Коллекция пар ключей и значений заголовка HTTP.
HttpOperationResponse	Http Response, совместимый с core-v1(core-http).
IHttpClient	Совместимый интерфейс для политик запросов core-http
Lease	Сведения о определенной аренде.
LeaseAccessConditions	Группа параметров
LeaseOperationOptions	Настраивает операции аренды.
ListBlobsHierarchySegmentResponse	Перечисление больших двоичных объектов
ListDeletedPathsOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
ListDeletedPathsSegmentOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
ListFileSystemsSegmentResponse
ListPathsOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
ListPathsSegmentOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders	Определяет заголовки для операции Path_appendData.
PathChangeAccessControlRecursiveOptions	Тип параметров для `setAccessControlRecursive`, `updateAccessControlRecursive` и `removeAccessControlRecursive`.
PathChangeAccessControlRecursiveResponse	Тип ответа для `setAccessControlRecursive`, `updateAccessControlRecursive` и `removeAccessControlRecursive`.
PathCreateHeaders	Определяет заголовки для операции Path_create.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathCreateIfNotExistsResponse	Содержит данные ответа для операции createIfNotExists.
PathCreateOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathDeleteHeaders	Определяет заголовки для операции Path_delete.
PathDeleteIfExistsResponse	Содержит данные ответа для операции deleteIfExists.
PathDeleteOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathExistsOptions	Интерфейс параметра для операций с каталогом или файлом Data Lake Видеть: существует
PathFlushDataHeaders	Определяет заголовки для операции Path_flushData.
PathGetAccessControlHeaders
PathGetAccessControlOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel	Определяет заголовки для операции Path_getProperties.
PathGetPropertiesOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders	Определяет заголовки для операции Path_setAccessControl.
PathSetAccessControlOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathSetMetadataHeaders
PathSetMetadataOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathSetPermissionsOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
PathUndeleteHeaders	Определяет заголовки для операции Path_undelete.
PathUpdateHeaders	Определяет заголовки для операции Path_update.
PipelineLike	Интерфейс для класса Pipeline, содержащего политики HTTP-запроса. Конвейер по умолчанию можно создать, вызвав newPipeline. Вы также можете создать конвейер с собственными политиками конструктором Конвейера. Перед реализацией настраиваемого конвейера обратитесь к newPipeline и предоставленным политикам.
PipelineOptions	Интерфейс параметра для конструктора конвейера.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicyFactory	Интерфейс для совместимости с requestPolicyFactory core-http
RequestPolicyOptions	Интерфейс для совместимости с RequestPolicy
RolePermissions
SASQueryParametersOptions	Параметры создания SASQueryParameters.
SasIPRange	Допустимый диапазон IP-адресов для SAS.
ServiceClientOptions	Подмножество `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Параметры настройки операции generateAccountSasUrl.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions	Параметры настройки undeleteFileSystem.
SignedIdentifier
StoragePipelineOptions	Интерфейс параметров для функции newPipeline.
StorageRetryOptions	Интерфейс параметров повторных попыток хранилища BLOB-объектов.
UserDelegationKey
UserDelegationKeyModel	Ключ делегирования пользователей
WebResource	Описание HTTP-запроса, который необходимо выполнить на удаленном сервере.

Псевдонимы типа

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse	Содержит данные ответа для операции getProperties.
EncryptionAlgorithmType	Определяет значения для EncryptionAlgorithmType. <xref:KnownEncryptionAlgorithmType> можно использовать взаимозаменяемо с EncryptionAlgorithmType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Нет AES256
FileAppendResponse
FileExpiryMode	Определяет значения для PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration	Параметры запроса к файлу с форматом Apache Arrow. Допустимо только для outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse	Содержит данные ответа для операции <xref:DataLakeServiceClient.renameFileSystem>.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse	Содержит данные ответа для операции отмены fileSystem.
FileUploadResponse
HttpRequestBody	Типы тел, поддерживаемые в запросе. NodeJS.ReadableStream и () => NodeJS.ReadableStream — только узел. Blob, ReadableStream и () => ReadableStream — это только браузер.
LeaseDurationType
LeaseOperationResponse	Содержит данные ответа для операций, которые создают, изменяют или удаляют аренду. См. <xref:BlobLeaseClient>.
LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel	Определяет значения для PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel	Определяет значения для PathRenameMode.
PathResourceTypeModel	Определяет значения для PathResourceType.
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse	Содержит данные ответа для операции listContainersSegment.
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions	Параметры настройки <xref:DataLakeServiceClient.renameFileSystem>.

Перечисления

PathGetPropertiesAction	Определяет значения для PathGetPropertiesAction. Возможные значения: GetAccessControl, GetStatus
PathRenameMode	Определяет значения для PathRenameMode. Возможные значения: "legacy", "posix"
PathResourceType	Определяет значения для PathResourceType. Возможные значения: "directory", "file"
SASProtocol	Протоколы для созданного SAS.
StorageDataLakeAudience	Определяет известные облачные аудитории для хранилища.
StorageRetryPolicyType	Типы RetryPolicy.

Функции

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает объект SASQueryParameters, содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST. См. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает экземпляр SASQueryParameters. Принимает только необходимые параметры для создания SAS. Для дополнительных параметров задайте соответствующие свойства напрямую, например разрешения, запуск и идентификатор. ПРЕДУПРЕЖДЕНИЕ. Если идентификатор не указан, требуются разрешения и истекает срок действия. Необходимо назначить значение идентификатору или истекает срок действия разрешений & вручную, если вы инициалы с помощью этого конструктора. Заполните необходимые сведения перед выполнением следующих фрагментов кода. пример // Generate service level SAS for a file system const containerSAS = generateDataLakeSASQueryParameters({ fileSystemName, // Required permissions: ContainerSASPermissions.parse("racwdl"), // Required startsOn: new Date(), // Optional expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString(); Заполните необходимые сведения перед запуском фрагмента кода. пример // Generate service level SAS for a file const fileSAS = generateDataLakeSASQueryParameters({ fileSystemName, // Required fileName, // Required permissions: DataLakeSASPermissions.parse("racwd"), // Required startsOn: new Date(), // Optional expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type cacheControl: "cache-control-override", // Optional contentDisposition: "content-disposition-override", // Optional contentEncoding: "content-encoding-override", // Optional contentLanguage: "content-language-override", // Optional contentType: "content-type-override", // Optional ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает экземпляр SASQueryParameters. ПРЕДУПРЕЖДЕНИЕ. Идентификатор будет игнорироваться при создании SAS делегирования пользователей, разрешений и истечении срока действияOn. пример // Generate user delegation SAS for a file system const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn); const fileSystemSAS = generateDataLakeSASQueryParameters({ fileSystemName, // Required permissions: FileSystemSASPermissions.parse("racwdl"), // Required startsOn, // Optional. Date type expiresOn, // Required. Date type ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS }, userDelegationKey, // UserDelegationKey accountName ).toString();
getDataLakeServiceAccountAudience(string)	Чтобы получить аудиторию OAuth для учетной записи хранения для службы datalake.
isPipelineLike(unknown)	Помощник, который решает, соответствует ли заданный аргумент контракту конвейера
newPipeline(StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Создает новый объект Pipeline с предоставленными учетными данными.

Сведения о функции

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

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

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

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Параметры

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

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

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

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

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

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

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

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

пример

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Заполните необходимые сведения перед запуском фрагмента кода.

пример

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Параметры

dataLakeSASSignatureValues: DataLakeSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

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

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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

Создает экземпляр SASQueryParameters. ПРЕДУПРЕЖДЕНИЕ. Идентификатор будет игнорироваться при создании SAS делегирования пользователей, разрешений и истечении срока действияOn.

пример

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Параметры

dataLakeSASSignatureValues: DataLakeSASSignatureValues

userDelegationKey: UserDelegationKey

Возвращаемое значение blobServiceClient.getUserDelegationKey()

accountName: string

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

SASQueryParameters

getDataLakeServiceAccountAudience(string)

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

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Параметры

storageAccountName: string

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

string

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown): pipeline

Параметры

pipeline: unknown

Аргумент, который может быть конвейером

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

pipeline

Значение true, если аргумент удовлетворяет контракту конвейера

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Параметры

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные данные из пакета @azure/identity для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.

pipelineOptions: StoragePipelineOptions

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

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

Pipeline

Новый объект Pipeline.

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

@azure/storage-file-datalake package

Классы

Интерфейсы

Псевдонимы типа

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

Перечисления

Функции

Сведения о функции

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Параметры

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

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

Параметры

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

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

Параметры

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

getDataLakeServiceAccountAudience(string)

Параметры

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

isPipelineLike(unknown)

Параметры

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

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Параметры

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

Дополнительные ресурсы