SASQueryParameters class

  • Referens
Paket:
@azure/storage-blob

Representerar de komponenter som utgör en Azure Storage SAS-frågeparametrar. Den här typen skapas inte direkt av användaren. den genereras endast av typerna AccountSASSignatureValues och BlobSASSignatureValues . När den har genererats kan den kodas till en toString() och läggas till i en URL direkt (även om försiktighet bör vidtas här om det finns befintliga frågeparametrar, vilket kan påverka lämpliga sätt att lägga till dessa frågeparametrar).

Obs! Instanser av den här klassen är oföränderliga.

Konstruktorer

SASQueryParameters(string, string, SASQueryParametersOptions)

Skapar en instans av SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string, string)

Skapar en instans av SASQueryParameters.

Egenskaper

cacheControl

Värde för cachekontrollhuvud i Blob/File Service SAS.
contentDisposition

Värde för innehållsdispositionshuvud i Blob/File Service SAS.
contentEncoding

Värde för innehållskodningshuvud i Blob/File Service SAS.
contentLanguage

Värde för innehållslängdsrubrik i BLOB/File Service SAS.
contentType

Värde för rubrik av innehållstyp i SAS för Blob/File Service.
correlationId

Ett GUID-värde som loggas i lagringsdiagnostikloggarna och kan användas för att korrelera SAS-generering med åtkomst till lagringsresurser. Detta används endast för SAS för användardelegering.
encryptionScope

Valfritt. Krypteringsomfång som ska användas när begäranden som auktoriseras med denna SAS-URI skickas.
expiresOn

Valfritt endast när identifierare anges. Förfallotiden för den här SAS-token.
identifier

Valfritt. Den signerade identifieraren (endast för BlobSASSignatureValues).

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

Valfritt. IP-intervall tillåts för denna SAS.
permissions

Valfritt endast när identifierare anges. Mer information finns i AccountSASPermissions, BlobSASPermissions eller ContainerSASPermissions .
preauthorizedAgentObjectId

AAD-objekt-ID i GUID-format. AAD-objekt-ID för en användare som har auktoriserats av ägaren av användardelegeringsnyckeln för att utföra åtgärden som beviljats av SAS. Azure Storage-tjänsten ser till att ägaren av användardelegeringsnyckeln har de behörigheter som krävs innan åtkomst beviljas, men ingen ytterligare behörighetskontroll för användaren som anges i det här värdet utförs. Detta används endast för SAS för användardelegering.
protocol

Valfritt. Tillåtna HTTP-protokoll.
resource

Valfritt. Anger vilka resurser som är tillgängliga via SAS (endast för BlobSASSignatureValues).

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

Valfritt. De lagringsresurstyper som används (endast för Konto-SAS). Mer information finns i AccountSASResourceTypes .
services

Valfritt. De lagringstjänster som används (endast för konto-SAS). Mer information finns i AccountSASServices .
signature

Signaturen för SAS-token.
startsOn

Valfritt. Starttiden för den här SAS-token.
version

Lagrings-API-versionen.

Metoder

toString()

Kodar alla SAS-frågeparametrar i en sträng som kan läggas till i en URL.

Konstruktorinformation

SASQueryParameters(string, string, SASQueryParametersOptions)

Skapar en instans av SASQueryParameters.

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

Parametrar

version

string

Representerar lagringsversionen

signature

string

Representerar signaturen för SAS-token

options
SASQueryParametersOptions

Valfritt. Alternativ för att konstruera SASQueryParameters.

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

Skapar en instans av 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)

Parametrar

version

string

Representerar lagringsversionen

signature

string

Representerar signaturen för SAS-token

permissions

string

Representerar lagringsbehörigheterna

services

string

Representerar de lagringstjänster som används (endast för konto-SAS)

resourceTypes

string

Representerar de lagringsresurstyper som används (endast för konto-SAS)

protocol
SASProtocol

Representerar tillåtna HTTP-protokoll

startsOn

Date

Representerar starttiden för den här SAS-token

expiresOn

Date

Representerar förfallotiden för den här SAS-token

ipRange
SasIPRange

Representerar intervallet med giltiga IP-adresser för den här SAS-token

identifier

string

Representerar den signerade identifieraren (endast för Service SAS)

resource

string

Representerar lagringscontainern eller bloben (endast för Service SAS)

cacheControl

