DataLakeSASSignatureValues interface

Pakiet:

@azure/storage-file-datalake

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Funkcja DataLakeSASSignatureValues ułatwia generowanie tokenów SAS usługi Blob i DataLake dla kontenerów, obiektów blob, systemu plików, katalogów i plików.

Właściwości

agentObjectId	Fakultatywny. Począwszy od wersji 2020-02-10, określa nieautoryzowany identyfikator obiektu usługi AAD w formacie GUID. Identyfikator obiektu usługi AAD użytkownika, który ma być nieautoryzowany przez właściciela klucza delegowania użytkownika. Usługa Azure Storage wykona dodatkową kontrolę listy ACL POSIX, aby określić, czy użytkownik ma uprawnienia do wykonania żądanej operacji. Nie można jej używać w połączeniu z preauthorizedAgentObjectId . Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkowników.
cacheControl	Fakultatywny. Nagłówek kontrolki pamięci podręcznej dla sygnatury dostępu współdzielonego.
contentDisposition	Fakultatywny. Nagłówek zawartości dla sygnatury dostępu współdzielonego.
contentEncoding	Fakultatywny. Nagłówek kodowania zawartości dla sygnatury dostępu współdzielonego.
contentLanguage	Fakultatywny. Nagłówek języka zawartości dla sygnatury dostępu współdzielonego.
contentType	Fakultatywny. Nagłówek typu zawartości dla sygnatury dostępu współdzielonego.
correlationId	Fakultatywny. Począwszy od wersji 2020-02-10, jest to wartość identyfikatora GUID, która zostanie zarejestrowana w dziennikach diagnostycznych magazynu i może służyć do korelowania generowania sygnatury dostępu współdzielonego z dostępem do zasobów magazynu. Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkowników.
directoryDepth	Fakultatywny. Począwszy od wersji 2020-02-10, wskaż głębokość katalogu określonego w polu canonicalizedresource ciągu do znaku. Głębokość katalogu to liczba katalogów pod folderem głównym.
encryptionScope	Fakultatywny. Zakres szyfrowania do użycia podczas wysyłania żądań autoryzowanych za pomocą tego identyfikatora URI sygnatury dostępu współdzielonego.
expiresOn	Opcjonalnie tylko w przypadku podania identyfikatora. Czas, po którym sygnatura dostępu współdzielonego nie będzie już działać.
fileSystemName	Nazwa systemu plików, do których użytkownik sygnatury dostępu współdzielonego może uzyskać dostęp.
identifier	Fakultatywny. Nazwa zasad dostępu w systemie plików, do którego odwołuje się ta sygnatura dostępu współdzielonego, jeśli istnieje. Zobacz https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Fakultatywny. Zakresy adresów IP dozwolone w tej sygnaturze dostępu współdzielonego.
isDirectory	Fakultatywny. Począwszy od wersji 2020-02-10, ta wartość określa, czy pathName jest katalogiem. Jeśli ta wartość ma wartość true, ścieżka jest katalogiem dla sygnatury dostępu współdzielonego katalogu. W przypadku ustawienia wartości false lub domyślnej ścieżka jest ścieżką pliku dla sygnatury dostępu współdzielonego ścieżki pliku.
pathName	Fakultatywny. Nazwa ścieżki katalogu lub użytkownika sygnatury dostępu współdzielonego pliku może uzyskać dostęp. Wymagane, jeśli podano wartość snapshotTime.
permissions	Opcjonalnie tylko w przypadku podania identyfikatora. Zapoznaj się z FileSystemSASPermissions, DirectorySASPermissions lub DataLakeSASPermissions w zależności od zasobu, do których uzyskuje się dostęp, aby uzyskać pomoc w konstruowaniu ciągu uprawnień.
preauthorizedAgentObjectId	Fakultatywny. Począwszy od wersji 2020-02-10, określa autoryzowany identyfikator obiektu usługi AAD w formacie GUID. Identyfikator obiektu usługi AAD użytkownika autoryzowanego przez właściciela klucza delegowania użytkownika w celu wykonania akcji przyznanej przez sygnaturę dostępu współdzielonego. Usługa Azure Storage zapewni, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, ale nie zostanie wykonane żadne dodatkowe sprawdzenie uprawnień dla użytkownika określonego w tej wartości. Nie można tego użyć w połączeniu z agentObjectId. Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkowników.
protocol	Fakultatywny. Protokoły SAS, tylko HTTPS lub HTTPSandHTTP
snapshotTime	Fakultatywny. Ciąg sygnatury czasowej migawki, do których użytkownik sygnatury dostępu współdzielonego może uzyskać dostęp. Obsługiwane tylko z interfejsu API w wersji 2018-11-09.
startsOn	Fakultatywny. Gdy sygnatura dostępu współdzielonego zacznie obowiązywać.
version	Wersja usługi, która będzie docelowa dla tej sygnatury dostępu współdzielonego. Jeśli nie zostanie określony, domyślnie będzie to wersja docelowa biblioteki.

Szczegóły właściwości

agentObjectId

Fakultatywny. Począwszy od wersji 2020-02-10, określa nieautoryzowany identyfikator obiektu usługi AAD w formacie GUID. Identyfikator obiektu usługi AAD użytkownika, który ma być nieautoryzowany przez właściciela klucza delegowania użytkownika. Usługa Azure Storage wykona dodatkową kontrolę listy ACL POSIX, aby określić, czy użytkownik ma uprawnienia do wykonania żądanej operacji. Nie można jej używać w połączeniu z preauthorizedAgentObjectId . Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkowników.

