Freigeben über

SASQueryParameters class

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

Stellt die Komponenten dar, aus denen die Abfrageparameter einer Azure Storage-SAS bestehen. Dieser Typ wird nicht direkt vom Benutzer erstellt. sie wird nur von den Typen AccountSASSignatureValues und <xref:BlobSASSignatureValues> generiert. Nach der Generierung kann es in eine toString() codiert und direkt an eine URL angefügt werden (obwohl hier Vorsicht geboten ist, falls Abfrageparameter vorhanden sind, die sich auf die geeignete Methode zum Anfügen dieser Abfrageparameter auswirken können).

HINWEIS: Instanzen dieser Klasse sind unveränderlich.

Konstruktoren

SASQueryParameters(string, string, SASQueryParametersOptions)

Erstellt eine Instanz von SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, string, string)

Erstellt eine Instanz von SASQueryParameters.

Eigenschaften

agentObjectId

Nicht autorisierte AAD-Objekt-ID im GUID-Format. 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 <xref:signedAuthorizedUserObjectId>verwendet werden. Dies wird nur für die SAS der Benutzerdelegierung verwendet.
cacheControl

Wert für cache-control header in Blob/File Service SAS.
contentDisposition

Wert für den Inhaltsdispositionsheader in blob/File Service SAS.
contentEncoding

Wert für inhaltscodierungsheader in Blob/File Service SAS.
contentLanguage

Wert für den Inhaltslängenheader in Blob/File Service SAS.
contentType

Wert für Inhaltstypheader in Blob/File Service SAS.
correlationId

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

Geben Sie die Tiefe des Verzeichnisses an, die im Feld canonicalizedresource des String-to-Sign-Felds angegeben ist. Die Tiefe des Verzeichnisses ist die Anzahl der Verzeichnisse unter dem Stammordner.
encryptionScope

Dies ist 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 Ablaufzeit für dieses SAS-Token.
identifier

Dies ist optional. Der signierte Bezeichner (nur für <xref:BlobSASSignatureValues>).

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

Dies ist optional. Für diese SAS zulässiger IP-Bereich.
permissions

Nur optional, wenn der Bezeichner angegeben wird. Weitere Informationen finden Sie unter AccountSASPermissions, <xref:BlobSASPermissions>oder <xref:ContainerSASPermissions> .
preauthorizedAgentObjectId

Autorisierte AAD-Objekt-ID im GUID-Format. 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 <xref:signedUnauthorizedUserObjectId>verwendet werden. Dies wird nur für die SAS der Benutzerdelegierung verwendet.
protocol

Dies ist optional. Die zulässigen HTTP-Protokolle.
resource

Dies ist optional. Gibt an, auf welche Ressourcen über die SAS zugegriffen werden kann (nur für <xref:BlobSASSignatureValues>).

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

Dies ist optional. Die Speicherressourcentypen, auf die zugegriffen wird (nur für Konto-SAS). Weitere Informationen finden Sie unter AccountSASResourceTypes .
services

Dies ist optional. Auf die Speicherdienste, auf die zugegriffen wird (nur für Konto-SAS). Weitere Informationen finden Sie unter AccountSASServices .
signature

Die Signatur für das SAS-Token.
startsOn

Dies ist optional. Die Startzeit für dieses SAS-Token.
version

Die Speicher-API-Version.

Methoden

toString()

Codiert alle SAS-Abfrageparameter in eine Zeichenfolge, die an eine URL angefügt werden kann.

Details zum Konstruktor

SASQueryParameters(string, string, SASQueryParametersOptions)

Erstellt eine Instanz von SASQueryParameters.

new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)

Parameter

version

string

Darstellen der Speicherversion

signature

string

Darstellen der Signatur für das SAS-Token

options
SASQueryParametersOptions

Dies ist optional. Optionen zum Erstellen der SASQueryParameters.

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, string, string)

Erstellt eine Instanz von 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)

Parameter

version

string

Darstellen der Speicherversion

signature

string

Darstellen der Signatur für das SAS-Token

permissions

string

Darstellen der Speicherberechtigungen

services

string

Darstellen der Speicherdienste, auf die zugegriffen wird (nur für Konto-SAS)

resourceTypes

string

Darstellen der Speicherressourcentypen, auf die zugegriffen wird (nur für Konto-SAS)

protocol
SASProtocol

Darstellen der zulässigen HTTP-Protokolle

startsOn

Date

Darstellen der Startzeit für dieses SAS-Token

expiresOn

Date

Darstellen der Ablaufzeit für dieses SAS-Token

ipRange
SasIPRange

Darstellen des Bereichs der gültigen IP-Adressen für dieses SAS-Token

identifier

string

Darstellen des signierten Bezeichners (nur für Dienst-SAS)

resource

string

Darstellen des Speichercontainers oder Blobs (nur für Service SAS)

