你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
ResourcesOperations 类
- 继承
-
builtins.objectResourcesOperations
构造函数
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 检查资源是否存在。 |
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]
参数
- 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 实例, (响应)
返回类型
例外
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}。 必需。
- 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 实例, (响应)
返回类型
例外
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]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
- continuation_token
- str
用于从保存状态重启轮询的继续标记。
- polling
- bool 或 PollingMethod
默认情况下,轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询,或为个人轮询策略传入你自己的初始化轮询对象。
- polling_interval
- int
如果没有Retry-After标头,则 LRO 操作的两次轮询之间的默认等待时间。
返回
LROPoller 的实例,返回 None 或 cls 的结果 (响应)
返回类型
例外
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}。 必需。
- cls
- callable
将传递直接响应的自定义类型或函数
- continuation_token
- str
用于从保存状态重启轮询的继续标记。
- polling
- bool 或 PollingMethod
默认情况下,轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询,或为个人轮询策略传入你自己的初始化轮询对象。
- polling_interval
- int
如果没有Retry-After标头,则 LRO 操作的两次轮询之间的默认等待时间。
返回
LROPoller 的实例,返回 None 或 cls 的结果 (响应)
返回类型
例外
begin_move_resources
将资源从一个资源组移动到另一个资源组。
要移动的资源必须位于同一源资源组中。 目标资源组可能位于不同的订阅中。 移动资源时,源组和目标组在操作期间都处于锁定状态。 在完成移动之前,将阻止对组执行写入和删除操作。
begin_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
参数
- 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 的结果 (响应)
返回类型
例外
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]
参数
- content_type
- str
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
- continuation_token
- str
用于从保存状态重启轮询的延续标记。
- polling
- bool 或 PollingMethod
默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。
- polling_interval
- int
如果没有Retry-After标头,则 LRO 操作的两次轮询之间的默认等待时间。
返回
LROPoller 的实例,返回 GenericResource 或 cls 的结果 (响应)
返回类型
例外
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}。 必需。
- content_type
- str
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
- continuation_token
- str
用于从保存状态重启轮询的延续标记。
- polling
- bool 或 PollingMethod
默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。
- polling_interval
- int
如果没有Retry-After标头,则 LRO 操作的两次轮询之间的默认等待时间。
返回
LROPoller 的实例,返回 GenericResource 或 cls 的结果 (响应)
返回类型
例外
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]
参数
- content_type
- str
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
- continuation_token
- str
用于从保存状态重启轮询的延续标记。
- polling
- bool 或 PollingMethod
默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。
- polling_interval
- int
如果没有Retry-After标头,则 LRO 操作的两次轮询之间的默认等待时间。
返回
LROPoller 的实例,返回 None 或 cls 的结果 (响应)
返回类型
例外
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
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
bool 或 cls 的结果 (响应)
返回类型
例外
check_existence_by_id
按 ID 检查资源是否存在。
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}。 必需。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
bool 或 cls 的结果 (响应)
返回类型
例外
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
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
GenericResource 或 cls 的结果 (响应)
返回类型
例外
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}。 必需。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
GenericResource 或 cls 的结果 (响应)
返回类型
例外
list
获取订阅中的所有资源。
list(filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]
参数
- filter
- str
要应用于操作的筛选器。: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、plan and plan and plan/publisher 和 plan/name、identity 和 identity/principalId。 默认值为 None。
- expand
- str
要包含在响应中的其他属性的逗号分隔列表。
有效值包括 createdTime
、 changedTime
和 provisioningState
。 例如,$expand=createdTime,changedTime
。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
一个迭代器,如 GenericResourceExpanded 的实例或 cls 的结果 (响应)
返回类型
例外
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]
参数
- filter
- str
要应用于操作的筛选器。: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、plan and plan and plan/publisher 和 plan/name、identity 和 identity/principalId。 默认值为 None。
- expand
- str
要包含在响应中的其他属性的逗号分隔列表。
有效值包括 createdTime
、 changedTime
和 provisioningState
。 例如,$expand=createdTime,changedTime
。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
一个迭代器,如 GenericResourceExpanded 的实例或 cls 的结果 (响应)
返回类型
例外
属性
models
models = <module 'azure.mgmt.resource.resources.v2019_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2019_03_01\\models\\__init__.py'>