agentObjectId?: string

Wartość właściwości

string

cacheControl

Fakultatywny. Nagłówek kontrolki pamięci podręcznej dla sygnatury dostępu współdzielonego.

cacheControl?: string

Wartość właściwości

string

contentDisposition

Fakultatywny. Nagłówek zawartości dla sygnatury dostępu współdzielonego.

contentDisposition?: string

Wartość właściwości

string

contentEncoding

Fakultatywny. Nagłówek kodowania zawartości dla sygnatury dostępu współdzielonego.

contentEncoding?: string

Wartość właściwości

string

contentLanguage

Fakultatywny. Nagłówek języka zawartości dla sygnatury dostępu współdzielonego.

contentLanguage?: string

Wartość właściwości

string

contentType

Fakultatywny. Nagłówek typu zawartości dla sygnatury dostępu współdzielonego.

contentType?: string

Wartość właściwości

string

correlationId

Fakultatywny. Począwszy od wersji 2020-02-10, jest to wartość identyfikatora GUID, która zostanie zarejestrowana w dziennikach diagnostycznych magazynu i może służyć do korelowania generowania sygnatury dostępu współdzielonego z dostępem do zasobów magazynu. Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkowników.

correlationId?: string

Wartość właściwości

string

directoryDepth

Fakultatywny. Począwszy od wersji 2020-02-10, wskaż głębokość katalogu określonego w polu canonicalizedresource ciągu do znaku. Głębokość katalogu to liczba katalogów pod folderem głównym.

directoryDepth?: number

Wartość właściwości

number

encryptionScope

Fakultatywny. Zakres szyfrowania do użycia podczas wysyłania żądań autoryzowanych za pomocą tego identyfikatora URI sygnatury dostępu współdzielonego.

encryptionScope?: string

Wartość właściwości

string

expiresOn

Opcjonalnie tylko w przypadku podania identyfikatora. Czas, po którym sygnatura dostępu współdzielonego nie będzie już działać.

expiresOn?: Date

Wartość właściwości

Date

fileSystemName

Nazwa systemu plików, do których użytkownik sygnatury dostępu współdzielonego może uzyskać dostęp.

fileSystemName: string

Wartość właściwości

string

identifier

Fakultatywny. Nazwa zasad dostępu w systemie plików, do którego odwołuje się ta sygnatura dostępu współdzielonego, jeśli istnieje.

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

identifier?: string

Wartość właściwości

string

ipRange

Fakultatywny. Zakresy adresów IP dozwolone w tej sygnaturze dostępu współdzielonego.

ipRange?: SasIPRange

Wartość właściwości

SasIPRange

isDirectory

Fakultatywny. Począwszy od wersji 2020-02-10, ta wartość określa, czy pathName jest katalogiem. Jeśli ta wartość ma wartość true, ścieżka jest katalogiem dla sygnatury dostępu współdzielonego katalogu. W przypadku ustawienia wartości false lub domyślnej ścieżka jest ścieżką pliku dla sygnatury dostępu współdzielonego ścieżki pliku.

isDirectory?: boolean

Wartość właściwości

boolean

pathName

Fakultatywny. Nazwa ścieżki katalogu lub użytkownika sygnatury dostępu współdzielonego pliku może uzyskać dostęp. Wymagane, jeśli podano wartość snapshotTime.

pathName?: string

Wartość właściwości

string

permissions

Opcjonalnie tylko w przypadku podania identyfikatora. Zapoznaj się z FileSystemSASPermissions, DirectorySASPermissions lub DataLakeSASPermissions w zależności od zasobu, do których uzyskuje się dostęp, aby uzyskać pomoc w konstruowaniu ciągu uprawnień.

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

Wartość właściwości

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

preauthorizedAgentObjectId

Fakultatywny. Począwszy od wersji 2020-02-10, określa autoryzowany identyfikator obiektu usługi AAD w formacie GUID. Identyfikator obiektu usługi AAD użytkownika autoryzowanego przez właściciela klucza delegowania użytkownika w celu wykonania akcji przyznanej przez sygnaturę dostępu współdzielonego. Usługa Azure Storage zapewni, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, ale nie zostanie wykonane żadne dodatkowe sprawdzenie uprawnień dla użytkownika określonego w tej wartości. Nie można tego użyć w połączeniu z agentObjectId. Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkowników.

preauthorizedAgentObjectId?: string

Wartość właściwości

string

protocol

Fakultatywny. Protokoły SAS, tylko HTTPS lub HTTPSandHTTP

protocol?: SASProtocol

Wartość właściwości

SASProtocol

snapshotTime

Fakultatywny. Ciąg sygnatury czasowej migawki, do których użytkownik sygnatury dostępu współdzielonego może uzyskać dostęp. Obsługiwane tylko z interfejsu API w wersji 2018-11-09.

snapshotTime?: string

Wartość właściwości

string

startsOn

Fakultatywny. Gdy sygnatura dostępu współdzielonego zacznie obowiązywać.

startsOn?: Date

Wartość właściwości

Date

version

Wersja usługi, która będzie docelowa dla tej sygnatury dostępu współdzielonego. Jeśli nie zostanie określony, domyślnie będzie to wersja docelowa biblioteki.

version?: string

Wartość właściwości

string