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

ResourcesOperations 类

警告

请勿直接实例化此类。

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

ResourceManagementClient's

<xref:resources> 属性。

继承

builtins.object

ResourcesOperations

构造函数

ResourcesOperations(*args, **kwargs)

方法

begin_create_or_update	创建资源。
begin_create_or_update_by_id	按 ID 创建资源。
begin_delete	删除资源。
begin_delete_by_id	按 ID 删除资源。
begin_move_resources	将资源从一个资源组移到另一个资源组。 要移动的资源必须位于正在使用的源订阅中的同一个源资源组中。 目标资源组可能位于不同的订阅中。 移动资源时，源组和目标组在操作期间均处于锁定状态。 在完成移动之前，将阻止对组执行写入和删除操作。
begin_update	更新资源。
begin_update_by_id	按 ID 汇报资源。
begin_validate_move_resources	验证是否可以将资源从一个资源组移动到另一个资源组。 此操作检查是否可以将指定的资源移动到目标。 要移动的资源必须位于正在使用的源订阅中的同一个源资源组中。 目标资源组可能位于不同的订阅中。 如果验证成功，它将返回 HTTP 响应代码 204 (无内容) 。 如果验证失败，它将返回 HTTP 响应代码 409 (冲突) 并显示错误消息。 检索 Location 标头值中的 URL，检查长时间运行的操作的结果。
check_existence	检查资源是否存在。
check_existence_by_id	按 ID 检查资源是否存在。 此 API 目前仅适用于有限的一组资源提供程序。 如果资源提供程序未实现此 API，ARM 将以 405 响应。 另一种方法是使用 GET API 来检查资源是否存在。
get	获取资源。
get_by_id	按 ID 获取资源。
list	获取订阅中的所有资源。
list_by_resource_group	获取资源组的所有资源。

begin_create_or_update

创建资源。

begin_create_or_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]

参数

resource_group_name

str

必需

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

resource_provider_namespace

str

必需

资源提供程序的命名空间。 必需。

parent_resource_path

str

必需

父资源标识。 必需。

resource_type

str

必需

要创建的资源的资源类型。 必需。

resource_name

str

必需

是要创建的资源的名称。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

parameters

GenericResource 或 IO

必需

用于创建或更新资源的参数。 是 GenericResource 类型或 IO 类型。 必需。

content_type

str

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

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

返回

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

返回类型

LROPoller[GenericResource]

例外

HttpResponseError

begin_create_or_update_by_id

按 ID 创建资源。

begin_create_or_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]

参数

resource_id

str

必需

资源的完全限定 ID，包括资源名称和资源类型。 使用格式/subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

parameters

GenericResource 或 IO

必需

创建或更新资源参数。 是 GenericResource 类型或 IO 类型。 必需。

content_type

str

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

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

返回

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

返回类型

LROPoller[GenericResource]

例外

HttpResponseError

begin_delete

删除资源。

begin_delete(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name

str

必需

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

resource_provider_namespace

str

必需

资源提供程序的命名空间。 必需。

parent_resource_path

str

必需

父资源标识。 必需。

resource_type

str

必需

资源类型。 必需。

resource_name

str

必需

要删除的资源的名称。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

返回

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

返回类型

LROPoller[None]

例外

HttpResponseError

begin_delete_by_id

按 ID 删除资源。

begin_delete_by_id(resource_id: str, api_version: str, **kwargs: Any) -> LROPoller[None]

参数

resource_id

str

必需

资源的完全限定 ID，包括资源名称和资源类型。 使用格式/subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

返回

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

返回类型

LROPoller[None]

例外

HttpResponseError

begin_move_resources

将资源从一个资源组移到另一个资源组。

要移动的资源必须位于正在使用的源订阅中的同一个源资源组中。 目标资源组可能位于不同的订阅中。 移动资源时，源组和目标组在操作期间均处于锁定状态。 在完成移动之前，将阻止对组执行写入和删除操作。

begin_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

source_resource_group_name

str

必需

包含要移动的资源的源订阅中的资源组的名称。 必需。

parameters

ResourcesMoveInfo 或 IO

必需

用于移动资源的参数。 是 ResourcesMoveInfo 类型或 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 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_update

更新资源。

begin_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]

参数

resource_group_name

str

必需

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

resource_provider_namespace

str

必需

资源提供程序的命名空间。 必需。

parent_resource_path

str

必需

父资源标识。 必需。

resource_type

str

必需

要更新的资源的资源类型。 必需。

resource_name

str

必需

要更新的资源的名称。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

parameters

GenericResource 或 IO

必需

用于更新资源的参数。 是 GenericResource 类型或 IO 类型。 必需。

content_type

str

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

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

返回

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

返回类型

LROPoller[GenericResource]

例外

HttpResponseError

begin_update_by_id

按 ID 汇报资源。

begin_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]

参数

resource_id

str

必需

资源的完全限定 ID，包括资源名称和资源类型。 使用格式/subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

parameters

GenericResource 或 IO

必需

更新资源参数。 是 GenericResource 类型或 IO 类型。 必需。

content_type

str

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

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

返回

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

返回类型

LROPoller[GenericResource]

例外

HttpResponseError

begin_validate_move_resources

验证是否可以将资源从一个资源组移动到另一个资源组。

此操作检查是否可以将指定的资源移动到目标。 要移动的资源必须位于正在使用的源订阅中的同一个源资源组中。 目标资源组可能位于不同的订阅中。 如果验证成功，它将返回 HTTP 响应代码 204 (无内容) 。 如果验证失败，它将返回 HTTP 响应代码 409 (冲突) 并显示错误消息。 检索 Location 标头值中的 URL，检查长时间运行的操作的结果。

begin_validate_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

