DataLakeSASSignatureValues interface

パッケージ:

@azure/storage-file-datalake

NODE.JSランタイムでのみ使用できます。

DataLakeSASSignatureValues は、コンテナー、BLOB、ファイルシステム、ディレクトリ、ファイルの BLOB および DataLake サービス SAS トークンの生成に役立ちます。

プロパティ

agentObjectId	省略可能。 バージョン 2020-02-10 以降では、未承認の AAD オブジェクト ID を GUID 形式で指定します。 ユーザー委任キーの所有者によって承認されていないと見なされるユーザーの AAD オブジェクト ID。 Azure Storage Service は、要求された操作の実行がユーザーに許可されているかどうかを判断するために、追加の POSIX ACL チェックを実行します。 これは、 事前認証されたAgentObjectIdとの組み合わせて使用することはできません。 これは、ユーザー委任 SAS でのみ使用されます。
cacheControl	省略可能。 SAS のキャッシュ制御ヘッダー。
contentDisposition	省略可能。 SAS のコンテンツ処理ヘッダー。
contentEncoding	省略可能。 SAS のコンテンツ エンコード ヘッダー。
contentLanguage	省略可能。 SAS のコンテンツ言語ヘッダー。
contentType	省略可能。 SAS のコンテンツ タイプ ヘッダー。
correlationId	省略可能。 バージョン 2020-02-10 以降では、これはストレージ診断ログに記録される GUID 値であり、SAS 生成とストレージ リソース アクセスを関連付けるために使用できます。 これは、ユーザー委任 SAS でのみ使用されます。
directoryDepth	省略可能。 バージョン 2020-02-10 以降では、string-to-sign の canonicalizedresource フィールドで指定されたディレクトリの深さを示します。 ディレクトリの深さは、ルート フォルダーの下にあるディレクトリの数です。
encryptionScope	省略可能。 この SAS URI で承認された要求を送信するときに使用する暗号化スコープ。
expiresOn	identifier が指定されている場合にのみ省略可能です。 SAS が機能しなくなる時間。
fileSystemName	SAS ユーザーがアクセス可能なファイル システムの名前。
identifier	省略可能。 この SAS が参照するファイル システム上のアクセス ポリシーの名前 (存在する場合)。 「https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy」を参照してください。
ipRange	省略可能。 この SAS で許可される IP 範囲。
isDirectory	省略可能。 バージョン 2020-02-10 以降、この値は pathName がディレクトリであるかどうかを定義します。 この値が true に設定されている場合、Path はディレクトリ SAS のディレクトリです。 false または既定値に設定した場合、パスはファイル パス SAS のファイル パスです。
pathName	省略可能。 アクセス可能なディレクトリまたはファイル SAS ユーザーのパス名。 snapshotTime が指定されている場合は必須。
permissions	identifier が指定されている場合にのみ省略可能です。 アクセス許可文字列の作成については、アクセスするリソースに応じて、 FileSystemSASPermissions、 DirectorySASPermissions 、 または DataLakeSASPermissions を参照してください。
preauthorizedAgentObjectId	省略可能。 バージョン 2020-02-10 以降では、承認された AAD オブジェクト ID を GUID 形式で指定します。 SAS によって付与されたアクションを実行するためにユーザー委任キーの所有者によって承認されたユーザーの AAD オブジェクト ID。 Azure Storage サービスでは、アクセスを許可する前に、ユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認しますが、この値で指定されたユーザーに対する追加のアクセス許可チェックは実行されません。 これは 、agentObjectId との連携では使用できません。 これは、ユーザー委任 SAS でのみ使用されます。
protocol	省略可能。 SAS プロトコル、HTTPS のみ、または HTTPSandHTTP
snapshotTime	省略可能。 SAS ユーザーがアクセス可能なスナップショット タイムスタンプ文字列。 API バージョン 2018-11-09 からのみサポートされます。
startsOn	省略可能。 SAS が有効になるタイミング。
version	この SAS が対象とするサービスのバージョン。 指定しない場合、既定ではライブラリが対象とするバージョンになります。

プロパティの詳細

agentObjectId

省略可能。 バージョン 2020-02-10 以降では、未承認の AAD オブジェクト ID を GUID 形式で指定します。 ユーザー委任キーの所有者によって承認されていないと見なされるユーザーの AAD オブジェクト ID。 Azure Storage Service は、要求された操作の実行がユーザーに許可されているかどうかを判断するために、追加の POSIX ACL チェックを実行します。 これは、 事前認証されたAgentObjectIdとの組み合わせて使用することはできません。 これは、ユーザー委任 SAS でのみ使用されます。

