Scheduled Actions - Virtual Machines Execute Hibernate

Servizio:

Compute Schedule

Versione API:

2024-10-01

VirtualMachinesExecuteHibernate: eseguire un'operazione di ibernazione per un batch di macchine virtuali, questa operazione viene attivata non appena computeschedule lo riceve.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
locationparameter	path	True	string minLength: 1	Nome della posizione.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
correlationid	True	string	Elemento CorrelationId
executionParameters	True	ExecutionParameters	Parametri di esecuzione per la richiesta
resources	True	Resources	Risorse per la richiesta

Risposte

Nome	Tipo	Descrizione
200 OK	HibernateResourceOperationResponse	Operazione di Azure completata correttamente.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ScheduledActions_VirtualMachinesExecuteHibernate

Esempio di richiesta

HTTP

POST https://management.azure.com/subscriptions/D8E30CC0-2763-4FCC-84A8-3C5659281032/providers/Microsoft.ComputeSchedule/locations/eastus2euap/virtualMachinesExecuteHibernate?api-version=2024-10-01

{
  "executionParameters": {
    "retryPolicy": {
      "retryCount": 5,
      "retryWindowInMinutes": 27
    }
  },
  "resources": {
    "ids": [
      "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"
    ]
  },
  "correlationid": "23480d2f-1dca-4610-afb4-dd25eec1f34r"
}

Java

