Freigeben über

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 <xref:AccountSASSignatureValues> Typen und <xref:BlobSASSignatureValues> generiert. Nach der Generierung kann es in eine <xref:String> 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, string, string)

Erstellt eine Instanz von SASQueryParameters.

Eigenschaften

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.
expiresOn

Nur optional, wenn der Bezeichner angegeben wird. Die Ablaufzeit für dieses SAS-Token.
identifier

Optional. Der signierte Bezeichner (nur für <xref:BlobSASSignatureValues>).
ipRange

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

Nur optional, wenn der Bezeichner angegeben wird. Weitere Informationen finden Sie unter <xref: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 wird nur für die SAS der Benutzerdelegierung verwendet.
protocol

Optional. Die zulässigen HTTP-Protokolle.
resource

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

Optional. Die Speicherressourcentypen, auf die zugegriffen wird (nur für Konto-SAS). Weitere Informationen finden Sie unter <xref:AccountSASResourceTypes> .
services

Optional. Auf die Speicherdienste, auf die zugegriffen wird (nur für Konto-SAS). Weitere Informationen finden Sie unter <xref:AccountSASServices> .
signature

Die Signatur für das SAS-Token.
startsOn

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

Optional. 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)

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)

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

preauthorizedAgentObjectId

string

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

correlationId

string

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

Details zur Eigenschaft

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

expiresOn

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

expiresOn?: Date

Eigenschaftswert

Date

identifier

Optional. Der signierte Bezeichner (nur für <xref:BlobSASSignatureValues>).

identifier?: string

Eigenschaftswert

string

ipRange

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

SasIPRange | undefined ipRange

Eigenschaftswert

SasIPRange | undefined

permissions

Nur optional, wenn der Bezeichner angegeben wird. Weitere Informationen finden Sie unter <xref: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 wird nur für die SAS der Benutzerdelegierung verwendet.

preauthorizedAgentObjectId?: string

Eigenschaftswert

string

protocol

Optional. Die zulässigen HTTP-Protokolle.

protocol?: SASProtocol

Eigenschaftswert

SASProtocol

resource

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

resource?: string

Eigenschaftswert

string

resourceTypes

Optional. Die Speicherressourcentypen, auf die zugegriffen wird (nur für Konto-SAS). Weitere Informationen finden Sie unter <xref:AccountSASResourceTypes> .

resourceTypes?: string

Eigenschaftswert

string

services

Optional. Auf die Speicherdienste, auf die zugegriffen wird (nur für Konto-SAS). Weitere Informationen finden Sie unter <xref:AccountSASServices> .

services?: string

Eigenschaftswert

string

signature

Die Signatur für das SAS-Token.

signature: string

Eigenschaftswert

string

startsOn

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()

Gibt zurück

string