Scheduled Actions - Virtual Machines Submit Hibernate

Servicio:: Compute Schedule

Versión de la API:: 2025-05-01

VirtualMachinesSubmitHibernate: programe la operación de hibernación para un lote de máquinas virtuales en datetime en el futuro.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
locationparameter	path	True	string minLength: 1	Nombre de ubicación.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
correlationid	True	string	Elemento CorrelationId
executionParameters	True	ExecutionParameters	Parámetros de ejecución de la solicitud
resources	True	Resources	Los recursos de la solicitud
schedule	True	Schedule	Programación de la solicitud

Respuestas

Nombre	Tipo	Description
200 OK	HibernateResourceOperationResponse	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen - generated by [MaximumSet] rule

ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen - generated by [MinimumSet] rule

ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen - generated by [MaximumSet] rule

Solicitud de ejemplo

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

{
  "schedule": {
    "deadline": "2025-04-15T19:47:04.403Z",
    "deadLine": "2025-04-15T19:47:04.403Z",
    "timezone": "qacufsmctpgjozovlsihrzoctatcsj",
    "timeZone": "upnmayfebiadztdktxzq",
    "deadlineType": "Unknown"
  },
  "executionParameters": {
    "optimizationPreference": "Cost",
    "retryPolicy": {
      "retryCount": 25,
      "retryWindowInMinutes": 4
    }
  },
  "resources": {
    "ids": [
      "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"
    ]
  },
  "correlationid": "htqivutynuoslvbp"
}


import com.azure.resourcemanager.computeschedule.models.DeadlineType;
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 com.azure.resourcemanager.computeschedule.models.Schedule;
import com.azure.resourcemanager.computeschedule.models.SubmitHibernateRequest;
import java.time.OffsetDateTime;
import java.util.Arrays;

