通过

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

FileSharesOperations 类

  • 参考

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

StorageManagementClient's

<xref:file_shares> 属性。

继承
builtins.object
FileSharesOperations

构造函数

FileSharesOperations(*args, **kwargs)

方法

create

根据请求正文所述，在指定帐户下创建新共享。 共享资源包括该共享的元数据和属性。 不包括该共享所包含的文件的列表。
delete

删除其帐户下的指定共享。
get

获取指定共享的属性。
lease

租约共享操作建立和管理共享上的锁，以便执行删除操作。 锁的持续时间可以是 15 到 60 秒，也可以是无限期。
list

列出所有共享。
restore

如果启用了共享软删除，请在有效的保留期内还原文件共享。
update

汇报共享请求正文中指定的属性。 不会更改请求中未提及的属性。 如果指定的共享尚不存在，更新将失败。

create

根据请求正文所述，在指定帐户下创建新共享。 共享资源包括该共享的元数据和属性。 不包括该共享所包含的文件的列表。

async 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
必需

可选，用于扩展共享属性中的属性。 有效值为：快照。 应作为带分隔符“，”的字符串传递。 默认值为 None。

content_type
str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

FileShare 或 cls 的结果 (响应)

返回类型

FileShare

例外

HttpResponseError

delete

删除其帐户下的指定共享。

async 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
必需

可选，用于删除快照。 默认值为 None。

include
str
必需

可选。 有效值为：snapshots、leased-snapshots、none。 默认值为 snapshots。 对于“snapshots”，将删除文件共享，包括其所有文件共享快照。 如果文件共享包含租用快照，则删除失败。 对于“leased-snapshots”，将删除文件共享，其中包括其所有文件共享快照 (租用/无租赁) 。 对于“none”，如果文件共享没有共享快照，则会将其删除。 如果文件共享包含 (租用或未发布的) 的任何快照，则删除操作将失败。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

get

获取指定共享的属性。

async 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
必需

可选，用于扩展共享属性中的属性。 有效值为：stats。应作为带分隔符“，”的字符串传递。 默认值为 None。

x_ms_snapshot
str
必需

可选，用于检索快照的属性。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

FileShare 或 cls 的结果 (响应)

返回类型

FileShare

例外

HttpResponseError

lease

租约共享操作建立和管理共享上的锁，以便执行删除操作。 锁的持续时间可以是 15 到 60 秒，也可以是无限期。

async 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
必需

可选。 指定租用快照的快照时间。 默认值为 None。

parameters
LeaseShareRequest 或 IO
必需

租约共享请求正文。 是 LeaseShareRequest 类型或 IO 类型。 默认值为 None。

content_type
str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

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) -> AsyncIterable[FileShareItem]

参数

resource_group_name
str
必需

用户订阅中资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。 必需。

maxpagesize
str
必需

可选。 指定列表中可包含的最大共享数。 默认值为 None。

filter
str
必需

可选。 指定后，仅列出以筛选器开头的共享名称。 默认值为 None。

expand
str
必需

可选，用于扩展共享属性中的属性。 有效值为：deleted、snapshots。 应作为带分隔符“，”的字符串传递。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

迭代器，例如 FileShareItem 的实例或 cls 的结果 (响应)

返回类型

AsyncItemPaged[FileShareItem]

例外

HttpResponseError

restore

如果启用了共享软删除，请在有效的保留期内还原文件共享。

async 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

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

update

汇报共享请求正文中指定的属性。 不会更改请求中未提及的属性。 如果指定的共享尚不存在，更新将失败。

async 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

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

FileShare 或 cls 的结果 (响应)

返回类型

FileShare

例外

HttpResponseError

属性

models 

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