string

Representerar cachekontrollhuvudet (endast för Blob/File Service SAS)

contentDisposition

string

Representerar innehållsdispositionshuvudet (endast för BLOB/File Service SAS)

contentEncoding

string

Representerar innehållskodningshuvudet (endast för SAS för Blob/File Service)

contentLanguage

string

Representerar innehållsspråkshuvudet (endast för Blob/File Service SAS)

contentType

string

Representerar innehållstypens rubrik (endast för Blob/File Service SAS)

userDelegationKey
UserDelegationKey

Representerar egenskaperna för användardelegeringsnyckeln

preauthorizedAgentObjectId

string

Representerar auktoriserat AAD-objekt-ID (endast för SAS för användardelegering)

correlationId

string

Representerar korrelations-ID :t (endast för SAS för användardelegering)

encryptionScope

string

Egenskapsinformation

cacheControl

Värde för cachekontrollhuvud i Blob/File Service SAS.

cacheControl?: string

Egenskapsvärde

string

contentDisposition

Värde för innehållsdispositionshuvud i Blob/File Service SAS.

contentDisposition?: string

Egenskapsvärde

string

contentEncoding

Värde för innehållskodningshuvud i Blob/File Service SAS.

contentEncoding?: string

Egenskapsvärde

string

contentLanguage

Värde för innehållslängdsrubrik i BLOB/File Service SAS.

contentLanguage?: string

Egenskapsvärde

string

contentType

Värde för rubrik av innehållstyp i SAS för Blob/File Service.

contentType?: string

Egenskapsvärde

string

correlationId

Ett GUID-värde som loggas i lagringsdiagnostikloggarna och kan användas för att korrelera SAS-generering med åtkomst till lagringsresurser. Detta används endast för SAS för användardelegering.

correlationId?: string

Egenskapsvärde

string

encryptionScope

Valfritt. Krypteringsomfång som ska användas när begäranden som auktoriseras med denna SAS-URI skickas.

encryptionScope?: string

Egenskapsvärde

string

expiresOn

Valfritt endast när identifierare anges. Förfallotiden för den här SAS-token.

expiresOn?: Date

Egenskapsvärde

Date

identifier

Valfritt. Den signerade identifieraren (endast för BlobSASSignatureValues).

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

identifier?: string

Egenskapsvärde

string

ipRange

Valfritt. IP-intervall tillåts för denna SAS.

undefined | SasIPRange ipRange

Egenskapsvärde

undefined | SasIPRange

permissions

Valfritt endast när identifierare anges. Mer information finns i AccountSASPermissions, BlobSASPermissions eller ContainerSASPermissions .

permissions?: string

Egenskapsvärde

string

preauthorizedAgentObjectId

AAD-objekt-ID i GUID-format. AAD-objekt-ID för en användare som har auktoriserats av ägaren av användardelegeringsnyckeln för att utföra åtgärden som beviljats av SAS. Azure Storage-tjänsten ser till att ägaren av användardelegeringsnyckeln har de behörigheter som krävs innan åtkomst beviljas, men ingen ytterligare behörighetskontroll för användaren som anges i det här värdet utförs. Detta används endast för SAS för användardelegering.

preauthorizedAgentObjectId?: string

Egenskapsvärde

string

protocol

Valfritt. Tillåtna HTTP-protokoll.

protocol?: SASProtocol

Egenskapsvärde

SASProtocol

resource

Valfritt. Anger vilka resurser som är tillgängliga via SAS (endast för BlobSASSignatureValues).

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

resource?: string

Egenskapsvärde

string

resourceTypes

Valfritt. De lagringsresurstyper som används (endast för Konto-SAS). Mer information finns i AccountSASResourceTypes .

resourceTypes?: string

Egenskapsvärde

string

services

Valfritt. De lagringstjänster som används (endast för konto-SAS). Mer information finns i AccountSASServices .

services?: string

Egenskapsvärde

string

signature

Signaturen för SAS-token.

signature: string

Egenskapsvärde

string

startsOn

Valfritt. Starttiden för den här SAS-token.

startsOn?: Date

Egenskapsvärde

Date

version

Lagrings-API-versionen.

version: string

Egenskapsvärde

string

Metodinformation

toString()

Kodar alla SAS-frågeparametrar i en sträng som kan läggas till i en URL.

function toString(): string

Returer

string