Freigeben über

DataLakeSASSignatureValues interface

  • Referenz
Paket:
@azure/storage-file-datalake

NUR IN NODE.JS RUNTIME VERFÜGBAR.

DataLakeSASSignatureValues wird verwendet, um blob- und DataLake-Dienst-SAS-Token für Container, Blobs, Dateisystem, Verzeichnisse und Dateien zu generieren.

Eigenschaften

agentObjectId

Optional. Ab Version 2020-02-10 gibt die Nicht autorisierte AAD-Objekt-ID im GUID-Format an. Die AAD-Objekt-ID eines Benutzers, der vom Besitzer des Benutzerdelegierungsschlüssels als nicht autorisiert angenommen wird. Der Azure Storage-Dienst führt eine zusätzliche POSIX-ACL-Überprüfung durch, um zu ermitteln, ob der Benutzer zum Ausführen des angeforderten Vorgangs autorisiert ist. Dies kann nicht in der Conjuction mit preauthorizedAgentObjectId verwendet werden. Dies wird nur für die SAS der Benutzerdelegierung verwendet.
cacheControl

Optional. Der Cachesteuerungsheader für die SAS.
contentDisposition

Optional. Der Inhaltsdispositionsheader für die SAS.
contentEncoding

Optional. Der Inhaltscodierungsheader für die SAS.
contentLanguage

Optional. Der Inhaltssprachheader für die SAS.
contentType

Optional. Der Inhaltstypheader für die SAS.
correlationId

Optional. Ab Version 2020-02-10 ist dies ein GUID-Wert, der in den Speicherdiagnoseprotokollen protokolliert wird und verwendet werden kann, um die SAS-Generierung mit dem Zugriff auf Speicherressourcen zu korrelieren. Dies wird nur für die SAS der Benutzerdelegierung verwendet.
directoryDepth

Optional. Geben Sie ab Version 2020-02-10 die Tiefe des Verzeichnisses an, die im Feld kanonicalizedresource des String-to-Sign angegeben ist. Die Tiefe des Verzeichnisses ist die Anzahl der Verzeichnisse unter dem Stammordner.
encryptionScope

Optional. Verschlüsselungsbereich, der beim Senden von Anforderungen verwendet werden soll, die mit diesem SAS-URI autorisiert sind.
expiresOn

Nur optional, wenn der Bezeichner angegeben wird. Die Zeit, nach der die SAS nicht mehr funktioniert.
fileSystemName

Der Name des Dateisystems, auf das der SAS-Benutzer zugreifen kann.
identifier

Optional. Der Name der Zugriffsrichtlinie für das Dateisystem, auf das diese SAS verweist, falls vorhanden.

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

Optional. In dieser SAS zulässige IP-Bereiche.
isDirectory

Optional. Ab Version 2020-02-10 definiert dieser Wert, ob pathName ein Verzeichnis ist oder nicht. Wenn dieser Wert auf true festgelegt ist, ist der Pfad ein Verzeichnis für eine Verzeichnis-SAS. Wenn auf false oder standard festgelegt ist, ist der Pfad ein Dateipfad für eine Dateipfad-SAS.
pathName

Optional. Der Pfadname des Verzeichnis- oder Datei-SAS-Benutzers kann zugreifen. Erforderlich, wenn snapshotTime bereitgestellt wird.
permissions

Nur optional, wenn der Bezeichner angegeben wird. Informationen zum Erstellen der Berechtigungszeichenfolge finden Sie unter FileSystemSASPermissions, DirectorySASPermissions oder DataLakeSASPermissions , je nach Ressource, auf die zugegriffen wird.
preauthorizedAgentObjectId

Optional. Ab Version 2020-02-10 gibt die autorisierte AAD-Objekt-ID im GUID-Format an. Die AAD-Objekt-ID eines Benutzers, der vom Besitzer des Benutzerdelegierungsschlüssels autorisiert ist, um die von der SAS gewährte Aktion auszuführen. Der Azure Storage-Dienst stellt sicher, dass der Besitzer des Benutzerdelegierungsschlüssels über die erforderlichen Berechtigungen verfügt, bevor der Zugriff gewährt wird, aber es wird keine zusätzliche Berechtigungsprüfung für den in diesem Wert angegebenen Benutzer durchgeführt. Dies kann nicht in der Conjuction mit agentObjectId verwendet werden. Dies wird nur für die SAS der Benutzerdelegierung verwendet.
protocol

Optional. SAS-Protokolle, nur HTTPS oder HTTPSandHTTP
snapshotTime

Optional. Momentaufnahmezeitstempelzeichenfolge, auf die der SAS-Benutzer möglicherweise zugreifen kann. Wird nur von API-Version 2018-11-09 unterstützt.
startsOn

Optional. Wann die SAS wirksam wird.
version

Die Version des Diensts, auf den diese SAS ausgerichtet wird. Wenn nicht angegeben, wird standardmäßig die Version verwendet, die von der Bibliothek als Ziel verwendet wird.

Details zur Eigenschaft

agentObjectId

Optional. Ab Version 2020-02-10 gibt die Nicht autorisierte AAD-Objekt-ID im GUID-Format an. Die AAD-Objekt-ID eines Benutzers, der vom Besitzer des Benutzerdelegierungsschlüssels als nicht autorisiert angenommen wird. Der Azure Storage-Dienst führt eine zusätzliche POSIX-ACL-Überprüfung durch, um zu ermitteln, ob der Benutzer zum Ausführen des angeforderten Vorgangs autorisiert ist. Dies kann nicht in der Conjuction mit preauthorizedAgentObjectId verwendet werden. Dies wird nur für die SAS der Benutzerdelegierung verwendet.

