az changesafety stageprogression

Note

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

Manage StageProgression resources that track the execution of individual stages within a ChangeRecord.

Commands

Name	Description	Type	Status
az changesafety stageprogression create	Create a StageProgression to track stage execution for a ChangeRecord.	Extension	GA
az changesafety stageprogression delete	Delete a StageProgression resource.	Extension	GA
az changesafety stageprogression list	List StageProgression resources for a ChangeRecord.	Extension	GA
az changesafety stageprogression show	Show details for a StageProgression resource.	Extension	GA
az changesafety stageprogression update	Update an existing StageProgression resource.	Extension	GA

az changesafety stageprogression create

Create a StageProgression to track stage execution for a ChangeRecord.

A StageProgression records the status of a specific stage defined in the ChangeRecord's StageMap. Use this command to signal that a stage has started, completed, or encountered an issue. The --stage-reference must match a stage name in the associated StageMap.

az changesafety stageprogression create --change-record-name
                                        --name --stage-progression-name
                                        [--acquire-policy-token]
                                        [--additional-data]
                                        [--change-reference]
                                        [--comments]
                                        [--links]
                                        [--parameters]
                                        [--resource-group]
                                        [--stage-reference]
                                        [--stage-variables]
                                        [--status {Cancelled, Completed, Failed, InProgress, Initialized, Paused, Skipped}]

Examples

Create a StageProgression for the Canary stage

az changesafety stageprogression create --change-record-name my-changerecord -n canary-progression --stage-reference Canary --status InProgress

Create a StageProgression with stage variables and a link

az changesafety stageprogression create --change-record-name my-changerecord -n prod-progression --stage-reference Production --status Initialized --stage-variables "{region:eastus,batchSize:50}" --links "[{name:dashboard,uri:'https://contoso.com/deploy/prod'}]"

Required Parameters

--change-record-name

The name of the ChangeRecord resource this progression belongs to.

--name --stage-progression-name -n

Name of the stageProgression.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--additional-data

Additional metadata for the stageProgression resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--comments

Optional comments about this stage progression.

Property	Value
Parameter group:	Properties Arguments

--links

Collection of related links. Use --links name=NAME uri=URL [description=TEXT].

Property	Value
Parameter group:	Properties Arguments

--parameters

Stage specific key value pairs of parameter names & their values for the current Stage, If any. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--resource-group -g

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

--stage-reference

Stage name from the associated StageMap (e.g., Canary, Production).

Property	Value
Parameter group:	Properties Arguments

--stage-variables

Key-value pairs of variables specific to this stage execution.

Property	Value
Parameter group:	Properties Arguments

--status

Status of the stage progression: Initialized, InProgress, Completed, Failed, Cancelled, Paused, or Skipped.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Cancelled, Completed, Failed, InProgress, Initialized, Paused, Skipped

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az changesafety stageprogression delete

Delete a StageProgression resource.

az changesafety stageprogression delete [--acquire-policy-token]
                                        [--change-record-name]
                                        [--change-reference]
                                        [--ids]
                                        [--name --stage-progression-name]
                                        [--resource-group]
                                        [--subscription]
                                        [--yes]

Examples

Delete a StageProgression

az changesafety stageprogression delete --change-record-name my-changerecord -n canary-progression --yes

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-record-name

The name of the ChangeRecord resource.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--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.

Property	Value
Parameter group:	Resource Id Arguments

--name --stage-progression-name -n

Name of the stageProgression.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az changesafety stageprogression list

List StageProgression resources for a ChangeRecord.

az changesafety stageprogression list --change-record-name
                                      [--max-items]
                                      [--next-token]
                                      [--resource-group]

Examples

List all StageProgressions for a ChangeRecord

az changesafety stageprogression list --change-record-name my-changerecord

Required Parameters

--change-record-name

The name of the ChangeRecord resource.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

--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.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az changesafety stageprogression show

Show details for a StageProgression resource.

az changesafety stageprogression show [--change-record-name]
                                      [--ids]
                                      [--name --stage-progression-name]
                                      [--resource-group]
                                      [--subscription]

Examples

Show a StageProgression

az changesafety stageprogression show --change-record-name my-changerecord -n canary-progression

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--change-record-name

The name of the ChangeRecord resource.

Property	Value
Parameter group:	Resource Id Arguments

--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.

Property	Value
Parameter group:	Resource Id Arguments

--name --stage-progression-name -n

Name of the stageProgression.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az changesafety stageprogression update

Update an existing StageProgression resource.

Update the status, comments, or other metadata of a StageProgression. Commonly used to transition a stage from InProgress to Completed or Failed.

az changesafety stageprogression update [--acquire-policy-token]
                                        [--add]
                                        [--additional-data]
                                        [--change-record-name]
                                        [--change-reference]
                                        [--comments]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--ids]
                                        [--links]
                                        [--name --stage-progression-name]
                                        [--parameters]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--stage-reference]
                                        [--stage-variables]
                                        [--status {Cancelled, Completed, Failed, InProgress, Initialized, Paused, Skipped}]
                                        [--subscription]

Examples

Mark a stage as completed

az changesafety stageprogression update --change-record-name my-changerecord -n canary-progression --status Completed --comments "Canary validation passed"

Mark a stage as failed

az changesafety stageprogression update --change-record-name my-changerecord -n prod-progression --status Failed --comments "Deployment rollback triggered"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--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>.

Property	Value
Parameter group:	Generic Update Arguments

--additional-data

Additional metadata for the stageProgression resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--change-record-name

The name of the ChangeRecord resource.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--comments

Add or update comments about this stage progression.

Property	Value
Parameter group:	Properties Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--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.

Property	Value
Parameter group:	Resource Id Arguments

--links

Collection of related links for the change. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--name --stage-progression-name -n

Name of the stageProgression.

Property	Value
Parameter group:	Resource Id Arguments

--parameters

Stage specific key value pairs of parameter names & their values for the current Stage, If any. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--stage-reference

Stage name relevant to hierarchical StageMap.

Property	Value
Parameter group:	Properties Arguments

--stage-variables

Variables to apply on the change of that stage. Key value pairs supporting any JSON values. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--status

Updated status: Initialized, InProgress, Completed, Failed, Cancelled, Paused, or Skipped.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Cancelled, Completed, Failed, InProgress, Initialized, Paused, Skipped

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False