SASQueryParameters class

Referência

Pacote:: @azure/storage-file-share

Representa os componentes que compõem os parâmetros de consulta de uma SAS do 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 a uma URL diretamente (embora seja necessário ter cuidado aqui caso haja 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 para o cabeçalho de controle de cache na SAS do Serviço de Blob/Arquivo.
contentDisposition	Valor para o cabeçalho de disposição de conteúdo na SAS do Serviço de Blob/Arquivo.
contentEncoding	Valor para o cabeçalho de codificação de conteúdo na SAS do Serviço de Blob/Arquivo.
contentLanguage	Valor para o cabeçalho de comprimento de conteúdo em SAS do Serviço de Blob/Arquivo.
contentType	Valor do cabeçalho do tipo conteúdo em SAS do Serviço de Blob/Arquivo.
expiresOn	Opcional somente quando o identificador é fornecido. O tempo de expiração para esse token SAS.
identifier	Opcional. O identificador assinado (somente para FileSASSignatureValues). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Opcional. Intervalo de IP permitido para essa SAS.
permissions	Opcional somente quando o identificador é fornecido. Consulte AccountSASPermissions, FileSASPermissions ou ShareSASPermissions para obter mais detalhes.
protocol	Opcional. Os protocolos HTTP permitidos.
resource	Opcional. O compartilhamento de armazenamento ou o caminho do arquivo (somente para FileSASSignatureValues).
resourceTypes	Opcional. Os tipos de recursos de armazenamento que estão sendo acessados (somente para SAS de conta). Consulte AccountSASResourceTypes para obter mais detalhes.
services	Opcional. Os serviços de armazenamento que estão sendo acessados (somente para SAS de conta). Consulte AccountSASServices para obter mais detalhes.
signature	A assinatura do token SAS.
startsOn	Opcional. A hora de início desse 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

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 para o token SAS

permissions: string

Representando as permissões de armazenamento

services: string

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

resourceTypes: string

Representando os tipos de recursos de armazenamento que estão sendo acessados (somente 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 Blob/Arquivo)

contentDisposition: string

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

contentEncoding: string

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

contentLanguage: string

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

contentType: string

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

Detalhes da propriedade

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

cacheControl?: string

Valor da propriedade

string

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

contentDisposition?: string

Valor da propriedade

string

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

contentEncoding?: string

Valor da propriedade

string

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

contentLanguage?: string

Valor da propriedade

string

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

contentType?: string

Valor da propriedade

string

Opcional somente quando o identificador é fornecido. O tempo de expiração para esse token SAS.

expiresOn?: Date

Valor da propriedade

Date

Opcional. O identificador assinado (somente para FileSASSignatureValues).

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

identifier?: string

Valor da propriedade

string

Opcional. Intervalo de IP permitido para essa SAS.

undefined | SasIPRange ipRange

Valor da propriedade

undefined | SasIPRange

Opcional somente quando o identificador é fornecido. Consulte AccountSASPermissions, FileSASPermissions ou ShareSASPermissions para obter mais detalhes.

permissions?: string

Valor da propriedade

string

Opcional. Os protocolos HTTP permitidos.

protocol?: SASProtocol

Valor da propriedade

SASProtocol

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

resource?: string

Valor da propriedade

string

Opcional. Os tipos de recursos de armazenamento que estão sendo acessados (somente para SAS de conta). Consulte AccountSASResourceTypes para obter mais detalhes.

resourceTypes?: string

Valor da propriedade

string

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

services?: string

Valor da propriedade

string

A assinatura do token SAS.

signature: string

Valor da propriedade

string

Opcional. A hora de início desse token SAS.

startsOn?: Date

Valor da propriedade

Date

A versão da API de armazenamento.

version: string

Valor da propriedade

string

Detalhes do método

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

Compartilhar via

SASQueryParameters class

Construtores

Propriedades

Métodos

Detalhes do construtor

Parâmetros

Detalhes da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Valor da propriedade

Detalhes do método

Retornos

Recursos adicionais