SASQueryParameters class

Referentie

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 typen AccountSASSignatureValues en BlobSASSignatureValues . Zodra deze is gegenereerd, kan deze worden gecodeerd in een toString() en rechtstreeks aan een URL worden toegevoegd (hoewel u hier voorzichtig moet zijn als er bestaande queryparameters zijn, die van invloed kunnen 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, string)	Hiermee maakt u een exemplaar van SASQueryParameters.

Eigenschappen

cacheControl	Waarde voor cache-control-header in Blob/File Service SAS.
contentDisposition	Waarde voor header voor verwijdering van inhoud in Blob/File Service SAS.
contentEncoding	Waarde voor inhoudscoderingsheader in blob-/bestandsservice-SAS.
contentLanguage	Waarde voor inhoudslengteheader in Blob/File Service SAS.
contentType	Waarde voor inhoudstypeheader 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.
encryptionScope	Optioneel. Versleutelingsbereik dat moet worden gebruikt bij het verzenden van aanvragen die zijn geautoriseerd met deze SAS-URI.
expiresOn	Alleen optioneel wanneer de id is opgegeven. De verlooptijd voor dit SAS-token.
identifier	Optioneel. De ondertekende id (alleen voor BlobSASSignatureValues). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optioneel. IP-bereik toegestaan voor deze SAS.
permissions	Alleen optioneel wanneer de id is opgegeven. Raadpleeg AccountSASPermissions, BlobSASPermissions of ContainerSASPermissions voor meer informatie.
preauthorizedAgentObjectId	Geautoriseerde AAD-object-id in GUID-indeling. De AAD-object-id van een gebruiker die is gemachtigd 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 aanvullende 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 BlobSASSignatureValues). Zie https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
resourceTypes	Optioneel. De opslagresourcetypen die worden geopend (alleen voor account-SAS). Raadpleeg AccountSASResourceTypes voor meer informatie.
services	Optioneel. De opslagservices die worden geopend (alleen voor account-SAS). Raadpleeg AccountSASServices voor 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, 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, encryptionScope?: 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

Vertegenwoordigt de ondertekende id (alleen voor service-SAS)

resource: string

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

cacheControl: string

Vertegenwoordigt de cache-control-header (alleen voor Blob/File Service SAS)

contentDisposition: string

De header voor inhoudsverwijdering vertegenwoordigen (alleen voor blob-/bestandsservice-SAS)

contentEncoding: string

De inhoudscoderingsheader vertegenwoordigen (alleen voor blob-/bestandsservice-SAS)

contentLanguage: string

De header van de inhoudstaal vertegenwoordigen (alleen voor blob-/bestandsservice-SAS)

contentType: string

De header van het inhoudstype vertegenwoordigen (alleen voor blob-/bestandsservice-SAS)

userDelegationKey: UserDelegationKey

De eigenschappen van de gebruikersdelegatiesleutel vertegenwoordigen

preauthorizedAgentObjectId: string

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

correlationId: string

De correlatie-id vertegenwoordigen (alleen voor SAS voor gebruikersdelegatie)

encryptionScope: string

Eigenschapdetails

cacheControl

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

cacheControl?: string

Waarde van eigenschap

string

contentDisposition

Waarde voor header voor verwijdering van inhoud in Blob/File Service SAS.

contentDisposition?: string

Waarde van eigenschap

string

contentEncoding

Waarde voor inhoudscoderingsheader in blob-/bestandsservice-SAS.

contentEncoding?: string

Waarde van eigenschap

string

contentLanguage

Waarde voor inhoudslengteheader in Blob/File Service SAS.

contentLanguage?: string

Waarde van eigenschap

string

contentType

Waarde voor inhoudstypeheader 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

encryptionScope

Optioneel. Versleutelingsbereik dat moet worden gebruikt bij het verzenden van aanvragen die zijn geautoriseerd met deze SAS-URI.

encryptionScope?: 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 BlobSASSignatureValues).

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

identifier?: string

Waarde van eigenschap

string

ipRange

Optioneel. IP-bereik toegestaan voor deze SAS.

undefined | SasIPRange ipRange

Waarde van eigenschap

undefined | SasIPRange

permissions

Alleen optioneel wanneer de id is opgegeven. Raadpleeg AccountSASPermissions, BlobSASPermissions of 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 gemachtigd 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 aanvullende 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 BlobSASSignatureValues).

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

resource?: string

Waarde van eigenschap

string

resourceTypes

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

resourceTypes?: string

Waarde van eigenschap

string

services

Optioneel. De opslagservices die worden geopend (alleen voor account-SAS). Raadpleeg AccountSASServices voor 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(): string

Retouren

string

Delen via

SASQueryParameters class

Constructors

Eigenschappen

Methoden

Constructordetails

SASQueryParameters(string, string, SASQueryParametersOptions)

Parameters

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

Parameters

Eigenschapdetails

cacheControl

Waarde van eigenschap

contentDisposition

Waarde van eigenschap

contentEncoding

Waarde van eigenschap

contentLanguage

Waarde van eigenschap

contentType

Waarde van eigenschap

correlationId

Waarde van eigenschap

encryptionScope

Waarde van eigenschap

expiresOn

Waarde van eigenschap

identifier

Waarde van eigenschap

ipRange

Waarde van eigenschap

permissions

Waarde van eigenschap

preauthorizedAgentObjectId

Waarde van eigenschap

protocol

Waarde van eigenschap

resource

Waarde van eigenschap

resourceTypes

Waarde van eigenschap

services

Waarde van eigenschap

signature

Waarde van eigenschap

startsOn

Waarde van eigenschap

version

Waarde van eigenschap

Methodedetails

toString()

Retouren

Aanvullende resources