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