DataLakeSasBuilder クラス

定義

名前空間:

Azure.Storage.Sas

アセンブリ:

Azure.Storage.Files.DataLake.dll

パッケージ:

Azure.Storage.Files.DataLake v12.18.0

ソース:

DataLakeSasBuilder.cs

DataLakeSasBuilder は、Data Lake ファイル システムまたはパスの Shared Access Signature (SAS) を生成するために使用されます

   For more information, see

サービス SAS の構築。

public class DataLakeSasBuilder

type DataLakeSasBuilder = class

Public Class DataLakeSasBuilder

継承

Object

DataLakeSasBuilder

コンストラクター

DataLakeSasBuilder(DataLakeFileSystemSasPermissions, DateTimeOffset)	Blob Service Sas を作成するために、 DataLakeSasBuilder クラスの新しいインスタンスを初期化します。
DataLakeSasBuilder(DataLakeSasPermissions, DateTimeOffset)	Blob Service Sas を作成するために、 DataLakeSasBuilder クラスの新しいインスタンスを初期化します。

プロパティ

AgentObjectId	省略可能。 バージョン 2020-02-10 以降、この値は、SAS によって付与されたアクションを実行するために、ユーザー委任キーの所有者によって承認されたユーザーの AAD オブジェクト ID に使用されます。 Azure Storage サービスでは、アクセスを許可する前に、ユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認します。 Azure Storage Service は、追加の POSIX ACL チェックを実行して、ユーザーが要求された操作を実行する権限があるかどうかを判断します。 これは、 との PreauthorizedAgentObjectId結合では使用できません。 これは、ユーザー委任 SAS の生成でのみ使用されます。
CacheControl	応答ヘッダーに対して返される値Cache-Controlオーバーライドします。
ContentDisposition	Content-Disposition 応答ヘッダーに返される値をオーバーライドします。
ContentEncoding	応答ヘッダーに対して返される値Cache-Encodingオーバーライドします。
ContentLanguage	応答ヘッダーに対して返される値Cache-Languageオーバーライドします。
ContentType	応答ヘッダーに対して返される値Cache-Typeオーバーライドします。
CorrelationId	省略可能。 バージョン 2020-02-10 以降では、この値が に使用され、ストレージ監査ログと、SAS の生成と配布のプリンシパルによって使用される監査ログが関連付けられます。 これは、ユーザー委任 SAS でのみ使用されます。
EncryptionScope	省略可能。 この SAS URI で承認された要求を送信するときに使用する暗号化スコープ。
ExpiresOn	共有アクセス署名が無効になる時刻。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
FileSystemName	アクセス可能なファイル システムの名前。
Identifier	ファイル システムに対して指定されたアクセス ポリシーに関連付けられる最大 64 文字の一意の値 (省略可能)。
IPRange	要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 IP アドレスの範囲を指定する場合は、その範囲が包括的であることに注意してください。
IsDirectory	バージョン 2020-02-10 以降では、 がディレクトリであるかどうかを Path 定義します。 この値が true に設定されている場合、Path はディレクトリ SAS のディレクトリです。 false または既定値に設定されている場合、パスはファイル パス SAS のファイル パスです。
Path	アクセス可能なパスの名前。ファイル Empty システム SAS の場合は 。 バージョン 2020-02-10 以降では、 を true に設定 IsDirectory すると、パスがディレクトリ SAS のディレクトリとして受け入れられます。 設定されていない場合、この値はファイル パス SAS のファイル パスと見なされます。
Permissions	共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 DataLakeFileSystemSasPermissions、または DataLakeAccountSasPermissions をDataLakeSasPermissions使用して、アクセス許可文字列を作成できます。
PreauthorizedAgentObjectId	省略可能。 バージョン 2020-02-10 以降、この値は、SAS によって付与されたアクションを実行するために、ユーザー委任キーの所有者によって承認されたユーザーの AAD オブジェクト ID に使用されます。 Azure Storage サービスでは、アクセスを許可する前に、ユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認します。 この値で指定されたユーザーに対する追加のアクセス許可チェックは実行されません。 これは、 との AgentObjectId結合では使用できません。 これは、ユーザー委任 SAS の生成でのみ使用されます。
Protocol	省略可能な署名付きプロトコル フィールドは、SAS で行われた要求に対して許可されるプロトコルを指定します。 指定できる値は、HttpsAndHttp、Https、None です。
Resource	共有アクセス署名を使用してアクセスできるリソースを指定します。 共有リソースが BLOB の場合は、"b" を指定します。 これにより、BLOB のコンテンツとメタデータへのアクセスが許可されます。 共有リソースが BLOB コンテナーの場合は、"c" を指定します。 これにより、コンテナー内のすべての BLOB のコンテンツとメタデータ、およびコンテナー内の BLOB の一覧へのアクセスが許可されます。 バージョン 2018-11-09 以降では、共有リソースが BLOB スナップショットの場合は"bs" を指定します。 これにより、特定のスナップショットのコンテンツとメタデータへのアクセスが許可されますが、対応するルート BLOB にはアクセスできません。 バージョン 2020-02-10 以降では、共有リソースが DataLake ディレクトリの場合は "d" を指定します。 これにより、ディレクトリ内のパスへのアクセスと、ディレクトリ内のパスの一覧表示が許可されます。 "d" を指定した場合は、sdd クエリ パラメーターも必要です。
StartsOn	必要に応じて、共有アクセス署名が有効になる時刻を指定します。 DateTimeOffset.MinValue を使用するときに省略した場合、この呼び出しの開始時刻は、ストレージ サービスが要求を受信した時刻と見なされます。

メソッド

SetPermissions(DataLakeAccountSasPermissions)	パス アカウント レベルの SAS のアクセス許可を設定します。
SetPermissions(DataLakeFileSystemSasPermissions)	ファイル システム SAS のアクセス許可を設定します。
SetPermissions(DataLakeSasPermissions)	ファイル SAS のアクセス許可を設定します。
SetPermissions(String)	生のアクセス許可文字列を使用して SAS のアクセス許可を設定します。
SetPermissions(String, Boolean)	生のアクセス許可文字列を使用して SAS のアクセス許可を設定します。
ToSasQueryParameters(StorageSharedKeyCredential)	この共有アクセス署名値に署名するには、アカウントの StorageSharedKeyCredential を使用して、要求を認証するための適切な SAS クエリ パラメーターを生成します。
ToSasQueryParameters(UserDelegationKey, String)	この共有アクセス署名値に署名するには、アカウントの UserDelegationKey を使用して、要求を認証するための適切な SAS クエリ パラメーターを生成します。