DataLakeSASSignatureValues interface

Pacote:

@azure/storage-file-datalake

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

DataLakeSASSignatureValues é usado para ajudar a gerar tokens SAS de serviço Blob e DataLake para contêineres, blobs, sistema de arquivos, diretórios e arquivos.

Propriedades

agentObjectId	Opcional. A partir da versão 2020-02-10, especifica a ID do objeto AAD não autorizado no formato GUID. A ID do objeto AAD de um usuário que é considerado não autorizado pelo proprietário da chave de delegação do usuário. O Serviço de Armazenamento do Azure executará uma verificação adicional da ACL POSIX para determinar se o usuário está autorizado a executar a operação solicitada. Isso não pode ser usado em conjunto com preauthorizedAgentObjectId . Isso só é usado para SAS de delegação de usuário.
cacheControl	Opcional. O cabeçalho cache-control para o SAS.
contentDisposition	Opcional. O cabeçalho de disposição de conteúdo para o SAS.
contentEncoding	Opcional. O cabeçalho de codificação de conteúdo para o SAS.
contentLanguage	Opcional. O cabeçalho de linguagem de conteúdo para o SAS.
contentType	Opcional. O cabeçalho de tipo de conteúdo para o SAS.
correlationId	Opcional. A partir da versão 2020-02-10, esse é 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.
directoryDepth	Opcional. A partir da versão 2020-02-10, indique a profundidade do diretório especificado no campo canonicalizedresource da string-to-sign. A profundidade do diretório é o número de diretórios abaixo da pasta raiz.
encryptionScope	Opcional. Escopo de criptografia a ser usado ao enviar solicitações autorizadas com este URI SAS.
expiresOn	Opcional apenas quando o identificador é fornecido. O tempo após o qual o SAS deixará de funcionar.
fileSystemName	O nome do sistema de arquivos que o usuário SAS pode acessar.
identifier	Opcional. O nome da política de acesso no sistema de arquivos ao qual esta SAS faz referência, se houver. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Opcional. Intervalos de IP permitidos nesta SAS.
isDirectory	Opcional. A partir da versão 2020-02-10, esse valor define se o pathName é ou não um diretório. Se esse valor for definido como true, o caminho será um diretório para uma SAS de diretório. Se definido como false ou default, o caminho é um caminho de arquivo para uma SAS de caminho de arquivo.
pathName	Opcional. O nome do caminho do diretório ou arquivo SAS usuário pode acessar. Necessário se snapshotTime for fornecido.
permissions	Opcional apenas quando o identificador é fornecido. Consulte FileSystemSASPermissions, DirectorySASPermissions ou DataLakeSASPermissions dependendo do recurso que está sendo acessado para obter ajuda na construção da cadeia de permissões.
preauthorizedAgentObjectId	Opcional. A partir da versão 2020-02-10, especifica a ID do objeto AAD autorizado no formato GUID. O ID de objeto do AAD de um usuário autorizado pelo proprietário da chave de delegação do usuário para executar a ação concedida pelo SAS. O serviço de Armazenamento do Azure garantirá que o proprietário da chave de delegação do 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 não pode ser usado em conjunto com agentObjectId. Isso só é usado para SAS de delegação de usuário.
protocol	Opcional. Protocolos SAS, apenas HTTPS ou HTTPSandHTTP
snapshotTime	Opcional. Cadeia de caracteres de carimbo de data/hora do instantâneo que o usuário SAS pode acessar. Apenas suportado a partir da versão API 2018-11-09.
startsOn	Opcional. Quando o SAS entrará em vigor.
version	A versão do serviço a que este SAS se destinará. Se não for especificado, o padrão será a versão direcionada pela biblioteca.

Detalhes de Propriedade

agentObjectId

Opcional. A partir da versão 2020-02-10, especifica a ID do objeto AAD não autorizado no formato GUID. A ID do objeto AAD de um usuário que é considerado não autorizado pelo proprietário da chave de delegação do usuário. O Serviço de Armazenamento do Azure executará uma verificação adicional da ACL POSIX para determinar se o usuário está autorizado a executar a operação solicitada. Isso não pode ser usado em conjunto com preauthorizedAgentObjectId . Isso só é usado para SAS de delegação de usuário.

