SASQueryParameters class

Referenz

Paket:: @azure/storage-blob

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 AccountSASSignatureValues und BlobSASSignatureValues Typen generiert. Nachdem sie generiert wurde, kann sie in eine toString() codiert und direkt an eine URL angefügt werden (allerdings sollten Sie hier vorsichtig sein, falls es vorhandene Abfrageparameter gibt, die sich auf die geeigneten Methoden 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, string, string, string)	Erstellt eine Instanz von SASQueryParameters.

Eigenschaften

cacheControl	Wert für den Cache-Steuerelementheader in BLOB/File Service SAS.
contentDisposition	Wert für den Inhaltsdispositionsheader in BLOB/File Service SAS.
contentEncoding	Wert für den Inhaltscodierungsheader in BLOB/File Service SAS.
contentLanguage	Wert für den Header der Inhaltslänge in BLOB/File Service SAS.
contentType	Wert für den 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 Speicherressourcenzugriff zu korrelieren. Dies wird nur für benutzerdelegierungs-SAS verwendet.
encryptionScope	Wahlfrei. Verschlüsselungsbereich, der beim Senden von Anforderungen verwendet werden soll, die mit diesem SAS-URI autorisiert sind.
expiresOn	Optional nur, wenn der Bezeichner angegeben wird. Die Ablaufzeit für dieses SAS-Token.
identifier	Wahlfrei. Der signierte Bezeichner (nur für BlobSASSignatureValues). Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Wahlfrei. Für diese SAS zulässiger IP-Bereich.
permissions	Optional nur, wenn der Bezeichner angegeben wird. Weitere Informationen finden Sie unter AccountSASPermissions, BlobSASPermissionsoder ContainerSASPermissions-.
preauthorizedAgentObjectId	Autorisierte AAD-Objekt-ID im GUID-Format. Die AAD-Objekt-ID eines Benutzers, der vom Besitzer des Benutzerdelegierungsschlüssels autorisiert wurde, um die vom SAS erteilte 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 keine zusätzliche Berechtigungsprüfung für den in diesem Wert angegebenen Benutzer ausgeführt wird. Dies wird nur für benutzerdelegierungs-SAS verwendet.
protocol	Wahlfrei. Die zulässigen HTTP-Protokolle.
resource	Wahlfrei. Gibt an, auf welche Ressourcen über das SAS zugegriffen werden kann (nur für BlobSASSignatureValues). Siehe https://learn.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
resourceTypes	Wahlfrei. Auf die Speicherressourcentypen wird zugegriffen (nur für Account SAS). Weitere Informationen finden Sie unter AccountSASResourceTypes.
services	Wahlfrei. Zugriff auf die Speicherdienste (nur für Account SAS). Weitere Informationen finden Sie unter AccountSASServices.
signature	Die Signatur für das SAS-Token.
startsOn	Wahlfrei. Die Startzeit für dieses SAS-Token.
version	Die Speicher-API-Version.

Methoden

toString()

Codiert alle SAS-Abfrageparameter in einer 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

Darstellung der Speicherversion

signature: string

Darstellen der Signatur für das SAS-Token

options: SASQueryParametersOptions

Wahlfrei. Optionen zum Erstellen der SASQueryParameters.

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, 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, preauthorizedAgentObjectId?: string, correlationId?: string, encryptionScope?: string)

Parameter

version: string

Darstellung der Speicherversion

signature: string

Darstellen der Signatur für das SAS-Token

permissions: string

Darstellen der Speicherberechtigungen

services: string

Darstellung der Speicherdienste, auf die zugegriffen wird (nur für Account SAS)

resourceTypes: string

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

protocol: SASProtocol

Darstellen der zulässigen HTTP-Protokolle

startsOn: Date

Darstellung der Startzeit für dieses SAS-Token

expiresOn: Date

Darstellung der Ablaufzeit für dieses SAS-Token

ipRange: SasIPRange

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

identifier: string

Darstellen des signierten Bezeichners (nur für Service SAS)

resource: string

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

