az automation schedule

  • Reference

Note

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

Automation Schedule.

Commands

Name Description Type Status
az automation schedule create

Create automation schedule.

 Extension GA
az automation schedule delete

Delete an automation schedule.

 Extension GA
az automation schedule list

Retrieve a list of schedules.

 Extension GA
az automation schedule show

Retrieve the schedule identified by schedule name.

 Extension GA
az automation schedule update

Update an automation schedule.

 Extension GA

az automation schedule create

Create automation schedule.

az automation schedule create --automation-account-name
                              --frequency
                              --interval
                              --name
                              --resource-group
                              [--description]
                              [--expiry-time]
                              [--start-time]
                              [--time-zone]

Examples

Create an automation schedule

az automation schedule create --automation-account-name "myAutomationAccount"  --resource-group "rg"                -n mySchedule --frequency Hour --interval 1 --start-time 2022-08-10 18:00:00 --time-zone UTC+08:00

Required Parameters

--automation-account-name

The name of the automation account.

--frequency

The frequency of the schedule.

--interval

The interval of the schedule.

--name --schedule-name -n

The schedule name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--description

The description of the schedule.

--expiry-time

The end time of the schedule. Format: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) timezone (+/-hh:mm).

--start-time

The start time of the schedule. Format: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) timezone (+/-hh:mm).

--time-zone

The time zone of the schedule.

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 automation schedule delete

Delete an automation schedule.

az automation schedule delete --automation-account-name
                              --name
                              --resource-group
                              [--yes]

Examples

Delete automation schedule

az automation schedule delete --name "myAutomationSchedule" --resource-group "rg"                --automation-account-name "myAutomationAccount"

Required Parameters

--automation-account-name

The name of the automation account.

--name --schedule-name -n

The schedule name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--yes -y

Do not prompt for confirmation.

Default value: False
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 automation schedule list

Retrieve a list of schedules.

az automation schedule list --automation-account-name
                            --resource-group

Examples

List schedules by automation account

az automation schedule list --automation-account-name "myAutomationAccount" --resource-group "rg"

Required Parameters

--automation-account-name

The name of the automation account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 automation schedule show

Retrieve the schedule identified by schedule name.

az automation schedule show --automation-account-name
                            --name
                            --resource-group

Examples

Get schedule

az automation schedule show --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "mySchedule"

Required Parameters

--automation-account-name

The name of the automation account.

--name --schedule-name -n

The schedule name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 automation schedule update

Update an automation schedule.

az automation schedule update --automation-account-name
                              --name
                              --resource-group
                              [--description]
                              [--is-enabled {false, true}]

Examples

Update an automation schedule

az automation schedule update --automation-account-name "myAutomationAccount" --description test                -n mySchedule --resource-group "rg" --is-enabled false

Required Parameters

--automation-account-name

The name of the automation account.

--name --schedule-name -n

The schedule name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--description

The description of the schedule.

--is-enabled

Indicate whether this schedule is enabled.

Accepted values: false, true
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.