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

Scheduled Actions - Virtual Machines Execute Hibernate

服务:: Compute Schedule

API 版本:: 2025-05-01

VirtualMachinesExecuteHibernate：对一批虚拟机执行休眠操作，计算计划收到该操作后立即触发此操作。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteHibernate?api-version=2025-05-01

URI 参数

名称	在	必需	类型	说明
locationparameter	path	True	string minLength: 1	位置名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
correlationid	True	string	CorrelationId 项
executionParameters	True	ExecutionParameters	请求的执行参数
resources	True	Resources	请求的资源

响应

名称	类型	说明
200 OK	HibernateResourceOperationResponse	Azure作已成功完成。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen - generated by [MaximumSet] rule

ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen - generated by [MinimumSet] rule

ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen - generated by [MaximumSet] rule

示例请求

POST https://management.azure.com/subscriptions/0505D8E4-D41A-48FB-9CA5-4AF8D93BE75F/providers/Microsoft.ComputeSchedule/locations/pxjjubifupovxakrcjafxrcbgizolx/virtualMachinesExecuteHibernate?api-version=2025-05-01

{
  "executionParameters": {
    "optimizationPreference": "Cost",
    "retryPolicy": {
      "retryCount": 25,
      "retryWindowInMinutes": 4
    }
  },
  "resources": {
    "ids": [
      "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"
    ]
  },
  "correlationid": "jmdiz"
}


import com.azure.resourcemanager.computeschedule.models.ExecuteHibernateRequest;
import com.azure.resourcemanager.computeschedule.models.ExecutionParameters;
import com.azure.resourcemanager.computeschedule.models.OptimizationPreference;
import com.azure.resourcemanager.computeschedule.models.Resources;
import com.azure.resourcemanager.computeschedule.models.RetryPolicy;
import java.util.Arrays;

