Share via

az computeschedule

  • Reference

Note

This reference is part of the computeschedule extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az computeschedule command. Learn more about extensions.

Computeschedule batch virtual machine operations.

Computeschedule operations allow customers perform one off operations on a batch of virtual machines.

Commands

Name Description Type Status
az computeschedule vm-cancel-operations

VirtualMachinesCancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request.

 Extension GA
az computeschedule vm-execute-deallocate

VirtualMachinesExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

 Extension GA
az computeschedule vm-execute-hibernate

VirtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

 Extension GA
az computeschedule vm-execute-start

VirtualMachinesExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

 Extension GA
az computeschedule vm-get-operation-errors

VirtualMachinesGetOperationErrors: Get error details on operation errors (like transient errors encountered, additional logs) if they exist.

 Extension GA
az computeschedule vm-get-operation-status

VirtualMachinesGetOperationStatus: Polling endpoint to read status of operations performed on virtual machines.

 Extension GA
az computeschedule vm-submit-deallocate

VirtualMachinesSubmitDeallocate: Schedule deallocate operation for a batch of virtual machines at datetime in future.

 Extension GA
az computeschedule vm-submit-hibernate

VirtualMachinesSubmitHibernate: Schedule hibernate operation for a batch of virtual machines at datetime in future.

 Extension GA
az computeschedule vm-submit-start

VirtualMachinesSubmitStart: Schedule start operation for a batch of virtual machines at datetime in future.

 Extension GA

az computeschedule vm-cancel-operations

VirtualMachinesCancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request.

az computeschedule vm-cancel-operations --correlationid
                                        --operation-ids
                                        [--ids]
                                        [--location]
                                        [--subscription]

Examples

VirtualMachinesCancelOperations

az computeschedule vm-cancel-operations --location eastus2euap --operation-ids "[23480d2f-1dca-4610-afb4-dd25eec1f34r]" --correlationid 23480d2f-1dca-4610-afb4-gg25eec1f34r

Required Parameters

--correlationid

CorrelationId item.

--operation-ids

The list of operation ids to get the status for Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location

The location of the azure resources. If value is blank it's asked from the tty.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az computeschedule vm-execute-deallocate

VirtualMachinesExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

az computeschedule vm-execute-deallocate --correlationid
                                         --execution-parameters
                                         --resources
                                         [--ids]
                                         [--location]
                                         [--subscription]

Examples

VirtualMachinesExecuteDeallocate

az computeschedule vm-execute-deallocate --location eastus2euap --execution-parameters "{retry-policy:{retry-count:4,retry-window-in-minutes:27}}" --resources "{ids:[/subscriptions/fe541807-8c68-475d-976d-f453f9db4d81/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/testResource3]}" --correlationid 23480d2f-1dca-4610-afb4-dd25eec1f34r

Required Parameters

--correlationid

CorrelationId item.

--execution-parameters

The execution parameters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resources

The resources for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location

The location of the azure resources. If value is blank it's asked from the tty.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az computeschedule vm-execute-hibernate

VirtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

az computeschedule vm-execute-hibernate --correlationid
                                        --execution-parameters
                                        --resources
                                        [--ids]
                                        [--location]
                                        [--subscription]

Examples

VirtualMachinesExecuteHibernate

az computeschedule vm-execute-hibernate --location eastus2euap --execution-parameters "{retry-policy:{retry-count:5,retry-window-in-minutes:27}}" --resources "{ids:[/subscriptions/fe541807-8c68-475d-976d-f453f9db4d81/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/testResource3]}" --correlationid 23480d2f-1dca-4610-afb4-dd25eec1f34r

Required Parameters

--correlationid

CorrelationId item.

--execution-parameters

The execution parameters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resources

The resources for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location

The location of the azure resources. If value is blank it's asked from the tty.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az computeschedule vm-execute-start

VirtualMachinesExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

az computeschedule vm-execute-start --correlationid
                                    --execution-parameters
                                    --resources
                                    [--ids]
                                    [--location]
                                    [--subscription]

Examples

VirtualMachinesExecuteStart

az computeschedule vm-execute-start --location eastus2euap --execution-parameters "{retry-policy:{retry-count:2,retry-window-in-minutes:27}}" --resources "{ids:[/subscriptions/fe541807-8c68-475d-976d-f453f9db4d81/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/testResource3]}" --correlationid 23480d2f-1dca-4610-afb4-dd25eec1f34r

Required Parameters

--correlationid

CorrelationId item.

--execution-parameters

The execution parameters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resources

The resources for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location

The location of the azure resources. If value is blank it's asked from the tty.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az computeschedule vm-get-operation-errors

