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

DeploymentsOperations 类

参考

警告

请勿直接实例化此类。

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

ResourceManagementClient的

<xref:deployments> 属性。

继承: builtins.object

DeploymentsOperations

构造函数

DeploymentsOperations(*args, **kwargs)

方法

begin_create_or_update	将资源部署到资源组。可以直接在请求或 JSON 文件链接中提供模板和参数。
begin_create_or_update_at_management_group_scope	在管理组范围内部署资源。可以直接在请求或 JSON 文件链接中提供模板和参数。
begin_create_or_update_at_scope	在给定范围内部署资源。可以直接在请求或 JSON 文件链接中提供模板和参数。
begin_create_or_update_at_subscription_scope	在订阅范围内部署资源。可以直接在请求或 JSON 文件链接中提供模板和参数。
begin_create_or_update_at_tenant_scope	在租户范围内部署资源。可以直接在请求或 JSON 文件链接中提供模板和参数。
begin_delete	从部署历史记录中删除部署。无法删除当前正在运行的模板部署。删除某个模板部署会删除关联的部署操作。删除模板部署不会影响资源组的状态。这是一个异步操作，在成功删除模板部署之前返回状态 202。 Location 响应标头包含用于获取进程状态的 URI。在进程运行时，对 Location 标头中的 URI 的调用将返回状态 202。进程完成后，Location 标头中的 URI 在成功时返回状态 204。如果异步请求失败，Location 标头中的 URI 将返回错误级别状态代码。
begin_delete_at_management_group_scope	从部署历史记录中删除部署。无法删除当前正在运行的模板部署。删除某个模板部署会删除关联的部署操作。这是一个异步操作，在成功删除模板部署之前返回状态 202。 Location 响应标头包含用于获取进程状态的 URI。在进程运行时，对 Location 标头中的 URI 的调用将返回状态 202。进程完成后，Location 标头中的 URI 在成功时返回状态 204。如果异步请求失败，Location 标头中的 URI 将返回错误级别状态代码。
begin_delete_at_scope	从部署历史记录中删除部署。无法删除当前正在运行的模板部署。删除某个模板部署会删除关联的部署操作。这是一个异步操作，在成功删除模板部署之前返回状态 202。 Location 响应标头包含用于获取进程状态的 URI。在进程运行时，对 Location 标头中的 URI 的调用将返回状态 202。进程完成后，Location 标头中的 URI 在成功时返回状态 204。如果异步请求失败，Location 标头中的 URI 将返回错误级别状态代码。
begin_delete_at_subscription_scope	从部署历史记录中删除部署。无法删除当前正在运行的模板部署。删除某个模板部署会删除关联的部署操作。这是一个异步操作，在成功删除模板部署之前返回状态 202。 Location 响应标头包含用于获取进程状态的 URI。在进程运行时，对 Location 标头中的 URI 的调用将返回状态 202。进程完成后，Location 标头中的 URI 在成功时返回状态 204。如果异步请求失败，Location 标头中的 URI 将返回错误级别状态代码。
begin_delete_at_tenant_scope	从部署历史记录中删除部署。无法删除当前正在运行的模板部署。删除某个模板部署会删除关联的部署操作。这是一个异步操作，在成功删除模板部署之前返回状态 202。 Location 响应标头包含用于获取进程状态的 URI。在进程运行时，对 Location 标头中的 URI 的调用将返回状态 202。进程完成后，Location 标头中的 URI 在成功时返回状态 204。如果异步请求失败，Location 标头中的 URI 将返回错误级别状态代码。
begin_validate	验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。
begin_validate_at_management_group_scope	验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。
begin_validate_at_scope	验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。
begin_validate_at_subscription_scope	验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。
begin_validate_at_tenant_scope	验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。
begin_what_if	返回部署在资源组范围内执行的更改。
begin_what_if_at_management_group_scope	返回部署在管理组范围内执行的更改。
begin_what_if_at_subscription_scope	返回部署将在订阅范围内执行的更改。
begin_what_if_at_tenant_scope	返回部署在租户组范围内执行的更改。
calculate_template_hash	计算给定模板的哈希。
cancel	取消当前正在运行的模板部署。仅当 provisioningState 为“已接受”或“正在运行”时，才能取消部署。取消部署后，provisioningState 设置为 Canceled。取消模板部署会停止当前正在运行的模板部署，并将资源组保持为部分部署状态。
cancel_at_management_group_scope	取消当前正在运行的模板部署。仅当 provisioningState 为“已接受”或“正在运行”时，才能取消部署。取消部署后，provisioningState 设置为 Canceled。取消模板部署会停止当前运行的模板部署，并使资源部分部署。
cancel_at_scope	取消当前正在运行的模板部署。仅当 provisioningState 为“已接受”或“正在运行”时，才能取消部署。取消部署后，provisioningState 设置为 Canceled。取消模板部署会停止当前运行的模板部署，并使资源部分部署。
cancel_at_subscription_scope	取消当前正在运行的模板部署。仅当 provisioningState 为“已接受”或“正在运行”时，才能取消部署。取消部署后，provisioningState 设置为 Canceled。取消模板部署会停止当前运行的模板部署，并使资源部分部署。
cancel_at_tenant_scope	取消当前正在运行的模板部署。仅当 provisioningState 为“已接受”或“正在运行”时，才能取消部署。取消部署后，provisioningState 设置为 Canceled。取消模板部署会停止当前运行的模板部署，并使资源部分部署。
check_existence	检查部署是否存在。
check_existence_at_management_group_scope	检查部署是否存在。
check_existence_at_scope	检查部署是否存在。
check_existence_at_subscription_scope	检查部署是否存在。
check_existence_at_tenant_scope	检查部署是否存在。
export_template	导出用于指定部署的模板。
export_template_at_management_group_scope	导出用于指定部署的模板。
export_template_at_scope	导出用于指定部署的模板。
export_template_at_subscription_scope	导出用于指定部署的模板。
export_template_at_tenant_scope	导出用于指定部署的模板。
get	获取部署。
get_at_management_group_scope	获取部署。
get_at_scope	获取部署。
get_at_subscription_scope	获取部署。
get_at_tenant_scope	获取部署。
list_at_management_group_scope	获取管理组的所有部署。
list_at_scope	获取给定范围内的所有部署。
list_at_subscription_scope	获取订阅的所有部署。
list_at_tenant_scope	获取租户范围内的所有部署。
list_by_resource_group	获取资源组的所有部署。

