DataLakeSASSignatureValues interface

套件:

@azure/storage-file-datalake

僅適用於運行時間NODE.JS。

DataLakeSASSignatureValues 可用來協助產生容器、Blob、文件系統、目錄和檔案的 Blob 和 DataLake 服務 SAS 令牌。

屬性

agentObjectId	Optional. 從 2020-02-10 版開始，以 GUID 格式指定未經授權的 AAD 物件識別碼。 假設使用者委派密鑰擁有者未經授權之使用者的 AAD 物件識別碼。 Azure 記憶體服務會執行額外的 POSIX ACL 檢查，以判斷使用者是否已獲授權執行要求的作業。 這不能與 preauthorizedAgentObjectId搭配使用。 這隻適用於使用者委派SAS。
cacheControl	Optional. SAS 的快取控制標頭。
contentDisposition	Optional. SAS 的內容處置標頭。
contentEncoding	Optional. SAS 的內容編碼標頭。
contentLanguage	Optional. SAS 的內容語言標頭。
contentType	Optional. SAS 的內容類型標頭。
correlationId	Optional. 從 2020-02-10 版開始，這是將在記憶體診斷記錄中記錄的 GUID 值，可用來將 SAS 產生與記憶體資源存取相互關聯。 這隻適用於使用者委派SAS。
directoryDepth	Optional. 從 2020-02-10 版開始，表示 string-to-sign 標準化資源欄位中所指定的目錄深度。 目錄的深度是根資料夾底下的目錄數目。
encryptionScope	Optional. 傳送具有此SAS URI授權的要求時要使用的加密範圍。
expiresOn	只有在提供標識符時，才為選擇性。 SAS 將無法再運作的時間。
fileSystemName	SAS 使用者可存取的檔案系統名稱。
identifier	Optional. 文件系統上的存取原則名稱，如果有任何，則此 SAS 會參考此原則。 請參閱 https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. 此 SAS 中允許的IP範圍。
isDirectory	Optional. 從 2020-02-10 版開始，此值會定義 pathName 是否為目錄。 如果此值設定為 true，則 Path 是目錄 SAS 的目錄。 如果設定為 false 或預設值，則路徑是檔案路徑 SAS 的檔案路徑。
pathName	Optional. 目錄或檔案 SAS 使用者的路徑名稱可以存取。 如果提供 snapshotTime，則為必要專案。
permissions	只有在提供標識符時，才為選擇性。 請參閱 FileSystemSASPermissions、DirectorySASPermissions 或 DataLakeSASPermissions，視存取的資源而定，以協助建構許可權字符串。
preauthorizedAgentObjectId	Optional. 從 2020-02-10 版開始，以 GUID 格式指定授權的 AAD 物件識別碼。 由使用者委派密鑰擁有者授權的使用者 AAD 物件識別碼，以執行 SAS 所授與的動作。 Azure 記憶體服務會確保使用者委派密鑰的擁有者在授與存取權之前具有必要許可權，但不會執行此值中所指定使用者的額外許可權檢查。 這不能與 agentObjectId搭配使用。 這隻適用於使用者委派SAS。
protocol	Optional. SAS 通訊協定、僅限 HTTPS 或 HTTPSandHTTP
snapshotTime	Optional. SAS 使用者可以存取的快照時間戳字串。 僅支援來自 API 2018-11-09 版。
startsOn	Optional. SAS 何時生效。
version	此 SAS 的目標服務版本。 如果未指定，它會預設為連結庫的目標版本。

屬性詳細資料

agentObjectId

Optional. 從 2020-02-10 版開始，以 GUID 格式指定未經授權的 AAD 物件識別碼。 假設使用者委派密鑰擁有者未經授權之使用者的 AAD 物件識別碼。 Azure 記憶體服務會執行額外的 POSIX ACL 檢查，以判斷使用者是否已獲授權執行要求的作業。 這不能與 preauthorizedAgentObjectId搭配使用。 這隻適用於使用者委派SAS。

agentObjectId?: string

屬性值

string

cacheControl

Optional. SAS 的快取控制標頭。

cacheControl?: string

屬性值

string

contentDisposition

Optional. SAS 的內容處置標頭。

contentDisposition?: string

屬性值

string

contentEncoding

Optional. SAS 的內容編碼標頭。

contentEncoding?: string

屬性值

string

contentLanguage

Optional. SAS 的內容語言標頭。

contentLanguage?: string

屬性值

string

contentType

Optional. SAS 的內容類型標頭。

contentType?: string

屬性值

string

correlationId

Optional. 從 2020-02-10 版開始，這是將在記憶體診斷記錄中記錄的 GUID 值，可用來將 SAS 產生與記憶體資源存取相互關聯。 這隻適用於使用者委派SAS。

correlationId?: string

屬性值

string

directoryDepth

Optional. 從 2020-02-10 版開始，表示 string-to-sign 標準化資源欄位中所指定的目錄深度。 目錄的深度是根資料夾底下的目錄數目。

directoryDepth?: number

屬性值

number

encryptionScope

Optional. 傳送具有此SAS URI授權的要求時要使用的加密範圍。

encryptionScope?: string

屬性值

string

expiresOn

只有在提供標識符時，才為選擇性。 SAS 將無法再運作的時間。

expiresOn?: Date

屬性值

Date

fileSystemName

SAS 使用者可存取的檔案系統名稱。

fileSystemName: string

屬性值

string

identifier

Optional. 文件系統上的存取原則名稱，如果有任何，則此 SAS 會參考此原則。

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

identifier?: string

屬性值

string

ipRange

Optional. 此 SAS 中允許的IP範圍。

ipRange?: SasIPRange

屬性值

SasIPRange

isDirectory

Optional. 從 2020-02-10 版開始，此值會定義 pathName 是否為目錄。 如果此值設定為 true，則 Path 是目錄 SAS 的目錄。 如果設定為 false 或預設值，則路徑是檔案路徑 SAS 的檔案路徑。

isDirectory?: boolean

屬性值

boolean

pathName

Optional. 目錄或檔案 SAS 使用者的路徑名稱可以存取。 如果提供 snapshotTime，則為必要專案。

pathName?: string

屬性值

string

permissions

只有在提供標識符時，才為選擇性。 請參閱 FileSystemSASPermissions、DirectorySASPermissions 或 DataLakeSASPermissions，視存取的資源而定，以協助建構許可權字符串。

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

屬性值

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

preauthorizedAgentObjectId

Optional. 從 2020-02-10 版開始，以 GUID 格式指定授權的 AAD 物件識別碼。 由使用者委派密鑰擁有者授權的使用者 AAD 物件識別碼，以執行 SAS 所授與的動作。 Azure 記憶體服務會確保使用者委派密鑰的擁有者在授與存取權之前具有必要許可權，但不會執行此值中所指定使用者的額外許可權檢查。 這不能與 agentObjectId搭配使用。 這隻適用於使用者委派SAS。

preauthorizedAgentObjectId?: string

屬性值

string

protocol

Optional. SAS 通訊協定、僅限 HTTPS 或 HTTPSandHTTP

protocol?: SASProtocol

屬性值

SASProtocol

snapshotTime

Optional. SAS 使用者可以存取的快照時間戳字串。 僅支援來自 API 2018-11-09 版。

snapshotTime?: string

屬性值

string

startsOn

Optional. SAS 何時生效。

startsOn?: Date

屬性值

Date

version

此 SAS 的目標服務版本。 如果未指定，它會預設為連結庫的目標版本。

version?: string

屬性值

string