SASQueryParameters class

Pakket:

@azure/storage-blob

Vertegenwoordigt de onderdelen waaruit de queryparameters van een Azure Storage SAS zijn opgebouwd. Dit type wordt niet rechtstreeks door de gebruiker samengesteld; het wordt alleen gegenereerd door de <xref:AccountSASSignatureValues> typen en <xref:BlobSASSignatureValues> . Zodra deze is gegenereerd, kan deze worden gecodeerd in een <xref:String> en rechtstreeks aan een URL worden toegevoegd (hoewel u hier voorzichtig moet zijn als er bestaande queryparameters zijn, wat van invloed kan zijn op de juiste manier om deze queryparameters toe te voegen). OPMERKING: exemplaren van deze klasse zijn onveranderbaar.

Constructors

SASQueryParameters(string, string, SASQueryParametersOptions)	Hiermee maakt u een exemplaar van SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string)	Hiermee maakt u een exemplaar van SASQueryParameters.

Eigenschappen

cacheControl	Waarde voor cache-control-header in Blob/File Service SAS.
contentDisposition	Waarde voor de header voor het verwijderen van inhoud in Blob/File Service SAS.
contentEncoding	Waarde voor inhoudscoderingsheader in Blob/File Service SAS.
contentLanguage	Waarde voor koptekst met lengte van inhoud in Blob/File Service SAS.
contentType	Waarde voor header van inhoudstype in Blob/File Service SAS.
correlationId	Een GUID-waarde die wordt vastgelegd in de diagnostische logboeken van de opslag en die kan worden gebruikt om sas-generatie te correleren met toegang tot opslagresources. Dit wordt alleen gebruikt voor SAS voor gebruikersdelegatie.
expiresOn	Alleen optioneel wanneer de id is opgegeven. De verlooptijd voor dit SAS-token.
identifier	Optioneel. De ondertekende id (alleen voor <xref:BlobSASSignatureValues>).
ipRange	Optioneel. IP-bereik toegestaan voor deze SAS.
permissions	Alleen optioneel wanneer de id is opgegeven. Raadpleeg <xref:AccountSASPermissions>, <xref:BlobSASPermissions>of <xref:ContainerSASPermissions> voor meer informatie.
preauthorizedAgentObjectId	Geautoriseerde AAD-object-id in GUID-indeling. De AAD-object-id van een gebruiker die is geautoriseerd door de eigenaar van de gebruikersdelegatiesleutel om de actie uit te voeren die door de SAS is verleend. De Azure Storage-service zorgt ervoor dat de eigenaar van de gebruikersdelegatiesleutel over de vereiste machtigingen beschikt voordat toegang wordt verleend, maar er wordt geen extra machtigingscontrole uitgevoerd voor de gebruiker die in deze waarde is opgegeven. Dit wordt alleen gebruikt voor SAS voor gebruikersdelegatie.
protocol	Optioneel. De toegestane HTTP-protocollen.
resource	Optioneel. Hiermee geeft u op welke resources toegankelijk zijn via de SAS (alleen voor <xref:BlobSASSignatureValues>).
resourceTypes	Optioneel. De opslagresourcetypen die worden geopend (alleen voor account-SAS). Raadpleeg voor <xref:AccountSASResourceTypes> meer informatie.
services	Optioneel. De opslagservices die worden geopend (alleen voor account-SAS). Raadpleeg voor <xref:AccountSASServices> meer informatie.
signature	De handtekening voor het SAS-token.
startsOn	Optioneel. De begintijd voor dit SAS-token.
version	De versie van de opslag-API.

Methoden

toString()

Codeert alle SAS-queryparameters in een tekenreeks die kan worden toegevoegd aan een URL.

Constructordetails

SASQueryParameters(string, string, SASQueryParametersOptions)

Hiermee maakt u een exemplaar van SASQueryParameters.

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

Parameters

version

string

De opslagversie vertegenwoordigen

signature

string

De handtekening voor het SAS-token vertegenwoordigen

options

SASQueryParametersOptions

Optioneel. Opties voor het samenstellen van de SASQueryParameters.

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

Hiermee maakt u een exemplaar van 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)

Parameters

version

string

De opslagversie vertegenwoordigen

signature

string

De handtekening voor het SAS-token vertegenwoordigen

permissions

string

De opslagmachtigingen vertegenwoordigen

services

string

De opslagservices vertegenwoordigen die worden geopend (alleen voor account-SAS)

resourceTypes

string

Vertegenwoordigen van de opslagresourcetypen die worden geopend (alleen voor account-SAS)

protocol

SASProtocol

De toegestane HTTP-protocollen vertegenwoordigen

startsOn

Date

De begintijd voor dit SAS-token vertegenwoordigen

expiresOn

Date

De verlooptijd voor dit SAS-token vertegenwoordigen

ipRange

SasIPRange

Het bereik van geldige IP-adressen voor dit SAS-token vertegenwoordigen

identifier

string