begin_create_or_update

将资源部署到资源组。

可以直接在请求或 JSON 文件链接中提供模板和参数。

begin_create_or_update(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

参数

resource_group_name: str

必需

要向其部署资源的资源组的名称。此名称不区分大小写。此资源组必须已存在。必需。

deployment_name: str

必需

部署的名称。必需。

parameters: Deployment 或 IO

必需

提供给操作的附加参数。部署类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentExtended]

例外

HttpResponseError

begin_create_or_update_at_management_group_scope

在管理组范围内部署资源。

可以直接在请求或 JSON 文件链接中提供模板和参数。

begin_create_or_update_at_management_group_scope(group_id: str, deployment_name: str, parameters: _models.ScopedDeployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

参数

group_id: str

必需

管理组 ID。必需。

deployment_name: str

必需

部署的名称。必需。

parameters: ScopedDeployment 或 IO

必需

提供给操作的附加参数。是 ScopedDeployment 类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentExtended]

例外

HttpResponseError

begin_create_or_update_at_scope

在给定范围内部署资源。

可以直接在请求或 JSON 文件链接中提供模板和参数。

begin_create_or_update_at_scope(scope: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

参数

scope: str

必需

资源范围。必需。

deployment_name: str

必需

部署的名称。必需。

parameters: Deployment 或 IO

必需

提供给操作的附加参数。部署类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentExtended]

例外

HttpResponseError

begin_create_or_update_at_subscription_scope

在订阅范围内部署资源。

可以直接在请求或 JSON 文件链接中提供模板和参数。

begin_create_or_update_at_subscription_scope(deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

参数

deployment_name: str

必需

部署的名称。必需。

parameters: Deployment 或 IO

必需

提供给操作的附加参数。部署类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentExtended]

例外

HttpResponseError

begin_create_or_update_at_tenant_scope

在租户范围内部署资源。

可以直接在请求或 JSON 文件链接中提供模板和参数。

begin_create_or_update_at_tenant_scope(deployment_name: str, parameters: _models.ScopedDeployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

参数

deployment_name: str

必需

部署的名称。必需。

parameters: ScopedDeployment 或 IO

必需

提供给操作的附加参数。是 ScopedDeployment 类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentExtended]

例外

HttpResponseError

begin_delete

从部署历史记录中删除部署。