cacheControl

string

Darstellen des Cache-Control-Headers (nur für Blob-/Dateidienst-SAS)

contentDisposition

string

Darstellen des Inhaltsdispositionsheaders (nur für Blob/File Service SAS)

contentEncoding

string

Darstellen des Inhaltscodierungsheaders (nur für Blob/File Service SAS)

contentLanguage

string

Darstellen des Inhaltssprachenheaders (nur für Blob/File Service SAS)

contentType

string

Darstellen des Inhaltstypheaders (nur für Blob/File Service SAS)

userDelegationKey
UserDelegationKey

Darstellen der Eigenschaften des Benutzerdelegierungsschlüssels

directoryDepth

number

preauthorizedAgentObjectId

string

Darstellen der autorisierten AAD-Objekt-ID (nur für Benutzerdelegierungs-SAS)

agentObjectId

string

Darstellen der nicht autorisierten AAD-Objekt-ID (nur für Benutzerdelegierungs-SAS)

correlationId

string

Darstellen der Korrelations-ID (nur für Benutzerdelegierungs-SAS)

encryptionScope

string

Details zur Eigenschaft

agentObjectId

Nicht autorisierte AAD-Objekt-ID im GUID-Format. 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 <xref:signedAuthorizedUserObjectId>verwendet werden. Dies wird nur für die SAS der Benutzerdelegierung verwendet.

agentObjectId?: string

Eigenschaftswert

string

cacheControl

Wert für cache-control header in Blob/File Service SAS.

cacheControl?: string

Eigenschaftswert

string

contentDisposition

Wert für den Inhaltsdispositionsheader in blob/File Service SAS.

contentDisposition?: string

Eigenschaftswert

string

contentEncoding

Wert für inhaltscodierungsheader in Blob/File Service SAS.

contentEncoding?: string

Eigenschaftswert

string

contentLanguage

Wert für den Inhaltslängenheader in Blob/File Service SAS.

contentLanguage?: string

Eigenschaftswert

string

contentType

Wert für Inhaltstypheader in Blob/File Service SAS.

contentType?: string

Eigenschaftswert

string

correlationId

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

Geben Sie die Tiefe des Verzeichnisses an, die im Feld canonicalizedresource des String-to-Sign-Felds angegeben ist. Die Tiefe des Verzeichnisses ist die Anzahl der Verzeichnisse unter dem Stammordner.

directoryDepth?: number

Eigenschaftswert

number

encryptionScope

Dies ist 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 Ablaufzeit für dieses SAS-Token.

expiresOn?: Date

Eigenschaftswert

Date

identifier

Dies ist optional. Der signierte Bezeichner (nur für <xref:BlobSASSignatureValues>).

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

identifier?: string

Eigenschaftswert

string

ipRange

Dies ist optional. Für diese SAS zulässiger IP-Bereich.

undefined | SasIPRange ipRange

Eigenschaftswert

undefined | SasIPRange

permissions

Nur optional, wenn der Bezeichner angegeben wird. Weitere Informationen finden Sie unter AccountSASPermissions, <xref:BlobSASPermissions>oder <xref:ContainerSASPermissions> .

permissions?: string

Eigenschaftswert

string

preauthorizedAgentObjectId

Autorisierte AAD-Objekt-ID im GUID-Format. 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 <xref:signedUnauthorizedUserObjectId>verwendet werden. Dies wird nur für die SAS der Benutzerdelegierung verwendet.

preauthorizedAgentObjectId?: string

Eigenschaftswert

string

protocol

Dies ist optional. Die zulässigen HTTP-Protokolle.

protocol?: SASProtocol

Eigenschaftswert

SASProtocol

resource

Dies ist optional. Gibt an, auf welche Ressourcen über die SAS zugegriffen werden kann (nur für <xref:BlobSASSignatureValues>).

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

resource?: string

Eigenschaftswert

string

resourceTypes

Dies ist optional. Die Speicherressourcentypen, auf die zugegriffen wird (nur für Konto-SAS). Weitere Informationen finden Sie unter AccountSASResourceTypes .

resourceTypes?: string

Eigenschaftswert

string

services

Dies ist optional. Auf die Speicherdienste, auf die zugegriffen wird (nur für Konto-SAS). Weitere Informationen finden Sie unter AccountSASServices .

services?: string

Eigenschaftswert

string

signature

Die Signatur für das SAS-Token.

signature: string

Eigenschaftswert

string

startsOn

Dies ist optional. Die Startzeit für dieses SAS-Token.

startsOn?: Date

Eigenschaftswert

Date

version

Die Speicher-API-Version.

version: string

Eigenschaftswert

string

Details zur Methode

toString()

Codiert alle SAS-Abfrageparameter in eine Zeichenfolge, die an eine URL angefügt werden kann.

function toString(): string

Gibt zurück

string