De ondertekende id vertegenwoordigen (alleen voor service-SAS)

resource

string

De opslagcontainer of blob vertegenwoordigen (alleen voor service-SAS)

cacheControl

string

De cache-control-header vertegenwoordigen (alleen voor Blob/File Service SAS)

contentDisposition

string

Vertegenwoordigt de header voor het verwijderen van inhoud (alleen voor Blob/File Service SAS)

contentEncoding

string

De header voor inhoudscodering vertegenwoordigen (alleen voor Blob/File Service SAS)

contentLanguage

string

De koptekst in de inhoudstaal vertegenwoordigen (alleen voor Blob/File Service SAS)

contentType

string

De header van het inhoudstype vertegenwoordigen (alleen voor Blob/File Service SAS)

userDelegationKey

UserDelegationKey

De sleuteleigenschappen voor gebruikersdelegatie vertegenwoordigen

preauthorizedAgentObjectId

string

Vertegenwoordigt de geautoriseerde AAD-object-id (alleen voor SAS voor gebruikersdelegatie)

correlationId

string

Vertegenwoordigt de correlatie-id (alleen voor SAS voor gebruikersdelegatie)

Eigenschapdetails

cacheControl

Waarde voor cache-control-header in Blob/File Service SAS.

cacheControl?: string

Waarde van eigenschap

string

contentDisposition

Waarde voor de header voor het verwijderen van inhoud in Blob/File Service SAS.

contentDisposition?: string

Waarde van eigenschap

string

contentEncoding

Waarde voor inhoudscoderingsheader in Blob/File Service SAS.

contentEncoding?: string

Waarde van eigenschap

string

contentLanguage

Waarde voor koptekst met lengte van inhoud in Blob/File Service SAS.

contentLanguage?: string

Waarde van eigenschap

string

contentType

Waarde voor header van inhoudstype in Blob/File Service SAS.

contentType?: string

Waarde van eigenschap

string

correlationId

Een GUID-waarde die wordt vastgelegd in de diagnostische logboeken van de opslag en die kan worden gebruikt om sas-generatie te correleren met toegang tot opslagresources. Dit wordt alleen gebruikt voor SAS voor gebruikersdelegatie.

correlationId?: string

Waarde van eigenschap

string

expiresOn

Alleen optioneel wanneer de id is opgegeven. De verlooptijd voor dit SAS-token.

expiresOn?: Date

Waarde van eigenschap

Date

identifier

Optioneel. De ondertekende id (alleen voor <xref:BlobSASSignatureValues>).

identifier?: string

Waarde van eigenschap

string

ipRange

Optioneel. IP-bereik toegestaan voor deze SAS.

SasIPRange | undefined ipRange

Waarde van eigenschap

SasIPRange | undefined

permissions

Alleen optioneel wanneer de id is opgegeven. Raadpleeg <xref:AccountSASPermissions>, <xref:BlobSASPermissions>of <xref:ContainerSASPermissions> voor meer informatie.

permissions?: string

Waarde van eigenschap

string

preauthorizedAgentObjectId

Geautoriseerde AAD-object-id in GUID-indeling. De AAD-object-id van een gebruiker die is geautoriseerd door de eigenaar van de gebruikersdelegatiesleutel om de actie uit te voeren die door de SAS is verleend. De Azure Storage-service zorgt ervoor dat de eigenaar van de gebruikersdelegatiesleutel over de vereiste machtigingen beschikt voordat toegang wordt verleend, maar er wordt geen extra machtigingscontrole uitgevoerd voor de gebruiker die in deze waarde is opgegeven. Dit wordt alleen gebruikt voor SAS voor gebruikersdelegatie.

preauthorizedAgentObjectId?: string

Waarde van eigenschap

string

protocol

Optioneel. De toegestane HTTP-protocollen.

protocol?: SASProtocol

Waarde van eigenschap

SASProtocol

resource

Optioneel. Hiermee geeft u op welke resources toegankelijk zijn via de SAS (alleen voor <xref:BlobSASSignatureValues>).

resource?: string

Waarde van eigenschap

string

resourceTypes

Optioneel. De opslagresourcetypen die worden geopend (alleen voor account-SAS). Raadpleeg voor <xref:AccountSASResourceTypes> meer informatie.

resourceTypes?: string

Waarde van eigenschap

string

services

Optioneel. De opslagservices die worden geopend (alleen voor account-SAS). Raadpleeg voor <xref:AccountSASServices> meer informatie.

services?: string

Waarde van eigenschap

string

signature

De handtekening voor het SAS-token.

signature: string

Waarde van eigenschap

string

startsOn

Optioneel. De begintijd voor dit SAS-token.

startsOn?: Date

Waarde van eigenschap

Date

version

De versie van de opslag-API.

version: string

Waarde van eigenschap

string

Methodedetails

toString()

Codeert alle SAS-queryparameters in een tekenreeks die kan worden toegevoegd aan een URL.

function toString()

Retouren

string