无法删除当前正在运行的模板部署。删除某个模板部署会删除关联的部署操作。删除模板部署不会影响资源组的状态。这是一个异步操作，在成功删除模板部署之前返回状态 202。 Location 响应标头包含用于获取进程状态的 URI。在进程运行时，对 Location 标头中的 URI 的调用将返回状态 202。进程完成后，Location 标头中的 URI 在成功时返回状态 204。如果异步请求失败，Location 标头中的 URI 将返回错误级别状态代码。

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

参数

resource_group_name: str

必需

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

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[None]

例外

HttpResponseError

begin_delete_at_management_group_scope

从部署历史记录中删除部署。

无法删除当前正在运行的模板部署。删除某个模板部署会删除关联的部署操作。这是一个异步操作，在成功删除模板部署之前返回状态 202。 Location 响应标头包含用于获取进程状态的 URI。在进程运行时，对 Location 标头中的 URI 的调用将返回状态 202。进程完成后，Location 标头中的 URI 在成功时返回状态 204。如果异步请求失败，Location 标头中的 URI 将返回错误级别状态代码。

begin_delete_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> LROPoller[None]

参数

group_id: str

必需

管理组 ID。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[None]

例外

HttpResponseError

begin_delete_at_scope

从部署历史记录中删除部署。

begin_delete_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> LROPoller[None]

参数

scope: str

必需

资源范围。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[None]

例外

HttpResponseError

begin_delete_at_subscription_scope

从部署历史记录中删除部署。

begin_delete_at_subscription_scope(deployment_name: str, **kwargs: Any) -> LROPoller[None]

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[None]

例外

HttpResponseError

begin_delete_at_tenant_scope

从部署历史记录中删除部署。

begin_delete_at_tenant_scope(deployment_name: str, **kwargs: Any) -> LROPoller[None]

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[None]

例外

HttpResponseError

begin_validate

验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。

begin_validate(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentValidateResult]

参数

resource_group_name: str

必需

模板将部署到的资源组的名称。此名称不区分大小写。必需。

deployment_name: str

必需

部署的名称。必需。

parameters: Deployment 或 IO

必需

要验证的参数。是部署类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentValidateResult]

例外

HttpResponseError

begin_validate_at_management_group_scope

验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。

begin_validate_at_management_group_scope(group_id: str, deployment_name: str, parameters: _models.ScopedDeployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentValidateResult]

参数

group_id: str

必需

管理组 ID。必需。

deployment_name: str

必需

部署的名称。必需。

parameters: ScopedDeployment 或 IO

必需

要验证的参数。是 ScopedDeployment 类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentValidateResult]

例外

HttpResponseError

begin_validate_at_scope

验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。

begin_validate_at_scope(scope: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentValidateResult]

参数

scope: str

必需

资源范围。必需。

deployment_name: str

必需

部署的名称。必需。

parameters: Deployment 或 IO

必需

要验证的参数。部署类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentValidateResult]

例外

HttpResponseError

begin_validate_at_subscription_scope

验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。

begin_validate_at_subscription_scope(deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentValidateResult]

参数

deployment_name: str

必需

部署的名称。必需。

parameters: Deployment 或 IO

必需

要验证的参数。部署类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentValidateResult]

例外

HttpResponseError

begin_validate_at_tenant_scope

验证指定的模板在语法上是否正确，以及 Azure 资源管理器是否接受。

begin_validate_at_tenant_scope(deployment_name: str, parameters: _models.ScopedDeployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentValidateResult]

参数

deployment_name: str

必需

部署的名称。必需。

parameters: ScopedDeployment 或 IO

必需

要验证的参数。是 ScopedDeployment 类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[DeploymentValidateResult]

例外

HttpResponseError

begin_what_if

返回部署在资源组范围内执行的更改。

begin_what_if(resource_group_name: str, deployment_name: str, parameters: _models.DeploymentWhatIf, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.WhatIfOperationResult]

参数

resource_group_name: str

必需

模板将部署到的资源组的名称。此名称不区分大小写。必需。

deployment_name: str

必需

部署的名称。必需。

parameters: DeploymentWhatIf 或 IO

必需

要验证的参数。是 DeploymentWhatIf 类型还是 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

LROPoller 的实例，返回 WhatIfOperationResult 或 cls (响应)

返回类型

LROPoller[WhatIfOperationResult]

例外

HttpResponseError

begin_what_if_at_management_group_scope

返回部署在管理组范围内执行的更改。

begin_what_if_at_management_group_scope(group_id: str, deployment_name: str, parameters: _models.ScopedDeploymentWhatIf, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.WhatIfOperationResult]

参数

group_id: str

必需

管理组 ID。必需。

deployment_name: str

必需

