Compartir a través de

SASQueryParameters class

  • Referencia
Paquete:
@azure/storage-blob

Representa los componentes que componen los parámetros de consulta de una SAS de Azure Storage. El usuario no construye directamente este tipo; solo lo generan los tipos AccountSASSignatureValues y BlobSASSignatureValues . Una vez generado, se puede codificar en y toString() anexarse directamente a una dirección URL (aunque debe tenerse cuidado aquí en caso de que haya parámetros de consulta existentes, lo que podría afectar a los medios adecuados para anexar estos parámetros de consulta).

NOTA: Las instancias de esta clase son inmutables.

Constructores

SASQueryParameters(string, string, SASQueryParametersOptions)

Crea una instancia de SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string, string)

Crea una instancia de SASQueryParameters.

Propiedades

cacheControl

Valor del encabezado de control de caché en SAS de Blob/File Service.
contentDisposition

Valor para el encabezado content-disposition en SAS de Blob/File Service.
contentEncoding

Valor para el encabezado de codificación de contenido en SAS de Blob/File Service.
contentLanguage

Valor del encabezado de longitud de contenido en SAS de Blob/File Service.
contentType

Valor del encabezado de tipo de contenido en SAS de Blob/File Service.
correlationId

Valor GUID que se registrará en los registros de diagnóstico de almacenamiento y se puede usar para correlacionar la generación de SAS con el acceso a recursos de almacenamiento. Esto solo se usa para la SAS de delegación de usuarios.
encryptionScope

Opcional. Ámbito de cifrado que se va a usar al enviar solicitudes autorizadas con este URI de SAS.
expiresOn

Opcional solo cuando se proporciona el identificador. Hora de expiración de este token de SAS.
identifier

Opcional. Identificador firmado (solo para BlobSASSignatureValues).

Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy.
ipRange

Opcional. Intervalo IP permitido para esta SAS.
permissions

Opcional solo cuando se proporciona el identificador. Consulte AccountSASPermissions, BlobSASPermissions o ContainerSASPermissions para obtener más detalles.
preauthorizedAgentObjectId

Identificador de objeto de AAD autorizado en formato GUID. Identificador de objeto de AAD de un usuario autorizado por el propietario de la clave de delegación de usuarios para realizar la acción concedida por la SAS. El servicio Azure Storage garantizará que el propietario de la clave de delegación de usuarios tenga los permisos necesarios antes de conceder acceso, pero no se realizará ninguna comprobación de permisos adicional para el usuario especificado en este valor. Esto solo se usa para la SAS de delegación de usuarios.
protocol

Opcional. Protocolos HTTP permitidos.
resource

Opcional. Especifica qué recursos son accesibles a través de la SAS (solo para BlobSASSignatureValues).

Consulta https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only.
resourceTypes

Opcional. Los tipos de recursos de almacenamiento a los que se accede (solo para SAS de cuenta). Consulte AccountSASResourceTypes para obtener más detalles.
services

Opcional. Se accede a los servicios de almacenamiento (solo para SAS de cuenta). Consulte AccountSASServices para obtener más información.
signature

Firma del token de SAS.
startsOn

Opcional. Hora de inicio de este token de SAS.
version

Versión de la API de almacenamiento.

Métodos

toString()

Codifica todos los parámetros de consulta saS en una cadena que se puede anexar a una dirección URL.

Detalles del constructor

SASQueryParameters(string, string, SASQueryParametersOptions)

Crea una instancia de SASQueryParameters.

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

Parámetros

version

string

Representación de la versión de almacenamiento

signature

string

Representación de la firma del token de SAS

options
SASQueryParametersOptions

Opcional. Opciones para construir SASQueryParameters.

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

Crea una instancia de 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)

Parámetros

version

string

Representación de la versión de almacenamiento

signature

string

Representación de la firma del token de SAS

permissions

string

Representación de los permisos de almacenamiento

services

string

Representación de los servicios de almacenamiento a los que se accede (solo para SAS de cuenta)

resourceTypes

string

Representación de los tipos de recursos de almacenamiento a los que se accede (solo para SAS de cuenta)

protocol
SASProtocol

Representación de los protocolos HTTP permitidos

startsOn

Date

Representa la hora de inicio de este token de SAS

expiresOn

Date

Representa la hora de expiración de este token de SAS

ipRange
SasIPRange

Representa el intervalo de direcciones IP válidas para este token de SAS

identifier

string

Representa el identificador firmado (solo para sas de servicio)

resource

string

