DataLakeSASSignatureValues interface

Пакет:

@azure/storage-file-datalake

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

DataLakeSASSignatureValues используется для создания маркеров SAS службы BLOB-объектов и DataLake для контейнеров, BLOB-объектов, файловой системы, каталогов и файлов.

Свойства

agentObjectId	Optional. Начиная с версии 2020-02-10, указывает идентификатор несанкционированного объекта AAD в формате GUID. Идентификатор объекта AAD пользователя, который, как предполагается, не несанкционированен владельцем ключа делегирования пользователей. Служба хранилища Azure выполнит дополнительную проверку ACL POSIX, чтобы определить, разрешен ли пользователь выполнять запрошенную операцию. Это не может использоваться в конъюнкции с preauthorizedAgentObjectId. Это используется только для SAS делегирования пользователей.
cacheControl	Optional. Заголовок элемента управления кэшем для SAS.
contentDisposition	Optional. Заголовок удаления содержимого для SAS.
contentEncoding	Optional. Заголовок кодирования содержимого для SAS.
contentLanguage	Optional. Заголовок языка содержимого для SAS.
contentType	Optional. Заголовок типа контента для SAS.
correlationId	Optional. Начиная с версии 2020-02-10, это значение GUID, которое будет зарегистрировано в журналах диагностики хранилища и может использоваться для сопоставления создания SAS с доступом к ресурсам хранилища. Это используется только для SAS делегирования пользователей.
delegatedUserObjectId	Optional. Начиная с версии 2025-07-05, это значение указывает Entra ID пользователя, которому разрешено использовать полученный SAS URL. Полученный SAS URL должен использоваться вместе с токеном Entra ID, который был выдан пользователю, указанному в этом значении.
directoryDepth	Optional. Начиная с версии 2020-02-10, укажите глубину каталога, указанного в канонизованном поле знака. Глубина каталога — это количество каталогов под корневой папкой.
encryptionScope	Optional. Область шифрования, используемая при отправке запросов, авторизованных с помощью этого URI SAS.
expiresOn	Необязательный только при указании идентификатора. Время, после которого SAS больше не будет работать.
fileSystemName	Имя файловой системы, к который может получить доступ пользователь SAS.
identifier	Optional. Имя политики доступа в файловой системе, на который ссылается SAS, если таковой есть. См. https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. Диапазоны IP-адресов, разрешенные в этом SAS.
isDirectory	Optional. Начиная с версии 2020-02-10, это значение определяет, является ли pathName каталогом. Если для этого значения задано значение true, Путь является каталогом для SAS каталога. Если задано значение false или значение по умолчанию, путь к файлу для SAS пути к файлу.
pathName	Optional. Имя пути для пользователя SAS каталога или файла может получить доступ. Требуется, если предоставляется моментальный снимок.
permissions	Необязательный только при указании идентификатора. Обратитесь к FileSystemSASPermissions, DirectorySASPermissions или DataLakeSASPermissions в зависимости от ресурса, доступного для создания строки разрешений.
preauthorizedAgentObjectId	Optional. Начиная с версии 2020-02-10, указывает идентификатор объекта AAD в формате GUID. Идентификатор объекта AAD пользователя, авторизованного владельцем ключа делегирования пользователя для выполнения действия, предоставленного SAS. Служба хранилища Azure гарантирует, что владелец ключа делегирования пользователей имеет необходимые разрешения перед предоставлением доступа, но не будет выполнена дополнительная проверка разрешений для пользователя, указанного в этом значении. Этот параметр нельзя использовать в конжуции с агентом AgentObjectId. Это используется только для SAS делегирования пользователей.
protocol	Optional. Протоколы SAS, только HTTPS или HTTPSandHTTP
snapshotTime	Optional. Строка метки времени моментального снимка, доступ к пользователю SAS. Поддерживается только в API версии 2018-11-09.
startsOn	Optional. Когда SAS вступит в силу.
version	Версия службы, предназначенная для этого SAS. Если он не указан, по умолчанию используется версия, предназначенная библиотекой.

Сведения о свойстве

agentObjectId

