az ml schedule

Note

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

Manage Azure ML schedule resources.

Azure ML schedule defines how to trigger jobs on a regular basis to keep training models up-to-date, to run and download inference results on a periodic basis and many other scenarios, you can use cron expression and recurrence to define the trigger pattern.

Commands

az ml schedule create

Create a schedule.

az ml schedule delete

Delete a schedule. The previous triggered jobs will NOT be deleted.

az ml schedule disable

Disable a schedule so that it will stop triggering jobs.

az ml schedule enable

Enable a schedule so that it will continue triggering jobs.

az ml schedule list

List the schedules in a workspace.

az ml schedule show

Show details of a schedule.

az ml schedule update

Update a schedule.

az ml schedule create

Create a schedule.

az ml schedule create --file
                      --resource-group
                      [--name]
                      [--no-wait]
                      [--set]
                      [--workspace-name]

Examples

Create a schedule from a YAML specification file

az ml schedule create --file schedule.yml --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--file -f

Local path to the YAML file containing the Azure ML schedule specification. The YAML reference docs for schedule can be found at: https://aka.ms/ml-cli-v2-schedule-yaml-reference.

--resource-group -g

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

Optional Parameters

--name -n

Name of the schedule.

--no-wait

Do not wait for the long-running operation to finish.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--workspace-name -w

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

az ml schedule delete

Delete a schedule. The previous triggered jobs will NOT be deleted.

az ml schedule delete --name
                      --resource-group
                      --workspace-name
                      [--no-wait]

Required Parameters

--name -n

Name of the schedule.

--resource-group -g

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

--workspace-name -w

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

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az ml schedule disable

Disable a schedule so that it will stop triggering jobs.

az ml schedule disable --name
                       --resource-group
                       --workspace-name
                       [--no-wait]

Required Parameters

--name -n

Name of the schedule.

--resource-group -g

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

--workspace-name -w

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

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az ml schedule enable

Enable a schedule so that it will continue triggering jobs.

az ml schedule enable --name
                      --resource-group
                      --workspace-name
                      [--no-wait]

Required Parameters

--name -n

Name of the schedule.

--resource-group -g

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

--workspace-name -w

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

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az ml schedule list

List the schedules in a workspace.

az ml schedule list --resource-group
                    [--max-results]
                    [--workspace-name]

Examples

List all the schedules in a workspace using --query argument to execute a JMESPath query on the results of commands.

az ml schedule list --query "[].{Name:name}"  --output table --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--resource-group -g

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

Optional Parameters

--max-results -r

Max number of results to return.

--workspace-name -w

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

az ml schedule show

Show details of a schedule.

az ml schedule show --name
                    --resource-group
                    [--workspace-name]

Examples

Show details of a schedule

az ml schedule show --name my-schedule --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--name -n

Name of the schedule.

--resource-group -g

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

Optional Parameters

--workspace-name -w

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

az ml schedule update

Update a schedule.

az ml schedule update --name
                      --resource-group
                      --workspace-name
                      [--add]
                      [--force-string]
                      [--no-wait]
                      [--remove]
                      [--set]

Examples

Update existing tags or add new tags for a schedule

az ml schedule update --name my-schedule --set tags.key1=value1 tags.key2=value2 --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--name -n

Name of the schedule.

--resource-group -g

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

--workspace-name -w

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--no-wait

Do not wait for the long-running operation to finish.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.