SASQueryParameters class

Ссылка

Пакет:: @azure/storage-blob

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

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

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

SASQueryParameters(string, string, SASQueryParametersOptions)	Создает экземпляр SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string, string)	Создает экземпляр SASQueryParameters.

Свойства

cacheControl	Значение заголовка управления кэшем в SAS службы BLOB-объектов или файлов.
contentDisposition	Значение заголовка content-disposition в SAS службы BLOB-объектов или файлов.
contentEncoding	Значение для заголовка кодирования содержимого в SAS службы BLOB-объектов или файлов.
contentLanguage	Значение заголовка content-length в SAS службы BLOB-объектов или файлов.
contentType	Значение для заголовка типа контента в SAS службы blob-объектов или файлов.
correlationId	Значение GUID, которое будет зарегистрировано в журналах диагностики хранилища и может использоваться для сопоставления создания SAS с доступом к ресурсам хранилища. Используется только для SAS делегирования пользователей.
encryptionScope	Необязательный элемент. Область шифрования, используемая при отправке запросов, авторизованных с помощью этого URI SAS.
expiresOn	Необязательный параметр, только если указан идентификатор. Время истечения срока действия этого маркера SAS.
identifier	Необязательный элемент. Подписанный идентификатор (только для BlobSASSignatureValues). См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Необязательный элемент. Диапазон IP-адресов, разрешенный для этого SAS.
permissions	Необязательный параметр, только если указан идентификатор. Дополнительные сведения см. в разделе AccountSASPermissions, BlobSASPermissions или ContainerSASPermissions .
preauthorizedAgentObjectId	Авторизованный идентификатор объекта AAD в формате GUID. Идентификатор объекта AAD пользователя, авторизованного владельцем ключа делегирования пользователя для выполнения действия, предоставленного SAS. Служба хранилища Azure гарантирует, что владелец ключа делегирования пользователя имеет необходимые разрешения перед предоставлением доступа, но не будет выполняться дополнительная проверка разрешений для пользователя, указанного в этом значении. Используется только для SAS делегирования пользователей.
protocol	Необязательный элемент. Разрешенные протоколы HTTP.
resource	Необязательный элемент. Указывает, какие ресурсы доступны через SAS (только для BlobSASSignatureValues). См. раздел https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
resourceTypes	Необязательный элемент. Типы ресурсов хранилища, к которых осуществляется доступ (только для SAS учетной записи). Дополнительные сведения см. в разделе AccountSASResourceTypes .
services	Необязательный элемент. Доступ к службам хранилища (только для SAS учетной записи). Дополнительные сведения см. в разделе AccountSASServices .
signature	Сигнатура для маркера SAS.
startsOn	Необязательный элемент. Время начала для этого маркера SAS.
version	Версия API хранилища.

Методы

toString()

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

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

SASQueryParameters(string, string, SASQueryParametersOptions)

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

new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)

Параметры

version: string

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

signature: string

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

options: SASQueryParametersOptions

Необязательный элемент. Параметры для создания sasQueryParameters.

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

Создает экземпляр 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, preauthorizedAgentObjectId?: string, correlationId?: string, encryptionScope?: 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

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

contentEncoding: string

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

contentLanguage: string

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

contentType: string

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

userDelegationKey: UserDelegationKey

Представление свойств ключа делегирования пользователя

preauthorizedAgentObjectId: string

Представление авторизованного идентификатора объекта AAD (только для SAS делегирования пользователей)

correlationId: string

Представляет идентификатор корреляции (только для SAS делегирования пользователей)

encryptionScope: string

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

cacheControl

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

cacheControl?: string

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

string

contentDisposition

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

contentDisposition?: string

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

string

contentEncoding

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

contentEncoding?: string

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

string

contentLanguage

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

contentLanguage?: string

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

string

contentType

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

contentType?: string

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

string

correlationId

Значение GUID, которое будет зарегистрировано в журналах диагностики хранилища и может использоваться для сопоставления создания SAS с доступом к ресурсам хранилища. Используется только для SAS делегирования пользователей.

correlationId?: string

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

string

encryptionScope

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

encryptionScope?: string

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

string

expiresOn

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

expiresOn?: Date

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

Date

identifier

Необязательный элемент. Подписанный идентификатор (только для BlobSASSignatureValues).

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

identifier?: string

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

string

ipRange

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

undefined | SasIPRange ipRange

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

undefined | SasIPRange

permissions

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

permissions?: string

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

string

preauthorizedAgentObjectId

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

preauthorizedAgentObjectId?: string

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

string

protocol

Необязательный элемент. Разрешенные протоколы HTTP.

protocol?: SASProtocol

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

SASProtocol

resource

Необязательный элемент. Указывает, какие ресурсы доступны через SAS (только для BlobSASSignatureValues).

См. раздел https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

resource?: string

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

string

resourceTypes

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

resourceTypes?: string

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

string

services

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

services?: string

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

string

signature

Сигнатура для маркера SAS.

signature: string

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

string

startsOn

Необязательный элемент. Время начала для этого маркера SAS.

startsOn?: Date

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

Date

version

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

version: string

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

string

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

toString()

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

function toString(): string

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

string

SASQueryParameters class

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

Свойства

Методы

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

SASQueryParameters(string, string, SASQueryParametersOptions)

Параметры

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

Параметры

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

cacheControl

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

contentDisposition

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

contentEncoding

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

contentLanguage

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

contentType

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

correlationId

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

encryptionScope

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

expiresOn

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

identifier

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

ipRange

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

permissions

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

preauthorizedAgentObjectId

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

protocol

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

resource

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

resourceTypes

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

services

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

signature

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

startsOn

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

version

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

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

toString()

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

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