FileService 類別

伺服器訊息區 (SMB) 通訊協定是現今內部部署偏好使用的檔案共用通訊協定。 Microsoft Azure 檔案服務可讓客戶利用 Azure 雲端基礎結構即服務的可用性和延展性， (IaaS) SMB，而不需要重寫 SMB 用戶端應用程式。

Azure 檔案服務也為傳統要安裝、設定及操作經常是既複雜且昂貴的「直接連接存取 (DAS)」和「存放區域網路 (SAN)」解決方案提供引人注目的替代方式。

繼承

StorageClient

FileService

建構函式

FileService(account_name=None, account_key=None, sas_token=None, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)

參數

名稱	Description
account_name	str 儲存體帳戶名稱。 這是用來驗證使用帳戶金鑰簽署的要求，以及建構儲存體端點。 除非提供連接字串，否則為必要專案。 預設值: None
account_key	str 儲存體帳戶金鑰。 這是用於共用金鑰驗證。 預設值: None
sas_token	str 用來驗證要求的共用存取簽章權杖，而不是帳戶金鑰。 如果同時指定帳戶金鑰和 sas 權杖，則會使用帳戶金鑰來簽署。 預設值: None
protocol	str 要用於要求的通訊協定。 預設為 HTTPs。 預設值: https
endpoint_suffix	str URL 的主機基底元件，減去帳戶名稱。 預設為 Azure (core.windows.net) 。 覆寫此選項以使用中國雲端 (core.chinacloudapi.cn) 。 預設值: core.windows.net
request_session	<xref:requests.Session> 要用於 HTTP 要求的會話物件。 預設值: None
connection_string	str 如果指定，這會覆寫要求會話以外的所有其他參數。 如需連接字串格式，請參閱 http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ 。 預設值: None
socket_timeout	int 如果指定，這會覆寫預設通訊端逾時。 指定的逾時以秒為單位。 如需預設值，請參閱 _constants.py 中的DEFAULT_SOCKET_TIMEOUT。 預設值: None

變數

名稱	Description
MAX_SINGLE_GET_SIZE	int 如果max_connections大於 1，則get_file_to_* 方法會執行第一個範圍的大小。 如果檔案小於這個值，則會傳回較少的資料。
MAX_CHUNK_GET_SIZE	int 如果max_connections大於 1 且檔案大於 MAX_SINGLE_GET_SIZE，則後續範圍的大小會由 get_file_to_* 方法執行。 如果檔案的其餘部分小於這個，則會傳回較少的資料。 如果此值設定為大於 4MB，content_validation會在啟用時擲回錯誤。 不過，如果content_validation不想要大於 4MB 的大小可能是最佳。 不建議將此設定為 4MB。
MAX_RANGE_SIZE	int create_file_from_* 方法放置的範圍大小。 如果提供的資料較少，可能會放置較小的範圍。 服務支援的範圍大小上限為 4 MB。

方法