Optional. Начиная с версии 2020-02-10, указывает идентификатор несанкционированного объекта AAD в формате GUID. Идентификатор объекта AAD пользователя, который, как предполагается, не несанкционированен владельцем ключа делегирования пользователей. Служба хранилища Azure выполнит дополнительную проверку ACL POSIX, чтобы определить, разрешен ли пользователь выполнять запрошенную операцию. Это не может использоваться в конъюнкции с preauthorizedAgentObjectId. Это используется только для SAS делегирования пользователей.

agentObjectId?: string

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

string

cacheControl

Optional. Заголовок элемента управления кэшем для SAS.

cacheControl?: string

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

string

contentDisposition

Optional. Заголовок удаления содержимого для SAS.

contentDisposition?: string

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

string

contentEncoding

Optional. Заголовок кодирования содержимого для SAS.

contentEncoding?: string

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

string

contentLanguage

Optional. Заголовок языка содержимого для SAS.

contentLanguage?: string

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

string

contentType

Optional. Заголовок типа контента для SAS.

contentType?: string

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

string

correlationId

Optional. Начиная с версии 2020-02-10, это значение GUID, которое будет зарегистрировано в журналах диагностики хранилища и может использоваться для сопоставления создания SAS с доступом к ресурсам хранилища. Это используется только для SAS делегирования пользователей.

correlationId?: string

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

string

delegatedUserObjectId

Optional. Начиная с версии 2025-07-05, это значение указывает Entra ID пользователя, которому разрешено использовать полученный SAS URL. Полученный SAS URL должен использоваться вместе с токеном Entra ID, который был выдан пользователю, указанному в этом значении.

delegatedUserObjectId?: string

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

string

directoryDepth

Optional. Начиная с версии 2020-02-10, укажите глубину каталога, указанного в канонизованном поле знака. Глубина каталога — это количество каталогов под корневой папкой.

directoryDepth?: number

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

number

encryptionScope

Optional. Область шифрования, используемая при отправке запросов, авторизованных с помощью этого URI SAS.

encryptionScope?: string

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

string

expiresOn

Необязательный только при указании идентификатора. Время, после которого SAS больше не будет работать.

expiresOn?: Date

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

Date

fileSystemName

Имя файловой системы, к который может получить доступ пользователь SAS.

fileSystemName: string

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

string

identifier

Optional. Имя политики доступа в файловой системе, на который ссылается SAS, если таковой есть.

См. https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy

identifier?: string

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

string

ipRange

Optional. Диапазоны IP-адресов, разрешенные в этом SAS.

ipRange?: SasIPRange

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

SasIPRange

isDirectory

Optional. Начиная с версии 2020-02-10, это значение определяет, является ли pathName каталогом. Если для этого значения задано значение true, Путь является каталогом для SAS каталога. Если задано значение false или значение по умолчанию, путь к файлу для SAS пути к файлу.

isDirectory?: boolean

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

boolean

pathName

Optional. Имя пути для пользователя SAS каталога или файла может получить доступ. Требуется, если предоставляется моментальный снимок.

pathName?: string

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

string

permissions

Необязательный только при указании идентификатора. Обратитесь к FileSystemSASPermissions, DirectorySASPermissions или DataLakeSASPermissions в зависимости от ресурса, доступного для создания строки разрешений.

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

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

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

preauthorizedAgentObjectId

Optional. Начиная с версии 2020-02-10, указывает идентификатор объекта AAD в формате GUID. Идентификатор объекта AAD пользователя, авторизованного владельцем ключа делегирования пользователя для выполнения действия, предоставленного SAS. Служба хранилища Azure гарантирует, что владелец ключа делегирования пользователей имеет необходимые разрешения перед предоставлением доступа, но не будет выполнена дополнительная проверка разрешений для пользователя, указанного в этом значении. Этот параметр нельзя использовать в конжуции с агентом AgentObjectId. Это используется только для SAS делегирования пользователей.

preauthorizedAgentObjectId?: string

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

string

protocol

Optional. Протоколы SAS, только HTTPS или HTTPSandHTTP

protocol?: SASProtocol

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

SASProtocol

snapshotTime

Optional. Строка метки времени моментального снимка, доступ к пользователю SAS. Поддерживается только в API версии 2018-11-09.

snapshotTime?: string

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

string

startsOn

Optional. Когда SAS вступит в силу.

startsOn?: Date

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

Date

version

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

version?: string

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

string