SASQueryParameters class

Referência

Pacote:: @azure/storage-blob

Representa os componentes que compõem os parâmetros de consulta da SAS do Armazenamento do Microsoft Azure. Este tipo não é construído diretamente pelo utilizador; só é gerado pelos tipos AccountSASSignatureValues e BlobSASSignatureValues . Uma vez gerado, pode ser codificado num toString() e anexado diretamente a um URL (embora deva ter cuidado aqui no caso de existirem parâmetros de consulta, o que pode afetar os meios adequados de acrescentar estes parâmetros de consulta).

NOTA: as instâncias desta 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 para o cabeçalho de controlo de cache no SAS do Serviço de Blobs/Ficheiros.
contentDisposition	Valor para o cabeçalho de eliminação de conteúdos no SAS do Serviço de Blobs/Ficheiros.
contentEncoding	Valor para o cabeçalho de codificação de conteúdos no SAS do Serviço de Blobs/Ficheiros.
contentLanguage	Valor do cabeçalho content-length na SAS do Serviço de Blobs/Ficheiros.
contentType	Valor do cabeçalho do tipo de conteúdo no SAS do Serviço de Blobs/Ficheiros.
correlationId	Um valor GUID que será registado nos registos de diagnóstico de armazenamento e pode ser utilizado para correlacionar a geração de SAS com o acesso a recursos de armazenamento. Isto só é utilizado para SAS de Delegação de Utilizador.
encryptionScope	Opcional. Âmbito de encriptação a utilizar ao enviar pedidos autorizados com este URI de SAS.
expiresOn	Opcional apenas quando o identificador é fornecido. O tempo de expiração deste token de SAS.
identifier	Opcional. O identificador assinado (apenas para BlobSASSignatureValues). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Opcional. Intervalo de IP permitido para esta SAS.
permissions	Opcional apenas quando o identificador é fornecido. Veja AccountSASPermissions, BlobSASPermissions ou ContainerSASPermissions para obter mais detalhes.
preauthorizedAgentObjectId	ID de Objeto do AAD Autorizado no formato GUID. O ID de Objeto do AAD de um utilizador autorizado pelo proprietário da Chave de Delegação de Utilizador para efetuar a ação concedida pela SAS. O serviço de Armazenamento do Azure garantirá que o proprietário da chave de delegação de utilizador tem as permissões necessárias antes de conceder acesso, mas não será efetuada nenhuma verificação de permissão adicional para o utilizador especificado neste valor. Isto só é utilizado para SAS de Delegação de Utilizador.
protocol	Opcional. Os protocolos HTTP permitidos.
resource	Opcional. Especifica que recursos estão acessíveis através da SAS (apenas para BlobSASSignatureValues). Veja https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
resourceTypes	Opcional. Os tipos de recursos de armazenamento que estão a ser acedidos (apenas para SAS de Conta). Veja AccountSASResourceTypes para obter mais detalhes.
services	Opcional. Os serviços de armazenamento que estão a ser acedidos (apenas para SAS de Conta). Veja AccountSASServices para obter mais detalhes.
signature	A assinatura do token de SAS.
startsOn	Opcional. A hora de início deste token de SAS.
version	A versão da API de armazenamento.

Métodos

toString()

Codifica todos os parâmetros de consulta SAS numa cadeia que pode ser anexada a um 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

Representar a versão de armazenamento

signature: string

Representar a assinatura do token de 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

Representar a versão de armazenamento

signature: string

Representar a assinatura do token de SAS

permissions: string

Representar as permissões de armazenamento

services: string

Representar os serviços de armazenamento que estão a ser acedidos (apenas para SAS de Conta)

resourceTypes: string

Representar os tipos de recursos de armazenamento que estão a ser acedidos (apenas para SAS de Conta)

protocol: SASProtocol

Representando os protocolos HTTP permitidos

startsOn: Date

Representa a hora de início deste token de SAS

expiresOn: Date

Representar o tempo de expiração deste token de SAS

ipRange: SasIPRange

Representar o intervalo de endereços IP válidos para este token de SAS

identifier: string

Representar o identificador assinado (apenas para SAS de Serviço)

resource: string

Representar o contentor de armazenamento ou blob (apenas para SAS de Serviço)

cacheControl: string

Representar o cabeçalho de controlo de cache (apenas para SAS do Serviço de Blobs/Ficheiros)

contentDisposition: string

Representar o cabeçalho de eliminação de conteúdo (apenas para SAS do Serviço de Blobs/Ficheiros)

contentEncoding: string

Representar o cabeçalho de codificação de conteúdos (apenas para SAS do Serviço de Blobs/Ficheiros)

contentLanguage: string

Representar o cabeçalho content-language (apenas para SAS do Serviço de Blobs/Ficheiros)

contentType: string