abort_copy_file	中止擱置copy_file作業，並保留長度為零和完整中繼資料的目的地檔案。
clear_range	清除指定的範圍，並釋放該範圍儲存體中使用的空間。
close_handles	傳回產生器，以關閉目錄或指定共用下檔案上開啟的控制碼。 產生器會延遲追蹤服務所傳回的接續權杖，並在所有控制碼都已關閉時停止。 產生的值代表每個交易中已關閉的控制碼數目。
copy_file	以非同步方式複製檔案。 此作業會傳回復製作業屬性物件，包括可用來檢查或中止複製作業的複製識別碼。 檔案服務會盡最大努力複製檔案。 如果目的地檔案存在，將會遭到覆寫。 複製作業正在進行時，無法修改目的地檔案。
create_directory	在指定的共用或父目錄下建立新的目錄。 如果具有相同名稱的目錄已經存在，則服務上的作業會失敗。 根據預設，用戶端會抑制例外狀況。 若要公開例外狀況，請針對fail_on_exists指定 True。
create_file	建立新檔案。 如需使用自動區塊處理和進度通知建立和上傳大型檔案的高階函式，請參閱 create_file_from_* 。
create_file_from_bytes	使用自動區塊處理和進度通知，從位元組陣列建立新檔案，或更新現有檔案的內容。
create_file_from_path	使用自動區塊處理和進度通知，從本機檔案路徑建立新的 Azure 檔案，或更新現有檔案的內容。
create_file_from_stream	從檔案/資料流程建立新的檔案，或使用自動區塊化和進度通知來更新現有檔案的內容。
create_file_from_text	使用自動區塊化和進度通知，從 str/unicode 建立新檔案，或更新現有檔案的內容。
create_permission_for_share	在共用層級建立 (安全性描述元) 的許可權。 此「許可權」可用於共用中的檔案/目錄。 如果 'permission' 已經存在，它應該會傳回它的金鑰，否則會在共用層級建立新的許可權，並傳回其金鑰。 ：傳回檔案許可權金鑰 ：rtype str
create_share	在指定的帳號下建立新的共用。 如果具有相同名稱的共用已經存在，則服務上的作業會失敗。 根據預設，用戶端會抑制例外狀況。 若要公開例外狀況，請針對 fail_on_exists 指定 True。
delete_directory	刪除指定的空白目錄。 請注意，必須先清空目錄才能將其刪除。 嘗試刪除不是空白的目錄將會失敗。 如果目錄不存在，作業會在服務上失敗。 根據預設，用戶端會修改例外狀況。 若要公開例外狀況，請針對fail_not_exist指定 True。
delete_file	標記要刪除的指定檔案。 檔案稍後會在垃圾收集期間刪除。
delete_share	標記要刪除的指定共用。 如果共用不存在，服務上的作業就會失敗。 根據預設，用戶端會修改例外狀況。 若要公開例外狀況，請針對fail_not_exist指定 True。
exists	傳回布林值，指出只有在指定共用名稱稱時，共用是否存在。 如果directory_name是特定的，則會傳回布林值，指出目錄是否存在。 如果同時指定file_name，則會傳回布林值，指出檔案是否存在。
extract_date_and_request_id
generate_account_shared_access_signature	產生檔案服務的共用存取簽章。 使用傳回的簽章搭配 FileService 的 sas_token 參數。
generate_file_shared_access_signature	產生檔案的共用存取簽章。 使用傳回的簽章搭配 FileService 的 sas_token 參數。
generate_share_shared_access_signature	產生共用的共用存取簽章。 使用傳回的簽章搭配 FileService 的 sas_token 參數。
get_directory_metadata	傳回指定目錄的所有使用者定義中繼資料。
get_directory_properties	傳回指定目錄的所有使用者定義中繼資料和系統屬性。 傳回的資料不包含目錄的檔案清單。
get_file_metadata	傳回指定檔案的所有使用者定義中繼資料。
get_file_properties	傳回檔案的所有使用者定義中繼資料、標準 HTTP 屬性和系統屬性。 使用 和 中繼資料聽寫傳回 的 FileFileProperties 實例。
get_file_service_properties	取得儲存體帳戶檔案服務的屬性，包括 Azure 儲存體分析。
get_file_to_bytes	使用自動區塊化和進度通知，將檔案下載為位元組陣列。 傳回 具有屬性、中繼資料和內容的 實例 File 。
get_file_to_path	使用自動區塊處理和進度通知，將檔案下載至檔案路徑。 傳回具有屬性和中繼資料的 File 實例。
get_file_to_stream	使用自動區塊處理和進度通知，將檔案下載至資料流程。 傳回 具有屬性和中繼資料的 File 實例。
get_file_to_text	使用自動區塊處理和進度通知，將檔案下載為 unicode 文字。 傳回 具有屬性、中繼資料和內容的 實例 File 。
get_permission_for_share	在共用層級建立安全性描述元 (許可權) 。 這個「許可權」可用於共用中的檔案/目錄。 如果 'permission' 已經存在，它應該傳回它的金鑰，否則會在共用層級建立新的許可權，並傳回其金鑰。 ：傳回可攜式 SDDL) ：rtype str (檔案許可權
get_share_acl	取得指定共用的許可權。
get_share_metadata	傳回指定共用的所有使用者定義中繼資料。
get_share_properties	傳回指定共用的所有使用者定義中繼資料和系統屬性。 傳回的資料不包含共用的檔案或目錄清單。
get_share_stats	取得儲存在共用上的大約資料大小，四捨五入為最接近的 GB。 請注意，此值可能不會包含最近建立或最近重新調整大小的檔案。
get_share_stats_in_bytes	取得儲存在共用上之資料的近似大小，以位元組為單位。 請注意，此值可能不會包含最近建立或最近重新調整大小的檔案。
list_directories_and_files	傳回產生器，以列出指定共用下的目錄和檔案。 產生器會延遲遵循服務所傳回的接續權杖，並在到達所有目錄和檔案或num_results時停止。 如果指定了num_results，且共用的檔案和目錄數目超過該數目，則產生器會在完成之後填入next_marker欄位。 如果需要更多結果，此標記可用來建立新的產生器。
list_handles	傳回產生器，以列出目錄或指定共用下檔案上開啟的控制碼。 產生器會延遲追蹤服務所傳回的接續權杖，並在到達所有控制碼或num_results時停止。 如果指定了num_results，且共用的檔案和目錄數目超過該數目，則產生器會在完成之後填入next_marker欄位。 如果需要更多結果，此標記可用來建立新的產生器。
list_ranges	擷取檔案的有效範圍。
list_shares	傳回產生器，以列出指定帳戶下的共用。 產生器會延遲遵循服務傳回的接續權杖，並在到達所有共用或num_results時停止。 如果指定了num_results，且帳戶的共用數目超過該數目，則產生器會在完成之後，填入next_marker欄位。 如果需要更多結果，此標記可用來建立新的產生器。
make_file_url	建立 URL 以存取檔案。
resize_file	將檔案調整為指定的大小。 如果指定的位元組值小於檔案目前的大小，則會清除大於指定位元組值的所有範圍。
set_directory_metadata	設定指定目錄的一或多個使用者定義名稱/值組。 每次呼叫這項作業都會取代附加至目錄的所有現存中繼資料。 若要從目錄中移除所有中繼資料，請呼叫此作業，而不使用中繼資料聽寫。
set_directory_properties
set_file_metadata	將指定檔案的使用者定義中繼資料設定為一或多個名稱/值組。
set_file_properties	設定檔案上的系統屬性。 如果已針對content_settings設定一個屬性，則會覆寫所有屬性。
set_file_service_properties	設定儲存體帳戶檔案服務的屬性，包括 Azure 儲存體分析。 如果 (ex HourMetrics) 的專案保留為 None，則會保留該服務上的現有設定。
set_proxy	設定 HTTP CONNECT Tunnelling 的 Proxy 伺服器主機和埠。
set_share_acl	設定可搭配共用存取簽章使用的指定共用或預存存取原則的許可權。
set_share_metadata	為指定的共用設定一或多個使用者定義的名稱/值組。 每次呼叫這項作業都會取代附加至共用的所有現存中繼資料。 若要從共用中移除所有中繼資料，請呼叫沒有中繼資料聽寫的這項作業。
set_share_properties	設定指定共用的服務定義屬性。
snapshot_share	在指定的帳號下建立現有共用的快照集。
update_range	將要求本文指定的位元組寫入指定的範圍。
update_range_from_file_url	將位元組從一個 Azure 檔案端點寫入另一個 Azure 檔案端點的指定範圍。

abort_copy_file

中止擱置copy_file作業，並保留長度為零和完整中繼資料的目的地檔案。

abort_copy_file(share_name, directory_name, file_name, copy_id, timeout=None)

參數

名稱	Description
share_name 必要	str 目的地共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 目的地檔案的名稱。
copy_id 必要	str 原始copy_file作業 copy.id 中提供的複製識別碼。
timeout	int timeout 參數以秒為單位。 預設值: None

clear_range

清除指定的範圍，並釋放該範圍儲存體中使用的空間。

clear_range(share_name, directory_name, file_name, start_range, end_range, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
start_range 必要	int 要用來清除檔案區段的位元組範圍開始。 此範圍的大小上限為 4 MB。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。
end_range 必要	int 要用來清除檔案區段的位元組範圍結尾。 此範圍的大小上限為 4 MB。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。
timeout	int timeout 參數以秒為單位。 預設值: None

close_handles

傳回產生器，以關閉目錄或指定共用下檔案上開啟的控制碼。 產生器會延遲追蹤服務所傳回的接續權杖，並在所有控制碼都已關閉時停止。 產生的值代表每個交易中已關閉的控制碼數目。

close_handles(share_name, directory_name=None, file_name=None, recursive=None, handle_id=None, marker=None, snapshot=None, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name	str 目錄的路徑。 預設值: None
file_name	str 現有檔案的名稱。 預設值: None
recursive	bool 布林值，指定作業是否應該套用至 URI、其檔案、其子目錄及其檔案中指定的目錄。 預設值: None
handle_id	str 必要。 指定要關閉之檔案或目錄上開啟的控制碼識別碼。 Astrix ('*') 是指定所有控制碼的萬用字元。 預設值: None
marker	str 不透明的接續權杖。 如果前一個產生器物件的next_marker欄位尚未完成關閉控制碼，就可以擷取此值。 如果指定，這個產生器會從上一個產生器停止的點開始關閉控制碼。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None

copy_file

以非同步方式複製檔案。 此作業會傳回復製作業屬性物件，包括可用來檢查或中止複製作業的複製識別碼。 檔案服務會盡最大努力複製檔案。

如果目的地檔案存在，將會遭到覆寫。 複製作業正在進行時，無法修改目的地檔案。

copy_file(share_name, directory_name, file_name, copy_source, metadata=None, timeout=None)

參數

名稱	Description
share_name 必要	str 目的地共用的名稱。 共用必須存在。
directory_name 必要	str 目的地目錄的名稱。 此目錄必須已存在。
file_name 必要	str 目的地檔案的名稱。 如果目的地檔案存在，將會遭到覆寫。 否則，將會建立它。
copy_source 必要	str 長度上限為 2 KB 的 URL，指定 Azure 檔案或 Blob。 此值應該像出現在要求 URI 中一樣以 URL 編碼。 如果來源位於另一個帳戶中，則來源必須是公用，或必須透過共用存取簽章進行驗證。 如果來源是公用的，則不需要驗證。 範例：https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
metadata	dict(str, str)<xref:./> 與檔案相關聯的名稱/值組，可做為中繼資料。 如果未指定名稱/值組，作業會將中繼資料從來源 Blob 或檔案複製到目的地檔案。 如果指定了一或多個名稱/值組，則會使用指定的中繼資料建立目的地檔案，而且中繼資料不會從來源 Blob 或檔案複製。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None

傳回

類型	Description
CopyProperties	複製作業屬性，例如狀態、來源和識別碼。

create_directory

在指定的共用或父目錄下建立新的目錄。 如果具有相同名稱的目錄已經存在，則服務上的作業會失敗。 根據預設，用戶端會抑制例外狀況。 若要公開例外狀況，請針對fail_on_exists指定 True。

create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 要建立的目錄名稱，包括父目錄的路徑。
metadata	dict(str, str)<xref::> 具有name_value組的聽寫，與共享建立關聯做為中繼資料。 範例：{'Category'：'test'} 預設值: None
fail_on_exist	bool 指定是否要在目錄存在時擲回例外狀況。 預設為 False。 預設值: False
file_permission	str 檔案許可權，可攜式 SDDL 預設值: None
smb_properties	SMBProperties 設定 SMB 相關檔案屬性
timeout	int timeout 參數以秒為單位。 預設值: None

傳回

類型	Description
bool	如果已建立目錄，則為 True;如果目錄已經存在，則為 False。

create_file

建立新檔案。

如需使用自動區塊處理和進度通知建立和上傳大型檔案的高階函式，請參閱 create_file_from_* 。

create_file(share_name, directory_name, file_name, content_length, content_settings=None, metadata=None, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 要建立或更新的檔案名。
content_length 必要	int 檔案的長度 (以位元組為單位)。
content_settings	ContentSettings 用來設定檔案屬性的 ContentSettings 物件。 預設值: None
metadata	dict(str, str) 與檔案相關聯的名稱/值組，可做為中繼資料。 預設值: None
file_permission	str 檔案許可權，可攜式 SDDL 預設值: None
smb_properties	SMBProperties 設定 SMB 相關檔案屬性
timeout	int timeout 參數以秒為單位。 預設值: None

create_file_from_bytes

使用自動區塊處理和進度通知，從位元組陣列建立新檔案，或更新現有檔案的內容。

create_file_from_bytes(share_name, directory_name, file_name, file, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 要建立或更新的檔案名。
file 必要	str 以位元組陣列表示的檔案內容。
index	int 位元組陣列中的開始索引。 預設值: 0
count	int 要上傳的位元組數。 設定為 [無] 或 [負值] 以上傳從索引開始的所有位元組。 預設值: None
content_settings	ContentSettings 用來設定檔案屬性的 ContentSettings 物件。 預設值: None
metadata	dict(str, str) 與檔案相關聯的名稱/值組，可做為中繼資料。 預設值: None
validate_content	bool 如果為 true，則計算檔案每個範圍的 MD5 雜湊。 儲存體服務會檢查與已傳送雜湊一起抵達之內容的雜湊。 如果使用 HTTP 而非 HTTPs 作為 HTTPs，則這主要對於偵測連線上的 bitflip 很有用， (預設) 將已經過驗證。 請注意，這個 MD5 雜湊不會與 檔案一起儲存。 預設值: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 簽章函式的進度回呼 (目前、目前的總) 是目前傳輸的位元組數目，而總計是檔案的大小，如果總大小未知，則為 None。 預設值: None
max_connections	int 要使用的平行連線數目上限。 預設值: 2
file_permission	str 檔案許可權，可攜式 SDDL 預設值: None
smb_properties	SMBProperties 設定 SMB 相關檔案屬性
timeout	int timeout 參數以秒為單位。 這個方法可能會對 Azure 服務進行多個呼叫，而逾時會個別套用至每個呼叫。 預設值: None

create_file_from_path

使用自動區塊處理和進度通知，從本機檔案路徑建立新的 Azure 檔案，或更新現有檔案的內容。

create_file_from_path(share_name, directory_name, file_name, local_file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 要建立或更新的檔案名。
local_file_path 必要	str 要上傳為檔案內容之本機檔案的路徑。
content_settings	ContentSettings 用於設定檔案屬性的 ContentSettings 物件。 預設值: None
metadata	dict(str, str) 與檔案相關聯的名稱/值組，可做為中繼資料。 預設值: None
validate_content	bool 如果為 true，則計算檔案每個範圍的 MD5 雜湊。 儲存體服務會檢查與已傳送雜湊一起抵達之內容的雜湊。 如果使用 HTTP 而非 HTTPs 作為 HTTPs，則這主要對於偵測連線上的 bitflip 很有用， (預設) 將已經過驗證。 請注意，這個 MD5 雜湊不會與 檔案一起儲存。 預設值: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 簽章函式的進度回呼 (目前、目前的總) 是目前傳輸的位元組數目，而總計是檔案的大小，如果總大小未知，則為 None。 預設值: None
max_connections	int 要使用的平行連線數目上限。 預設值: 2
file_permission	str 檔案許可權，可攜式 SDDL 預設值: None
smb_properties	SMBProperties 設定 SMB 相關檔案屬性
timeout	int timeout 參數以秒為單位。 這個方法可能會對 Azure 服務進行多個呼叫，而逾時會個別套用至每個呼叫。 預設值: None

create_file_from_stream

從檔案/資料流程建立新的檔案，或使用自動區塊化和進度通知來更新現有檔案的內容。

create_file_from_stream(share_name, directory_name, file_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 要建立或更新的檔案名。
stream 必要	IOBase 開啟的檔案/資料流程，以上傳為檔案內容。
count 必要	int 要從資料流程讀取的位元組數目。 這是必要的，如果計數未知，就無法建立檔案。
content_settings	ContentSettings 用來設定檔案屬性的 ContentSettings 物件。 預設值: None
metadata	dict(str, str) 與檔案相關聯的名稱/值組，可做為中繼資料。 預設值: None
validate_content	bool 如果為 true，則計算檔案每個範圍的 MD5 雜湊。 儲存體服務會檢查與已傳送雜湊一起抵達之內容的雜湊。 如果使用 HTTP 而非 HTTPs 作為 HTTPs，則這主要對於偵測連線上的 bitflip 很有用， (預設) 將已經過驗證。 請注意，這個 MD5 雜湊不會與 檔案一起儲存。 預設值: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 簽章函式的進度回呼 (目前、目前的總) 是目前傳輸的位元組數目，而總計是檔案的大小，如果總大小未知，則為 None。 預設值: None
max_connections	int 要使用的平行連線數目上限。 請注意，平行上傳需要可搜尋資料流程。 預設值: 2
file_permission	str 檔案許可權，可攜式 SDDL 預設值: None
smb_properties	SMBProperties 設定 SMB 相關檔案屬性
timeout	int timeout 參數以秒為單位。 這個方法可能會對 Azure 服務進行多個呼叫，而逾時會個別套用至每個呼叫。 預設值: None

create_file_from_text

使用自動區塊化和進度通知，從 str/unicode 建立新檔案，或更新現有檔案的內容。

create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 要建立或更新的檔案名。
text 必要	str 要上傳至檔案的文字。
encoding	str 用來將文字轉換成位元組的 Python 編碼方式。 預設值: utf-8
content_settings	ContentSettings 用來設定檔案屬性的 ContentSettings 物件。 預設值: None
metadata	dict(str, str) 與檔案相關聯的名稱/值組，可做為中繼資料。 預設值: None
validate_content	bool 如果為 true，則計算檔案每個範圍的 MD5 雜湊。 儲存體服務會檢查與已傳送雜湊一起抵達之內容的雜湊。 如果使用 HTTP 而非 HTTPs 作為 HTTPs，則這主要對於偵測連線上的 bitflip 很有用， (預設) 將已經過驗證。 請注意，這個 MD5 雜湊不會與 檔案一起儲存。 預設值: False
file_permission	str 檔案許可權，可攜式 SDDL 預設值: None
smb_properties	SMBProperties 設定 SMB 相關檔案屬性
timeout	int timeout 參數以秒為單位。 這個方法可能會對 Azure 服務進行多個呼叫，而逾時會個別套用至每個呼叫。 預設值: None

create_permission_for_share

在共用層級建立 (安全性描述元) 的許可權。 此「許可權」可用於共用中的檔案/目錄。 如果 'permission' 已經存在，它應該會傳回它的金鑰，否則會在共用層級建立新的許可權，並傳回其金鑰。

：傳回檔案許可權金鑰 ：rtype str

create_permission_for_share(share_name, file_permission, timeout=None)

參數

名稱	Description
share_name 必要	共用的名稱。
file_permission 必要	檔案許可權，可攜式 SDDL
timeout	timeout 參數以秒為單位。 預設值: None

create_share

在指定的帳號下建立新的共用。 如果具有相同名稱的共用已經存在，則服務上的作業會失敗。 根據預設，用戶端會抑制例外狀況。 若要公開例外狀況，請針對 fail_on_exists 指定 True。

create_share(share_name, metadata=None, quota=None, fail_on_exist=False, timeout=None)

參數

名稱	Description
share_name 必要	str 要建立的共用名稱稱。
metadata	dict(str, str) 具有name_value組的聽寫，與共享建立關聯做為中繼資料。 範例：{'Category'：'test'} 預設值: None
quota	int 指定共用的大小上限 (以 GB 為單位)。 必須大於 0 且小於或等於 5TB (5120)。 預設值: None
fail_on_exist	bool 指定是否要在共用存在時擲回例外狀況。 預設為 False。 預設值: False
timeout	int timeout 參數以秒為單位。 預設值: None

傳回

類型	Description
bool	如果已建立共用，則為 True;如果共用已經存在，則為 False。

delete_directory

刪除指定的空白目錄。 請注意，必須先清空目錄才能將其刪除。 嘗試刪除不是空白的目錄將會失敗。

如果目錄不存在，作業會在服務上失敗。 根據預設，用戶端會修改例外狀況。 若要公開例外狀況，請針對fail_not_exist指定 True。

delete_directory(share_name, directory_name, fail_not_exist=False, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 要刪除的目錄名稱，包括父目錄的路徑。
fail_not_exist	bool 指定目錄不存在時是否擲回例外狀況。 預設值: False
timeout	int timeout 參數以秒為單位。 預設值: None

傳回

類型	Description
bool	如果刪除目錄，則為 True，否則為 False。

delete_file

標記要刪除的指定檔案。 檔案稍後會在垃圾收集期間刪除。

delete_file(share_name, directory_name, file_name, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
timeout	int timeout 參數以秒為單位。 預設值: None

delete_share

標記要刪除的指定共用。 如果共用不存在，服務上的作業就會失敗。 根據預設，用戶端會修改例外狀況。 若要公開例外狀況，請針對fail_not_exist指定 True。

delete_share(share_name, fail_not_exist=False, timeout=None, snapshot=None, delete_snapshots=None)

參數

名稱	Description
share_name 必要	str 要刪除的共用名稱稱。
fail_not_exist	bool 指定共用不存在時是否擲回例外狀況。 預設為 False。 預設值: False
timeout	int timeout 參數以秒為單位。 預設值: None
snapshot	str 表示快照集版本的字串，如果適用的話。 指定此引數，只刪除特定快照集。 如果指定這個，delete_snapshots必須是 None。 預設值: None
delete_snapshots	DeleteSnapshot 若要刪除具有快照集的共用，這必須指定為 DeleteSnapshot.Include。 預設值: None

傳回

類型	Description
bool	True 是表示 如果刪除共用，則為 False 共用不存在。

exists

傳回布林值，指出只有在指定共用名稱稱時，共用是否存在。 如果directory_name是特定的，則會傳回布林值，指出目錄是否存在。 如果同時指定file_name，則會傳回布林值，指出檔案是否存在。

exists(share_name, directory_name=None, file_name=None, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 共用的名稱。
directory_name	str 目錄的路徑。 預設值: None
file_name	str 檔案名。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None
snapshot	str 表示快照集版本的字串，如果適用的話。 預設值: None

傳回

類型	Description
bool	布林值，指出資源是否存在。

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

參數

名稱	Description
retry_context 必要

generate_account_shared_access_signature

產生檔案服務的共用存取簽章。 使用傳回的簽章搭配 FileService 的 sas_token 參數。

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

參數

名稱	Description
resource_types 必要	<xref:ResourceTypes> 指定帳戶 SAS 可存取的資源類型。
permission 必要	<xref:AccountPermissions> 這些權限與共用存取簽章相關聯。 使用者只能執行這些權限允許的作業。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。
expiry 必要	datetime 或 str 共用存取簽章變成不正確時間。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。 Azure 一律會將值轉換成 UTC。 如果在沒有時區資訊的情況下傳入日期，則會假設為 UTC。
start	datetime 或 str 共用存取簽章生效的時間。 如果省略，此呼叫的開始時間會假設為儲存體服務收到要求的時間。 Azure 一律會將值轉換成 UTC。 如果在沒有時區資訊的情況下傳入日期，則會假設為 UTC。 預設值: None
ip	str 指定要接受要求的 IP 位址或 IP 位址範圍。 如果要求的來源 IP 位址不符合 SAS 權杖上指定的 IP 位址或位址範圍，則不會驗證要求。 例如，在 SAS 上指定 sip=168.1.5.65 或 sip=168.1.5.60-168.1.5.70 會限制這些 IP 位址的要求。 預設值: None
protocol	str 指定要求允許的通訊協定。 可能的值為 HTTPS 和 HTTP (HTTPs、HTTP) 或 HTTPS，只會 (HTTPs) 。 預設值為 HTTPs，HTTP。 請注意，僅 HTTP 是不允許的值。 預設值: None

傳回

類型	Description
str	共用存取簽章 (sas) 權杖。

generate_file_shared_access_signature

產生檔案的共用存取簽章。 使用傳回的簽章搭配 FileService 的 sas_token 參數。

generate_file_shared_access_signature(share_name, directory_name=None, file_name=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

參數

名稱	Description
share_name 必要	str 共用的名稱。
directory_name	str 目錄的名稱。 無法為目錄建立 SAS 權杖，因此只有在提供file_name時，才應該存在此參數。 預設值: None
file_name	str 檔案名。 預設值: None
permission	FilePermissions 這些權限與共用存取簽章相關聯。 使用者只能執行這些權限允許的作業。 許可權必須排序為讀取、建立、寫入、刪除、清單。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。 預設值: None
expiry	datetime 或 str 共用存取簽章變成不正確時間。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。 Azure 一律會將值轉換成 UTC。 如果在沒有時區資訊的情況下傳入日期，則會假設為 UTC。 預設值: None
start	datetime 或 str 共用存取簽章生效的時間。 如果省略，此呼叫的開始時間會假設為儲存體服務收到要求的時間。 Azure 一律會將值轉換成 UTC。 如果在沒有時區資訊的情況下傳入日期，則會假設為 UTC。 預設值: None
id	str 長度上限為 64 個字元的唯一值，與預存存取原則相互關聯。 若要建立預存存取原則，請使用 set_file_service_properties。 預設值: None
ip	str 指定要接受要求的 IP 位址或 IP 位址範圍。 如果要求的來源 IP 位址不符合 SAS 權杖上指定的 IP 位址或位址範圍，則不會驗證要求。 例如，在 SAS 上指定 sip=168.1.5.65 或 sip=168.1.5.60-168.1.5.70 會限制這些 IP 位址的要求。 預設值: None
protocol	str 指定要求允許的通訊協定。 可能的值為 HTTPS 和 HTTP (HTTPs、HTTP) 或 HTTPS，只會 (HTTPs) 。 預設值為 HTTPs，HTTP。 請注意，僅 HTTP 是不允許的值。 預設值: None
cache_control	str 當使用此共用存取簽章存取資源時，Cache-Control 的回應標頭值。 預設值: None
content_disposition	str 當使用此共用存取簽章存取資源時，Content-Disposition 的回應標頭值。 預設值: None
content_encoding	str 當使用此共用存取簽章存取資源時，Content-Encoding 的回應標頭值。 預設值: None
content_language	str 當使用此共用存取簽章存取資源時，Content-Language 的回應標頭值。 預設值: None
content_type	str 當使用此共用存取簽章存取資源時，Content-Type 的回應標頭值。 預設值: None

傳回

類型	Description
str	共用存取簽章 (sas) 權杖。

generate_share_shared_access_signature

產生共用的共用存取簽章。 使用傳回的簽章搭配 FileService 的 sas_token 參數。

generate_share_shared_access_signature(share_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

參數

名稱	Description
share_name 必要	str 共用的名稱。
permission	SharePermissions 這些權限與共用存取簽章相關聯。 使用者只能執行這些權限允許的作業。 許可權必須排序為讀取、建立、寫入、刪除、清單。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。 預設值: None
expiry	datetime 或 str 共用存取簽章變成不正確時間。 除非指定參考包含此欄位之預存存取原則的識別碼，否則為必要專案。 如果已在相關聯的預存存取原則中指定，則必須省略此欄位。 Azure 一律會將值轉換為 UTC。 如果在沒有時區資訊的情況下傳入日期，則會假設為 UTC。 預設值: None
start	datetime 或 str 共用存取簽章生效的時間。 如果省略，此呼叫的開始時間會假設為儲存體服務收到要求的時間。 Azure 一律會將值轉換為 UTC。 如果在沒有時區資訊的情況下傳入日期，則會假設為 UTC。 預設值: None
id	str 長度上限為 64 個字元的唯一值，與預存存取原則相互關聯。 若要建立預存存取原則，請使用 set_share_acl 。 預設值: None
ip	str 指定要接受要求的 IP 位址或 IP 位址範圍。 如果要求的來源 IP 位址不符合 SAS 權杖上指定的 IP 位址或位址範圍，則不會驗證要求。 例如，在 SAS 上指定 sip=168.1.5.65 或 sip=168.1.5.60-168.1.5.70 會將要求限制為這些 IP 位址。 預設值: None
protocol	str 指定所提出要求的允許通訊協定。 可能的值為 HTTPS 和 HTTP (HTTPs、HTTP) 或 HTTPS，只會 (HTTPs) 。 預設值為 HTTPs，HTTP。 請注意，僅 HTTP 是不允許的值。 預設值: None
cache_control	str 使用這個共用存取簽章存取資源時，Cache-Control 的回應標頭值。 預設值: None
content_disposition	str 使用這個共用存取簽章存取資源時，Content-Disposition 的回應標頭值。 預設值: None
content_encoding	str 使用這個共用存取簽章存取資源時，Content-Encoding 的回應標頭值。 預設值: None
content_language	str 使用這個共用存取簽章存取資源時，Content-Language 的回應標頭值。 預設值: None
content_type	str 使用這個共用存取簽章存取資源時，Content-Type 的回應標頭值。 預設值: None

傳回

類型	Description
str	共用存取簽章 (sas) 權杖。

get_directory_metadata

傳回指定目錄的所有使用者定義中繼資料。

get_directory_metadata(share_name, directory_name, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
timeout	int timeout 參數以秒為單位。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None

傳回

類型	Description
dict(str, str)	字典，表示目錄中繼資料名稱、值組。

get_directory_properties

傳回指定目錄的所有使用者定義中繼資料和系統屬性。 傳回的資料不包含目錄的檔案清單。

get_directory_properties(share_name, directory_name, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 現有目錄的路徑。
timeout	int timeout 參數以秒為單位。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None

傳回

類型	Description
Directory	目錄物件內指定目錄的屬性。

get_file_metadata

傳回指定檔案的所有使用者定義中繼資料。

get_file_metadata(share_name, directory_name, file_name, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
timeout	int timeout 參數以秒為單位。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None

傳回

類型	Description
dict(str, str)	字典，表示檔案中繼資料名稱、值組。

get_file_properties

傳回檔案的所有使用者定義中繼資料、標準 HTTP 屬性和系統屬性。 使用 和 中繼資料聽寫傳回 的 FileFileProperties 實例。

get_file_properties(share_name, directory_name, file_name, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
timeout	int timeout 參數以秒為單位。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None

傳回

類型	Description
File	檔案物件，包括屬性和中繼資料。

get_file_service_properties

取得儲存體帳戶檔案服務的屬性，包括 Azure 儲存體分析。

get_file_service_properties(timeout=None)

參數

名稱	Description
timeout	int timeout 參數以秒為單位。 預設值: None

傳回

類型	Description
ServiceProperties	檔案服務屬性。

get_file_to_bytes

使用自動區塊化和進度通知，將檔案下載為位元組陣列。 傳回 具有屬性、中繼資料和內容的 實例 File 。

get_file_to_bytes(share_name, directory_name, file_name, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
start_range	int 要用來下載檔案區段的位元組範圍開始。 如果未指定任何end_range，則會下載start_range之後的所有位元組。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
end_range	int 要用於下載檔案區段的位元組範圍結尾。 如果提供end_range，則必須提供start_range。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
validate_content	bool 如果設定為 true，則會針對檔案的每個擷取部分驗證 MD5 雜湊。 如果使用 HTTP 而非 HTTPs 作為 HTTPs，則這主要對於偵測連線上的 bitflip 很有用， (預設) 將已經過驗證。 請注意，服務只會針對區塊 4MB 或更少傳回交易式 MD5，因此第一個取得要求的大小會是自我。MAX_CHUNK_GET_SIZE而非自我。MAX_SINGLE_GET_SIZE。 如果為 self。MAX_CHUNK_GET_SIZE設定為大於 4 MB，將會擲回錯誤。 由於區塊大小降低，因此計算 MD5 需要處理時間，而且需要完成更多要求，延遲可能會增加一些。 預設值: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 簽章函式的進度回呼 (目前、目前) 目前傳輸的位元組數目，而總計是已知檔案的大小。 預設值: None
max_connections	int 如果設定為 2 或更新版本，則會針對第一個自我完成初始取得。MAX_SINGLE_GET_SIZE個檔案的位元組。 如果這是整個檔案，則此時會傳回 方法。 如果沒有，則會使用等於max_connections的執行緒數目，下載剩餘的資料平行。 每個區塊的大小都會是自我。MAX_CHUNK_GET_SIZE。 如果設定為 1，將會完成單一大型 get 要求。 這通常不建議使用，但如果應該使用非常少的執行緒、網路要求非常昂貴，或無法搜尋的資料流程會防止平行下載。 如果同時修改檔案以強制執行不可部分完成性，或如果許多檔案預期為空白，如果max_connections大於 1，則需要額外的要求，這也可能很實用。 預設值: 2
timeout	int timeout 參數以秒為單位。 這個方法可能會對 Azure 服務進行多個呼叫，而逾時會個別套用至每個呼叫。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None

傳回

類型	Description
File	具有屬性、內容和中繼資料的檔案。

get_file_to_path

使用自動區塊處理和進度通知，將檔案下載至檔案路徑。 傳回具有屬性和中繼資料的 File 實例。

get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
file_path 必要	str 要寫入的檔案路徑。
open_mode	str 開啟檔案時要使用的模式。 請注意，只指定附加open_mode可防止平行下載。 因此，如果使用這個open_mode，max_connections必須設定為 1。 預設值: wb
start_range	int 要用來下載檔案區段的位元組範圍開始。 如果未指定end_range，則會下載start_range之後的所有位元組。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
end_range	int 要用於下載檔案區段的位元組範圍結束。 如果提供end_range，則必須提供start_range。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
validate_content	bool 如果設定為 true，請針對檔案的每個擷取部分驗證 MD5 雜湊。 如果使用 HTTP 而非 HTTPs 作為 HTTPs， (預設) 已驗證，這主要對於偵測線路上的 bitflip 相當重要。 請注意，服務只會針對區塊 4MB 或更少傳回交易式 MD5，因此第一個取得要求的大小會是自我。MAX_CHUNK_GET_SIZE而不是自我。MAX_SINGLE_GET_SIZE。 如果為 self。MAX_CHUNK_GET_SIZE設定為大於 4MB，將會擲回錯誤。 當計算 MD5 需要處理時間，而且由於區塊大小降低而需要完成更多要求時，可能會有一些延遲增加。 預設值: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 簽章函式的進度回呼 (目前、目前) 是目前傳輸的位元組數目，而且已知時總計是檔案的大小。 預設值: None
max_connections	int 如果設定為 2 或更新版本，則會針對第一個自我完成初始取得。MAX_SINGLE_GET_SIZE檔案的位元組。 如果這是整個檔案，則方法會在此時傳回。 如果沒有，則會使用等於max_connections的執行緒數目，來下載剩餘的資料平行。 每個區塊的大小都會是自我。MAX_CHUNK_GET_SIZE。 如果設定為 1，將會完成單一大型 get 要求。 這通常不建議使用，但如果應該使用非常少的執行緒、網路要求非常昂貴，或無法搜尋的資料流程會防止平行下載。 如果同時修改檔案以強制執行不可部分完成性，或如果許多檔案預期為空白，如果max_connections大於 1，則此檔案也可能很重要。 預設值: 2
timeout	int timeout 參數以秒為單位。 這個方法可能會對 Azure 服務進行多個呼叫，而逾時會個別套用至每個呼叫。 預設值: None
snapshot	str 表示快照集版本的字串，如果適用的話。 預設值: None

傳回

類型	Description
File	具有屬性和中繼資料的檔案。

get_file_to_stream

使用自動區塊處理和進度通知，將檔案下載至資料流程。 傳回 具有屬性和中繼資料的 File 實例。

get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
stream 必要	IOBase 開啟要寫入的檔案/資料流程。
start_range	int 要用於下載檔案區段的位元組範圍開始。 如果未指定end_range，則會下載start_range之後的所有位元組。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
end_range	int 要用於下載檔案區段的位元組範圍結束。 如果提供end_range，則必須提供start_range。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
validate_content	bool 如果設定為 true，請針對檔案的每個擷取部分驗證 MD5 雜湊。 如果使用 HTTP 而非 HTTPs 作為 HTTPs， (預設) 已驗證，這主要對於偵測線路上的 bitflip 相當重要。 請注意，服務只會針對區塊 4MB 或更少傳回交易式 MD5，因此第一個取得要求的大小會是自我。MAX_CHUNK_GET_SIZE而不是自我。MAX_SINGLE_GET_SIZE。 如果為 self。MAX_CHUNK_GET_SIZE設定為大於 4MB，將會擲回錯誤。 當計算 MD5 需要處理時間，而且由於區塊大小降低而需要完成更多要求時，可能會有一些延遲增加。 預設值: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 簽章函式的進度回呼 (目前、目前) 是目前傳輸的位元組數目，而且已知時總計是檔案的大小。 預設值: None
max_connections	int 如果設定為 2 或更新版本，則會針對第一個自我完成初始取得。MAX_SINGLE_GET_SIZE檔案的位元組。 如果這是整個檔案，則方法會在此時傳回。 如果沒有，則會使用等於max_connections的執行緒數目，來下載剩餘的資料平行。 每個區塊的大小都會是自我。MAX_CHUNK_GET_SIZE。 如果設定為 1，將會完成單一大型 get 要求。 這通常不建議使用，但如果應該使用非常少的執行緒、網路要求非常昂貴，或無法搜尋的資料流程會防止平行下載。 如果同時修改檔案以強制執行不可部分完成性，或如果許多檔案預期為空白，如果max_connections大於 1，則此檔案也可能很重要。 預設值: 2
timeout	int timeout 參數以秒為單位。 這個方法可能會對 Azure 服務進行多個呼叫，而逾時會個別套用至每個呼叫。 預設值: None
snapshot	str 表示快照集版本的字串，如果適用的話。 預設值: None

傳回

類型	Description
File	具有屬性和中繼資料的檔案。

get_file_to_text

使用自動區塊處理和進度通知，將檔案下載為 unicode 文字。 傳回 具有屬性、中繼資料和內容的 實例 File 。

get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
encoding	str 解碼檔案資料時要使用的 Python 編碼方式。 預設值: utf-8
start_range	int 要用於下載檔案區段的位元組範圍開始。 如果未指定end_range，則會下載start_range之後的所有位元組。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
end_range	int 要用於下載檔案區段的位元組範圍結束。 如果提供end_range，則必須提供start_range。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
validate_content	bool 如果設定為 true，請針對檔案的每個擷取部分驗證 MD5 雜湊。 如果使用 HTTP 而非 HTTPs 作為 HTTPs， (預設) 已驗證，這主要對於偵測線路上的 bitflip 相當重要。 請注意，服務只會針對區塊 4MB 或更少傳回交易式 MD5，因此第一個取得要求的大小會是自我。MAX_CHUNK_GET_SIZE而不是自我。MAX_SINGLE_GET_SIZE。 如果為 self。MAX_CHUNK_GET_SIZE設定為大於 4MB，將會擲回錯誤。 當計算 MD5 需要處理時間，而且由於區塊大小降低而需要完成更多要求時，可能會有一些延遲增加。 預設值: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 簽章函式的進度回呼 (目前、目前) 是目前傳輸的位元組數目，而且已知時總計是檔案的大小。 預設值: None
max_connections	int 如果設定為 2 或更新版本，則會針對第一個自我完成初始取得。MAX_SINGLE_GET_SIZE檔案的位元組。 如果這是整個檔案，則方法會在此時傳回。 如果沒有，則會使用等於max_connections的執行緒數目，來下載剩餘的資料平行。 每個區塊的大小都會是自我。MAX_CHUNK_GET_SIZE。 如果設定為 1，將會完成單一大型 get 要求。 這通常不建議使用，但如果應該使用非常少的執行緒、網路要求非常昂貴，或無法搜尋的資料流程會防止平行下載。 如果同時修改檔案以強制執行不可部分完成性，或如果許多檔案預期為空白，如果max_connections大於 1，則此檔案也可能很重要。 預設值: 2
timeout	int timeout 參數以秒為單位。 這個方法可能會對 Azure 服務進行多個呼叫，而逾時會個別套用至每個呼叫。 預設值: None
snapshot	str 表示快照集版本的字串，如果適用的話。 預設值: None

傳回

類型	Description
File	具有屬性、內容和中繼資料的檔案。

get_permission_for_share

在共用層級建立安全性描述元 (許可權) 。 這個「許可權」可用於共用中的檔案/目錄。 如果 'permission' 已經存在，它應該傳回它的金鑰，否則會在共用層級建立新的許可權，並傳回其金鑰。

：傳回可攜式 SDDL) ：rtype str (檔案許可權

get_permission_for_share(share_name, file_permission_key, timeout=None)

參數

名稱	Description
share_name 必要	共用的名稱。
file_permission_key 必要	要擷取之檔案許可權的索引鍵
timeout	timeout 參數以秒為單位。 預設值: None

get_share_acl

取得指定共用的許可權。

get_share_acl(share_name, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
timeout	int timeout 參數以秒為單位。 預設值: None

傳回

類型	Description
dict(str, AccessPolicy)	與共享相關聯的存取原則字典。

get_share_metadata

傳回指定共用的所有使用者定義中繼資料。

get_share_metadata(share_name, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
timeout	int timeout 參數以秒為單位。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None

傳回

類型	Description
dict(str, str)	字典，表示共用中繼資料名稱、值組。

get_share_properties

傳回指定共用的所有使用者定義中繼資料和系統屬性。 傳回的資料不包含共用的檔案或目錄清單。

get_share_properties(share_name, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
timeout	int timeout 參數以秒為單位。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None

傳回

類型	Description
Share	公開屬性和中繼資料的共用。

get_share_stats

取得儲存在共用上的大約資料大小，四捨五入為最接近的 GB。

請注意，此值可能不會包含最近建立或最近重新調整大小的檔案。

get_share_stats(share_name, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
timeout	int timeout 參數以秒為單位。 預設值: None

傳回

類型	Description
int	儲存在共用上的大約資料大小。

get_share_stats_in_bytes

取得儲存在共用上之資料的近似大小，以位元組為單位。

請注意，此值可能不會包含最近建立或最近重新調整大小的檔案。

get_share_stats_in_bytes(share_name, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
timeout	int timeout 參數以秒為單位。 預設值: None

傳回

類型	Description
int	儲存在共用上的大約資料大小。

list_directories_and_files

傳回產生器，以列出指定共用下的目錄和檔案。 產生器會延遲遵循服務所傳回的接續權杖，並在到達所有目錄和檔案或num_results時停止。

如果指定了num_results，且共用的檔案和目錄數目超過該數目，則產生器會在完成之後填入next_marker欄位。 如果需要更多結果，此標記可用來建立新的產生器。

list_directories_and_files(share_name, directory_name=None, num_results=None, marker=None, timeout=None, prefix=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name	str 目錄的路徑。 預設值: None
num_results	int 指定要傳回的檔案數目上限，包括所有目錄專案。 如果要求未指定num_results或指定大於 5,000 的值，則伺服器最多會傳回 5,000 個專案。 將num_results設定為小於或等於零的值會導致錯誤回應碼 400 (不正確的要求) 。 預設值: None
marker	str 不透明的接續權杖。 如果指定num_results且該產生器已完成列舉結果，則可以從先前產生器物件的next_marker欄位擷取此值。 如果指定，這個產生器會從先前產生器停止的點開始傳回結果。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None
prefix	str 只列出具有指定前置詞的檔案和/或目錄。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None

list_handles

傳回產生器，以列出目錄或指定共用下檔案上開啟的控制碼。 產生器會延遲追蹤服務所傳回的接續權杖，並在到達所有控制碼或num_results時停止。

如果指定了num_results，且共用的檔案和目錄數目超過該數目，則產生器會在完成之後填入next_marker欄位。 如果需要更多結果，此標記可用來建立新的產生器。

list_handles(share_name, directory_name=None, file_name=None, recursive=None, max_results=None, marker=None, snapshot=None, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name	str 目錄的路徑。 預設值: None
file_name	str 現有檔案的名稱。 預設值: None
recursive	bool 布林值，指定作業是否應該套用至 URI、其檔案、其子目錄及其檔案中指定的目錄。 預設值: None
max_results	int 指定要傳回之檔案和/或目錄的控制碼數目上限。 如果要求未指定max_results或指定大於 5,000 的值，則伺服器最多會傳回 5,000 個專案。 將max_results設定為小於或等於零的值會導致錯誤回應碼 400 (不正確的要求) 。 預設值: None
marker	str 不透明的接續權杖。 如果指定max_results且該產生器已完成列舉結果，則可以從先前產生器物件的next_marker欄位擷取此值。 如果指定，這個產生器會從先前產生器停止的點開始傳回結果。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None

list_ranges

擷取檔案的有效範圍。

list_ranges(share_name, directory_name, file_name, start_range=None, end_range=None, timeout=None, snapshot=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
start_range	int 指定要列出範圍的位元組開始位移。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
end_range	int 指定要列出範圍的位元組結束位移。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None
snapshot	str 如果適用，表示快照集版本的字串。 預設值: None

傳回

類型	Description
<xref:a> list <xref:of> FileRange	有效範圍的清單

list_shares

傳回產生器，以列出指定帳戶下的共用。 產生器會延遲遵循服務傳回的接續權杖，並在到達所有共用或num_results時停止。

如果指定了num_results，且帳戶的共用數目超過該數目，則產生器會在完成之後，填入next_marker欄位。 如果需要更多結果，此標記可用來建立新的產生器。

list_shares(prefix=None, marker=None, num_results=None, include_metadata=False, timeout=None, include_snapshots=False)

參數

名稱	Description
prefix	str 篩選結果，只傳回名稱開頭為指定前置詞的共用。 預設值: None
num_results	int 指定要傳回的最大共用數目。 預設值: None
include_metadata	bool 指定在回應中傳回共用中繼資料。 預設值: False
marker	str 不透明的接續權杖。 如果指定num_results且該產生器已完成列舉結果，則可以從先前產生器物件的next_marker欄位擷取此值。 如果指定，這個產生器會從先前產生器停止的點開始傳回結果。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None
include_snapshots	bool 指定在回應中傳回共用快照集。 預設值: False

make_file_url

建立 URL 以存取檔案。

make_file_url(share_name, directory_name, file_name, protocol=None, sas_token=None)

參數

名稱	Description
share_name 必要	str 共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 檔案名。
protocol	str 要使用的通訊協定：'HTTP' 或 'HTTPs'。 如果未指定，請使用初始化 FileService 時指定的通訊協定。 預設值: None
sas_token	str 使用 generate_shared_access_signature 建立的共用存取簽章權杖。 預設值: None

傳回

類型	Description
str	檔案存取 URL。

resize_file

將檔案調整為指定的大小。 如果指定的位元組值小於檔案目前的大小，則會清除大於指定位元組值的所有範圍。

resize_file(share_name, directory_name, file_name, content_length, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
content_length 必要	int 要調整檔案大小所要調整的長度。
timeout	int timeout 參數以秒為單位。 預設值: None

set_directory_metadata

設定指定目錄的一或多個使用者定義名稱/值組。 每次呼叫這項作業都會取代附加至目錄的所有現存中繼資料。 若要從目錄中移除所有中繼資料，請呼叫此作業，而不使用中繼資料聽寫。

set_directory_metadata(share_name, directory_name, metadata=None, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
metadata	dict(str, str)<xref:./> 包含名稱/值組的聽寫，與目錄產生關聯做為中繼資料。 範例：{'category'：'test'} 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None

set_directory_properties

set_directory_properties(share_name, directory_name, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

參數

名稱	Description
share_name 必要	共用的名稱
directory_name 必要	目錄的名稱
file_permission	str 檔案許可權，可攜式 SDDL 預設值: None
smb_properties	SMBProperties 設定 SMB 相關的檔案屬性
timeout	int timeout 參數以秒為單位。 預設值: None

set_file_metadata

將指定檔案的使用者定義中繼資料設定為一或多個名稱/值組。

set_file_metadata(share_name, directory_name, file_name, metadata=None, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
metadata	dict(str, str) 包含名稱和值組的聽寫。 每次呼叫這項作業都會取代附加至檔案的所有現有中繼資料。 若要從檔案中移除所有中繼資料，請呼叫這項作業，並且不使用中繼資料標頭。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None

set_file_properties

設定檔案上的系統屬性。 如果已針對content_settings設定一個屬性，則會覆寫所有屬性。

set_file_properties(share_name, directory_name, file_name, content_settings, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
content_settings 必要	ContentSettings 用來設定檔案屬性的 ContentSettings 物件。
file_permission	str 檔案許可權，可攜式 SDDL 預設值: None
smb_properties	SMBProperties 設定 SMB 相關的檔案屬性
timeout	int timeout 參數以秒為單位。 預設值: None

set_file_service_properties

設定儲存體帳戶檔案服務的屬性，包括 Azure 儲存體分析。 如果 (ex HourMetrics) 的專案保留為 None，則會保留該服務上的現有設定。

set_file_service_properties(hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

參數

名稱	Description
hour_metrics	<xref:Metrics> 小時計量設定會提供依 API 分組的要求統計資料摘要，以每小時匯總檔案。 預設值: None
minute_metrics	<xref:Metrics> 分鐘計量設定會針對檔案的每個分鐘提供要求統計資料。 預設值: None
cors	list(CorsRule) 您可以在清單中包含最多五個 CorsRule 元素。 如果指定了空白清單，則會刪除所有 CORS 規則，且服務會停用 CORS。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None

set_proxy

設定 HTTP CONNECT Tunnelling 的 Proxy 伺服器主機和埠。

set_proxy(host, port, user=None, password=None)

參數

名稱	Description
host 必要	str Proxy 的位址。 例如：'192.168.0.100'
port 必要	int Proxy 的埠。 例如：6000
user	str Proxy 授權的使用者。 預設值: None
password	str Proxy 授權的密碼。 預設值: None

set_share_acl

設定可搭配共用存取簽章使用的指定共用或預存存取原則的許可權。

set_share_acl(share_name, signed_identifiers=None, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
signed_identifiers	dict(str, AccessPolicy) 要與共享建立關聯的存取原則字典。 字典最多可以包含 5 個元素。 空的字典會清除服務上設定的存取原則。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None

set_share_metadata

為指定的共用設定一或多個使用者定義的名稱/值組。 每次呼叫這項作業都會取代附加至共用的所有現存中繼資料。 若要從共用中移除所有中繼資料，請呼叫沒有中繼資料聽寫的這項作業。

set_share_metadata(share_name, metadata=None, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
metadata	dict(str, str) 包含要與共享建立關聯做為中繼資料之名稱/值組的聽寫。 範例： {'category'：'test'} 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None

set_share_properties

設定指定共用的服務定義屬性。

set_share_properties(share_name, quota, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
quota 必要	int 指定共用的大小上限 (以 GB 為單位)。 必須大於 0，且小於或等於 5 TB (5120 GB) 。
timeout	int timeout 參數以秒為單位。 預設值: None

snapshot_share

在指定的帳號下建立現有共用的快照集。

snapshot_share(share_name, metadata=None, quota=None, timeout=None)

參數

名稱	Description
share_name 必要	str 要建立快照集的共用名稱稱。
metadata	<xref:<xref:a dict> of <xref:str to str:>> 具有name_value組的聽寫，與共享建立關聯為中繼資料。 範例：{'Category'：'test'} 預設值: None
quota	int 指定共用的大小上限 (以 GB 為單位)。 必須大於 0 且小於或等於 5TB (5120)。 預設值: None
timeout	int timeout 參數以秒為單位。 預設值: None

傳回

類型	Description
Share	快照集屬性

update_range

將要求本文指定的位元組寫入指定的範圍。

update_range(share_name, directory_name, file_name, data, start_range, end_range, validate_content=False, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
data 必要	bytes 範圍的內容。
start_range 必要	int 要用於更新檔案區段的位元組範圍開始。 此範圍的大小上限為 4 MB。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。
end_range 必要	int 要用於更新檔案區段的位元組範圍結束。 此範圍的大小上限為 4 MB。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。
validate_content	bool 如果為 true，則計算頁面內容的 MD5 雜湊。 儲存體服務會檢查已使用已傳送之雜湊抵達的內容雜湊。 如果使用 HTTP 而非 HTTPs 作為 HTTPs， (預設) 已驗證，這主要對於偵測線路上的 bitflip 相當重要。 請注意，這個 MD5 雜湊不會與檔案一起儲存。 預設值: False
timeout	int timeout 參數以秒為單位。 預設值: None

update_range_from_file_url

將位元組從一個 Azure 檔案端點寫入另一個 Azure 檔案端點的指定範圍。

update_range_from_file_url(share_name, directory_name, file_name, start_range, end_range, source, source_start_range, timeout=None)

參數

名稱	Description
share_name 必要	str 現有共用的名稱。
directory_name 必要	str 目錄的路徑。
file_name 必要	str 現有檔案的名稱。
start_range 必要	int 要用於更新檔案區段的位元組範圍開始。 此範圍的大小上限為 4 MB。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。
end_range 必要	int 要用於更新檔案區段的位元組範圍結束。 此範圍的大小上限為 4 MB。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。
source 必要	str 長度上限為 2 KB 的 URL，指定 Azure 檔案或 Blob。 此值應該像出現在要求 URI 中一樣以 URL 編碼。 如果來源位於另一個帳戶中，則來源必須是公用，或必須透過共用存取簽章進行驗證。 如果來源是公用的，則不需要驗證。 範例：https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
source_start_range 必要	int 要用於更新檔案區段的位元組範圍開始。 此範圍的大小上限為 4 MB。 start_range和end_range參數皆包含。 例如：start_range=0，end_range=511 會下載前 512 個位元組的檔案。
timeout	int timeout 參數以秒為單位。 預設值: None

屬性

protocol

request_session

socket_timeout

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 8388608

MAX_RANGE_SIZE

MAX_RANGE_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432