你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

FileShares interface

包:: @azure/arm-storage

表示 FileShares 的接口。

方法

create(string, string, string, FileShare, FileSharesCreateOptionalParams)	根据请求正文所述，在指定帐户下创建新共享。共享资源包括该共享的元数据和属性。它不包括共享包含的文件列表。
delete(string, string, string, FileSharesDeleteOptionalParams)	删除其帐户下的指定共享。
get(string, string, string, FileSharesGetOptionalParams)	获取指定共享的属性。
lease(string, string, string, FileSharesLeaseOptionalParams)	租约共享作建立和管理共享上的锁，以便执行删除作。锁持续时间可以是 15 到 60 秒，也可以是无限的。
list(string, string, FileSharesListOptionalParams)	列出所有共享。
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)	如果启用了共享软删除，在有效的保留期内还原文件共享
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)	更新请求正文中指定的共享属性。请求中未提及的属性不会更改。如果指定的共享尚不存在，更新将失败。

方法详细信息

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

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

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

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

选项参数。

PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>

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

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

fileShare: FileShare

要更新文件共享的属性。

options: FileSharesUpdateOptionalParams

选项参数。

Promise<FileShare>

通过

方法

create(string, string, string, FileShare, FileSharesCreateOptionalParams)

参数

返回

delete(string, string, string, FileSharesDeleteOptionalParams)

参数

返回

get(string, string, string, FileSharesGetOptionalParams)

参数

返回

lease(string, string, string, FileSharesLeaseOptionalParams)

参数

返回

list(string, string, FileSharesListOptionalParams)

参数

返回

restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)

参数

返回

update(string, string, string, FileShare, FileSharesUpdateOptionalParams)

参数

返回