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	Значение заголовка удаления содержимого в SAS BLOB-объектов или файловой службы.
contentEncoding	Значение заголовка кодирования содержимого в SAS BLOB-объектов или файловой службы.
contentLanguage	Значение заголовка длины содержимого в 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

Представление заголовка удаления содержимого (только для 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

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

contentDisposition?: string

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

string

contentEncoding

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

contentEncoding?: string

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

string

contentLanguage

Значение заголовка длины содержимого в 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()

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

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