cacheControl: string

Darstellen des Cachesteuerelementheaders (nur für BLOB/File Service SAS)

contentDisposition: string

Darstellen des Inhaltsverfügungsheaders (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 Schlüsseleigenschaften der Benutzerdelegierung

preauthorizedAgentObjectId: string

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

correlationId: string

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

encryptionScope: string

Details zur Eigenschaft

cacheControl

Wert für den Cache-Steuerelementheader 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 den Inhaltscodierungsheader in BLOB/File Service SAS.

contentEncoding?: string

Eigenschaftswert

string

contentLanguage

Wert für den Header der Inhaltslänge in BLOB/File Service SAS.

contentLanguage?: string

Eigenschaftswert

string

contentType

Wert für den 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 Speicherressourcenzugriff zu korrelieren. Dies wird nur für benutzerdelegierungs-SAS verwendet.

correlationId?: string

Eigenschaftswert

string

encryptionScope

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

encryptionScope?: string

Eigenschaftswert

string

expiresOn

Optional nur, wenn der Bezeichner angegeben wird. Die Ablaufzeit für dieses SAS-Token.

expiresOn?: Date

Eigenschaftswert

Date

identifier

Wahlfrei. Der signierte Bezeichner (nur für BlobSASSignatureValues).

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

identifier?: string

Eigenschaftswert

string

ipRange

Wahlfrei. Für diese SAS zulässiger IP-Bereich.

undefined | SasIPRange ipRange

Eigenschaftswert

undefined | SasIPRange

permissions

Optional nur, wenn der Bezeichner angegeben wird. Weitere Informationen finden Sie unter AccountSASPermissions, BlobSASPermissionsoder 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 wurde, um die vom SAS erteilte 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 keine zusätzliche Berechtigungsprüfung für den in diesem Wert angegebenen Benutzer ausgeführt wird. Dies wird nur für benutzerdelegierungs-SAS verwendet.

preauthorizedAgentObjectId?: string

Eigenschaftswert

string

protocol

Wahlfrei. Die zulässigen HTTP-Protokolle.

protocol?: SASProtocol

Eigenschaftswert

SASProtocol

resource

Wahlfrei. Gibt an, auf welche Ressourcen über das SAS zugegriffen werden kann (nur für BlobSASSignatureValues).

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

resource?: string

Eigenschaftswert

string

resourceTypes

Wahlfrei. Auf die Speicherressourcentypen wird zugegriffen (nur für Account SAS). Weitere Informationen finden Sie unter AccountSASResourceTypes.

resourceTypes?: string

Eigenschaftswert

string

services

Wahlfrei. Zugriff auf die Speicherdienste (nur für Account SAS). Weitere Informationen finden Sie unter AccountSASServices.

services?: string

Eigenschaftswert

string

signature

Die Signatur für das SAS-Token.

signature: string

Eigenschaftswert

string

startsOn

Wahlfrei. 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 einer Zeichenfolge, die an eine URL angefügt werden kann.

function toString(): string

Gibt zurück

string

Freigeben über

SASQueryParameters class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

SASQueryParameters(string, string, SASQueryParametersOptions)

Parameter

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

Parameter

Details zur Eigenschaft

cacheControl

Eigenschaftswert

contentDisposition

Eigenschaftswert

contentEncoding

Eigenschaftswert

contentLanguage

Eigenschaftswert

contentType

Eigenschaftswert

correlationId

Eigenschaftswert

encryptionScope

Eigenschaftswert

expiresOn

Eigenschaftswert

identifier

Eigenschaftswert

ipRange

Eigenschaftswert

permissions

Eigenschaftswert

preauthorizedAgentObjectId

Eigenschaftswert

protocol

Eigenschaftswert

resource

Eigenschaftswert

resourceTypes

Eigenschaftswert

services

Eigenschaftswert

signature

Eigenschaftswert

startsOn

Eigenschaftswert

version

Eigenschaftswert

Details zur Methode

toString()

Gibt zurück

Zusätzliche Ressourcen