source_resource_group_name

str

必需

包含要验证移动的资源的源订阅中的资源组的名称。 必需。

parameters

ResourcesMoveInfo 或 IO

必需

用于移动资源的参数。 是 ResourcesMoveInfo 类型或 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 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

check_existence

检查资源是否存在。

check_existence(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> bool

参数

resource_group_name

str

必需

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

resource_provider_namespace

str

必需

要检查的资源的资源提供程序。 必需。

parent_resource_path

str

必需

父资源标识。 必需。

resource_type

str

必需

资源类型。 必需。

resource_name

str

必需

要检查资源是否存在的资源的名称。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

cls

callable

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

返回

bool 或 cls 的结果 (响应)

返回类型

bool

例外

HttpResponseError

check_existence_by_id

按 ID 检查资源是否存在。 此 API 目前仅适用于有限的一组资源提供程序。 如果资源提供程序未实现此 API，ARM 将以 405 响应。 另一种方法是使用 GET API 来检查资源是否存在。

check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> bool

参数

resource_id

str

必需

资源的完全限定 ID，包括资源名称和资源类型。 使用格式/subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

cls

callable

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

返回

bool 或 cls 的结果 (响应)

返回类型

bool

例外

HttpResponseError

get

获取资源。

get(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> GenericResource

参数

resource_group_name

str

必需

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

resource_provider_namespace

str

必需

资源提供程序的命名空间。 必需。

parent_resource_path

str

必需

父资源标识。 必需。

resource_type

str

必需

资源的资源类型。 必需。

resource_name

str

必需

要获取的资源名。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

cls

callable

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

返回

GenericResource 或 cls 的结果 (响应)

返回类型

GenericResource

例外

HttpResponseError

get_by_id

按 ID 获取资源。

get_by_id(resource_id: str, api_version: str, **kwargs: Any) -> GenericResource

参数

resource_id

str

必需

资源的完全限定 ID，包括资源名称和资源类型。 使用格式/subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必需。

api_version

str

必需

要用于操作的 API 版本。 必需。

cls

callable

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

返回

GenericResource 或 cls 的结果 (响应)

返回类型

GenericResource

例外

HttpResponseError

list

获取订阅中的所有资源。

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

参数

filter

str

必需

要应用于 operation.：code 的筛选器：
<br>筛选器比较运算符包括eq (等于) ，ne (不等于) ，并且可与以下属性一起使用：location、、resourceTypename、 resourceGroupidentity 、identity/principalId、plan、、 plan/productplan/nameplan/publisherplan/version和 plan/promotionCode.：code：
<br>例如，若要按资源类型进行筛选，请使用 $filter=resourceType eq 'Microsoft.Network/virtualNetworks'```<br>
<br>` `substringof(value, property)` can be used to filter for substrings of the following currently-supported properties: `name` and `resourceGroup
<br>`For example, to get all resources with 'demo' anywhere in the resource name, use $filter=substringof ('demo'，名称) '''
<br>`Multiple substring operations can also be combined using and/`or` operators.:code:*<br>*`<br>`Note that any truncated number of results queried via $top may also not be compatible when using a filter.:code:*<br>*`<br>
Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use ``$filter=tagName eq 'tag1' and tagValue eq 'Value1'``. Note that when resources are filtered by tag name and value, 结果中不会返回每个资源的原始标记。Any list of additional properties queried via$expandmay also not be compatible when filtering by tag names/values.
<br>`For tag names only, resources can be filtered by prefix using the following syntax: $filter=startswith (tagName， 'depart') . This query will return all resources with a tag name prefixed by the phrase `depart` (i.e.`department`, `departureDate`, `departureTime`, etc.):code:*<br>*`<br>
Note that some properties can be combined when filtering resources, which include the following: ``substringof() and/or resourceType``, plan and plan/publisher and plan/name, and identity and identity/principalId'. 默认值为 None。

expand

str

必需

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

top

int

必需

使用此 API 的分页版本时每页的建议数。 默认值为 None。

cls

callable

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

返回

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

返回类型

ItemPaged[GenericResourceExpanded]

例外

HttpResponseError

list_by_resource_group

获取资源组的所有资源。

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

参数

resource_group_name

str

必需

包含要获取的资源的资源组。 必需。

filter

str

必需

要应用于 operation.：code 的筛选器：
<br>可用于 eq (等于) 或 ne (不等于) 的属性包括：location、 resourceType、name、resourceGroup、identity、identity/principalId、plan、plan/publisher、plan/product、plan/name、plan/version 和 plan/promotionCode.：code：<br>``<br>例如，若要按资源类型进行筛选，请使用：$filter=resourceType eq 'Microsoft.Network/virtualNetworks'：code：<br>``<br>可以使用 substringof (值， 筛选器中的属性) 。 可用于子字符串的属性包括：name 和 resourceGroup.：code：<br>``<br>例如，若要获取名称中任意位置带有“demo”的所有资源，请使用：$filter=substringof ('demo'，name) ：code：<br>``<br>可以通过添加和/或运算符将多个子字符串链接在一起。：code：<br>``<br>可以按标记名称和值进行筛选。 例如，若要筛选标记名称和值，请使用 $filter=tagName eq 'tag1' 和 tagValue eq 'Value1'。 按标记名称和值进行筛选时，每个资源的标记不会在结果中返回。：code：<br>：code：>><<<br>可以在筛选时同时使用某些属性。 可以使用的组合包括：substringof 和/或 resourceType、计划和计划/发布者和计划/名称、标识和标识/principalId。 默认值为 None。

expand

str

必需

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

top

int

必需

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

cls

callable

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

返回

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

返回类型

ItemPaged[GenericResourceExpanded]

例外

HttpResponseError

属性

models

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