filedatalake パッケージ
パッケージ
| aio |
クラス
| AccessControlChangeCounters |
AccessControlChangeCounters には、リストを再帰的に変更する操作の数Access Control含まれています。 |
| AccessControlChangeFailure |
リストの更新に失敗したエントリAccess Control表します。 |
| AccessControlChangeResult |
AccessControlChangeResult には、リストを再帰的に変更する操作の結果Access Control含まれます。 |
| AccessControlChanges |
AccessControlChanges には、リストを再帰的に変更する操作のバッチ数と累積数Access Control含まれています。 さらに、これらの操作の進行中に更新に失敗したパス エントリも公開されます。 |
| AccessPolicy |
各サービスの set メソッドと get アクセス ポリシー メソッドによって使用されるアクセス ポリシー クラス。 保存されているアクセス ポリシーでは、関連付けられている共有アクセス署名の開始時刻、有効期限、およびアクセス許可を指定できます。 リソースへのアクセスを制御する方法に応じて、格納されているアクセス ポリシー内でこれらのパラメーターをすべて指定し、Shared Access Signature の URL から省略できます。 これにより、関連付けられた署名の動作をいつでも変更または取り消しできます。 また、保存されているアクセス ポリシー内で 1 つ以上のアクセス ポリシー パラメーターを指定し、残りのパラメーターを URL で指定することもできます。 すべてのパラメーターを URL で指定することもできます。 この場合、保存されているアクセス ポリシーを使用して署名を取り消すことができますが、署名の動作を変更することはできません。 共有アクセス署名と保存されているアクセス ポリシーの組み合わせには、署名を認証するために必要なすべてのフィールドが含まれている必要があります。 必須フィールドが欠落している場合、要求は失敗します。 同様に、共有アクセス署名の URL と保存されているアクセス ポリシーの両方で同じフィールドが指定されている場合、ステータス コード 400 (Bad Request) が返されて要求は失敗します。 |
| AccountSasPermissions | |
| AnalyticsLogging |
Azure Analytics のログ設定。 |
| ArrowDialect |
矢印スキーマのフィールド。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。 |
| ContentSettings |
ファイルまたはディレクトリのコンテンツ設定。 |
| CorsRule |
CORS は、あるドメインで実行されている Web アプリケーションが別のドメイン内にあるリソースにアクセスできるようにする HTTP 機能です。 Web ブラウザーには、Web ページで別のドメインの API を呼び出すことができないようにする同一呼び出し元ポリシーと呼ばれるセキュリティ制限が実装されています。CORS を使用すると、あるドメイン (元のドメイン) から別のドメインの API を安全に呼び出すことができます。 |
| CustomerProvidedEncryptionKey |
Azure Storage 内のすべてのデータは、アカウント レベルの暗号化キーを使用して保存時に暗号化されます。 バージョン 2021-06-08 以降では、ストレージ サービスへの要求で AES-256 暗号化キーを指定することで、ファイルの内容とアプリケーション メタデータのファイルごとの暗号化に使用されるキーを管理できます。 顧客提供のキーを使用する場合、Azure Storage ではキーの管理や永続化は行われません。 ファイルにデータを書き込む場合は、ディスクに書き込む前に、指定されたキーを使用してデータを暗号化します。 暗号化キーの SHA-256 ハッシュがファイルの内容と共に書き込まれ、ファイルに対する後続のすべての操作で同じ暗号化キーが使用されていることを確認するために使用されます。 このハッシュを使用して暗号化キーを取得したり、ファイルの内容を復号化したりすることはできません。 ファイルを読み取るときに、指定されたキーを使用して、ディスクからデータを読み取った後にデータの暗号化を解除します。 どちらの場合も、指定された暗号化キーは、暗号化または暗号化解除プロセスが完了するとすぐに安全に破棄されます。 |
| DataLakeDirectoryClient |
ディレクトリがまだ存在しない可能性がある場合でも、DataLake ディレクトリと対話するクライアント。 ディレクトリの下の特定のサブディレクトリまたはファイルに関連する操作の場合は、 または get_file_client 関数を使用してディレクトリ クライアントまたはファイル クライアントをget_sub_directory_client取得できます。 |
| DataLakeFileClient |
ファイルがまだ存在しない可能性がある場合でも、DataLake ファイルと対話するクライアント。 |
| DataLakeFileQueryError |
このエラーは、クイック クエリ操作中に発生しました。 |
| DataLakeLeaseClient |
新しい DataLakeLeaseClient を作成します。 このクライアントは、FileSystemClient、DataLakeDirectoryClient、または DataLakeFileClient に対するリース操作を提供します。 |
| DataLakeServiceClient |
アカウント レベルで DataLake サービスと対話するクライアント。 このクライアントは、アカウントのプロパティを取得および構成する操作と、アカウント内のファイル システムの一覧表示、作成、削除を行う操作を提供します。 特定のファイル システム、ディレクトリ、またはファイルに関連する操作の場合、これらのエンティティのクライアントは 、get_client 関数を使用して取得することもできます。 |
| DeletedPathProperties |
削除されたパスに設定されたプロパティ。 |
| DelimitedJsonDialect |
データレイク クエリの入力または出力の JSON シリアル化を定義します。 キーワード (keyword) str 区切り記号: 行区切り文字。既定値は ' です ' |
| DelimitedTextDialect |
datalake クエリ要求の入力または出力区切り (CSV) シリアル化を定義します。 キーワード (keyword) str 区切り記号: 列区切り記号は、既定値は ',' です。 キーワード (keyword) str quotechar: フィールド引用符、既定値は '"' です。 キーワード (keyword) str lineterminator: レコード区切り記号、既定値は ' '. キーワード (keyword) str escapechar: エスケープ文字。既定値は空です。 キーワード (keyword) bool has_header: BLOB データに最初の行にヘッダーが含まれているかどうか。 既定値は False です。つまり、最初の行を含むデータが返されます。 True に設定すると、最初の行を除くデータが返されます。 |
| DirectoryProperties | |
| DirectorySasPermissions |
関数で generate_directory_sas 使用する DirectorySasPermissions クラス。 |
| EncryptionScopeOptions |
ファイル システムの既定の暗号化スコープ構成。 このスコープは、ファイル システム内のすべての将来の書き込みに暗黙的に使用されますが、BLOB 操作ごとにオーバーライドできます。 バージョン 12.9.0 の新機能。 |
| ExponentialRetry |
指数再試行。 指数再試行オブジェクトを構築します。 initial_backoffは、最初の再試行に使用されます。 以降の再試行は、initial_backoff + increment_power^retry_count 秒後に再試行されます。 |
| FileProperties | |
| FileSasPermissions |
関数で generate_file_sas 使用する FileSasPermissions クラス。 |
| FileSystemClient |
そのファイル システムがまだ存在しない可能性がある場合でも、特定のファイル システムと対話するクライアント。 このファイル システム内の特定のディレクトリまたはファイルに関連する操作の場合は、 または get_file_client 関数を使用してディレクトリ クライアントまたはファイル クライアントをget_directory_client取得できます。 |
| FileSystemProperties |
ファイル システムのプロパティ クラス。 返される |
| FileSystemPropertiesPaged |
ファイル システム プロパティの Iterable。 |
| FileSystemSasPermissions |
関数で generate_file_system_sas 使用する FileSystemSasPermissions クラス。 |
| LeaseProperties |
DataLake のリース プロパティ。 |
| LinearRetry |
線形再試行。 Linear 再試行オブジェクトを構築します。 |
| LocationMode |
要求の送信先となる場所を指定します。 このモードは、セカンダリ読み取りアクセスを許可する RA-GRS アカウントにのみ適用されます。 他のすべてのアカウントの種類では PRIMARY を使用する必要があります。 |
| Metrics |
API 別にグループ化された要求統計の要約 (時間または分単位)。 |
| PathProperties |
api によって一覧表示されるパス プロパティget_paths。 |
| ResourceTypes |
アカウント SAS でアクセスできるリソースの種類を指定します。 |
| RetentionPolicy |
関連付けられているデータを保持する期間を決定するアイテム保持ポリシー。 |
| StaticWebsite |
アカウントで静的 Web サイトをホストできるようにするプロパティ。 |
| StorageStreamDownloader |
Azure Storage からダウンロードするストリーミング オブジェクト。 |
| UserDelegationKey |
Azure Active Directory アクセス トークンに基づいて Azure Storage によってユーザーに提供されるユーザー委任キーを表します。 ユーザーはこのオブジェクトを操作する必要がないため、フィールドは単純な文字列として保存されます。識別 SAS を生成するために、ユーザーは単純に適切な API に渡すことができます。 |
列挙型
| ArrowType | |
| PublicAccess |
ファイル システム内のデータにパブリックにアクセスできるかどうかを指定し、アクセス レベルを指定します。 |
| QuickQueryDialect |
クイック クエリの入出力言語を指定します。 |
| StorageErrorCode |
機能
generate_account_sas
DataLake サービスの共有アクセス署名を生成します。
返された署名は、DataLakeServiceClient、FileSystemClient、DataLakeDirectoryClient、または DataLakeFileClient の資格情報パラメーターとして使用します。
generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str | None, **kwargs: Any) -> strパラメーター
- permission
- str または AccountSasPermissions
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で ip=168.1.5.65 または ip=168.1.5.60-168.1.5.70 を指定すると、要求はこれらの IP アドレスに制限されます。
- protocol
- str
要求に対して許可されるプロトコルを指定します。 既定値は https です。
- encryption_scope
- str
すべての書き込み操作がサービスで暗号化されるように、要求の暗号化スコープを指定します。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
generate_directory_sas
ディレクトリの共有アクセス署名を生成します。
返されたシグネチャは、DataLakeServiceClient、FileSystemClient、DataLakeDirectoryClient、DataLakeFileClient のいずれかの資格情報パラメーターと共に使用します。
generate_directory_sas(account_name: str, file_system_name: str, directory_name: str, credential: str | UserDelegationKey, permission: DirectorySasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> strパラメーター
- credential
- str または UserDelegationKey
資格情報には、アカウント キーまたはユーザー委任キーを指定できます。 アカウント キーを資格情報として使用する場合、資格情報の種類は str である必要があります。 アカウント キーの代わりに、ユーザーはユーザー委任キーを渡すこともできます。 ユーザー委任キーは、AAD ID を使用して認証することで、サービスから取得できます。これを実現するには、 を呼び出します get_user_delegation_key。 存在する場合、SAS は代わりにユーザー委任キーで署名されます。
- permission
- str または DirectorySasPermissions
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 アクセス許可は racwdlmeop に並べ替える必要があります。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で ip=168.1.5.65 または ip=168.1.5.60-168.1.5.70 を指定すると、要求はこれらの IP アドレスに制限されます。
- protocol
- str
要求に対して許可されるプロトコルを指定します。 既定値は https です。
- cache_control
- str
この共有アクセス署名を使用してリソースにアクセスするときのCache-Controlの応答ヘッダー値。
- content_disposition
- str
この共有アクセス署名を使用してリソースにアクセスするときの Content-Disposition の応答ヘッダー値。
- content_encoding
- str
この共有アクセス署名を使用してリソースにアクセスするときの Content-Encoding の応答ヘッダー値。
- content_language
- str
この共有アクセス署名を使用してリソースにアクセスするときの Content-Language の応答ヘッダー値。
- content_type
- str
この共有アクセス署名を使用してリソースにアクセスするときの Content-Type の応答ヘッダー値。
- preauthorized_agent_object_id
- str
SAS トークンによって付与されたアクションを実行するために、ユーザー委任キーの所有者によって承認されていると見なされるユーザーの AAD オブジェクト ID。 サービスは SAS トークンを検証し、アクセスを許可する前にユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認しますが、エージェント オブジェクト ID に対する追加のアクセス許可チェックは実行されません。
- agent_object_id
- str
SAS トークンによって付与されたアクションを実行するために、ユーザー委任キーの所有者によって承認されていないと見なされたユーザーの AAD オブジェクト ID。 サービスは SAS トークンを検証し、アクセスを許可する前にユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認し、サービスは追加の POSIX ACL チェックを実行して、このユーザーが要求された操作を実行する権限があるかどうかを判断します。
- correlation_id
- str
ストレージ監査ログと、SAS を生成して配布するプリンシパルによって使用される監査ログを関連付ける関連付け ID。
- encryption_scope
- str
すべての書き込み操作がサービスで暗号化されるように、要求の暗号化スコープを指定します。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
generate_file_sas
ファイルの共有アクセス署名を生成します。
返された署名は、BDataLakeServiceClient、FileSystemClient、DataLakeDirectoryClient、または DataLakeFileClient の資格情報パラメーターと共に使用します。
generate_file_sas(account_name: str, file_system_name: str, directory_name: str, file_name: str, credential: str | UserDelegationKey, permission: FileSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> strパラメーター
- credential
- str または UserDelegationKey
資格情報には、アカウント キーまたはユーザー委任キーを指定できます。 アカウント キーを資格情報として使用する場合、資格情報の種類は str である必要があります。 アカウント キーの代わりに、ユーザーはユーザー委任キーを渡すこともできます。 ユーザー委任キーは、AAD ID を使用して認証することで、サービスから取得できます。これを実現するには、 を呼び出します get_user_delegation_key。 存在する場合、SAS は代わりにユーザー委任キーで署名されます。
- permission
- str または FileSasPermissions
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 アクセス許可は racwdlmeop に並べ替える必要があります。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で ip=168.1.5.65 または ip=168.1.5.60-168.1.5.70 を指定すると、要求はこれらの IP アドレスに制限されます。
- protocol
- str
要求に対して許可されるプロトコルを指定します。 既定値は https です。
- cache_control
- str
この共有アクセス署名を使用してリソースにアクセスするときのCache-Controlの応答ヘッダー値。
- content_disposition
- str
この共有アクセス署名を使用してリソースにアクセスするときの Content-Disposition の応答ヘッダー値。
- content_encoding
- str
この共有アクセス署名を使用してリソースにアクセスするときの Content-Encoding の応答ヘッダー値。
- content_language
- str
この共有アクセス署名を使用してリソースにアクセスするときの Content-Language の応答ヘッダー値。
- content_type
- str
この共有アクセス署名を使用してリソースにアクセスするときの Content-Type の応答ヘッダー値。
- preauthorized_agent_object_id
- str
SAS トークンによって付与されたアクションを実行するために、ユーザー委任キーの所有者によって承認されていると見なされるユーザーの AAD オブジェクト ID。 サービスは SAS トークンを検証し、アクセスを許可する前にユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認しますが、エージェント オブジェクト ID に対する追加のアクセス許可チェックは実行されません。
- agent_object_id
- str
SAS トークンによって付与されたアクションを実行するために、ユーザー委任キーの所有者によって承認されていないと見なされたユーザーの AAD オブジェクト ID。 サービスは SAS トークンを検証し、アクセスを許可する前にユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認し、サービスは追加の POSIX ACL チェックを実行して、このユーザーが要求された操作を実行する権限があるかどうかを判断します。
- correlation_id
- str
ストレージ監査ログと、SAS を生成して配布するプリンシパルによって使用される監査ログを関連付ける関連付け ID。 これは、委任キーを使用して SAS を生成する場合にのみ使用できます。
- encryption_scope
- str
すべての書き込み操作がサービスで暗号化されるように、要求の暗号化スコープを指定します。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
generate_file_system_sas
ファイル システムの共有アクセス署名を生成します。
返された署名は、DataLakeServiceClient、FileSystemClient、DataLakeDirectoryClient、または DataLakeFileClient の資格情報パラメーターと共に使用します。
generate_file_system_sas(account_name: str, file_system_name: str, credential: str | UserDelegationKey, permission: FileSystemSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> strパラメーター
- credential
- str または UserDelegationKey
資格情報には、アカウント キーまたはユーザー委任キーを指定できます。 アカウント キーを資格情報として使用する場合、資格情報の種類は str である必要があります。 アカウント キーの代わりに、ユーザーはユーザー委任キーを渡すこともできます。 ユーザー委任キーは、AAD ID を使用して認証することで、サービスから取得できます。これを実現するには、 を呼び出します get_user_delegation_key。 存在する場合、SAS は代わりにユーザー委任キーで署名されます。
- permission
- str または FileSystemSasPermissions
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 アクセス許可は racwdlmeop に並べ替える必要があります。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で ip=168.1.5.65 または ip=168.1.5.60-168.1.5.70 を指定すると、要求はそれらの IP アドレスに制限されます。
- protocol
- str
要求に対して許可されるプロトコルを指定します。 既定値は https です。
- cache_control
- str
この共有アクセス署名を使用してリソースにアクセスする場合のCache-Controlの応答ヘッダー値。
- content_disposition
- str
この共有アクセス署名を使用してリソースにアクセスする場合の Content-Disposition の応答ヘッダー値。
- content_encoding
- str
この共有アクセス署名を使用してリソースにアクセスする場合の Content-Encoding の応答ヘッダー値。
- content_language
- str
この共有アクセス署名を使用してリソースにアクセスする場合の Content-Language の応答ヘッダー値。
- content_type
- str
この共有アクセス署名を使用してリソースにアクセスする場合の Content-Type の応答ヘッダー値。
- preauthorized_agent_object_id
- str
SAS トークンによって付与されたアクションを実行するために、ユーザー委任キーの所有者によって承認されていると見なされるユーザーの AAD オブジェクト ID。 サービスは SAS トークンを検証し、アクセスを許可する前にユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認しますが、エージェント オブジェクト ID に対する追加のアクセス許可チェックは実行されません。
- agent_object_id
- str
SAS トークンによって付与されたアクションを実行するために、ユーザー委任キーの所有者によって承認されていないと見なされたユーザーの AAD オブジェクト ID。 サービスは SAS トークンを検証し、アクセスを許可する前にユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認し、サービスは追加の POSIX ACL チェックを実行して、このユーザーが要求された操作の実行を承認されているかどうかを判断します。
- correlation_id
- str
ストレージ監査ログと、SAS を生成して配布するプリンシパルによって使用される監査ログを関連付ける関連付け ID。
- encryption_scope
- str
すべての書き込み操作がサービスで暗号化されるように、要求の暗号化スコープを指定します。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
Azure SDK for Python
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示