SASQueryParameters class

Pacote:

@azure/storage-file-share

Representa os componentes que compõem os parâmetros de consulta de uma SAS de Armazenamento do Azure. Esse tipo não é construído diretamente pelo usuário; ele só é gerado pelos tipos AccountSASSignatureValues e FileSASSignatureValues. Uma vez gerado, ele pode ser codificado em um toString() e acrescentado diretamente a uma URL (embora seja necessário ter cuidado aqui no caso de haver parâmetros de consulta existentes, o que pode afetar os meios apropriados de acrescentar esses parâmetros de consulta).

OBSERVAÇÃO: as instâncias dessa classe são imutáveis.

Construtores

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

Cria uma instância de SASQueryParameters.

Propriedades

cacheControl	Valor do cabeçalho de controle de cache na SAS do Serviço de Arquivo/Blob.
contentDisposition	Valor do cabeçalho de disposição de conteúdo na SAS do Serviço de Arquivo/Blob.
contentEncoding	Valor do cabeçalho de codificação de conteúdo na SAS do Serviço de Arquivo/Blob.
contentLanguage	Valor do cabeçalho de comprimento de conteúdo na SAS do Serviço de Arquivo/Blob.
contentType	Valor do cabeçalho de tipo de conteúdo na SAS do Serviço de Arquivo/Blob.
expiresOn	Opcional somente quando o identificador for fornecido. A hora de expiração desse token SAS.
identifier	Optional. O identificador assinado (somente para FileSASSignatureValues). Consulte https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. Intervalo de IP permitido para essa SAS.
permissions	Opcional somente quando o identificador for fornecido. Consulte AccountSASPermissions, FileSASPermissionsou ShareSASPermissions para obter mais detalhes.
protocol	Optional. Os protocolos HTTP permitidos.
resource	Optional. O compartilhamento de armazenamento ou o caminho do arquivo (somente para FileSASSignatureValues).
resourceTypes	Optional. Os tipos de recurso de armazenamento que estão sendo acessados (apenas para SAS de conta). Consulte AccountSASResourceTypes para obter mais detalhes.
services	Optional. Os serviços de armazenamento que estão sendo acessados (apenas para SAS de conta). Consulte AccountSASServices para obter mais detalhes.
signature	A assinatura do token SAS.
startsOn	Optional. A hora de início deste token SAS.
version	A versão da API de armazenamento.

Métodos

toString()

Codifica todos os parâmetros de consulta SAS em uma cadeia de caracteres que pode ser acrescentada a uma URL.

Detalhes do construtor

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

Cria uma instância 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

Representando a versão de armazenamento

signature

string

Representando a assinatura do token SAS

permissions

string

Representando as permissões de armazenamento

services

string

Representando os serviços de armazenamento que estão sendo acessados (apenas para SAS de conta)

resourceTypes

string

Representando os tipos de recursos de armazenamento que estão sendo acessados (apenas para SAS de conta)

protocol

SASProtocol

Representando os protocolos HTTP permitidos

startsOn

Date

Representando a hora de início deste token SAS

expiresOn

Date

Representando o tempo de expiração para este token SAS

ipRange

SasIPRange

Representando o intervalo de endereços IP válidos para este token SAS

identifier

string

Representando o identificador assinado (somente para SAS de serviço)

resource

string

Representando o contêiner de armazenamento ou blob (somente para SAS de serviço)

cacheControl

string

Representando o cabeçalho de controle de cache (somente para SAS do Serviço de Arquivo/Blob)

contentDisposition

string

Representando o cabeçalho de disposição de conteúdo (somente para SAS do Serviço de Arquivo/Blob)

contentEncoding

string

Representando o cabeçalho de codificação de conteúdo (somente para SAS do Serviço de Arquivo/Blob)

contentLanguage

string

Representando o cabeçalho de linguagem de conteúdo (somente para SAS do Serviço de Arquivo/Blob)

contentType

string

Representando o cabeçalho do tipo conteúdo (somente para SAS do Serviço de Arquivo/Blob)

Detalhes da propriedade

cacheControl

Valor do cabeçalho de controle de cache na SAS do Serviço de Arquivo/Blob.

cacheControl?: string

Valor da propriedade

string

contentDisposition

Valor do cabeçalho de disposição de conteúdo na SAS do Serviço de Arquivo/Blob.

contentDisposition?: string

Valor da propriedade

string

contentEncoding

Valor do cabeçalho de codificação de conteúdo na SAS do Serviço de Arquivo/Blob.

contentEncoding?: string

Valor da propriedade

string

contentLanguage

Valor do cabeçalho de comprimento de conteúdo na SAS do Serviço de Arquivo/Blob.

contentLanguage?: string

Valor da propriedade

string

contentType

Valor do cabeçalho de tipo de conteúdo na SAS do Serviço de Arquivo/Blob.

contentType?: string

Valor da propriedade

string

expiresOn

Opcional somente quando o identificador for fornecido. A hora de expiração desse token SAS.

expiresOn?: Date

Valor da propriedade

Date

identifier

Optional. O identificador assinado (somente para FileSASSignatureValues).

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

identifier?: string

Valor da propriedade

string

ipRange

Optional. Intervalo de IP permitido para essa SAS.

undefined | SasIPRange ipRange

Valor da propriedade

undefined | SasIPRange

permissions

Opcional somente quando o identificador for fornecido. Consulte AccountSASPermissions, FileSASPermissionsou ShareSASPermissions para obter mais detalhes.

permissions?: string

Valor da propriedade

string

protocol

Optional. Os protocolos HTTP permitidos.

protocol?: SASProtocol

Valor da propriedade

SASProtocol

resource

Optional. O compartilhamento de armazenamento ou o caminho do arquivo (somente para FileSASSignatureValues).

resource?: string

Valor da propriedade

string

resourceTypes

Optional. Os tipos de recurso de armazenamento que estão sendo acessados (apenas para SAS de conta). Consulte AccountSASResourceTypes para obter mais detalhes.

resourceTypes?: string

Valor da propriedade

string

services

Optional. Os serviços de armazenamento que estão sendo acessados (apenas para SAS de conta). Consulte AccountSASServices para obter mais detalhes.

services?: string

Valor da propriedade

string

signature

A assinatura do token SAS.

signature: string

Valor da propriedade

string

startsOn

Optional. A hora de início deste token SAS.

startsOn?: Date

Valor da propriedade

Date

version

A versão da API de armazenamento.

version: string

Valor da propriedade

string

Detalhes do método

toString()

Codifica todos os parâmetros de consulta SAS em uma cadeia de caracteres que pode ser acrescentada a uma URL.

function toString(): string

Retornos

string