agentObjectId?: string

Eigenschaftswert

string

cacheControl

Optional. Der Cachesteuerungsheader für die SAS.

cacheControl?: string

Eigenschaftswert

string

contentDisposition

Optional. Der Inhaltsdispositionsheader für die SAS.

contentDisposition?: string

Eigenschaftswert

string

contentEncoding

Optional. Der Inhaltscodierungsheader für die SAS.

contentEncoding?: string

Eigenschaftswert

string

contentLanguage

Optional. Der Inhaltssprachheader für die SAS.

contentLanguage?: string

Eigenschaftswert

string

contentType

Optional. Der Inhaltstypheader für die SAS.

contentType?: string

Eigenschaftswert

string

correlationId

Optional. Ab Version 2020-02-10 ist dies ein GUID-Wert, der in den Speicherdiagnoseprotokollen protokolliert wird und verwendet werden kann, um die SAS-Generierung mit dem Zugriff auf Speicherressourcen zu korrelieren. Dies wird nur für die SAS der Benutzerdelegierung verwendet.

correlationId?: string

Eigenschaftswert

string

directoryDepth

Optional. Geben Sie ab Version 2020-02-10 die Tiefe des Verzeichnisses an, die im Feld kanonicalizedresource des String-to-Sign angegeben ist. Die Tiefe des Verzeichnisses ist die Anzahl der Verzeichnisse unter dem Stammordner.

directoryDepth?: number

Eigenschaftswert

number

encryptionScope

Optional. Verschlüsselungsbereich, der beim Senden von Anforderungen verwendet werden soll, die mit diesem SAS-URI autorisiert sind.

encryptionScope?: string

Eigenschaftswert

string

expiresOn

Nur optional, wenn der Bezeichner angegeben wird. Die Zeit, nach der die SAS nicht mehr funktioniert.

expiresOn?: Date

Eigenschaftswert

Date

fileSystemName

Der Name des Dateisystems, auf das der SAS-Benutzer zugreifen kann.

fileSystemName: string

Eigenschaftswert

string

identifier

Optional. Der Name der Zugriffsrichtlinie für das Dateisystem, auf das diese SAS verweist, falls vorhanden.

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

identifier?: string

Eigenschaftswert

string

ipRange

Optional. In dieser SAS zulässige IP-Bereiche.

ipRange?: SasIPRange

Eigenschaftswert

SasIPRange

isDirectory

Optional. Ab Version 2020-02-10 definiert dieser Wert, ob pathName ein Verzeichnis ist oder nicht. Wenn dieser Wert auf true festgelegt ist, ist der Pfad ein Verzeichnis für eine Verzeichnis-SAS. Wenn auf false oder standard festgelegt ist, ist der Pfad ein Dateipfad für eine Dateipfad-SAS.

isDirectory?: boolean

Eigenschaftswert

boolean

pathName

Optional. Der Pfadname des Verzeichnis- oder Datei-SAS-Benutzers kann zugreifen. Erforderlich, wenn snapshotTime bereitgestellt wird.

pathName?: string

Eigenschaftswert

string

permissions

Nur optional, wenn der Bezeichner angegeben wird. Informationen zum Erstellen der Berechtigungszeichenfolge finden Sie unter FileSystemSASPermissions, DirectorySASPermissions oder DataLakeSASPermissions , je nach Ressource, auf die zugegriffen wird.

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

Eigenschaftswert

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

preauthorizedAgentObjectId

Optional. Ab Version 2020-02-10 gibt die autorisierte AAD-Objekt-ID im GUID-Format an. Die AAD-Objekt-ID eines Benutzers, der vom Besitzer des Benutzerdelegierungsschlüssels autorisiert ist, um die von der SAS gewährte Aktion auszuführen. Der Azure Storage-Dienst stellt sicher, dass der Besitzer des Benutzerdelegierungsschlüssels über die erforderlichen Berechtigungen verfügt, bevor der Zugriff gewährt wird, aber es wird keine zusätzliche Berechtigungsprüfung für den in diesem Wert angegebenen Benutzer durchgeführt. Dies kann nicht in der Conjuction mit agentObjectId verwendet werden. Dies wird nur für die SAS der Benutzerdelegierung verwendet.

preauthorizedAgentObjectId?: string

Eigenschaftswert

string

protocol

Optional. SAS-Protokolle, nur HTTPS oder HTTPSandHTTP

protocol?: SASProtocol

Eigenschaftswert

SASProtocol

snapshotTime

Optional. Momentaufnahmezeitstempelzeichenfolge, auf die der SAS-Benutzer möglicherweise zugreifen kann. Wird nur von API-Version 2018-11-09 unterstützt.

snapshotTime?: string

Eigenschaftswert

string

startsOn

Optional. Wann die SAS wirksam wird.

startsOn?: Date

Eigenschaftswert

Date

version

Die Version des Diensts, auf den diese SAS ausgerichtet wird. Wenn nicht angegeben, wird standardmäßig die Version verwendet, die von der Bibliothek als Ziel verwendet wird.

version?: string

Eigenschaftswert

string