DataLakeSASSignatureValues interface

Paket:

@azure/storage-file-datalake

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

DataLakeSASSignatureValues används för att generera SAS-token för Blob- och DataLake-tjänsten för containrar, blobar, filsystem, kataloger och filer.

Egenskaper

agentObjectId	Optional. Från och med version 2020-02-10 anger det obehöriga AAD-objekt-ID:t i GUID-format. AAD-objekt-ID:t för en användare som antas vara obehörig av ägaren av användarens delegeringsnyckel. Azure Storage Service utför ytterligare en POSIX ACL-kontroll för att avgöra om användaren har behörighet att utföra den begärda åtgärden. Detta kan inte användas i samband med preauthorizedAgentObjectId. Detta används endast för SAS för användardelegering.
cacheControl	Optional. Cache-control-huvudet för SAS.
contentDisposition	Optional. Innehållsborttagningshuvudet för SAS.
contentEncoding	Optional. Innehållskodningshuvudet för SAS.
contentLanguage	Optional. Innehållsspråksrubriken för SAS.
contentType	Optional. Innehållstypens rubrik för SAS.
correlationId	Optional. Från och med version 2020-02-10 är detta 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.
delegatedUserObjectId	Optional. Från och med version 2025-07-05 specificerar detta värde att användarens entra-ID är auktoriserad att använda den resulterande SAS-URL:en. Den resulterande SAS-URL:en måste användas tillsammans med en Entra ID-token som har utfärdats till användaren som anges i detta värde.
directoryDepth	Optional. Från och med version 2020-02-10 anger du djupet i katalogen som anges i fältet canonicalizedresource i sträng-till-tecken. Katalogens djup är antalet kataloger under rotmappen.
encryptionScope	Optional. Krypteringsomfång som ska användas när begäranden som auktoriseras med denna SAS-URI skickas.
expiresOn	Valfritt endast när identifierare anges. Den tid efter vilken SAS inte längre fungerar.
fileSystemName	Namnet på filsystemet som SAS-användaren kan komma åt.
identifier	Optional. Namnet på åtkomstprincipen i filsystemet som denna SAS refererar till om det finns någon. Se https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. IP-intervall tillåts i denna SAS.
isDirectory	Optional. Från och med version 2020-02-10 definierar det här värdet om pathName är en katalog eller inte. Om det här värdet är inställt på true är sökvägen en katalog för en Katalog-SAS. Om den är inställd på false eller standard är sökvägen en filsökväg för en FILsökvägs-SAS.
pathName	Optional. Sökvägen till katalogen eller filen som SAS-användaren kan komma åt. Krävs om snapshotTime tillhandahålls.
permissions	Valfritt endast när identifierare anges. Se FileSystemSASPermissions, DirectorySASPermissions eller DataLakeSASPermissions beroende på vilken resurs som används för att skapa behörighetssträngen.
preauthorizedAgentObjectId	Optional. Från och med version 2020-02-10 anger det auktoriserade AAD-objekt-ID:t 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 till 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 kan inte användas i samband med agentObjectId. Detta används endast för SAS för användardelegering.
protocol	Optional. SAS-protokoll, endast HTTPS eller HTTPSandHTTP
snapshotTime	Optional. Tidsstämpelsträng för ögonblicksbilder som SAS-användaren kan komma åt. Stöds endast från API-version 2018-11-09.
startsOn	Optional. När SAS börjar gälla.
version	Den version av tjänsten som denna SAS kommer att rikta in sig på. Om den inte anges kommer den som standard att vara den version som biblioteket riktar in sig på.

Fastighetsdetaljer

agentObjectId

Optional. Från och med version 2020-02-10 anger det obehöriga AAD-objekt-ID:t i GUID-format. AAD-objekt-ID:t för en användare som antas vara obehörig av ägaren av användarens delegeringsnyckel. Azure Storage Service utför ytterligare en POSIX ACL-kontroll för att avgöra om användaren har behörighet att utföra den begärda åtgärden. Detta kan inte användas i samband med preauthorizedAgentObjectId. Detta används endast för SAS för användardelegering.