/**
 * Samples for ScheduledActions VirtualMachinesExecuteHibernate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen.json
     */
    /**
     * Sample code: ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen - generated by [MaximumSet] rule.
     * 
     * @param manager Entry point to ComputeScheduleManager.
     */
    public static void scheduledActionsVirtualMachinesExecuteHibernateMaximumSetGenGeneratedByMaximumSetRule(
        com.azure.resourcemanager.computeschedule.ComputeScheduleManager manager) {
        manager.scheduledActions().virtualMachinesExecuteHibernateWithResponse("pxjjubifupovxakrcjafxrcbgizolx",
            new ExecuteHibernateRequest()
                .withExecutionParameters(
                    new ExecutionParameters().withOptimizationPreference(OptimizationPreference.COST)
                        .withRetryPolicy(new RetryPolicy().withRetryCount(25).withRetryWindowInMinutes(4)))
                .withResources(new Resources().withIds(Arrays.asList(
                    "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3")))
                .withCorrelationid("jmdiz"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.computeschedule import ComputeScheduleMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-computeschedule
# USAGE
    python scheduled_actions_virtual_machines_execute_hibernate_maximum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeScheduleMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.scheduled_actions.virtual_machines_execute_hibernate(
        locationparameter="pxjjubifupovxakrcjafxrcbgizolx",
        request_body={
            "correlationid": "jmdiz",
            "executionParameters": {
                "optimizationPreference": "Cost",
                "retryPolicy": {"retryCount": 25, "retryWindowInMinutes": 4},
            },
            "resources": {
                "ids": [
                    "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"
                ]
            },
        },
    )
    print(response)


# x-ms-original-file: 2025-05-01/ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "type": "yrmuumqaqiyotst",
  "location": "hhioerbsucdqayxk",
  "results": [
    {
      "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3",
      "errorCode": "ynukyltendgmn",
      "errorDetails": "tifeuh",
      "operation": {
        "operationId": "vppyaxq",
        "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3",
        "opType": "Unknown",
        "subscriptionId": "vofvsus",
        "deadline": "2025-04-15T19:47:03.591Z",
        "deadlineType": "Unknown",
        "state": "Unknown",
        "timezone": "nwugsooykqggcokphgdj",
        "timeZone": "qkxnxnumvfqmsmpyccv",
        "resourceOperationError": {
          "errorCode": "fagfsojftlff",
          "errorDetails": "rtihrkjasrjkllqccuysjrg"
        },
        "completedAt": "2025-04-15T19:47:03.591Z",
        "retryPolicy": {
          "retryCount": 25,
          "retryWindowInMinutes": 4
        }
      }
    }
  ],
  "description": "ploigcuqj"
}

ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen - generated by [MinimumSet] rule

示例请求

POST https://management.azure.com/subscriptions/0505D8E4-D41A-48FB-9CA5-4AF8D93BE75F/providers/Microsoft.ComputeSchedule/locations/klbbfkgnebotnwosvbsze/virtualMachinesExecuteHibernate?api-version=2025-05-01

{
  "executionParameters": {},
  "resources": {
    "ids": [
      "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"
    ]
  },
  "correlationid": "jmdiz"
}


import com.azure.resourcemanager.computeschedule.models.ExecuteHibernateRequest;
import com.azure.resourcemanager.computeschedule.models.ExecutionParameters;
import com.azure.resourcemanager.computeschedule.models.Resources;
import java.util.Arrays;

/**
 * Samples for ScheduledActions VirtualMachinesExecuteHibernate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen.json
     */
    /**
     * Sample code: ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen - generated by [MinimumSet] rule.
     * 
     * @param manager Entry point to ComputeScheduleManager.
     */
    public static void scheduledActionsVirtualMachinesExecuteHibernateMinimumSetGenGeneratedByMinimumSetRule(
        com.azure.resourcemanager.computeschedule.ComputeScheduleManager manager) {
        manager.scheduledActions().virtualMachinesExecuteHibernateWithResponse("klbbfkgnebotnwosvbsze",
            new ExecuteHibernateRequest().withExecutionParameters(new ExecutionParameters())
                .withResources(new Resources().withIds(Arrays.asList(
                    "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3")))
                .withCorrelationid("jmdiz"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.computeschedule import ComputeScheduleMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-computeschedule
# USAGE
    python scheduled_actions_virtual_machines_execute_hibernate_minimum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeScheduleMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.scheduled_actions.virtual_machines_execute_hibernate(
        locationparameter="klbbfkgnebotnwosvbsze",
        request_body={
            "correlationid": "jmdiz",
            "executionParameters": {},
            "resources": {
                "ids": [
                    "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"
                ]
            },
        },
    )
    print(response)


# x-ms-original-file: 2025-05-01/ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "type": "yrmuumqaqiyotst",
  "location": "hhioerbsucdqayxk",
  "description": "ploigcuqj"
}

定义

名称	说明
DeadlineType	ScheduledActions 支持的截止时间类型
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExecuteHibernateRequest	executeHibernateRequest 请求执行Hibernate 操作
ExecutionParameters	运行用户请求所需的额外详细信息
HibernateResourceOperationResponse	来自休眠请求的响应
OperationState	在计划操作中定义操作状态的值
OptimizationPreference	客户可以选择的首选项来优化其对 ScheduledActions 的请求
ResourceOperation	对资源执行的操作的高级别响应
ResourceOperationDetails	对资源执行的操作的响应的详细信息
ResourceOperationError	这些描述在资源级别发生的错误
ResourceOperationType	可以使用 ScheduledActions 对资源执行的操作类型
Resources	用户请求所需的资源
RetryPolicy	用户请求的重试策略

DeadlineType

枚举

ScheduledActions 支持的截止时间类型

值	说明
CompleteBy	在给定的最后期限之前完成操作。
InitiateAt	在给定的最后期限启动操作。
Unknown	默认值为 Unknown。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ExecuteHibernateRequest

Object

executeHibernateRequest 请求执行Hibernate 操作

名称	类型	说明
correlationid	string	CorrelationId 项
executionParameters	ExecutionParameters	请求的执行参数
resources	Resources	请求的资源

ExecutionParameters

Object

运行用户请求所需的额外详细信息

名称	类型	说明
optimizationPreference	OptimizationPreference	可以优化用户请求的详细信息
retryPolicy	RetryPolicy	用户可以传递的重试策略

HibernateResourceOperationResponse

Object

来自休眠请求的响应

名称	类型	说明
description	string	操作响应的说明
location	string	休眠请求的位置，例如 westus
results	ResourceOperation[]	如果不存在错误，则来自 Hibernate 请求的结果
type	string	休眠请求中使用的资源类型，例如虚拟机

OperationState

枚举

在计划操作中定义操作状态的值

值	说明
Blocked	被阻止的操作
Cancelled	用户已取消的操作
Executing	正在执行的操作
Failed	失败的操作
PendingExecution	正在等待执行的操作
PendingScheduling	挂起计划的操作
Scheduled	已计划的操作
Succeeded	起诉的操作
Unknown	操作状态枚举的默认值

OptimizationPreference

枚举

客户可以选择的首选项来优化其对 ScheduledActions 的请求

值	说明
Availability	考虑资源可用性时进行优化
Cost	考虑节省成本的同时进行优化
CostAvailabilityBalanced	考虑成本和可用性的平衡时进行优化

ResourceOperation

Object

对资源执行的操作的高级别响应

名称	类型	说明
errorCode	string	资源级别错误代码（如果存在）
errorDetails	string	资源级别错误详细信息（如果存在）
operation	ResourceOperationDetails	对资源执行的操作的详细信息
resourceId	string (arm-id)	操作中涉及的资源的唯一标识符，例如 ArmId

ResourceOperationDetails

Object

对资源执行的操作的响应的详细信息

名称	类型	默认值	说明
completedAt	string (date-time)		如果错误为 null，操作完成的时间
deadline	string (date-time)		操作的最后期限
deadlineType	DeadlineType	Unknown	操作的最后期限类型
opType	ResourceOperationType	Unknown	对资源执行的操作类型
operationId	string		唯一操作的操作标识符
resourceId	string (arm-id)		操作中涉及的资源的唯一标识符，例如 ArmId
resourceOperationError	ResourceOperationError		操作级别错误（如果存在）
retryPolicy	RetryPolicy		用户可以传递的重试策略
state	OperationState	Unknown	操作的当前状态
subscriptionId	string		附加到请求的订阅 ID
timeZone	string		操作的时区
timezone	string		操作的时区

ResourceOperationError

Object

这些描述在资源级别发生的错误

名称	类型	说明
errorCode	string	错误的代码，例如 404、500
errorDetails	string	有关错误的详细消息

ResourceOperationType

枚举

可以使用 ScheduledActions 对资源执行的操作类型

值	说明
Deallocate	解除分配对资源的操作
Hibernate	对资源的休眠操作
Start	开始对资源执行的操作
Unknown	此枚举类型的默认值

Resources

Object

用户请求所需的资源

名称	类型	说明
ids	string[] (arm-id)	用于请求的资源 ID

RetryPolicy

Object

用户请求的重试策略

名称	类型	说明
retryCount	integer (int32)	用户请求的重试计数
retryWindowInMinutes	integer (int32)	用户请求的重试窗口（以分钟为单位）

通过

Scheduled Actions - Virtual Machines Execute Hibernate

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen - generated by [MaximumSet] rule

示例请求

示例响应

ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen - generated by [MinimumSet] rule

示例请求

示例响应

定义

DeadlineType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExecuteHibernateRequest

ExecutionParameters

HibernateResourceOperationResponse

OperationState

OptimizationPreference

ResourceOperation

ResourceOperationDetails

ResourceOperationError

ResourceOperationType

Resources

RetryPolicy