部署的名称。必需。

parameters: ScopedDeploymentWhatIf 或 IO

必需

要验证的参数。是 ScopedDeploymentWhatIf 类型还是 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

LROPoller 的实例，返回 WhatIfOperationResult 或 cls (响应)

返回类型

LROPoller[WhatIfOperationResult]

例外

HttpResponseError

begin_what_if_at_subscription_scope

返回部署将在订阅范围内执行的更改。

begin_what_if_at_subscription_scope(deployment_name: str, parameters: _models.DeploymentWhatIf, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.WhatIfOperationResult]

参数

deployment_name: str

必需

部署的名称。必需。

parameters: DeploymentWhatIf 或 IO

必需

What If 的参数。是 DeploymentWhatIf 类型或 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 的实例，返回 WhatIfOperationResult 或 cls (响应)

返回类型

LROPoller[WhatIfOperationResult]

例外

HttpResponseError

begin_what_if_at_tenant_scope

返回部署在租户组范围内执行的更改。

begin_what_if_at_tenant_scope(deployment_name: str, parameters: _models.ScopedDeploymentWhatIf, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.WhatIfOperationResult]

参数

deployment_name: str

必需

部署的名称。必需。

parameters: ScopedDeploymentWhatIf 或 IO

必需

要验证的参数。是 ScopedDeploymentWhatIf 类型或 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 的实例，返回 WhatIfOperationResult 或 cls (响应)

返回类型

LROPoller[WhatIfOperationResult]

例外

HttpResponseError

calculate_template_hash

计算给定模板的哈希。

calculate_template_hash(template: MutableMapping[str, Any], **kwargs: Any) -> TemplateHashResult

参数

template: <xref:JSON>

必需

提供的用于计算哈希的模板。必需。

cls: callable

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

TemplateHashResult 或 cls 的结果 (响应)

返回类型

TemplateHashResult

例外

HttpResponseError

cancel

取消当前正在运行的模板部署。

仅当 provisioningState 为“已接受”或“正在运行”时，才能取消部署。取消部署后，provisioningState 设置为 Canceled。取消模板部署会停止当前正在运行的模板部署，并将资源组保持为部分部署状态。

cancel(resource_group_name: str, deployment_name: str, **kwargs: Any) -> None

参数

resource_group_name: str

必需

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

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

cancel_at_management_group_scope

取消当前正在运行的模板部署。

仅当 provisioningState 为“已接受”或“正在运行”时，才能取消部署。取消部署后，provisioningState 设置为 Canceled。取消模板部署会停止当前运行的模板部署，并使资源部分部署。

cancel_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> None

参数

group_id: str

必需

管理组 ID。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

cancel_at_scope

取消当前正在运行的模板部署。

cancel_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> None

参数

scope: str

必需

资源范围。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

cancel_at_subscription_scope

取消当前正在运行的模板部署。

cancel_at_subscription_scope(deployment_name: str, **kwargs: Any) -> None

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

cancel_at_tenant_scope

取消当前正在运行的模板部署。

cancel_at_tenant_scope(deployment_name: str, **kwargs: Any) -> None

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

check_existence

检查部署是否存在。

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

参数

resource_group_name: str

必需

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

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

bool 或 cls 的结果 (响应)

返回类型

bool

例外

HttpResponseError

check_existence_at_management_group_scope

检查部署是否存在。

check_existence_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> bool

参数

group_id: str

必需

管理组 ID。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

bool 或 cls 的结果 (响应)

返回类型

bool

例外

HttpResponseError

check_existence_at_scope

检查部署是否存在。

check_existence_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> bool

参数

scope: str

必需

资源范围。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

bool 或 cls 的结果 (响应)

返回类型

bool

例外

HttpResponseError

check_existence_at_subscription_scope

检查部署是否存在。

check_existence_at_subscription_scope(deployment_name: str, **kwargs: Any) -> bool

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

bool 或 cls 的结果 (响应)

返回类型

bool

例外

HttpResponseError

check_existence_at_tenant_scope

检查部署是否存在。

check_existence_at_tenant_scope(deployment_name: str, **kwargs: Any) -> bool

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

bool 或 cls 的结果 (响应)

返回类型

bool

例外

HttpResponseError

export_template

导出用于指定部署的模板。