agentObjectId?: string

プロパティ値

string

cacheControl

省略可能。 SAS のキャッシュ制御ヘッダー。

cacheControl?: string

プロパティ値

string

contentDisposition

省略可能。 SAS のコンテンツ処理ヘッダー。

contentDisposition?: string

プロパティ値

string

contentEncoding

省略可能。 SAS のコンテンツ エンコード ヘッダー。

contentEncoding?: string

プロパティ値

string

contentLanguage

省略可能。 SAS のコンテンツ言語ヘッダー。

contentLanguage?: string

プロパティ値

string

contentType

省略可能。 SAS のコンテンツ タイプ ヘッダー。

contentType?: string

プロパティ値

string

correlationId

省略可能。 バージョン 2020-02-10 以降では、これはストレージ診断ログに記録される GUID 値であり、SAS 生成とストレージ リソース アクセスを関連付けるために使用できます。 これは、ユーザー委任 SAS でのみ使用されます。

correlationId?: string

プロパティ値

string

directoryDepth

省略可能。 バージョン 2020-02-10 以降では、string-to-sign の canonicalizedresource フィールドで指定されたディレクトリの深さを示します。 ディレクトリの深さは、ルート フォルダーの下にあるディレクトリの数です。

directoryDepth?: number

プロパティ値

number

encryptionScope

省略可能。 この SAS URI で承認された要求を送信するときに使用する暗号化スコープ。

encryptionScope?: string

プロパティ値

string

expiresOn

identifier が指定されている場合にのみ省略可能です。 SAS が機能しなくなる時間。

expiresOn?: Date

プロパティ値

Date

fileSystemName

SAS ユーザーがアクセス可能なファイル システムの名前。

fileSystemName: string

プロパティ値

string

identifier

省略可能。 この SAS が参照するファイル システム上のアクセス ポリシーの名前 (存在する場合)。

「https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy」を参照してください。

identifier?: string

プロパティ値

string

ipRange

省略可能。 この SAS で許可される IP 範囲。

ipRange?: SasIPRange

プロパティ値

SasIPRange

isDirectory

省略可能。 バージョン 2020-02-10 以降、この値は pathName がディレクトリであるかどうかを定義します。 この値が true に設定されている場合、Path はディレクトリ SAS のディレクトリです。 false または既定値に設定した場合、パスはファイル パス SAS のファイル パスです。

isDirectory?: boolean

プロパティ値

boolean

pathName

省略可能。 アクセス可能なディレクトリまたはファイル SAS ユーザーのパス名。 snapshotTime が指定されている場合は必須。

pathName?: string

プロパティ値

string

permissions

identifier が指定されている場合にのみ省略可能です。 アクセス許可文字列の作成については、アクセスするリソースに応じて、 FileSystemSASPermissions、 DirectorySASPermissions 、 または DataLakeSASPermissions を参照してください。

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

プロパティ値

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

preauthorizedAgentObjectId

省略可能。 バージョン 2020-02-10 以降では、承認された AAD オブジェクト ID を GUID 形式で指定します。 SAS によって付与されたアクションを実行するためにユーザー委任キーの所有者によって承認されたユーザーの AAD オブジェクト ID。 Azure Storage サービスでは、アクセスを許可する前に、ユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認しますが、この値で指定されたユーザーに対する追加のアクセス許可チェックは実行されません。 これは 、agentObjectId との連携では使用できません。 これは、ユーザー委任 SAS でのみ使用されます。

preauthorizedAgentObjectId?: string

プロパティ値

string

protocol

省略可能。 SAS プロトコル、HTTPS のみ、または HTTPSandHTTP

protocol?: SASProtocol

プロパティ値

SASProtocol

snapshotTime

省略可能。 SAS ユーザーがアクセス可能なスナップショット タイムスタンプ文字列。 API バージョン 2018-11-09 からのみサポートされます。

snapshotTime?: string

プロパティ値

string

startsOn

省略可能。 SAS が有効になるタイミング。

startsOn?: Date

プロパティ値

Date

version

この SAS が対象とするサービスのバージョン。 指定しない場合、既定ではライブラリが対象とするバージョンになります。

version?: string

プロパティ値

string