Representar o cabeçalho do tipo de conteúdo (apenas para SAS do Serviço de Blobs/Ficheiros)

userDelegationKey: UserDelegationKey

Representar as propriedades da chave de delegação de utilizador

preauthorizedAgentObjectId: string

Representar o ID de Objeto do AAD autorizado (apenas para SAS de Delegação de Utilizador)

correlationId: string

Representar o ID de correlação (apenas para SAS de Delegação de Utilizador)

encryptionScope: string

Detalhes de Propriedade

cacheControl

Valor para o cabeçalho de controlo de cache no SAS do Serviço de Blobs/Ficheiros.

cacheControl?: string

Valor de Propriedade

string

contentDisposition

Valor para o cabeçalho de eliminação de conteúdos no SAS do Serviço de Blobs/Ficheiros.

contentDisposition?: string

Valor de Propriedade

string

contentEncoding

Valor para o cabeçalho de codificação de conteúdos no SAS do Serviço de Blobs/Ficheiros.

contentEncoding?: string

Valor de Propriedade

string

contentLanguage

Valor do cabeçalho content-length na SAS do Serviço de Blobs/Ficheiros.

contentLanguage?: string

Valor de Propriedade

string

contentType

Valor do cabeçalho do tipo de conteúdo no SAS do Serviço de Blobs/Ficheiros.

contentType?: string

Valor de Propriedade

string

correlationId

Um valor GUID que será registado nos registos de diagnóstico de armazenamento e pode ser utilizado para correlacionar a geração de SAS com o acesso a recursos de armazenamento. Isto só é utilizado para SAS de Delegação de Utilizador.

correlationId?: string

Valor de Propriedade

string

encryptionScope

Opcional. Âmbito de encriptação a utilizar ao enviar pedidos autorizados com este URI de SAS.

encryptionScope?: string

Valor de Propriedade

string

expiresOn

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

expiresOn?: Date

Valor de Propriedade

Date

identifier

Opcional. O identificador assinado (apenas para BlobSASSignatureValues).

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

identifier?: string

Valor de Propriedade

string

ipRange

Opcional. Intervalo de IP permitido para esta SAS.

undefined | SasIPRange ipRange

Valor de Propriedade

undefined | SasIPRange

permissions

Opcional apenas quando o identificador é fornecido. Veja AccountSASPermissions, BlobSASPermissions ou ContainerSASPermissions para obter mais detalhes.

permissions?: string

Valor de Propriedade

string

preauthorizedAgentObjectId

ID de Objeto do AAD Autorizado no formato GUID. O ID de Objeto do AAD de um utilizador autorizado pelo proprietário da Chave de Delegação de Utilizador para efetuar a ação concedida pela SAS. O serviço de Armazenamento do Azure garantirá que o proprietário da chave de delegação de utilizador tem as permissões necessárias antes de conceder acesso, mas não será efetuada nenhuma verificação de permissão adicional para o utilizador especificado neste valor. Isto só é utilizado para SAS de Delegação de Utilizador.

preauthorizedAgentObjectId?: string

Valor de Propriedade

string

protocol

Opcional. Os protocolos HTTP permitidos.

protocol?: SASProtocol

Valor de Propriedade

SASProtocol

resource

Opcional. Especifica que recursos estão acessíveis através da SAS (apenas para BlobSASSignatureValues).

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

resource?: string

Valor de Propriedade

string

resourceTypes

Opcional. Os tipos de recursos de armazenamento que estão a ser acedidos (apenas para SAS de Conta). Veja AccountSASResourceTypes para obter mais detalhes.

resourceTypes?: string

Valor de Propriedade

string

services

Opcional. Os serviços de armazenamento que estão a ser acedidos (apenas para SAS de Conta). Veja AccountSASServices para obter mais detalhes.

services?: string

Valor de Propriedade

string

signature

A assinatura do token de SAS.

signature: string

Valor de Propriedade

string

startsOn

Opcional. A hora de início deste token de 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 numa cadeia que pode ser anexada a um URL.

function toString(): string

Devoluções

string

Partilhar 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 de Propriedade

cacheControl

Valor de Propriedade

contentDisposition

Valor de Propriedade

contentEncoding

Valor de Propriedade

contentLanguage

Valor de Propriedade

contentType

Valor de Propriedade

correlationId

Valor de Propriedade

encryptionScope

Valor de Propriedade

expiresOn

Valor de Propriedade

identifier

Valor de Propriedade

ipRange

Valor de Propriedade

permissions

Valor de Propriedade

preauthorizedAgentObjectId

Valor de Propriedade

protocol

Valor de Propriedade

resource

Valor de Propriedade

resourceTypes

Valor de Propriedade

services

Valor de Propriedade

signature

Valor de Propriedade

startsOn

Valor de Propriedade

version

Valor de Propriedade

Detalhes de Método

toString()

Devoluções

Recursos adicionais