export_template(resource_group_name: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResult

参数

resource_group_name: str

必需

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

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExportResult 或 cls 的结果 (响应)

返回类型

DeploymentExportResult

例外

HttpResponseError

export_template_at_management_group_scope

导出用于指定部署的模板。

export_template_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResult

参数

group_id: str

必需

管理组 ID。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExportResult 或 cls 的结果 (响应)

返回类型

DeploymentExportResult

例外

HttpResponseError

export_template_at_scope

导出用于指定部署的模板。

export_template_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResult

参数

scope: str

必需

资源范围。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExportResult 或 cls 的结果 (响应)

返回类型

DeploymentExportResult

例外

HttpResponseError

export_template_at_subscription_scope

导出用于指定部署的模板。

export_template_at_subscription_scope(deployment_name: str, **kwargs: Any) -> DeploymentExportResult

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExportResult 或 cls 的结果 (响应)

返回类型

DeploymentExportResult

例外

HttpResponseError

export_template_at_tenant_scope

导出用于指定部署的模板。

export_template_at_tenant_scope(deployment_name: str, **kwargs: Any) -> DeploymentExportResult

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExportResult 或 cls 的结果 (响应)

返回类型

DeploymentExportResult

例外

HttpResponseError

get

获取部署。

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

参数

resource_group_name: str

必需

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

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExtended 或 cls 的结果 (响应)

返回类型

DeploymentExtended

例外

HttpResponseError

get_at_management_group_scope

获取部署。

get_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> DeploymentExtended

参数

group_id: str

必需

管理组 ID。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExtended 或 cls 的结果 (响应)

返回类型

DeploymentExtended

例外

HttpResponseError

get_at_scope

获取部署。

get_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> DeploymentExtended

参数

scope: str

必需

资源范围。必需。

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExtended 或 cls 的结果 (响应)

返回类型

DeploymentExtended

例外

HttpResponseError

get_at_subscription_scope

获取部署。

get_at_subscription_scope(deployment_name: str, **kwargs: Any) -> DeploymentExtended

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExtended 或 cls 的结果 (响应)

返回类型

DeploymentExtended

例外

HttpResponseError

get_at_tenant_scope

获取部署。

get_at_tenant_scope(deployment_name: str, **kwargs: Any) -> DeploymentExtended

参数

deployment_name: str

必需

部署的名称。必需。

cls: callable

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

DeploymentExtended 或 cls 的结果 (响应)

返回类型

DeploymentExtended

例外

HttpResponseError

list_at_management_group_scope

获取管理组的所有部署。

list_at_management_group_scope(group_id: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[DeploymentExtended]

参数

group_id: str

必需

管理组 ID。必需。

filter: str

必需

要应用于操作的筛选器。例如，可以使用 $filter=provisioningState eq '{state}'。默认值为 None。

top: int

必需

要获取的结果数。如果传递 null，则返回所有部署。默认值为 None。

cls: callable

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

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

返回类型

ItemPaged[DeploymentExtended]

例外

HttpResponseError

list_at_scope

获取给定范围内的所有部署。

list_at_scope(scope: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[DeploymentExtended]

参数

scope: str

必需

资源范围。必需。

filter: str

必需

要应用于操作的筛选器。例如，可以使用 $filter=provisioningState eq '{state}'。默认值为 None。

top: int

必需

要获取的结果数。如果传递 null，则返回所有部署。默认值为 None。

cls: callable

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

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

返回类型

ItemPaged[DeploymentExtended]

例外

HttpResponseError

list_at_subscription_scope

获取订阅的所有部署。

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

参数

filter: str

必需

要应用于操作的筛选器。例如，可以使用 $filter=provisioningState eq“{state}”。默认值为 None。

top: int

必需

要获取的结果数。如果传递 null，则返回所有部署。默认值为 None。

cls: callable

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

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

返回类型

ItemPaged[DeploymentExtended]

例外

HttpResponseError

list_at_tenant_scope

获取租户范围内的所有部署。

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

参数

filter: str

必需

要应用于操作的筛选器。例如，可以使用 $filter=provisioningState eq“{state}”。默认值为 None。

top: int

必需

要获取的结果数。如果传递 null，则返回所有部署。默认值为 None。

cls: callable

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

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

返回类型

ItemPaged[DeploymentExtended]

例外

HttpResponseError

list_by_resource_group

获取资源组的所有部署。

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

参数

resource_group_name: str

必需

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

filter: str

必需

要应用于操作的筛选器。例如，可以使用 $filter=provisioningState eq“{state}”。默认值为 None。

top: int

必需

要获取的结果数。如果传递 null，则返回所有部署。默认值为 None。

cls: callable

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

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

返回类型

ItemPaged[DeploymentExtended]

例外

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'>