import com.azure.resourcemanager.computeschedule.models.ExecuteHibernateRequest;
import com.azure.resourcemanager.computeschedule.models.ExecutionParameters;
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: 2024-10-01/ScheduledActions_VirtualMachinesExecuteHibernate.json
     */
    /**
     * Sample code: ScheduledActions_VirtualMachinesExecuteHibernate.
     * 
     * @param manager Entry point to ComputeScheduleManager.
     */
    public static void scheduledActionsVirtualMachinesExecuteHibernate(
        com.azure.resourcemanager.computeschedule.ComputeScheduleManager manager) {
        manager.scheduledActions().virtualMachinesExecuteHibernateWithResponse("eastus2euap",
            new ExecuteHibernateRequest()
                .withExecutionParameters(new ExecutionParameters()
                    .withRetryPolicy(new RetryPolicy().withRetryCount(5).withRetryWindowInMinutes(27)))
                .withResources(new Resources().withIds(Arrays.asList(
                    "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3")))
                .withCorrelationid("23480d2f-1dca-4610-afb4-dd25eec1f34r"),
            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

Python

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.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="eastus2euap",
        request_body={
            "correlationid": "23480d2f-1dca-4610-afb4-dd25eec1f34r",
            "executionParameters": {"retryPolicy": {"retryCount": 5, "retryWindowInMinutes": 27}},
            "resources": {
                "ids": [
                    "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"
                ]
            },
        },
    )
    print(response)


# x-ms-original-file: 2024-10-01/ScheduledActions_VirtualMachinesExecuteHibernate.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

Go

package armcomputeschedule_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/computeschedule/armcomputeschedule"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8a4eca6b060cf70da696963245656fdc440b666b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/stable/2024-10-01/examples/ScheduledActions_VirtualMachinesExecuteHibernate.json
func ExampleScheduledActionsClient_VirtualMachinesExecuteHibernate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcomputeschedule.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewScheduledActionsClient().VirtualMachinesExecuteHibernate(ctx, "eastus2euap", armcomputeschedule.ExecuteHibernateRequest{
		Correlationid: to.Ptr("23480d2f-1dca-4610-afb4-dd25eec1f34r"),
		ExecutionParameters: &armcomputeschedule.ExecutionParameters{
			RetryPolicy: &armcomputeschedule.RetryPolicy{
				RetryCount:           to.Ptr[int32](5),
				RetryWindowInMinutes: to.Ptr[int32](27),
			},
		},
		Resources: &armcomputeschedule.Resources{
			IDs: []*string{
				to.Ptr("/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3")},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.HibernateResourceOperationResponse = armcomputeschedule.HibernateResourceOperationResponse{
	// 	Type: to.Ptr("VirtualMachine"),
	// 	Description: to.Ptr("Hibernate Resource Request"),
	// 	Location: to.Ptr("eastus2euap"),
	// 	Results: []*armcomputeschedule.ResourceOperation{
	// 		{
	// 			ErrorCode: to.Ptr("null"),
	// 			ErrorDetails: to.Ptr("null"),
	// 			Operation: &armcomputeschedule.ResourceOperationDetails{
	// 				OperationID: to.Ptr("23480d2f-1dca-4610-afb4-dd25eec1f34r"),
	// 				CompletedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-11-01T17:52:53.668Z"); return t}()),
	// 				Deadline: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-11-01T17:52:53.667Z"); return t}()),
	// 				DeadlineType: to.Ptr(armcomputeschedule.DeadlineTypeInitiateAt),
	// 				OpType: to.Ptr(armcomputeschedule.ResourceOperationTypeHibernate),
	// 				ResourceID: to.Ptr("/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"),
	// 				ResourceOperationError: &armcomputeschedule.ResourceOperationError{
	// 					ErrorCode: to.Ptr("null"),
	// 					ErrorDetails: to.Ptr("null"),
	// 				},
	// 				RetryPolicy: &armcomputeschedule.RetryPolicy{
	// 					RetryCount: to.Ptr[int32](5),
	// 					RetryWindowInMinutes: to.Ptr[int32](27),
	// 				},
	// 				State: to.Ptr(armcomputeschedule.OperationStateSucceeded),
	// 				SubscriptionID: to.Ptr("D8E30CC0-2763-4FCC-84A8-3C5659281032"),
	// 				TimeZone: to.Ptr("UTC"),
	// 				Timezone: to.Ptr("UTC"),
	// 			},
	// 			ResourceID: to.Ptr("/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3"),
	// 	}},
	// }
}

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

JavaScript

const { ComputeScheduleClient } = require("@azure/arm-computeschedule");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to virtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
 *
 * @summary virtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
 * x-ms-original-file: 2024-10-01/ScheduledActions_VirtualMachinesExecuteHibernate.json
 */
async function scheduledActionsVirtualMachinesExecuteHibernate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "D8E30CC0-2763-4FCC-84A8-3C5659281032";
  const client = new ComputeScheduleClient(credential, subscriptionId);
  const result = await client.scheduledActions.virtualMachinesExecuteHibernate("eastus2euap", {
    executionParameters: {
      retryPolicy: { retryCount: 5, retryWindowInMinutes: 27 },
    },
    resources: {
      ids: [
        "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3",
      ],
    },
    correlationId: "23480d2f-1dca-4610-afb4-dd25eec1f34r",
  });
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ComputeSchedule.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ComputeSchedule;

// Generated from example definition: 2024-10-01/ScheduledActions_VirtualMachinesExecuteHibernate.json
// this example is just showing the usage of "ScheduledActions_ExecuteVirtualMachineHibernate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "D8E30CC0-2763-4FCC-84A8-3C5659281032";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
string locationparameter = "eastus2euap";
ExecuteHibernateContent content = new ExecuteHibernateContent(new ScheduledActionExecutionParameterDetail
{
    RetryPolicy = new UserRequestRetryPolicy
    {
        RetryCount = 5,
        RetryWindowInMinutes = 27,
    },
}, new UserRequestResources(new ResourceIdentifier[] { new ResourceIdentifier("/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3") }), "23480d2f-1dca-4610-afb4-dd25eec1f34r");
HibernateResourceOperationResult result = await subscriptionResource.ExecuteVirtualMachineHibernateAsync(locationparameter, content);

Console.WriteLine($"Succeeded: {result}");

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

Risposta di esempio

Codice di stato:

200

{
  "type": "VirtualMachine",
  "location": "eastus2euap",
  "results": [
    {
      "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3",
      "errorCode": "null",
      "errorDetails": "null",
      "operation": {
        "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34r",
        "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3",
        "opType": "Hibernate",
        "subscriptionId": "D8E30CC0-2763-4FCC-84A8-3C5659281032",
        "deadline": "2024-11-01T17:52:53.667Z",
        "deadlineType": "InitiateAt",
        "state": "Succeeded",
        "timezone": "UTC",
        "resourceOperationError": {
          "errorCode": "null",
          "errorDetails": "null"
        },
        "completedAt": "2024-11-01T17:52:53.668Z",
        "retryPolicy": {
          "retryCount": 5,
          "retryWindowInMinutes": 27
        },
        "timeZone": "UTC"
      }
    }
  ],
  "description": "Hibernate Resource Request"
}

Definizioni

Nome	Descrizione
DeadlineType	Tipi di scadenze supportate da ScheduledActions
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ExecuteHibernateRequest	Richiesta ExecuteHibernateRequest per le operazioni executeHibernate
ExecutionParameters	Dettagli aggiuntivi necessari per eseguire la richiesta dell'utente
HibernateResourceOperationResponse	Risposta da una richiesta di ibernazione
OperationState	Valori che definiscono gli stati delle operazioni nelle azioni pianificate
OptimizationPreference	Le preferenze che i clienti possono selezionare per ottimizzare le richieste alle utilità pianificate
ResourceOperation	Risposta di alto livello da un'operazione su una risorsa
ResourceOperationDetails	Dettagli di una risposta da un'operazione su una risorsa
ResourceOperationError	Questi descrivono gli errori che si verificano a livello di risorsa
ResourceOperationType	Tipo di tipi di operazione che possono essere eseguiti sulle risorse tramite ScheduledActions
Resources	Risorse necessarie per la richiesta dell'utente
RetryPolicy	Criteri di ripetizione dei tentativi per la richiesta utente

DeadlineType

Enumerazione

Tipi di scadenze supportate da ScheduledActions

Valore	Descrizione
CompleteBy	Completare l'operazione entro la scadenza specificata.
InitiateAt	Avviare l'operazione alla scadenza specificata.
Unknown	Valore predefinito Sconosciuto.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ExecuteHibernateRequest

Object

Richiesta ExecuteHibernateRequest per le operazioni executeHibernate

Nome	Tipo	Descrizione
correlationid	string	Elemento CorrelationId
executionParameters	ExecutionParameters	Parametri di esecuzione per la richiesta
resources	Resources	Risorse per la richiesta

ExecutionParameters

Object

Dettagli aggiuntivi necessari per eseguire la richiesta dell'utente

Nome	Tipo	Descrizione
optimizationPreference	OptimizationPreference	Dettagli che potrebbero ottimizzare la richiesta dell'utente
retryPolicy	RetryPolicy	Criterio di ripetizione dei tentativi che l'utente può passare

HibernateResourceOperationResponse

Object

Risposta da una richiesta di ibernazione

Nome	Tipo	Descrizione
description	string	Descrizione della risposta dell'operazione
location	string	Posizione della richiesta hibernate, ad esempio westus
results	ResourceOperation[]	Risultati della richiesta di Iberna se non esistono errori
type	string	Tipo di risorse usate nelle macchine virtuali della richiesta di ibernazione

OperationState

Enumerazione

Valori che definiscono gli stati delle operazioni nelle azioni pianificate

Valore	Descrizione
Blocked	Operazioni bloccate
Cancelled	Operazioni annullate dall'utente
Executing	Operazioni in corso di esecuzione
Failed	Operazioni non riuscite
PendingExecution	Operazioni in attesa di esecuzione
PendingScheduling	Operazioni in sospeso per la pianificazione
Scheduled	Operazioni pianificate
Succeeded	Operazioni sucesse
Unknown	Valore predefinito per l'enumerazione dello stato dell'operazione

OptimizationPreference

Enumerazione

Le preferenze che i clienti possono selezionare per ottimizzare le richieste alle utilità pianificate

Valore	Descrizione
Availability	Ottimizzare durante la disponibilità delle risorse
Cost	Ottimizzare durante la considerazione dei risparmi sui costi
CostAvailabilityBalanced	Ottimizza durante la considerazione di un equilibrio tra costi e disponibilità

ResourceOperation

Object

Risposta di alto livello da un'operazione su una risorsa

Nome	Tipo	Descrizione
errorCode	string	Codice di errore a livello di risorsa, se esistente
errorDetails	string	Dettagli dell'errore a livello di risorsa, se esistenti
operation	ResourceOperationDetails	Dettagli dell'operazione eseguita su una risorsa
resourceId	string (arm-id)	Identificatore univoco per la risorsa coinvolta nell'operazione, ad esempio ArmId

ResourceOperationDetails

Object

Dettagli di una risposta da un'operazione su una risorsa

Nome	Tipo	Valore predefinito	Descrizione
completedAt	string (date-time)		Ora in cui l'operazione è stata completata se gli errori sono Null
deadline	string (date-time)		Scadenza per l'operazione
deadlineType	DeadlineType	Unknown	Tipo di scadenza dell'operazione
opType	ResourceOperationType	Unknown	Tipo di operazione eseguita sulle risorse
operationId	string		Identificatore dell'operazione per l'operazione univoca
resourceId	string (arm-id)		Identificatore univoco per la risorsa coinvolta nell'operazione, ad esempio ArmId
resourceOperationError	ResourceOperationError		Errori a livello di operazione se esistenti
retryPolicy	RetryPolicy		Criterio di ripetizione dei tentativi che l'utente può passare
state	OperationState	Unknown	Stato corrente dell'operazione
subscriptionId	string		ID sottoscrizione associato alla richiesta
timeZone	string		Fuso orario per l'operazione
timezone	string		Fuso orario per l'operazione

ResourceOperationError

Object

Questi descrivono gli errori che si verificano a livello di risorsa

Nome	Tipo	Descrizione
errorCode	string	Codice per l'errore, ad esempio 404, 500
errorDetails	string	Messaggio dettagliato sull'errore

ResourceOperationType

Enumerazione

Tipo di tipi di operazione che possono essere eseguiti sulle risorse tramite ScheduledActions

Valore	Descrizione
Deallocate	Deallocare le operazioni sulle risorse
Hibernate	Operazioni di ibernazione sulle risorse
Start	Avviare operazioni sulle risorse
Unknown	Valore predefinito per questo tipo di enumerazione

Resources

Object

Risorse necessarie per la richiesta dell'utente

Nome	Tipo	Descrizione
ids	string[] (arm-id)	ID risorsa usati per la richiesta

RetryPolicy

Object

Criteri di ripetizione dei tentativi per la richiesta utente

Nome	Tipo	Descrizione
retryCount	integer (int32)	Numero di tentativi per la richiesta utente
retryWindowInMinutes	integer (int32)	Intervallo tra tentativi in minuti per la richiesta dell'utente