agentObjectId?: string

Valor de Propriedade

string

cacheControl

Opcional. O cabeçalho cache-control para o SAS.

cacheControl?: string

Valor de Propriedade

string

contentDisposition

Opcional. O cabeçalho de disposição de conteúdo para o SAS.

contentDisposition?: string

Valor de Propriedade

string

contentEncoding

Opcional. O cabeçalho de codificação de conteúdo para o SAS.

contentEncoding?: string

Valor de Propriedade

string

contentLanguage

Opcional. O cabeçalho de linguagem de conteúdo para o SAS.

contentLanguage?: string

Valor de Propriedade

string

contentType

Opcional. O cabeçalho de tipo de conteúdo para o SAS.

contentType?: string

Valor de Propriedade

string

correlationId

Opcional. A partir da versão 2020-02-10, esse é 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 de Propriedade

string

directoryDepth

Opcional. A partir da versão 2020-02-10, indique a profundidade do diretório especificado no campo canonicalizedresource da string-to-sign. A profundidade do diretório é o número de diretórios abaixo da pasta raiz.

directoryDepth?: number

Valor de Propriedade

number

encryptionScope

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

encryptionScope?: string

Valor de Propriedade

string

expiresOn

Opcional apenas quando o identificador é fornecido. O tempo após o qual o SAS deixará de funcionar.

expiresOn?: Date

Valor de Propriedade

Date

fileSystemName

O nome do sistema de arquivos que o usuário SAS pode acessar.

fileSystemName: string

Valor de Propriedade

string

identifier

Opcional. O nome da política de acesso no sistema de arquivos ao qual esta SAS faz referência, se houver.

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

identifier?: string

Valor de Propriedade

string

ipRange

Opcional. Intervalos de IP permitidos nesta SAS.

ipRange?: SasIPRange

Valor de Propriedade

SasIPRange

isDirectory

Opcional. A partir da versão 2020-02-10, esse valor define se o pathName é ou não um diretório. Se esse valor for definido como true, o caminho será um diretório para uma SAS de diretório. Se definido como false ou default, o caminho é um caminho de arquivo para uma SAS de caminho de arquivo.

isDirectory?: boolean

Valor de Propriedade

boolean

pathName

Opcional. O nome do caminho do diretório ou arquivo SAS usuário pode acessar. Necessário se snapshotTime for fornecido.

pathName?: string

Valor de Propriedade

string

permissions

Opcional apenas quando o identificador é fornecido. Consulte FileSystemSASPermissions, DirectorySASPermissions ou DataLakeSASPermissions dependendo do recurso que está sendo acessado para obter ajuda na construção da cadeia de permissões.

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

Valor de Propriedade

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

preauthorizedAgentObjectId

Opcional. A partir da versão 2020-02-10, especifica a ID do objeto AAD autorizado no formato GUID. O ID de objeto do AAD de um usuário autorizado pelo proprietário da chave de delegação do usuário para executar a ação concedida pelo SAS. O serviço de Armazenamento do Azure garantirá que o proprietário da chave de delegação do 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 não pode ser usado em conjunto com agentObjectId. Isso só é usado para SAS de delegação de usuário.

preauthorizedAgentObjectId?: string

Valor de Propriedade

string

protocol

Opcional. Protocolos SAS, apenas HTTPS ou HTTPSandHTTP

protocol?: SASProtocol

Valor de Propriedade

SASProtocol

snapshotTime

Opcional. Cadeia de caracteres de carimbo de data/hora do instantâneo que o usuário SAS pode acessar. Apenas suportado a partir da versão API 2018-11-09.

snapshotTime?: string

Valor de Propriedade

string

startsOn

Opcional. Quando o SAS entrará em vigor.

startsOn?: Date

Valor de Propriedade

Date

version

A versão do serviço a que este SAS se destinará. Se não for especificado, o padrão será a versão direcionada pela biblioteca.

version?: string

Valor de Propriedade

string