Bendrinti naudojant

az load trigger schedule

  • Preview
  • Reference

Note

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

Command group 'load trigger' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command group to manage schedule triggers.

Commands

Name Description Type Status
az load trigger schedule create

Create a new load trigger schedule.

 Extension Preview
az load trigger schedule delete

Delete a load trigger schedule.

 Extension Preview
az load trigger schedule enable

Enable a schedule trigger.

 Extension Preview
az load trigger schedule list

List all schedule triggers.

 Extension Preview
az load trigger schedule pause

Pause a schedule trigger.

 Extension Preview
az load trigger schedule show

Show details of a load trigger schedule.

 Extension Preview
az load trigger schedule update

Update a load trigger schedule.

 Extension Preview

az load trigger schedule create

Preview

Command group 'load trigger schedule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new load trigger schedule.

az load trigger schedule create --load-test-resource
                                [--description]
                                [--display-name]
                                [--end-after-date-time]
                                [--end-after-occurrence]
                                [--recurrence-cron-exp]
                                [--recurrence-dates]
                                [--recurrence-index {1, 2, 3, 4, 5}]
                                [--recurrence-interval]
                                [--recurrence-type {Cron, Daily, Hourly, MonthlyByDates, MonthlyByDays, Weekly}]
                                [--recurrence-week-days {Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]
                                [--resource-group]
                                [--start-date-time]
                                [--test-ids]
                                [--trigger-id]

Examples

Create a schedule trigger with daily recurrence.

az load trigger schedule create --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id --description "Sample description" --display-name "Sample display name" --start-date-time 2023-01-01T15:16:17Z --recurrence-type Daily --recurrence-interval 1 --end-after-occurrence 5 --test-ids sample-test-id

Create a schedule trigger with weekly recurrence.

az load trigger schedule create --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id --description "Sample description" --display-name "Sample display name" --start-date-time 2023-01-01T15:16:17Z --recurrence-type Weekly --recurrence-interval 1 --recurrence-week-days Monday Tuesday Wednesday Thursday Friday --end-after-occurrence 15 --test-ids sample-test-id

Create a schedule trigger with cron expression.

az load trigger schedule create --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id --description "Sample description" --display-name "Sample display name" --start-date-time 2023-01-01T15:16:17Z --recurrence-cron-exp "0 0 12 * *" --end-after-occurrence 10 --test-ids sample-test-id

Required Parameters

--load-test-resource --name -n

Name or ARM resource ID of the Load Testing resource.

Optional Parameters

--description

Description of the load trigger schedule.

--display-name

Display name of the load trigger schedule.

--end-after-date-time

End after date time of the load trigger schedule.

--end-after-occurrence

End after occurrence of the load trigger schedule.

--recurrence-cron-exp

Cron expression for the recurrence type 'Cron'.

--recurrence-dates

Space separated list of dates in month for the recurrence type 'Monthly'.

--recurrence-index

Index for the recurrence type 'MonthlyByDays'.

Accepted values: 1, 2, 3, 4, 5
--recurrence-interval

Interval for all recurrence type except 'Cron'.

--recurrence-type

Recurrence type of the load trigger schedule.

Accepted values: Cron, Daily, Hourly, MonthlyByDates, MonthlyByDays, Weekly
--recurrence-week-days

Week days for the recurrence type 'Weekly' and 'MonthlyByDays'.

Accepted values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday
--resource-group -g

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

--start-date-time

Start date time of the load trigger schedule.

--test-ids

Test IDs of the load tests to be triggered by schedule. Currently we only support one test ID per schedule.

--trigger-id

Trigger ID of the load trigger.

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 load trigger schedule delete

Preview

Command group 'load trigger schedule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a load trigger schedule.

az load trigger schedule delete --load-test-resource
                                --trigger-id
                                [--resource-group]
                                [--yes]

Examples

Delete schedule.

az load trigger schedule delete --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id

Required Parameters

--load-test-resource --name -n

Name or ARM resource ID of the Load Testing resource.

--trigger-id

Trigger ID of the load trigger.

Optional Parameters

--resource-group -g

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

--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 load trigger schedule enable

Preview

Command group 'load trigger schedule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Enable a schedule trigger.

az load trigger schedule enable --load-test-resource
                                --trigger-id
                                [--resource-group]

Examples

Enable schedule.

az load trigger schedule enable --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id

Required Parameters

--load-test-resource --name -n

Name or ARM resource ID of the Load Testing resource.

--trigger-id

Trigger ID of the load trigger.

Optional Parameters

--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 load trigger schedule list

Preview

Command group 'load trigger schedule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all schedule triggers.

az load trigger schedule list --load-test-resource
                              [--resource-group]
                              [--states {Active, Completed, Disabled, Paused}]
                              [--test-ids]

Examples

List all schedule triggers.

az load trigger schedule list --load-test-resource sample-alt-resource --resource-group sample-rg

List schedule which are in active state.

az load trigger schedule list --load-test-resource sample-alt-resource --resource-group sample-rg --states Active

List schedule which are associated with given test ids.

az load trigger schedule list --load-test-resource sample-alt-resource --resource-group sample-rg --test-ids sample-test-id1 sample-test-id2

List schedule which are in paused state and associated with given test ids.

az load trigger schedule list --load-test-resource sample-alt-resource --resource-group sample-rg --states Paused --test-ids sample-test-id1 sample-test-id2

Required Parameters

--load-test-resource --name -n

Name or ARM resource ID of the Load Testing resource.

Optional Parameters

--resource-group -g

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

--states

List all the schedules in the resource which are in the provided states.

Accepted values: Active, Completed, Disabled, Paused
--test-ids

List all the schedules which are associated with the provided test ids.

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 load trigger schedule pause

Preview

Command group 'load trigger schedule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Pause a schedule trigger.

az load trigger schedule pause --load-test-resource
                               --trigger-id
                               [--resource-group]

Examples

Pause schedule.

az load trigger schedule pause --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id

Required Parameters

--load-test-resource --name -n

Name or ARM resource ID of the Load Testing resource.

--trigger-id

Trigger ID of the load trigger.

Optional Parameters

--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 load trigger schedule show

Preview

Command group 'load trigger schedule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a load trigger schedule.

az load trigger schedule show --load-test-resource
                              --trigger-id
                              [--resource-group]

Examples

Show schedule.

az load trigger schedule show --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id

Required Parameters

--load-test-resource --name -n

Name or ARM resource ID of the Load Testing resource.

--trigger-id

Trigger ID of the load trigger.

Optional Parameters

--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 load trigger schedule update

Preview

Command group 'load trigger schedule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a load trigger schedule.

az load trigger schedule update --load-test-resource
                                --trigger-id
                                [--description]
                                [--display-name]
                                [--end-after-date-time]
                                [--end-after-occurrence]
                                [--recurrence-cron-exp]
                                [--recurrence-dates]
                                [--recurrence-index {1, 2, 3, 4, 5}]
                                [--recurrence-interval]
                                [--recurrence-type {Cron, Daily, Hourly, MonthlyByDates, MonthlyByDays, Weekly}]
                                [--recurrence-week-days {Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]
                                [--resource-group]
                                [--start-date-time]
                                [--test-ids]

Examples

Update display name of schedule.

az load trigger schedule update --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id --display-name "Updated display name"

Update recurrence type of schedule.

az load trigger schedule update --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id --recurrence-type Weekly --recurrence-interval 2 --recurrence-week-days Monday Tuesday Wednesday Thursday Friday

Update recurrence end date of schedule.

az load trigger schedule update --load-test-resource sample-alt-resource --resource-group sample-rg --trigger-id sample-trigger-id --end-after-date-time 2025-12-31T15:16:17Z

Required Parameters

--load-test-resource --name -n

Name or ARM resource ID of the Load Testing resource.

--trigger-id

Trigger ID of the load trigger.

Optional Parameters

--description

Description of the load trigger schedule.

--display-name

Display name of the load trigger schedule.

--end-after-date-time

End after date time of the load trigger schedule.

--end-after-occurrence

End after occurrence of the load trigger schedule.

--recurrence-cron-exp

Cron expression for the recurrence type 'Cron'.

--recurrence-dates

Space separated list of dates in month for the recurrence type 'Monthly'.

--recurrence-index

Index for the recurrence type 'MonthlyByDays'.

Accepted values: 1, 2, 3, 4, 5
--recurrence-interval

Interval for all recurrence type except 'Cron'.

--recurrence-type

Recurrence type of the load trigger schedule.

Accepted values: Cron, Daily, Hourly, MonthlyByDates, MonthlyByDays, Weekly
--recurrence-week-days

Week days for the recurrence type 'Weekly' and 'MonthlyByDays'.

Accepted values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday
--resource-group -g

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

--start-date-time

Start date time of the load trigger schedule.

--test-ids

Test IDs of the load tests to be triggered by schedule. Currently we only support one test ID per 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.