/**
 * Samples for ScheduledActions VirtualMachinesSubmitHibernate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen.json
     */
    /**
     * Sample code: ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen - generated by [MaximumSet] rule.
     * 
     * @param manager Entry point to ComputeScheduleManager.
     */
    public static void scheduledActionsVirtualMachinesSubmitHibernateMaximumSetGenGeneratedByMaximumSetRule(
        com.azure.resourcemanager.computeschedule.ComputeScheduleManager manager) {
        manager.scheduledActions().virtualMachinesSubmitHibernateWithResponse("sgwaluihhyqoxbfskudgqcikbns",
            new SubmitHibernateRequest()
                .withSchedule(new Schedule().withDeadline(OffsetDateTime.parse("2025-04-15T19:47:04.403Z"))
                    .withDeadLine(OffsetDateTime.parse("2025-04-15T19:47:04.403Z"))
                    .withTimezone("qacufsmctpgjozovlsihrzoctatcsj").withTimeZone("upnmayfebiadztdktxzq")
                    .withDeadlineType(DeadlineType.UNKNOWN))
                .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("htqivutynuoslvbp"),
            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_submit_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_submit_hibernate(
        locationparameter="sgwaluihhyqoxbfskudgqcikbns",
        request_body={
            "correlationid": "htqivutynuoslvbp",
            "executionParameters": {
                "optimizationPreference": "Cost",
                "retryPolicy": {"retryCount": 25, "retryWindowInMinutes": 4},
            },
            "resources": {
                "ids": [
                    "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"
                ]
            },
            "schedule": {
                "deadLine": "2025-04-15T19:47:04.403Z",
                "deadline": "2025-04-15T19:47:04.403Z",
                "deadlineType": "Unknown",
                "timeZone": "upnmayfebiadztdktxzq",
                "timezone": "qacufsmctpgjozovlsihrzoctatcsj",
            },
        },
    )
    print(response)


# x-ms-original-file: 2025-05-01/ScheduledActions_VirtualMachinesSubmitHibernate_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

Respuesta de muestra

status code:: 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_VirtualMachinesSubmitHibernate_MinimumSet_Gen - generated by [MinimumSet] rule

Solicitud de ejemplo

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

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


import com.azure.resourcemanager.computeschedule.models.DeadlineType;
import com.azure.resourcemanager.computeschedule.models.ExecutionParameters;
import com.azure.resourcemanager.computeschedule.models.Resources;
import com.azure.resourcemanager.computeschedule.models.Schedule;
import com.azure.resourcemanager.computeschedule.models.SubmitHibernateRequest;
import java.util.Arrays;

/**
 * Samples for ScheduledActions VirtualMachinesSubmitHibernate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen.json
     */
    /**
     * Sample code: ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen - generated by [MinimumSet] rule.
     * 
     * @param manager Entry point to ComputeScheduleManager.
     */
    public static void scheduledActionsVirtualMachinesSubmitHibernateMinimumSetGenGeneratedByMinimumSetRule(
        com.azure.resourcemanager.computeschedule.ComputeScheduleManager manager) {
        manager.scheduledActions().virtualMachinesSubmitHibernateWithResponse("slxeawqkswmmfjbvkratyfhx",
            new SubmitHibernateRequest().withSchedule(new Schedule().withDeadlineType(DeadlineType.UNKNOWN))
                .withExecutionParameters(new ExecutionParameters())
                .withResources(new Resources().withIds(Arrays.asList(
                    "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3")))
                .withCorrelationid("htqivutynuoslvbp"),
            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_submit_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_submit_hibernate(
        locationparameter="slxeawqkswmmfjbvkratyfhx",
        request_body={
            "correlationid": "htqivutynuoslvbp",
            "executionParameters": {},
            "resources": {
                "ids": [
                    "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"
                ]
            },
            "schedule": {"deadlineType": "Unknown"},
        },
    )
    print(response)


# x-ms-original-file: 2025-05-01/ScheduledActions_VirtualMachinesSubmitHibernate_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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
DeadlineType	Los tipos de fechas límite admitidas por ScheduledActions
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ExecutionParameters	Detalles adicionales necesarios para ejecutar la solicitud del usuario
HibernateResourceOperationResponse	Respuesta de una solicitud Hibernate
OperationState	Valores que definen los estados de las operaciones en Acciones programadas
OptimizationPreference	Las preferencias que los clientes pueden seleccionar para optimizar sus solicitudes a ScheduledActions
ResourceOperation	Respuesta de alto nivel de una operación en un recurso
ResourceOperationDetails	Detalles de una respuesta de una operación en un recurso
ResourceOperationError	Estos describen los errores que se producen en el nivel de recurso.
ResourceOperationType	El tipo de tipos de operación que se pueden realizar en recursos mediante ScheduledActions
Resources	Los recursos necesarios para la solicitud de usuario
RetryPolicy	Directiva de reintento para la solicitud de usuario
Schedule	Los detalles de programación de la solicitud de usuario
SubmitHibernateRequest	Esta es la solicitud de hibernación.

DeadlineType

Enumeración

Los tipos de fechas límite admitidas por ScheduledActions

Valor	Description
Unknown	Valor predeterminado de Desconocido.
InitiateAt	Inicie la operación en la fecha límite especificada.
CompleteBy	Complete la operación según la fecha límite especificada.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ExecutionParameters

Object

Detalles adicionales necesarios para ejecutar la solicitud del usuario

Nombre	Tipo	Description
optimizationPreference	OptimizationPreference	Detalles que podrían optimizar la solicitud del usuario
retryPolicy	RetryPolicy	Directiva de reintento que el usuario puede pasar

HibernateResourceOperationResponse

Object

Respuesta de una solicitud Hibernate

Nombre	Tipo	Description
description	string	Descripción de la respuesta de la operación
location	string	Ubicación de la solicitud Hibernate por ejemplo westus
results	ResourceOperation[]	Resultados de la solicitud Hibernate si no existe ningún error.
type	string	Tipo de recursos usados en la solicitud Hibernate, por ejemplo, máquinas virtuales

OperationState

Enumeración

Valores que definen los estados de las operaciones en Acciones programadas

Valor	Description
Unknown	Valor predeterminado de la enumeración de estado de la operación
PendingScheduling	Operaciones pendientes de programación
Scheduled	Operaciones programadas
PendingExecution	Operaciones que esperan ejecutarse
Executing	Operaciones que están en proceso de ejecución
Succeeded	Operaciones que sucedieron
Failed	Operaciones con errores
Cancelled	Operaciones canceladas por el usuario
Blocked	Operaciones bloqueadas

OptimizationPreference

Enumeración

Las preferencias que los clientes pueden seleccionar para optimizar sus solicitudes a ScheduledActions

Valor	Description
Cost	Optimización al considerar el ahorro de costos
Availability	Optimización al considerar la disponibilidad de los recursos
CostAvailabilityBalanced	Optimización al considerar un equilibrio de costo y disponibilidad

ResourceOperation

Object

Respuesta de alto nivel de una operación en un recurso

Nombre	Tipo	Description
errorCode	string	Código de error de nivel de recurso si existe
errorDetails	string	Detalles del error de nivel de recurso si existen
operation	ResourceOperationDetails	Detalles de la operación realizada en un recurso
resourceId	string (arm-id)	Identificador único del recurso implicado en la operación, por ejemplo ArmId

ResourceOperationDetails

Object

Detalles de una respuesta de una operación en un recurso

Nombre	Tipo	Valor predeterminado	Description
completedAt	string (date-time)		Hora en que se completó la operación si los errores son null
deadline	string (date-time)		Fecha límite de la operación
deadlineType	DeadlineType	Unknown	Tipo de fecha límite de la operación
opType	ResourceOperationType	Unknown	Tipo de operación realizada en los recursos
operationId	string		Identificador de operación para la operación única
resourceId	string (arm-id)		Identificador único del recurso implicado en la operación, por ejemplo ArmId
resourceOperationError	ResourceOperationError		Errores de nivel de operación si existen
retryPolicy	RetryPolicy		Directiva de reintento que el usuario puede pasar
state	OperationState	Unknown	Estado actual de la operación
subscriptionId	string		Identificador de suscripción adjunto a la solicitud
timeZone	string		Zona horaria de la operación
timezone	string		Zona horaria de la operación

ResourceOperationError

Object

Estos describen los errores que se producen en el nivel de recurso.

Nombre	Tipo	Description
errorCode	string	Código para el error, por ejemplo, 404, 500
errorDetails	string	Mensaje detallado sobre el error

ResourceOperationType

Enumeración

El tipo de tipos de operación que se pueden realizar en recursos mediante ScheduledActions

Valor	Description
Unknown	Valor predeterminado para este tipo de enumeración
Start	Iniciar operaciones en los recursos
Deallocate	Desasignar operaciones en los recursos
Hibernate	Operaciones de hibernación en los recursos

Resources

Object

Los recursos necesarios para la solicitud de usuario

Nombre	Tipo	Description
ids	string[] (arm-id)	Identificadores de recurso usados para la solicitud

RetryPolicy

Object

Directiva de reintento para la solicitud de usuario

Nombre	Tipo	Description
retryCount	integer (int32)	Recuento de reintentos para la solicitud de usuario
retryWindowInMinutes	integer (int32)	Período de reintento en minutos para la solicitud de usuario

Schedule

Object

Los detalles de programación de la solicitud de usuario

Nombre	Tipo	Valor predeterminado	Description
deadLine	string (date-time)		La fecha límite de la operación
deadline	string (date-time)		La fecha límite de la operación
deadlineType	DeadlineType	Unknown	El tipo de fecha límite de la operación, puede ser InitiateAt o CompleteBy.
timeZone	string		Zona horaria de la operación
timezone	string		Zona horaria de la operación

SubmitHibernateRequest

Object

Esta es la solicitud de hibernación.

Nombre	Tipo	Description
correlationid	string	Elemento CorrelationId
executionParameters	ExecutionParameters	Parámetros de ejecución de la solicitud
resources	Resources	Los recursos de la solicitud
schedule	Schedule	Programación de la solicitud

Compartir a través de

Scheduled Actions - Virtual Machines Submit Hibernate

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen - generated by [MaximumSet] rule

Solicitud de ejemplo

Respuesta de muestra

ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen - generated by [MinimumSet] rule

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DeadlineType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExecutionParameters

HibernateResourceOperationResponse

OperationState

OptimizationPreference

ResourceOperation

ResourceOperationDetails

ResourceOperationError

ResourceOperationType

Resources

RetryPolicy

Schedule

SubmitHibernateRequest