SASQueryParameters class

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 é gerado apenas pelos tipos AccountSASSignatureValues e blobSASSignatureValues. 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, 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, 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.
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.
encryptionScope	Opcional. Escopo de criptografia a ser usado ao enviar solicitações autorizadas com esse URI SAS.
expiresOn	Opcional somente quando o identificador for fornecido. A hora de expiração desse token SAS.
identifier	Opcional. O identificador assinado (somente para BlobSASSignatureValues). Consulte https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Opcional. Intervalo de IP permitido para essa SAS.
permissions	Opcional somente quando o identificador for fornecido. Consulte accountSASPermissions, blobSASPermissionsou containerSASPermissions para obter mais detalhes.
preauthorizedAgentObjectId	ID de objeto do AAD autorizado no formato GUID. A ID de objeto do 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 BlobSASSignatureValues). Consulte https://learn.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
resourceTypes	Opcional. Os tipos de recurso de armazenamento que estão sendo acessados (apenas para SAS de conta). Consulte AccountSASResourceTypes para obter mais detalhes.
services	Opcional. 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	Opcional. 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, 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 do 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, 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, encryptionScope?: 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)

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)

encryptionScope: string

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

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

encryptionScope

Opcional. Escopo de criptografia a ser usado ao enviar solicitações autorizadas com esse URI SAS.

encryptionScope?: 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

Opcional. O identificador assinado (somente para BlobSASSignatureValues).

Consulte https://learn.microsoft.com/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 for fornecido. Consulte accountSASPermissions, blobSASPermissionsou containerSASPermissions para obter mais detalhes.

permissions?: string

Valor da propriedade

string

preauthorizedAgentObjectId

ID de objeto do AAD autorizado no formato GUID. A ID de objeto do 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 BlobSASSignatureValues).

Consulte https://learn.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

resource?: string

Valor da propriedade

string

resourceTypes

Opcional. 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

Opcional. 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

Opcional. 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

Compartilhar via

SASQueryParameters class

Construtores

Propriedades

Métodos

Detalhes do construtor

SASQueryParameters(string, string, SASQueryParametersOptions)

Parâmetros

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

Parâmetros

Detalhes da propriedade

cacheControl

Valor da propriedade

contentDisposition

Valor da propriedade

contentEncoding

Valor da propriedade

contentLanguage

Valor da propriedade

contentType

Valor da propriedade

correlationId

Valor da propriedade

encryptionScope

Valor da propriedade

expiresOn

Valor da propriedade

identifier

Valor da propriedade

ipRange

Valor da propriedade

permissions

Valor da propriedade

preauthorizedAgentObjectId

Valor da propriedade

protocol

Valor da propriedade

resource

Valor da propriedade

resourceTypes

Valor da propriedade

services

Valor da propriedade

signature

Valor da propriedade

startsOn

Valor da propriedade

version

Valor da propriedade

Detalhes do método

toString()

Retornos