agentObjectId?: string

Fastighetsvärde

string

cacheControl

Optional. Cache-control-huvudet för SAS.

cacheControl?: string

Fastighetsvärde

string

contentDisposition

Optional. Innehållsborttagningshuvudet för SAS.

contentDisposition?: string

Fastighetsvärde

string

contentEncoding

Optional. Innehållskodningshuvudet för SAS.

contentEncoding?: string

Fastighetsvärde

string

contentLanguage

Optional. Innehållsspråksrubriken för SAS.

contentLanguage?: string

Fastighetsvärde

string

contentType

Optional. Innehållstypens rubrik för SAS.

contentType?: string

Fastighetsvärde

string

correlationId

Optional. Från och med version 2020-02-10 är detta 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

Fastighetsvärde

string

delegatedUserObjectId

Optional. Från och med version 2025-07-05 specificerar detta värde att användarens entra-ID är auktoriserad att använda den resulterande SAS-URL:en. Den resulterande SAS-URL:en måste användas tillsammans med en Entra ID-token som har utfärdats till användaren som anges i detta värde.

delegatedUserObjectId?: string

Fastighetsvärde

string

directoryDepth

Optional. Från och med version 2020-02-10 anger du djupet i katalogen som anges i fältet canonicalizedresource i sträng-till-tecken. Katalogens djup är antalet kataloger under rotmappen.

directoryDepth?: number

Fastighetsvärde

number

encryptionScope

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

encryptionScope?: string

Fastighetsvärde

string

expiresOn

Valfritt endast när identifierare anges. Den tid efter vilken SAS inte längre fungerar.

expiresOn?: Date

Fastighetsvärde

Date

fileSystemName

Namnet på filsystemet som SAS-användaren kan komma åt.

fileSystemName: string

Fastighetsvärde

string

identifier

Optional. Namnet på åtkomstprincipen i filsystemet som denna SAS refererar till om det finns någon.

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

identifier?: string

Fastighetsvärde

string

ipRange

Optional. IP-intervall tillåts i denna SAS.

ipRange?: SasIPRange

Fastighetsvärde

SasIPRange

isDirectory

Optional. Från och med version 2020-02-10 definierar det här värdet om pathName är en katalog eller inte. Om det här värdet är inställt på true är sökvägen en katalog för en Katalog-SAS. Om den är inställd på false eller standard är sökvägen en filsökväg för en FILsökvägs-SAS.

isDirectory?: boolean

Fastighetsvärde

boolean

pathName

Optional. Sökvägen till katalogen eller filen som SAS-användaren kan komma åt. Krävs om snapshotTime tillhandahålls.

pathName?: string

Fastighetsvärde

string

permissions

Valfritt endast när identifierare anges. Se FileSystemSASPermissions, DirectorySASPermissions eller DataLakeSASPermissions beroende på vilken resurs som används för att skapa behörighetssträngen.

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

Fastighetsvärde

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

preauthorizedAgentObjectId

Optional. Från och med version 2020-02-10 anger det auktoriserade AAD-objekt-ID:t 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 till 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 kan inte användas i samband med agentObjectId. Detta används endast för SAS för användardelegering.

preauthorizedAgentObjectId?: string

Fastighetsvärde

string

protocol

Optional. SAS-protokoll, endast HTTPS eller HTTPSandHTTP

protocol?: SASProtocol

Fastighetsvärde

SASProtocol

snapshotTime

Optional. Tidsstämpelsträng för ögonblicksbilder som SAS-användaren kan komma åt. Stöds endast från API-version 2018-11-09.

snapshotTime?: string

Fastighetsvärde

string

startsOn

Optional. När SAS börjar gälla.

startsOn?: Date

Fastighetsvärde

Date

version

Den version av tjänsten som denna SAS kommer att rikta in sig på. Om den inte anges kommer den som standard att vara den version som biblioteket riktar in sig på.

version?: string

Fastighetsvärde

string