Compartilhar via

SASQueryParameters class

  • Referência
Pacote:
@azure/storage-blob

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 <xref:AccountSASSignatureValues> tipos e <xref:BlobSASSignatureValues> . Depois de gerado, ele pode ser codificado em um <xref:String> 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, SASQueryParametersOptions)

Cria uma instância de SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, 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 para o cabeçalho do tipo conteúdo em SAS do Serviço de Blob/Arquivo.
correlationId

Um valor guid que será registrado nos logs de diagnóstico de armazenamento e pode ser usado para correlacionar a geração de SAS com o acesso a recursos de armazenamento. Isso só é usado para SAS de Delegação de Usuário.
expiresOn

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

Opcional. O identificador assinado (somente para <xref:BlobSASSignatureValues>).
ipRange

Opcional. Intervalo de IP permitido para essa SAS.
permissions

Opcional somente quando o identificador é fornecido. <xref:AccountSASPermissions>Consulte , <xref:BlobSASPermissions>ou <xref:ContainerSASPermissions> para obter mais detalhes.
preauthorizedAgentObjectId

ID de objeto do AAD autorizada no formato GUID. A ID do objeto AAD de um usuário autorizado pelo proprietário da Chave de Delegação de Usuário para executar a ação concedida pela SAS. O serviço de Armazenamento do Azure garantirá que o proprietário da chave de delegação de usuário tenha as permissões necessárias antes de conceder acesso, mas nenhuma verificação de permissão adicional para o usuário especificado nesse valor será executada. Isso só é usado para SAS de Delegação de Usuário.
protocol

Opcional. Os protocolos HTTP permitidos.
resource

Opcional. Especifica quais recursos podem ser acessados por meio da SAS (somente para <xref:BlobSASSignatureValues>).
resourceTypes

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

Opcional. Os serviços de armazenamento que estão sendo acessados (somente para SAS de conta). Consulte para <xref:AccountSASServices> 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, SASQueryParametersOptions)

Cria uma instância de SASQueryParameters.

new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)

Parâmetros

version

string

Representando a versão de armazenamento

signature

string

Representando a assinatura para o token SAS

options
SASQueryParametersOptions

Opcional. Opções para construir os SASQueryParameters.

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, 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, userDelegationKey?: UserDelegationKey, preauthorizedAgentObjectId?: string, correlationId?: 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 a hora de expiração para esse token SAS

ipRange
SasIPRange

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

identifier

string

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

resource

string

Representando o contêiner de armazenamento ou o 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)

userDelegationKey
UserDelegationKey

Representando as propriedades da chave de delegação do usuário

preauthorizedAgentObjectId

string

Representando a ID de objeto do AAD autorizada (somente para SAS de delegação de usuário)

correlationId

string

Representando a ID de correlação (somente para SAS de delegação de usuário)

Detalhes da propriedade

cacheControl

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

cacheControl?: string

Valor da propriedade

string

contentDisposition

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

contentEncoding

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

contentLanguage

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

contentLanguage?: string

Valor da propriedade

string

contentType

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

contentType?: string

Valor da propriedade

string

correlationId

Um valor guid que será registrado nos logs de diagnóstico de armazenamento e pode ser usado para correlacionar a geração de SAS com o acesso a recursos de armazenamento. Isso só é usado para SAS de Delegação de Usuário.

correlationId?: string

Valor da propriedade

string

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 <xref:BlobSASSignatureValues>).

identifier?: string

Valor da propriedade

string

ipRange

Opcional. Intervalo de IP permitido para essa SAS.

SasIPRange | undefined ipRange

Valor da propriedade

SasIPRange | undefined

permissions

Opcional somente quando o identificador é fornecido. <xref:AccountSASPermissions>Consulte , <xref:BlobSASPermissions>ou <xref:ContainerSASPermissions> para obter mais detalhes.

permissions?: string

Valor da propriedade

string

preauthorizedAgentObjectId

ID de objeto do AAD autorizada no formato GUID. A ID do objeto AAD de um usuário autorizado pelo proprietário da Chave de Delegação de Usuário para executar a ação concedida pela SAS. O serviço de Armazenamento do Azure garantirá que o proprietário da chave de delegação de usuário tenha as permissões necessárias antes de conceder acesso, mas nenhuma verificação de permissão adicional para o usuário especificado nesse valor será executada. Isso só é usado para SAS de Delegação de Usuário.

preauthorizedAgentObjectId?: string

Valor da propriedade

string

protocol

Opcional. Os protocolos HTTP permitidos.

protocol?: SASProtocol

Valor da propriedade

SASProtocol

resource

Opcional. Especifica quais recursos podem ser acessados por meio da SAS (somente para <xref:BlobSASSignatureValues>).

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 para <xref:AccountSASResourceTypes> 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 para <xref:AccountSASServices> 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()

Retornos

string