通过

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

ResourceGroupsOperations 类

  • 参考

警告

请勿直接实例化此类。

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

ResourceManagementClient's

<xref:resource_groups> 属性。

继承
builtins.object
ResourceGroupsOperations

构造函数

ResourceGroupsOperations(*args, **kwargs)

方法

begin_delete

删除资源组。

删除资源组时，其所有资源也会被删除。 删除资源组会删除其所有模板部署和当前存储的操作。
begin_export_template

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

检查资源组是否存在。
create_or_update

创建或更新资源组。
get

获取资源组。
list

获取订阅的所有资源组。
update

汇报资源组。

可以通过对组地址执行简单的 PATCH 操作来更新资源组。 请求的格式与创建资源组的格式相同。 如果未指定字段，则保留当前值。

begin_delete

删除资源组。

删除资源组时，其所有资源也会被删除。 删除资源组会删除其所有模板部署和当前存储的操作。

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

参数

resource_group_name
str
必需

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

force_deletion_types
str
必需

要强制删除的资源类型。 目前仅支持以下项：forceDeletionTypes=Microsoft.Compute/virtualMachines，Microsoft.Compute/virtualMachineScaleSets。 默认值为 None。

cls
callable

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

continuation_token
str

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

polling
bool 或 PollingMethod

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

polling_interval
int

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

返回

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

返回类型

LROPoller[None]

例外

HttpResponseError

begin_export_template

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

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

参数

resource_group_name
str
必需

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

parameters
ExportTemplateRequest 或 IO
必需

用于导出模板的参数。 是 ExportTemplateRequest 类型或 IO 类型。 必需。

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
bool 或 PollingMethod

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

polling_interval
int

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

返回

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

返回类型

LROPoller[ResourceGroupExportResult]

例外

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

要创建或更新的资源组的名称。 可以包含字母数字、下划线、括号、连字符、句点 (（结尾) 除外）和与允许字符匹配的 Unicode 字符。 必需。

parameters
ResourceGroup 或 IO
必需

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

content_type
str

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

cls
callable

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

返回

ResourceGroup 或 cls 的结果 (响应)

返回类型

ResourceGroup

例外

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

要应用于 operation.：code 的筛选器：
：code：>><<<br>可以按标记名称和值进行筛选。 例如，若要筛选标记名称和值，请使用 $filter=tagName eq 'tag1' 和 tagValue eq 'Value1'。 默认值为 None。

top
int
必需

要返回的结果数。 如果传递 null，则返回所有资源组。 默认值为 None。

cls
callable

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

返回

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

返回类型

ItemPaged[ResourceGroup]

例外

HttpResponseError

update

汇报资源组。

可以通过对组地址执行简单的 PATCH 操作来更新资源组。 请求的格式与创建资源组的格式相同。 如果未指定字段，则保留当前值。

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

参数

resource_group_name
str
必需

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

parameters
ResourceGroupPatchable 或 IO
必需

提供用于更新资源组的参数。 是 ResourceGroupPatchable 类型或 IO 类型。 必需。

content_type
str

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

cls
callable

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

返回

ResourceGroup 或 cls 的结果 (响应)

返回类型

ResourceGroup

例外

HttpResponseError

属性

models 

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