SASQueryParameters class

Paquete:

@azure/storage-file-share

Representa los componentes que componen los parámetros de consulta de saS de Azure Storage. El usuario no construye directamente este tipo; solo lo generan los accountSASSignatureValues y fileSASSignatureValues tipos. Una vez generado, se puede codificar en un toString() y 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 de anexar estos parámetros de consulta).

NOTA: Las instancias de esta clase son inmutables.

Constructores

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

Crea una instancia de SASQueryParameters.

Propiedades

cacheControl	Valor para el encabezado de control de caché en SAS de Blob/File Service.
contentDisposition	Valor del encabezado content-disposition en SAS de Blob/File Service.
contentEncoding	Valor del 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.
expiresOn	Opcional solo cuando se proporciona el identificador. Hora de expiración de este token de SAS.
identifier	Optional. Identificador firmado (solo para FileSASSignatureValues). Consulte https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. Intervalo IP permitido para esta SAS.
permissions	Opcional solo cuando se proporciona el identificador. Consulte accountSASPermissions, FileSASPermissionso shareSASPermissions para obtener más detalles.
protocol	Optional. Protocolos HTTP permitidos.
resource	Optional. El recurso compartido de almacenamiento o la ruta de acceso del archivo (solo para FileSASSignatureValues).
resourceTypes	Optional. Los tipos de recursos de almacenamiento a los que se accede (solo para SAS de cuenta). Consulte accountSASResourceTypes para obtener más detalles.
services	Optional. Los servicios de almacenamiento a los que se accede (solo para SAS de cuenta). Consulte AccountSASServices para obtener más información.
signature	Firma del token de SAS.
startsOn	Optional. 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 de SAS en una cadena que se puede anexar a una dirección URL.

Detalles del constructor

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, 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)

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

Representación del 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

Representación del encabezado content-language (solo para SAS de Blob/File Service)

contentType

string

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

Detalles de las propiedades

cacheControl

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

cacheControl?: string

Valor de propiedad

string

contentDisposition

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

contentDisposition?: string

Valor de propiedad

string

contentEncoding

Valor del 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

expiresOn

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

expiresOn?: Date

Valor de propiedad

Date

identifier

Optional. Identificador firmado (solo para FileSASSignatureValues).

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

identifier?: string

Valor de propiedad

string

ipRange

Optional. Intervalo IP permitido para esta SAS.

undefined | SasIPRange ipRange

Valor de propiedad

undefined | SasIPRange

permissions

Opcional solo cuando se proporciona el identificador. Consulte accountSASPermissions, FileSASPermissionso shareSASPermissions para obtener más detalles.

permissions?: string

Valor de propiedad

string

protocol

Optional. Protocolos HTTP permitidos.

protocol?: SASProtocol

Valor de propiedad

SASProtocol

resource

Optional. El recurso compartido de almacenamiento o la ruta de acceso del archivo (solo para FileSASSignatureValues).

resource?: string

Valor de propiedad

string

resourceTypes

Optional. 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

Optional. Los servicios de almacenamiento a los que se accede (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

Optional. 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 de SAS en una cadena que se puede anexar a una dirección URL.

function toString(): string

Devoluciones

string