共用方式為

FileSharesOperations 類別

  • 參考

警告

請勿直接具現化此類別。

您應該改為透過 存取下列作業

StorageManagementClient's

<xref:file_shares> 屬性。

繼承
builtins.object
FileSharesOperations

建構函式

FileSharesOperations(*args, **kwargs)

方法

create

依照要求本文所述，在指定的帳號下建立新的共用。 共用資源包含該共用的中繼資料和屬性。 不包含共用中的檔案清單。
delete

刪除其帳戶下的指定共用。
get

取得指定共用的屬性。
lease

租用共用作業會建立和管理共用的鎖定以進行刪除作業。 鎖定持續時間的範圍是 15 到 60 秒，也可以設為無限。
list

列出所有共用。
restore

如果已啟用共用虛刪除，請在有效的保留天內還原檔案共用。
update

更新如要求本文中指定的共用屬性。 要求中未提及的屬性將不會變更。 如果指定的共用不存在，更新就會失敗。

create

依照要求本文所述，在指定的帳號下建立新的共用。 共用資源包含該共用的中繼資料和屬性。 不包含共用中的檔案清單。

create(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, expand: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare

參數

resource_group_name
str
必要

使用者訂用帳戶內的資源組名。 名稱不區分大小寫。 必要。

account_name
str
必要

指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。 必要。

share_name
str
必要

指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱的長度必須介於 3 到 63 個字元之間，而且只能使用數位、小寫字母和虛線 ( 連字號 ) 。 每個虛線 (-) 字元的前後都必須是字母或數字。 必要。

file_share
FileShare 或 IO
必要

要建立之檔案共用的屬性。 這是 FileShare 類型或 IO 類型。 必要。

expand
str
必要

選擇性，用來展開共用屬性內的屬性。 有效值為：快照集。 應該以具有分隔符號 '，' 的字串傳遞。 預設值為 [無]。

content_type
str

本文參數內容類型。 已知值為：'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

FileShare 或 cls 的結果 (回應)

傳回類型

FileShare

例外狀況

HttpResponseError

delete

刪除其帳戶下的指定共用。

delete(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, include: str | None = None, **kwargs: Any) -> None

參數

resource_group_name
str
必要

使用者訂用帳戶內的資源組名。 名稱不區分大小寫。 必要。

account_name
str
必要

指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。 必要。

share_name
str
必要

指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱的長度必須介於 3 到 63 個字元之間，而且只能使用數位、小寫字母和虛線 ( 連字號 ) 。 每個虛線 (-) 字元的前後都必須是字母或數字。 必要。

x_ms_snapshot
str
必要

選擇性，用來刪除快照集。 預設值為 [無]。

include
str
必要

選擇性。 有效值為：快照集、租用快照集、無。 預設值為快照集。 針對「快照集」，檔案共用會遭到刪除，包括其所有檔案共用快照集。 如果檔案共用包含 leased-snapshots，則刪除會失敗。 對於「租用快照集」，檔案共用會被刪除，其中包含其所有檔案共用快照集， (租用/未發行) 。 針對 'none'，如果檔案共用沒有共用快照集，則會刪除檔案共用。 如果檔案共用包含任何快照集 (租用或未發行) ，則刪除會失敗。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

無或 cls (回應的結果)

傳回類型

None

例外狀況

HttpResponseError

get

取得指定共用的屬性。

get(resource_group_name: str, account_name: str, share_name: str, expand: str | None = None, x_ms_snapshot: str | None = None, **kwargs: Any) -> FileShare

參數

resource_group_name
str
必要

使用者訂用帳戶內的資源組名。 名稱不區分大小寫。 必要。

account_name
str
必要

指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。 必要。

share_name
str
必要

指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱的長度必須介於 3 到 63 個字元之間，而且只能使用數位、小寫字母和虛線 ( 連字號 ) 。 每個虛線 (-) 字元的前後都必須是字母或數字。 必要。

expand
str
必要

選擇性，用來展開共用屬性內的屬性。 有效值為：統計資料。應該以具有分隔符號 '，' 的字串傳遞。 預設值為 [無]。

x_ms_snapshot
str
必要

選擇性，用來擷取快照集的屬性。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

FileShare 或 cls 的結果 (回應)

傳回類型

FileShare

例外狀況

HttpResponseError

lease

租用共用作業會建立和管理共用的鎖定以進行刪除作業。 鎖定持續時間的範圍是 15 到 60 秒，也可以設為無限。

lease(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, parameters: _models.LeaseShareRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LeaseShareResponse

參數

resource_group_name
str
必要

使用者訂用帳戶內的資源組名。 名稱不區分大小寫。 必要。

account_name
str
必要

指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。 必要。

share_name
str
必要

指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱的長度必須介於 3 到 63 個字元之間，而且只能使用數位、小寫字母和虛線 ( 連字號 ) 。 每個虛線 (-) 字元的前後都必須是字母或數字。 必要。

x_ms_snapshot
str
必要

選擇性。 指定要租用快照集的快照集時間。 預設值為 [無]。

parameters
LeaseShareRequest 或 IO
必要

租用共用要求本文。 這是 LeaseShareRequest 類型或 IO 類型。 預設值為 [無]。

content_type
str

本文參數內容類型。 已知值為：'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

LeaseShareResponse 或 cls (回應的結果)

傳回類型

LeaseShareResponse

例外狀況

HttpResponseError

list

列出所有共用。

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, expand: str | None = None, **kwargs: Any) -> Iterable[FileShareItem]

參數

resource_group_name
str
必要

使用者訂用帳戶內的資源組名。 名稱不區分大小寫。 必要。

account_name
str
必要

指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。 必要。

maxpagesize
str
必要

選擇性。 指定清單中可包含的共用數目上限。 預設值為 [無]。

filter
str
必要

選擇性。 指定時，只會列出以篩選開頭的共用名稱。 預設值為 [無]。

expand
str
必要

選擇性，用來展開共用屬性內的屬性。 有效值為：已刪除、快照集。 應該以具有分隔符號 '，' 的字串傳遞。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

Iterator，例如 FileShareItem 的實例或 cls (回應的結果)

傳回類型

ItemPaged[FileShareItem]

例外狀況

HttpResponseError

restore

如果已啟用共用虛刪除，請在有效的保留天內還原檔案共用。

restore(resource_group_name: str, account_name: str, share_name: str, deleted_share: _models.DeletedShare, *, content_type: str = 'application/json', **kwargs: Any) -> None

參數

resource_group_name
str
必要

使用者訂用帳戶內的資源組名。 名稱不區分大小寫。 必要。

account_name
str
必要

指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。 必要。

share_name
str
必要

指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱的長度必須介於 3 到 63 個字元之間，而且只能使用數位、小寫字母和虛線 ( 連字號 ) 。 每個虛線 (-) 字元的前後都必須是字母或數字。 必要。

deleted_share
DeletedShare 或 IO
必要

這是 DeletedShare 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為：'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

無或 cls (回應的結果)

傳回類型

None

例外狀況

HttpResponseError

update

更新如要求本文中指定的共用屬性。 要求中未提及的屬性將不會變更。 如果指定的共用不存在，更新就會失敗。

update(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare

參數

resource_group_name
str
必要

使用者訂用帳戶內的資源組名。 名稱不區分大小寫。 必要。

account_name
str
必要

指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。 必要。

share_name
str
必要

指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱的長度必須介於 3 到 63 個字元之間，而且只能使用數位、小寫字母和虛線 ( 連字號 ) 。 每個虛線 (-) 字元的前後都必須是字母或數字。 必要。

file_share
FileShare 或 IO
必要

要更新檔案共用的屬性。 這是 FileShare 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為：'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

FileShare 或 cls 的結果 (回應)

傳回類型

FileShare

例外狀況

HttpResponseError

屬性

models 

models = <module 'azure.mgmt.storage.v2022_05_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2022_05_01\\models\\__init__.py'>