Representa el contenedor de almacenamiento o el blob (solo para SAS de servicio)

cacheControl

string

Representa el encabezado de control de caché (solo para SAS de Blob/File Service)

contentDisposition

string

Representa el encabezado content-disposition (solo para SAS de Blob/File Service)

contentEncoding

string

Representa el encabezado de codificación de contenido (solo para SAS de Blob/File Service)

contentLanguage

string

Representa el encabezado content-language (solo para SAS de Blob/File Service)

contentType

string

Representa el encabezado de tipo de contenido (solo para la SAS de Blob/File Service)

userDelegationKey
UserDelegationKey

Representación de las propiedades de clave de delegación de usuarios

preauthorizedAgentObjectId

string

Representa el identificador de objeto de AAD autorizado (solo para la SAS de delegación de usuarios)

correlationId

string

Representa el identificador de correlación (solo para la SAS de delegación de usuarios)

encryptionScope

string

Detalles de las propiedades

cacheControl

Valor del encabezado de control de caché en SAS de Blob/File Service.

cacheControl?: string

Valor de propiedad

string

contentDisposition

Valor para el encabezado content-disposition en SAS de Blob/File Service.

contentDisposition?: string

Valor de propiedad

string

contentEncoding

Valor para el encabezado de codificación de contenido en SAS de Blob/File Service.

contentEncoding?: string

Valor de propiedad

string

contentLanguage

Valor del encabezado de longitud de contenido en SAS de Blob/File Service.

contentLanguage?: string

Valor de propiedad

string

contentType

Valor del encabezado de tipo de contenido en SAS de Blob/File Service.

contentType?: string

Valor de propiedad

string

correlationId

Valor GUID que se registrará en los registros de diagnóstico de almacenamiento y se puede usar para correlacionar la generación de SAS con el acceso a recursos de almacenamiento. Esto solo se usa para la SAS de delegación de usuarios.

correlationId?: string

Valor de propiedad

string

encryptionScope

Opcional. Ámbito de cifrado que se va a usar al enviar solicitudes autorizadas con este URI de SAS.

encryptionScope?: string

Valor de propiedad

string

expiresOn

Opcional solo cuando se proporciona el identificador. Hora de expiración de este token de SAS.

expiresOn?: Date

Valor de propiedad

Date

identifier

Opcional. Identificador firmado (solo para BlobSASSignatureValues).

Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy.

identifier?: string

Valor de propiedad

string

ipRange

Opcional. Intervalo IP permitido para esta SAS.

undefined | SasIPRange ipRange

Valor de propiedad

undefined | SasIPRange

permissions

Opcional solo cuando se proporciona el identificador. Consulte AccountSASPermissions, BlobSASPermissions o ContainerSASPermissions para obtener más detalles.

permissions?: string

Valor de propiedad

string

preauthorizedAgentObjectId

Identificador de objeto de AAD autorizado en formato GUID. Identificador de objeto de AAD de un usuario autorizado por el propietario de la clave de delegación de usuarios para realizar la acción concedida por la SAS. El servicio Azure Storage garantizará que el propietario de la clave de delegación de usuarios tenga los permisos necesarios antes de conceder acceso, pero no se realizará ninguna comprobación de permisos adicional para el usuario especificado en este valor. Esto solo se usa para la SAS de delegación de usuarios.

preauthorizedAgentObjectId?: string

Valor de propiedad

string

protocol

Opcional. Protocolos HTTP permitidos.

protocol?: SASProtocol

Valor de propiedad

SASProtocol

resource

Opcional. Especifica qué recursos son accesibles a través de la SAS (solo para BlobSASSignatureValues).

Consulta https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only.

resource?: string

Valor de propiedad

string

resourceTypes

Opcional. Los tipos de recursos de almacenamiento a los que se accede (solo para SAS de cuenta). Consulte AccountSASResourceTypes para obtener más detalles.

resourceTypes?: string

Valor de propiedad

string

services

Opcional. Se accede a los servicios de almacenamiento (solo para SAS de cuenta). Consulte AccountSASServices para obtener más información.

services?: string

Valor de propiedad

string

signature

Firma del token de SAS.

signature: string

Valor de propiedad

string

startsOn

Opcional. Hora de inicio de este token de SAS.

startsOn?: Date

Valor de propiedad

Date

version

Versión de la API de almacenamiento.

version: string

Valor de propiedad

string

Detalles del método

toString()

Codifica todos los parámetros de consulta saS en una cadena que se puede anexar a una dirección URL.

function toString(): string

Devoluciones

string