SASQueryParameters class

Referencia

Paquete:: @azure/storage-file-datalake

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 <xref:BlobSASSignatureValues> . Una vez generada, se puede codificar en y toString() anexarse directamente a una dirección URL (aunque se debe tener 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, number, string, string, string, string)	Crea una instancia de SASQueryParameters.

Propiedades

agentObjectId	Id. de objeto de AAD no autorizado en formato GUID. Identificador de objeto de AAD de un usuario que se supone no autorizado por el propietario de la clave de delegación de usuarios. El servicio Azure Storage realizará una comprobación de ACL POSIX adicional para determinar si el usuario está autorizado para realizar la operación solicitada. No se puede usar en conjucción con <xref:signedAuthorizedUserObjectId>. Esto solo se usa para la SAS de delegación de usuarios.
cacheControl	Valor del encabezado cache-control 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 los recursos de almacenamiento. Esto solo se usa para la SAS de delegación de usuarios.
directoryDepth	Indique la profundidad del directorio especificado en el campo canonicalizedresource del string-to-sign. La profundidad del directorio es el número de directorios debajo de la carpeta raíz.
encryptionScope	Opcional. Ámbito de cifrado que se usará al enviar solicitudes autorizadas con este URI de SAS.
expiresOn	Opcional solo cuando se proporciona el identificador. La hora de expiración de este token de SAS.
identifier	Opcional. Identificador firmado (solo para <xref: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, <xref:BlobSASPermissions>o <xref:ContainerSASPermissions> para obtener más detalles.
preauthorizedAgentObjectId	Id. 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. No se puede usar en conjucción con <xref:signedUnauthorizedUserObjectId>. 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 <xref: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. Los servicios de almacenamiento a los que se accede (solo para la SAS de la 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	La 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, 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, number, 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, userDelegationKey?: UserDelegationKey, directoryDepth?: number, preauthorizedAgentObjectId?: string, agentObjectId?: 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

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

Representación del identificador firmado (solo para SAS de servicio)

resource: string

Representación del contenedor o blob de almacenamiento (solo para SAS de servicio)

cacheControl: string

Representación del encabezado de control de caché (solo para SAS de Blob/File Service)

contentDisposition: string

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

contentEncoding: string

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

Representación del encabezado de tipo de contenido (solo para SAS de Blob/File Service)

userDelegationKey: UserDelegationKey

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

directoryDepth: number

preauthorizedAgentObjectId: string

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

agentObjectId: string

Representa el identificador de objeto de AAD no 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

agentObjectId

Id. de objeto de AAD no autorizado en formato GUID. Identificador de objeto de AAD de un usuario que se supone no autorizado por el propietario de la clave de delegación de usuarios. El servicio Azure Storage realizará una comprobación de ACL POSIX adicional para determinar si el usuario está autorizado para realizar la operación solicitada. No se puede usar en conjucción con <xref:signedAuthorizedUserObjectId>. Esto solo se usa para la SAS de delegación de usuarios.

agentObjectId?: string

Valor de propiedad

string

cacheControl

Valor del encabezado cache-control 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 los recursos de almacenamiento. Esto solo se usa para la SAS de delegación de usuarios.

correlationId?: string

Valor de propiedad

string

directoryDepth

Indique la profundidad del directorio especificado en el campo canonicalizedresource del string-to-sign. La profundidad del directorio es el número de directorios debajo de la carpeta raíz.

directoryDepth?: number

Valor de propiedad

number

encryptionScope

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

encryptionScope?: string

Valor de propiedad

string

expiresOn

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

expiresOn?: Date

Valor de propiedad

Date

identifier

Opcional. Identificador firmado (solo para <xref: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, <xref:BlobSASPermissions>o <xref:ContainerSASPermissions> para obtener más detalles.

permissions?: string

Valor de propiedad

string

preauthorizedAgentObjectId

Id. 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. No se puede usar en conjucción con <xref:signedUnauthorizedUserObjectId>. 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 <xref: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. Los servicios de almacenamiento a los que se accede (solo para la SAS de la 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

La 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

Compartir a través de

SASQueryParameters class

Constructores

Propiedades

Métodos

Detalles del constructor

SASQueryParameters(string, string, SASQueryParametersOptions)

Parámetros

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

Parámetros

Detalles de las propiedades

agentObjectId

Valor de propiedad

cacheControl

Valor de propiedad

contentDisposition

Valor de propiedad

contentEncoding

Valor de propiedad

contentLanguage

Valor de propiedad

contentType

Valor de propiedad

correlationId

Valor de propiedad

directoryDepth

Valor de propiedad

encryptionScope

Valor de propiedad

expiresOn

Valor de propiedad

identifier

Valor de propiedad

ipRange

Valor de propiedad

permissions

Valor de propiedad

preauthorizedAgentObjectId

Valor de propiedad

protocol

Valor de propiedad

resource

Valor de propiedad

resourceTypes

Valor de propiedad

services

Valor de propiedad

signature

Valor de propiedad

startsOn

Valor de propiedad

version

Valor de propiedad

Detalles del método

toString()

Devoluciones

Recursos adicionales