通过

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

ResourceGroupsOperations 类

  • 参考

警告

请勿直接实例化此类。

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

ResourceManagementClient的

<xref:resource_groups> 属性。

继承
builtins.object
ResourceGroupsOperations

构造函数

ResourceGroupsOperations(*args, **kwargs)

方法

begin_delete

删除资源组。
check_existence

检查是否有资源组。
create_or_update

创建资源组。
export_template

将指定的资源组捕获为模板。
get

获取资源组。
list

获取资源组集合。
list_resources

获取订阅下的所有资源。
patch

可以通过对组地址执行简单的 PATCH 操作来更新资源组。 该请求的格式与用于创建资源组的格式相同，但如果未指定某一字段，将转入当前值。

begin_delete

删除资源组。

begin_delete(resource_group_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

要删除的资源组的名称。 此名称不区分大小写。 必需。

cls
callable

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

continuation_token
str

用于从保存状态重启轮询的延续标记。

polling
bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 如果此操作不轮询，则传入 False，或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

check_existence

检查是否有资源组。

check_existence(resource_group_name: str, **kwargs: Any) -> bool

参数

resource_group_name
str
必需

要检查的资源组名称。 此名称不区分大小写。 必需。

cls
callable

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

返回

bool 或 cls 的结果 (响应)

返回类型

bool

例外

HttpResponseError

create_or_update

创建资源组。

create_or_update(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

参数

resource_group_name
str
必需

要创建或更新的资源组的名称。 必需。

parameters
ResourceGroup 或 IO
必需

提供给创建或更新资源组服务操作的参数。 是 ResourceGroup 类型还是 IO 类型。 必需。

content_type
str

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

cls
callable

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

返回

ResourceGroup 或 cls 的结果 (响应)

返回类型

ResourceGroup

例外

HttpResponseError

export_template

将指定的资源组捕获为模板。

export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroupExportResult

参数

resource_group_name
str
必需

要创建或更新的资源组的名称。 必需。

parameters
ExportTemplateRequest 或 IO
必需

提供给导出模板资源组操作的参数。 是 ExportTemplateRequest 类型还是 IO 类型。 必需。

content_type
str

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

cls
callable

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

返回

ResourceGroupExportResult 或 cls 的结果 (响应)

返回类型

ResourceGroupExportResult

例外

HttpResponseError

get

获取资源组。

get(resource_group_name: str, **kwargs: Any) -> ResourceGroup

参数

resource_group_name
str
必需

要获取的资源组名称。 此名称不区分大小写。 必需。

cls
callable

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

返回

ResourceGroup 或 cls 的结果 (响应)

返回类型

ResourceGroup

例外

HttpResponseError

list

获取资源组集合。

list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ResourceGroup]

参数

filter
str
必需

要应用于操作的筛选器。 默认值为 None。

top
int
必需

查询参数。 如果传递了 null，则返回所有资源组。 默认值为 None。

cls
callable

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

返回

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

返回类型

ItemPaged[ResourceGroup]

例外

HttpResponseError

list_resources

获取订阅下的所有资源。

list_resources(resource_group_name: str, filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]

参数

resource_group_name
str
必需

查询参数。 如果传递了 null，则返回所有资源组。 必需。

filter
str
必需

要应用于操作的筛选器。 默认值为 None。

expand
str
必需

要包含在响应中的其他属性的逗号分隔列表。 有效值包括 createdTime、 changedTime 和 provisioningState。 例如，$expand=createdTime,changedTime。 默认值为 None。

top
int
必需

查询参数。 如果传递了 null，则返回所有资源组。 默认值为 None。

cls
callable

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

返回

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

返回类型

ItemPaged[GenericResourceExpanded]

例外

HttpResponseError

patch

可以通过对组地址执行简单的 PATCH 操作来更新资源组。 该请求的格式与用于创建资源组的格式相同，但如果未指定某一字段，将转入当前值。

patch(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

参数

resource_group_name
str
必需

要创建或更新的资源组的名称。 此名称不区分大小写。 必需。

parameters
ResourceGroup 或 IO
必需

提供给更新状态资源组服务操作的参数。 是 ResourceGroup 类型还是 IO 类型。 必需。

content_type
str

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

cls
callable

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

返回

ResourceGroup 或 cls 的结果 (响应)

返回类型

ResourceGroup

例外

HttpResponseError

属性

models 

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