DataLakeSASSignatureValues interface

Pacote:

@azure/storage-file-datalake

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

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 de objeto do AAD não autorizado no formato GUID. A ID de objeto do 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 de ACL POSIX adicional para determinar se o usuário está autorizado a executar a operação solicitada. Isso não pode ser usado em conjúria com preauthorizedAgentObjectId. Isso só é usado para SAS de Delegação de Usuário.
cacheControl	Opcional. O cabeçalho de controle de cache para a SAS.
contentDisposition	Opcional. O cabeçalho de disposição de conteúdo para a SAS.
contentEncoding	Opcional. O cabeçalho de codificação de conteúdo para a SAS.
contentLanguage	Opcional. O cabeçalho de linguagem de conteúdo para a SAS.
contentType	Opcional. O cabeçalho de tipo de conteúdo para a 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 cadeia de caracteres para assinar. 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 esse URI de SAS.
expiresOn	Opcional somente quando o identificador é fornecido. O tempo após o qual a SAS não funcionará mais.
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 que essa SAS faz referência, se houver. Veja 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 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 falso ou padrão, o Caminho será um Caminho de Arquivo para uma SAS de Caminho de Arquivo.
pathName	Opcional. O nome do caminho do diretório ou do arquivo que o usuário SAS pode acessar. Obrigatório se snapshotTime for fornecido.
permissions	Opcional somente quando o identificador é fornecido. Consulte FileSystemSASPermissions, DirectorySASPermissions ou DataLakeSASPermissions , dependendo do recurso que está sendo acessado para obter ajuda para construir a cadeia de caracteres de permissões.
preauthorizedAgentObjectId	Opcional. A partir da versão 2020-02-10, especifica a 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 não pode ser usado em conjução com agentObjectId. Isso só é usado para SAS de Delegação de Usuário.
protocol	Opcional. Protocolos SAS, somente HTTPS ou HTTPSandHTTP
snapshotTime	Opcional. Cadeia de caracteres de carimbo de data/hora do instantâneo que o usuário sas pode acessar. Compatível apenas com a versão da API 2018-11-09.
startsOn	Opcional. Quando a SAS entrará em vigor.
version	A versão do serviço que essa SAS terá como destino. Se não for especificado, ele usará como padrão a versão direcionada pela biblioteca.

Detalhes da propriedade

agentObjectId

Opcional. A partir da versão 2020-02-10, especifica a ID de objeto do AAD não autorizado no formato GUID. A ID de objeto do 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 de ACL POSIX adicional para determinar se o usuário está autorizado a executar a operação solicitada. Isso não pode ser usado em conjúria com preauthorizedAgentObjectId. Isso só é usado para SAS de Delegação de Usuário.

agentObjectId?: string

Valor da propriedade

string

cacheControl

Opcional. O cabeçalho de controle de cache para a SAS.

cacheControl?: string

Valor da propriedade

string

contentDisposition

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

contentDisposition?: string

Valor da propriedade

string

contentEncoding

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

contentEncoding?: string

Valor da propriedade

string

contentLanguage

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

contentLanguage?: string

Valor da propriedade

string

contentType

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

contentType?: string

Valor da 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 da propriedade

string

directoryDepth

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

directoryDepth?: number

Valor da propriedade

number

encryptionScope

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

encryptionScope?: string

Valor da propriedade

string

expiresOn

Opcional somente quando o identificador é fornecido. O tempo após o qual a SAS não funcionará mais.

expiresOn?: Date

Valor da propriedade

Date

fileSystemName

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

fileSystemName: string

Valor da propriedade

string

identifier

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

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

identifier?: string

Valor da propriedade

string

ipRange

Opcional. Intervalos de IP permitidos nesta SAS.

ipRange?: SasIPRange

Valor da propriedade

SasIPRange

isDirectory

Opcional. A partir da versão 2020-02-10, esse valor define se 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 falso ou padrão, o Caminho será um Caminho de Arquivo para uma SAS de Caminho de Arquivo.

isDirectory?: boolean

Valor da propriedade

boolean

pathName

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

pathName?: string

Valor da propriedade

string

permissions

Opcional somente quando o identificador é fornecido. Consulte FileSystemSASPermissions, DirectorySASPermissions ou DataLakeSASPermissions , dependendo do recurso que está sendo acessado para obter ajuda para construir a cadeia de caracteres de permissões.

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

Valor da propriedade

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

preauthorizedAgentObjectId

Opcional. A partir da versão 2020-02-10, especifica a 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 não pode ser usado em conjução com agentObjectId. Isso só é usado para SAS de Delegação de Usuário.

preauthorizedAgentObjectId?: string

Valor da propriedade

string

protocol

Opcional. Protocolos SAS, somente HTTPS ou HTTPSandHTTP

protocol?: SASProtocol

Valor da propriedade

SASProtocol

snapshotTime

Opcional. Cadeia de caracteres de carimbo de data/hora do instantâneo que o usuário sas pode acessar. Compatível apenas com a versão da API 2018-11-09.

snapshotTime?: string

Valor da propriedade

string

startsOn

Opcional. Quando a SAS entrará em vigor.

startsOn?: Date

Valor da propriedade

Date

version

A versão do serviço que essa SAS terá como destino. Se não for especificado, ele usará como padrão a versão direcionada pela biblioteca.

version?: string

Valor da propriedade

string