SASQueryParameters class

Pacote:

@azure/storage-file-share

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

Observação : 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 no Blob/File Service SAS.
contentDisposition	Valor para cabeçalho de disposição de conteúdo em Blob/File Service SAS.
contentEncoding	Valor para cabeçalho de codificação de conteúdo em Blob/File Service SAS.
contentLanguage	Valor para cabeçalho de comprimento de conteúdo em Blob/File Service SAS.
contentType	Valor para cabeçalho de tipo de conteúdo em Blob/File Service SAS.
expiresOn	Opcional apenas quando o identificador é fornecido. O tempo de expiração para este token SAS.
identifier	Optional. O identificador assinado (somente para FileSASSignatureValues). Visualizar https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. Intervalo de IP permitido para este SAS.
permissions	Opcional apenas quando o identificador é fornecido. Consulte AccountSASPermissions, FileSASPermissionsou ShareSASPermissions para obter mais detalhes.
protocol	Optional. O(s) protocolo(s) HTTP(s) permitido(s).
resource	Optional. O compartilhamento de armazenamento ou caminho de arquivo (somente para FileSASSignatureValues).
resourceTypes	Optional. Os tipos de recursos de armazenamento que estão sendo acessados (somente para SAS de Conta). Consulte AccountSASResourceTypes para obter mais detalhes.
services	Optional. 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	Optional. A hora de início para este 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 anexada 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 (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 o(s) protocolo(s) HTTP(s) permitido(s)

startsOn

Date

Representando a hora de início deste token SAS

expiresOn

Date

Representando o tempo de expiração deste 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 ou blob de armazenamento (somente para SAS de serviço)

cacheControl

string

Representando o cabeçalho cache-control (somente para Blob/File Service SAS)

contentDisposition

string

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

contentEncoding

string

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

contentLanguage

string

Representando o cabeçalho do idioma de conteúdo (somente para Blob/File Service SAS)

contentType

string

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

Detalhes de Propriedade

cacheControl

Valor para o cabeçalho de controle de cache no Blob/File Service SAS.

cacheControl?: string

Valor de Propriedade

string

contentDisposition

Valor para cabeçalho de disposição de conteúdo em Blob/File Service SAS.

contentDisposition?: string

Valor de Propriedade

string

contentEncoding

Valor para cabeçalho de codificação de conteúdo em Blob/File Service SAS.

contentEncoding?: string

Valor de Propriedade

string

contentLanguage

Valor para cabeçalho de comprimento de conteúdo em Blob/File Service SAS.

contentLanguage?: string

Valor de Propriedade

string

contentType

Valor para cabeçalho de tipo de conteúdo em Blob/File Service SAS.

contentType?: string

Valor de Propriedade

string

expiresOn

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

expiresOn?: Date

Valor de Propriedade

Date

identifier

Optional. O identificador assinado (somente para FileSASSignatureValues).

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

identifier?: string

Valor de Propriedade

string

ipRange

Optional. Intervalo de IP permitido para este SAS.

undefined | SasIPRange ipRange

Valor de Propriedade

undefined | SasIPRange

permissions

Opcional apenas quando o identificador é fornecido. Consulte AccountSASPermissions, FileSASPermissionsou ShareSASPermissions para obter mais detalhes.

permissions?: string

Valor de Propriedade

string

protocol

Optional. O(s) protocolo(s) HTTP(s) permitido(s).

protocol?: SASProtocol

Valor de Propriedade

SASProtocol

resource

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

resource?: string

Valor de Propriedade

string

resourceTypes

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

string

services

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

services?: string

Valor de Propriedade

string

signature

A assinatura do token SAS.

signature: string

Valor de Propriedade

string

startsOn

Optional. A hora de início para este token SAS.

startsOn?: Date

Valor de Propriedade

Date

version

A versão da API de armazenamento.

version: string

Valor de Propriedade

string

Detalhes de Método

toString()

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

function toString(): string

Devoluções

string