SASQueryParameters class

Pacote:

@azure/storage-queue

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 QueueSASSignatureValues . Depois de gerado, ele pode ser codificado em um toString() e acrescentado a uma URL diretamente (embora tenha cuidado para ser tomado 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)

Cria uma instância de SASQueryParameters.

Propriedades

expiresOn	Opcional somente quando o identificador é fornecido. O tempo de expiração para esse token SAS.
identifier	Opcional. O identificador assinado (somente para QueueSASSignatureValues). 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, QueueSASPermissions para obter mais detalhes.
protocol	Opcional. Os protocolos HTTP permitidos.
resource	Opcional. A fila de armazenamento (somente para QueueSASSignatureValues).
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

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

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 a fila de armazenamento (somente para SAS de Serviço)

Detalhes da propriedade

expiresOn

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

expiresOn?: Date

Valor da propriedade

Date

identifier

Opcional. O identificador assinado (somente para QueueSASSignatureValues).

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

identifier?: string

Valor da propriedade

string

ipRange

Opcional. Intervalo de IP permitido para essa SAS.

undefined | SasIPRange ipRange

Valor da propriedade

undefined | SasIPRange

permissions

Opcional somente quando o identificador é fornecido. Consulte AccountSASPermissions, QueueSASPermissions para obter mais detalhes.

permissions?: string

Valor da propriedade

string

protocol

Opcional. Os protocolos HTTP permitidos.

protocol?: SASProtocol

Valor da propriedade

SASProtocol

resource

Opcional. A fila de armazenamento (somente para QueueSASSignatureValues).

resource?: string

Valor da propriedade

string

resourceTypes

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

services

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

signature

A assinatura do token SAS.

signature: string

Valor da propriedade

string

startsOn

Opcional. A hora de início desse 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