SASQueryParameters class

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

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

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

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

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string)

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

Свойства

cacheControl	Значение заголовка элемента управления кэшем в SAS BLOB-объектов или файловой службы.
contentDisposition	Значение заголовка удаления содержимого в SAS BLOB-объектов или файловой службы.
contentEncoding	Значение заголовка кодирования содержимого в SAS BLOB-объектов или файловой службы.
contentLanguage	Значение заголовка длины содержимого в SAS BLOB-объектов или файловой службы.
contentType	Значение заголовка типа контента в SAS BLOB-объектов или файловой службы.
delegatedUserObjectId	Optional. Начиная с версии 2025-07-05, это значение указывает идентификатор Entra пользователя, уполномоченный использовать полученный SAS URL. Полученный SAS URL должен использоваться вместе с токеном Entra ID, который был выдан пользователю, указанному в этом значении.
expiresOn	Необязательный только при указании идентификатора. Время истечения срока действия этого маркера SAS.
identifier	Optional. Подписанный идентификатор (только для FileSASSignatureValues). См. https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. Диапазон IP-адресов, разрешенный для этого SAS.
permissions	Необязательный только при указании идентификатора. Дополнительные сведения см. в AccountSASPermissions, FileSASPermissionsили ShareSASPermissions.
protocol	Optional. Разрешенные протоколы HTTP.
resource	Optional. Общий ресурс хранилища или путь к файлам (только для FileSASSignatureValues).
resourceTypes	Optional. Доступ к типам ресурсов хранилища (только для SAS учетной записи). Дополнительные сведения см. в AccountSASResourceTypes.
services	Optional. Доступ к службам хранилища (только для SAS учетной записи). Дополнительные сведения см. в AccountSASServices.
signature	Подпись маркера SAS.
startsOn	Optional. Время начала для этого маркера SAS.
version	Версия API хранилища.

Методы

toString()

Кодирует все параметры запроса SAS в строку, которую можно добавить к URL-адресу.

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

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

new SASQueryParameters(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string, cacheControl?: string, contentDisposition?: string, contentEncoding?: string, contentLanguage?: string, contentType?: string, userDelegationKey?: UserDelegationKey, delegatedUserObjectId?: string)

Параметры

version: string

Представление версии хранилища

signature: string

Представление подписи для маркера SAS

permissions: string

Представление разрешений на хранение

services: string

Представление доступных служб хранилища (только для SAS учетной записи)

resourceTypes: string

Представление доступных типов ресурсов хранилища (только для SAS учетной записи)

protocol: SASProtocol

Представление разрешенных протоколов HTTP

startsOn: Date

Представление времени начала для этого маркера SAS

expiresOn: Date

Представление времени истечения срока действия этого маркера SAS

ipRange: SasIPRange

Представление диапазона допустимых IP-адресов для этого маркера SAS

identifier: string

Представляет подписанный идентификатор (только для SAS службы)

resource: string

Представление контейнера хранилища или большого двоичного объекта (только для SAS службы)

cacheControl: string

Представление заголовка элемента управления кэшем (только для SAS службы BLOB-объектов или файлов)

contentDisposition: string

Представление заголовка удаления содержимого (только для SAS службы BLOB-объектов или файлов)

contentEncoding: string

Представление заголовка кодирования содержимого (только для SAS службы BLOB-объектов или файлов)

contentLanguage: string

Представление заголовка языка содержимого (только для SAS службы BLOB-объектов или файлов)

contentType: string

Представление заголовка типа контента (только для SAS службы BLOB-объектов и файловых служб)

userDelegationKey: UserDelegationKey

delegatedUserObjectId: string

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

Значение заголовка элемента управления кэшем в SAS BLOB-объектов или файловой службы.

cacheControl?: string

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

string

Значение заголовка удаления содержимого в SAS BLOB-объектов или файловой службы.

contentDisposition?: string

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

string

Значение заголовка кодирования содержимого в SAS BLOB-объектов или файловой службы.

contentEncoding?: string

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

string

Значение заголовка длины содержимого в SAS BLOB-объектов или файловой службы.

contentLanguage?: string

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

string

Значение заголовка типа контента в SAS BLOB-объектов или файловой службы.

contentType?: string

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

string

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

delegatedUserObjectId?: string

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

string

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

expiresOn?: Date

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

Date

Optional. Подписанный идентификатор (только для FileSASSignatureValues).

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

identifier?: string

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

string

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

undefined | SasIPRange ipRange

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

undefined | SasIPRange

Необязательный только при указании идентификатора. Дополнительные сведения см. в AccountSASPermissions, FileSASPermissionsили ShareSASPermissions.

permissions?: string

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

string

Optional. Разрешенные протоколы HTTP.

protocol?: SASProtocol

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

SASProtocol

Optional. Общий ресурс хранилища или путь к файлам (только для FileSASSignatureValues).

resource?: string

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

string

Optional. Доступ к типам ресурсов хранилища (только для SAS учетной записи). Дополнительные сведения см. в AccountSASResourceTypes.

resourceTypes?: string

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

string

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

services?: string

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

string

Подпись маркера SAS.

signature: string

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

string

Optional. Время начала для этого маркера SAS.

startsOn?: Date

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

Date

Версия API хранилища.

version: string

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

string

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

Кодирует все параметры запроса SAS в строку, которую можно добавить к URL-адресу.

function toString(): string

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

string

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

SASQueryParameters class

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

Свойства

Методы

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

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string)

Параметры

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

cacheControl

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

contentDisposition

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

contentEncoding

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

contentLanguage

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

contentType

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

delegatedUserObjectId

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

expiresOn

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

identifier

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

ipRange

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

permissions

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

protocol

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

resource

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

resourceTypes

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

services

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

signature

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

startsOn

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

version

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

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

toString()

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