SASQueryParameters class

Referência

Pacote:: @azure/storage-file-datalake

Representa os componentes que compõem os parâmetros de consulta de um SAS de Armazenamento do Azure. Este tipo não é construído diretamente pelo usuário; ele é gerado apenas pelos AccountSASSignatureValues e <xref:BlobSASSignatureValues> tipos. Uma vez gerado, ele pode ser codificado em um toString() e anexado a uma URL diretamente (embora seja necessário ter cuidado aqui caso existam parâmetros de consulta existentes, o que pode afetar os meios apropriados de anexar esses parâmetros de consulta).

Observação : 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, number, string, string, string, string)	Cria uma instância de SASQueryParameters.

Propriedades

agentObjectId	ID de objeto AAD não autorizado no formato GUID. O 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 adicional da ACL POSIX para determinar se o usuário está autorizado a executar a operação solicitada. Isto não pode ser usado em conjunto com <xref:signedAuthorizedUserObjectId>. Isso só é usado para SAS de delegação de usuário.
cacheControl	Valor para o cabeçalho de controle de cache no Blob/File Service SAS.
contentDisposition	Valor para cabeçalho de disposição de conteúdo em Blob/File Service SAS.
contentEncoding	Valor para cabeçalho de codificação de conteúdo em Blob/File Service SAS.
contentLanguage	Valor para cabeçalho de comprimento de conteúdo em Blob/File Service SAS.
contentType	Valor para cabeçalho de tipo de conteúdo em Blob/File Service SAS.
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 ao recurso de armazenamento. Isso só é usado para SAS de delegação de usuário.
directoryDepth	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 de expiração para este token SAS.
identifier	Opcional. O identificador assinado (apenas para <xref:BlobSASSignatureValues>). Visualizar https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Opcional. Intervalo de IP permitido para este SAS.
permissions	Opcional apenas quando o identificador é fornecido. Consulte AccountSASPermissions, <xref:BlobSASPermissions>ou <xref:ContainerSASPermissions> para obter mais detalhes.
preauthorizedAgentObjectId	ID de objeto autorizado do AAD no formato GUID. O 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 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. Isto não pode ser usado em conjunto com <xref:signedUnauthorizedUserObjectId>. Isso só é usado para SAS de delegação de usuário.
protocol	Opcional. O(s) protocolo(s) HTTP(s) permitido(s).
resource	Opcional. Especifica quais recursos podem ser acessados por meio do SAS (somente para <xref:BlobSASSignatureValues>). Visualizar https://learn.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 sendo acessados (somente para SAS de Conta). Consulte AccountSASResourceTypes para obter mais detalhes.
services	Opcional. Os serviços de armazenamento que estão sendo acessados (somente para SAS de conta). Consulte AccountSASServices para obter mais detalhes.
signature	A assinatura do token SAS.
startsOn	Opcional. A hora de início para este 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 anexada 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 o SASQueryParameters.

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, 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, directoryDepth?: number, preauthorizedAgentObjectId?: string, agentObjectId?: 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 (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 o(s) protocolo(s) HTTP(s) permitido(s)

startsOn: Date

Representando a hora de início deste token SAS

expiresOn: Date

Representando o tempo de expiração deste 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 ou blob de armazenamento (somente para SAS de serviço)

cacheControl: string

Representando o cabeçalho cache-control (somente para Blob/File Service SAS)

contentDisposition: string

Representando o cabeçalho de disposição de conteúdo (somente para Blob/File Service SAS)

contentEncoding: string

Representando o cabeçalho de codificação de conteúdo (somente para Blob/File Service SAS)

contentLanguage: string

Representando o cabeçalho do idioma de conteúdo (somente para Blob/File Service SAS)

contentType: string

Representando o cabeçalho de tipo de conteúdo (somente para Blob/File Service SAS)

userDelegationKey: UserDelegationKey

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

directoryDepth: number

preauthorizedAgentObjectId: string

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

agentObjectId: string

Representando o ID de objeto do AAD não autorizado (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 de Propriedade

agentObjectId

ID de objeto AAD não autorizado no formato GUID. O 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 adicional da ACL POSIX para determinar se o usuário está autorizado a executar a operação solicitada. Isto não pode ser usado em conjunto com <xref:signedAuthorizedUserObjectId>. Isso só é usado para SAS de delegação de usuário.

agentObjectId?: string

Valor de Propriedade

string

cacheControl

Valor para o cabeçalho de controle de cache no Blob/File Service SAS.

cacheControl?: string

Valor de Propriedade

string

contentDisposition

Valor para cabeçalho de disposição de conteúdo em Blob/File Service SAS.

contentDisposition?: string

Valor de Propriedade

string

contentEncoding

Valor para cabeçalho de codificação de conteúdo em Blob/File Service SAS.

contentEncoding?: string

Valor de Propriedade

string

contentLanguage

Valor para cabeçalho de comprimento de conteúdo em Blob/File Service SAS.

contentLanguage?: string

Valor de Propriedade

string

contentType

Valor para cabeçalho de tipo de conteúdo em Blob/File Service SAS.

contentType?: string

Valor de 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 ao recurso de armazenamento. Isso só é usado para SAS de delegação de usuário.

correlationId?: string

Valor de Propriedade

string

directoryDepth

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 de expiração para este token SAS.

expiresOn?: Date

Valor de Propriedade

Date

identifier

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

Visualizar https://learn.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 este SAS.

undefined | SasIPRange ipRange

Valor de Propriedade

undefined | SasIPRange

permissions

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

permissions?: string

Valor de Propriedade

string

preauthorizedAgentObjectId

ID de objeto autorizado do AAD no formato GUID. O 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 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. Isto não pode ser usado em conjunto com <xref:signedUnauthorizedUserObjectId>. Isso só é usado para SAS de delegação de usuário.

preauthorizedAgentObjectId?: string

Valor de Propriedade

string

protocol

Opcional. O(s) protocolo(s) HTTP(s) permitido(s).

protocol?: SASProtocol

Valor de Propriedade

SASProtocol

resource

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

Visualizar https://learn.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 sendo acessados (somente para SAS de Conta). Consulte AccountSASResourceTypes para obter mais detalhes.

resourceTypes?: string

Valor de Propriedade

string

services

Opcional. Os serviços de armazenamento que estão sendo acessados (somente para SAS de conta). Consulte AccountSASServices para obter mais detalhes.

services?: string

Valor de Propriedade

string

signature

A assinatura do token SAS.

signature: string

Valor de Propriedade

string

startsOn

Opcional. A hora de início para este token 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 em uma cadeia de caracteres que pode ser anexada a uma 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, number, string, string, string, string)

Parâmetros

Detalhes de Propriedade

agentObjectId

Valor 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

directoryDepth

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