VirtualMachinesGetOperationErrors: Get error details on operation errors (like transient errors encountered, additional logs) if they exist.

az computeschedule vm-get-operation-errors --operation-ids
                                           [--ids]
                                           [--location]
                                           [--subscription]

Examples

VirtualMachinesGetOperationErrors

az computeschedule vm-get-operation-errors --location eastus2euap --operation-ids "[23480d2f-1dca-4610-afb4-dd25eec1f34r]"

Required Parameters

--operation-ids

The list of operation ids to get the status for Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location

The location of the azure resources. If value is blank it's asked from the tty.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az computeschedule vm-get-operation-status

VirtualMachinesGetOperationStatus: Polling endpoint to read status of operations performed on virtual machines.

az computeschedule vm-get-operation-status --correlationid
                                           --operation-ids
                                           [--ids]
                                           [--location]
                                           [--subscription]

Examples

VirtualMachinesGetOperationStatus

az computeschedule vm-get-operation-status --location eastus2euap --operation-ids "[23480d2f-1dca-4610-afb4-dd25eec1f34r]" --correlationid 35780d2f-1dca-4610-afb4-dd25eec1f34r

Required Parameters

--correlationid

CorrelationId item.

--operation-ids

The list of operation ids to get the status for Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location

The location of the azure resources. If value is blank it's asked from the tty.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az computeschedule vm-submit-deallocate

VirtualMachinesSubmitDeallocate: Schedule deallocate operation for a batch of virtual machines at datetime in future.

az computeschedule vm-submit-deallocate --correlationid
                                        --execution-parameters
                                        --resources
                                        --schedule
                                        [--ids]
                                        [--location]
                                        [--subscription]

Examples

VirtualMachinesSubmitDeallocate

az computeschedule vm-submit-deallocate --location eastus2euap --schedule "{deadline:'2024-11-01T17:52:54.215Z',timezone:UTC,deadline-type:InitiateAt}" --execution-parameters "{retry-policy:{retry-count:4,retry-window-in-minutes:27}}" --resources "{ids:[/subscriptions/fe541807-8c68-475d-976d-f453f9db4d81/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/testResource3]}" --correlationid 23480d2f-1dca-4610-afb4-dd25eec1f34r

Required Parameters

--correlationid

CorrelationId item.

--execution-parameters

The execution parameters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resources

The resources for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--schedule

The schedule for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location

The location of the azure resources. If value is blank it's asked from the tty.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az computeschedule vm-submit-hibernate

VirtualMachinesSubmitHibernate: Schedule hibernate operation for a batch of virtual machines at datetime in future.

az computeschedule vm-submit-hibernate --correlationid
                                       --execution-parameters
                                       --resources
                                       --schedule
                                       [--ids]
                                       [--location]
                                       [--subscription]

Examples

VirtualMachinesSubmitHibernate

az computeschedule vm-submit-hibernate --location eastus2euap --schedule "{deadline:'2024-11-01T17:52:54.215Z',timezone:UTC,deadline-type:InitiateAt}" --execution-parameters "{retry-policy:{retry-count:2,retry-window-in-minutes:27}}" --resources "{ids:[/subscriptions/fe541807-8c68-475d-976d-f453f9db4d81/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/testResource3]}" --correlationid 23480d2f-1dca-4610-afb4-dd25eec1f34r

Required Parameters

--correlationid

CorrelationId item.

--execution-parameters

The execution parameters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resources

The resources for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--schedule

The schedule for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location

The location of the azure resources. If value is blank it's asked from the tty.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az computeschedule vm-submit-start

VirtualMachinesSubmitStart: Schedule start operation for a batch of virtual machines at datetime in future.

az computeschedule vm-submit-start --correlationid
                                   --execution-parameters
                                   --resources
                                   --schedule
                                   [--ids]
                                   [--location]
                                   [--subscription]

Examples

VirtualMachinesSubmitStart

az computeschedule vm-submit-start --location eastus2euap --schedule "{deadline:'2024-11-01T17:52:54.215Z',timezone:UTC,deadline-type:InitiateAt}" --execution-parameters "{retry-policy:{retry-count:5,retry-window-in-minutes:27}}" --resources "{ids:[/subscriptions/fe541807-8c68-475d-976d-f453f9db4d81/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/testResource3]}" --correlationid 23480d2f-1dca-4610-afb4-dd25eec1f34r

Required Parameters

--correlationid

CorrelationId item.

--execution-parameters

The execution parameters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resources

The resources for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--schedule

The schedule for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location

The location of the azure resources. If value is blank it's asked from the tty.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.