filedatalake 套件
套件
| aio |
類別
| AccessControlChangeCounters |
AccessControlChangeCounters 包含以遞迴方式變更存取控制清單的作業計數。 |
| AccessControlChangeFailure |
表示無法更新存取控制清單的專案。 |
| AccessControlChangeResult |
AccessControlChangeResult 包含以遞迴方式變更存取控制清單的作業結果。 |
| AccessControlChanges |
AccessControlChanges 包含以遞迴方式變更存取控制清單的作業批次和累計計數。 此外，也會公開這些作業進行時無法更新的路徑專案。 |
| AccessPolicy |
集合所使用的存取原則類別，並在每個服務中取得存取原則方法。 儲存的存取原則可以指定其相關聯之共用存取簽章的開始時間、到期時間及權限。 根據您想要如何控制資源的存取權，您可以在預存存取原則中指定所有這些參數，並從共用存取簽章的 URL 中省略這些參數。 這樣做可讓您隨時修改相關聯的簽章行為，以及將它撤銷。 您也可以在儲存的存取原則中指定一個或多個存取原則參數，然後在 URL 上指定其他參數。 最後，您可以在 URL 上指定所有參數。 在此情況下，您可以使用儲存的存取原則撤銷簽章，但不修改其行為。 共用存取簽章和預存存取原則必須包含驗證簽章所需的所有欄位。 如果遺漏任何必要的欄位，要求將會失敗。 同樣地，如果同時在共用存取簽章 URL 和預存存取原則中指定某個欄位，則要求會失敗，並顯示狀態碼 400 (不正確的要求)。 |
| AccountSasPermissions | |
| AnalyticsLogging |
Azure 分析記錄設定。 |
| ArrowDialect |
箭號架構的欄位。 必須填入所有必要的參數，才能傳送至 Azure。 |
| ContentSettings |
檔案或目錄的內容設定。 |
| CorsRule |
CORS 是一項 HTTP 功能，可讓 Web 應用程式在某個網域下執行，以存取其他網域中的資源。 網頁瀏覽器會實作稱為同源原則的安全性限制，其可防止網頁呼叫不同網域中的 API；CORS 則提供了一個安全的方式，可讓一個網域 (原始網域) 能夠呼叫其他網域中的 API。 |
| CustomerProvidedEncryptionKey |
Azure 儲存體中的所有資料都會使用帳戶層級加密金鑰進行待用加密。 在 2021-06-08 版和更新版本中，您可以透過對儲存體服務的要求中提供 AES-256 加密金鑰，來管理用來加密檔案內容和應用程式中繼資料的金鑰。 當您使用客戶提供的金鑰時，Azure 儲存體不會管理或保存金鑰。 將資料寫入檔案時，提供的金鑰會用來加密您的資料，然後再將資料寫入磁片。 加密金鑰的 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 序列化。 關鍵字 str 分隔符號：行分隔符號，預設值為 ' ' |
| DelimitedTextDialect |
定義資料湖查詢要求的輸入或輸出， (CSV) 序列化。 關鍵字 str 分隔符號：資料行分隔符號，預設為 '，'。 關鍵字 str quotechar：欄位引號，預設值為 '「'。 關鍵字 str lineterminator：記錄分隔符號，預設值為 ' '. 關鍵字 str escapechar：Escape char，預設為空白。 關鍵字 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 |
可反覆運算檔案系統屬性。 |
| FileSystemSasPermissions |
要與 函 generate_file_system_sas 式搭配使用的 FileSystemSasPermissions 類別。 |
| LeaseProperties |
DataLake 租用屬性。 |
| LinearRetry |
線性重試。 建構線性重試物件。 |
| LocationMode |
指定要求應傳送至的位置。 此模式僅適用于允許次要讀取存取的 RA-GRS 帳戶。 所有其他帳戶類型都必須使用 PRIMARY。 |
| Metrics |
依 API 分組的要求統計資料摘要，以小時或分鐘匯總為單位。 |
| PathProperties |
get_paths api 列出的路徑屬性。 |
| ResourceTypes |
指定帳戶 SAS 可存取的資源類型。 |
| RetentionPolicy |
決定相關聯資料應保存多久的保留原則。 |
| StaticWebsite |
可讓帳戶裝載靜態網站的屬性。 |
| StorageStreamDownloader |
要從 Azure 儲存體下載的串流物件。 |
| UserDelegationKey |
代表使用者委派金鑰，根據 Azure 儲存體的 Azure Active Directory 存取權杖提供給使用者。 欄位會儲存為簡單的字串，因為使用者不需要與此物件互動;若要產生識別 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
這些權限與共用存取簽章相關聯。 使用者只能執行這些權限允許的作業。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。
共用存取簽章變成不正確時間。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。 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
指定所提出要求的加密範圍，讓所有寫入作業都會服務加密。
傳回
共用存取簽章 (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 身分識別進行驗證，以從服務取得使用者委派金鑰;呼叫 即可完成 get_user_delegation_key 此作業。 存在時，SAS 會改用使用者委派金鑰簽署。
- permission
- str 或 DirectorySasPermissions
這些權限與共用存取簽章相關聯。 使用者只能執行這些權限允許的作業。 許可權必須排序 racwdlmeop。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。
共用存取簽章變成不正確時間。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。 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
假設由使用者委派金鑰擁有者授權的使用者 AAD 物件識別碼，以執行 SAS 權杖所授與的動作。 服務會驗證 SAS 權杖，並確保使用者委派金鑰的擁有者具有必要的許可權，再授與存取權，但不會執行代理程式物件識別碼的其他許可權檢查。
- agent_object_id
- str
使用者的 AAD 物件識別碼，假設使用者委派金鑰的擁有者未經授權，以執行 SAS 權杖所授與的動作。 服務會驗證 SAS 權杖，並確保使用者委派金鑰的擁有者具有必要的許可權，再授與存取權，而服務將會執行額外的 POSIX ACL 檢查，以判斷此使用者是否已獲授權執行要求的作業。
- correlation_id
- str
用來將儲存體稽核記錄與主體產生和散發 SAS 所使用的稽核記錄相互關聯之相互關聯識別碼。
- encryption_scope
- str
指定所提出要求的加密範圍，讓所有寫入作業都會服務加密。
傳回
共用存取簽章 (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 身分識別進行驗證，以從服務取得使用者委派金鑰;呼叫 即可完成 get_user_delegation_key 此作業。 存在時，SAS 會改用使用者委派金鑰簽署。
- permission
- str 或 FileSasPermissions
這些權限與共用存取簽章相關聯。 使用者只能執行這些權限允許的作業。 許可權必須排序 racwdlmeop。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。
共用存取簽章變成不正確時間。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。 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
假設由使用者委派金鑰擁有者授權的使用者 AAD 物件識別碼，以執行 SAS 權杖所授與的動作。 服務會驗證 SAS 權杖，並確保使用者委派金鑰的擁有者具有必要的許可權，再授與存取權，但不會執行代理程式物件識別碼的其他許可權檢查。
- agent_object_id
- str
使用者的 AAD 物件識別碼，假設使用者委派金鑰的擁有者未經授權，以執行 SAS 權杖所授與的動作。 服務會驗證 SAS 權杖，並確保使用者委派金鑰的擁有者具有必要的許可權，再授與存取權，而服務將會執行額外的 POSIX ACL 檢查，以判斷此使用者是否已獲授權執行要求的作業。
- correlation_id
- str
用來將儲存體稽核記錄與主體產生和散發 SAS 所使用的稽核記錄相互關聯之相互關聯識別碼。 這只能在產生具有委派金鑰的 SAS 時使用。
- encryption_scope
- str
指定所提出要求的加密範圍，讓所有寫入作業都會服務加密。
傳回
共用存取簽章 (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 身分識別進行驗證，以從服務取得使用者委派金鑰;呼叫 即可完成 get_user_delegation_key 此作業。 存在時，SAS 會改用使用者委派金鑰簽署。
- permission
- str 或 FileSystemSasPermissions
這些權限與共用存取簽章相關聯。 使用者只能執行這些權限允許的作業。 許可權必須排序 racwdlmeop。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。
共用存取簽章變成不正確時間。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。 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
使用者的 AAD 物件識別碼，假設由使用者委派金鑰的擁有者授權，以執行 SAS 權杖所授與的動作。 服務會驗證 SAS 權杖，並確保使用者委派金鑰的擁有者具有必要的許可權，再授與存取權，但不會執行代理程式物件識別碼的其他許可權檢查。
- agent_object_id
- str
使用者的 AAD 物件識別碼，假設使用者委派金鑰的擁有者未經授權，以執行 SAS 權杖所授與的動作。 服務會驗證 SAS 權杖，並確保使用者委派金鑰的擁有者具有必要的許可權，再授與存取權，而服務將會執行額外的 POSIX ACL 檢查，以判斷此使用者是否已獲授權執行要求的作業。
- correlation_id
- str
用來將儲存體稽核記錄與主體產生和散發 SAS 所使用的稽核記錄相互關聯識別碼。
- encryption_scope
- str
指定所提出要求的加密範圍，讓所有寫入作業都會服務加密。
傳回
共用存取簽章 (sas) 權杖。
