FileShares interface
表示 FileShares 的介面。
方法
| create(string, string, string, File |
依照要求本文所述，在指定的帳號下建立新的共用。 共用資源包含該共用的中繼資料和屬性。 不包含共用中的檔案清單。 |
| delete(string, string, string, File |
刪除其帳戶下的指定共用。 |
| get(string, string, string, File |
取得指定共用的屬性。 |
| lease(string, string, string, File |
租用共用作業會建立和管理共用上的鎖定，以進行刪除作業。 鎖定持續時間的範圍是 15 到 60 秒，也可以設為無限。 |
| list(string, string, File |
列出所有共用。 |
| restore(string, string, string, Deleted |
如果啟用共用虛刪除，請在有效的保留天內還原檔案共用 |
| update(string, string, string, File |
更新要求本文中指定的共用屬性。 要求中未提及的屬性將不會變更。 如果指定的共用不存在，更新就會失敗。 |
方法詳細資料
create(string, string, string, FileShare, FileSharesCreateOptionalParams)
依照要求本文所述，在指定的帳號下建立新的共用。 共用資源包含該共用的中繼資料和屬性。 不包含共用中的檔案清單。
function create(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams): Promise<FileShare>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- shareName
-
string
指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱長度必須介於 3 到 63 個字元之間，且只能使用數位、小寫字母和虛線 () 。 每個虛線 (-) 字元的前後都必須是字母或數字。
- fileShare
- FileShare
要建立之檔案共用的屬性。
- options
- FileSharesCreateOptionalParams
選項參數。
傳回
Promise<FileShare>
delete(string, string, string, FileSharesDeleteOptionalParams)
刪除其帳戶下的指定共用。
function delete(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- shareName
-
string
指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱長度必須介於 3 到 63 個字元之間，且只能使用數位、小寫字母和虛線 () 。 每個虛線 (-) 字元的前後都必須是字母或數字。
- options
- FileSharesDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, FileSharesGetOptionalParams)
取得指定共用的屬性。
function get(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- shareName
-
string
指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱長度必須介於 3 到 63 個字元之間，且只能使用數位、小寫字母和虛線 () 。 每個虛線 (-) 字元的前後都必須是字母或數字。
- options
- FileSharesGetOptionalParams
選項參數。
傳回
Promise<FileShare>
lease(string, string, string, FileSharesLeaseOptionalParams)
租用共用作業會建立和管理共用上的鎖定，以進行刪除作業。 鎖定持續時間的範圍是 15 到 60 秒，也可以設為無限。
function lease(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams): Promise<FileSharesLeaseResponse>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- shareName
-
string
指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱長度必須介於 3 到 63 個字元之間，且只能使用數位、小寫字母和虛線 () 。 每個虛線 (-) 字元的前後都必須是字母或數字。
- options
- FileSharesLeaseOptionalParams
選項參數。
傳回
Promise<FileSharesLeaseResponse>
list(string, string, FileSharesListOptionalParams)
列出所有共用。
function list(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams): PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- options
- FileSharesListOptionalParams
選項參數。
傳回
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)
如果啟用共用虛刪除，請在有效的保留天內還原檔案共用
function restore(resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams): Promise<void>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- shareName
-
string
指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱長度必須介於 3 到 63 個字元之間，且只能使用數位、小寫字母和虛線 () 。 每個虛線 (-) 字元的前後都必須是字母或數字。
- deletedShare
- DeletedShare
要還原的已刪除共用。
- options
- FileSharesRestoreOptionalParams
選項參數。
傳回
Promise<void>
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)
更新要求本文中指定的共用屬性。 要求中未提及的屬性將不會變更。 如果指定的共用不存在，更新就會失敗。
function update(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams): Promise<FileShare>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- shareName
-
string
指定儲存體帳戶內的檔案共用名稱稱。 檔案共用名稱稱長度必須介於 3 到 63 個字元之間，且只能使用數位、小寫字母和虛線 () 。 每個虛線 (-) 字元的前後都必須是字母或數字。
- fileShare
- FileShare
要更新檔案共用的屬性。
- options
- FileSharesUpdateOptionalParams
選項參數。
傳回
Promise<FileShare>