|
151 | 151 | - name: Create a StageMap with parameters |
152 | 152 | text: |- |
153 | 153 | az changesafety stagemap create --subscription 00000000-0000-0000-0000-000000000000 --stage-map-name parameterized-rollout --stages "[{name:Canary,sequence:1},{name:Production,sequence:2}]" --parameters region.string.default-value=westus batchSize.number.default-value=10 |
| 154 | + - name: Create a StageMap with stage variables |
| 155 | + text: |- |
| 156 | + az changesafety stagemap create --subscription 00000000-0000-0000-0000-000000000000 --stage-map-name staged-rollout --stages "[{name:Canary,sequence:1,stage-variables:{region:westus,batchSize:5}},{name:Production,sequence:2,stage-variables:{region:eastus,batchSize:50}}]" |
154 | 157 | """ |
155 | 158 |
|
156 | 159 | helps['changesafety stagemap update'] = """ |
|
194 | 197 | text: |- |
195 | 198 | az changesafety stagemap list --subscription 00000000-0000-0000-0000-000000000000 |
196 | 199 | """ |
| 200 | + |
| 201 | +helps['changesafety stageprogression'] = """ |
| 202 | + type: group |
| 203 | + short-summary: Manage StageProgression resources that track the execution of individual stages within a ChangeRecord. |
| 204 | +""" |
| 205 | + |
| 206 | +helps['changesafety stageprogression create'] = """ |
| 207 | + type: command |
| 208 | + short-summary: Create a StageProgression to track stage execution for a ChangeRecord. |
| 209 | + long-summary: > |
| 210 | + A StageProgression records the status of a specific stage defined in the ChangeRecord's |
| 211 | + StageMap. Use this command to signal that a stage has started, completed, or encountered |
| 212 | + an issue. The --stage-reference must match a stage name in the associated StageMap. |
| 213 | + parameters: |
| 214 | + - name: --change-record-name |
| 215 | + short-summary: The name of the ChangeRecord resource this progression belongs to. |
| 216 | + - name: --stage-reference |
| 217 | + short-summary: Stage name from the associated StageMap (e.g., Canary, Production). |
| 218 | + - name: --status |
| 219 | + short-summary: "Status of the stage progression: Initialized, InProgress, Completed, Failed, Cancelled, Paused, or Skipped." |
| 220 | + - name: --comments |
| 221 | + short-summary: Optional comments about this stage progression. |
| 222 | + - name: --stage-variables |
| 223 | + short-summary: Key-value pairs of variables specific to this stage execution. |
| 224 | + - name: --links |
| 225 | + short-summary: Collection of related links. Use --links name=NAME uri=URL [description=TEXT]. |
| 226 | + examples: |
| 227 | + - name: Create a StageProgression for the Canary stage |
| 228 | + text: |- |
| 229 | + az changesafety stageprogression create --change-record-name my-changerecord -n canary-progression --stage-reference Canary --status InProgress |
| 230 | + - name: Create a StageProgression with stage variables and a link |
| 231 | + text: |- |
| 232 | + 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'}]" |
| 233 | +""" |
| 234 | + |
| 235 | +helps['changesafety stageprogression update'] = """ |
| 236 | + type: command |
| 237 | + short-summary: Update an existing StageProgression resource. |
| 238 | + long-summary: > |
| 239 | + Update the status, comments, or other metadata of a StageProgression. Commonly used |
| 240 | + to transition a stage from InProgress to Completed or Failed. |
| 241 | + parameters: |
| 242 | + - name: --change-record-name |
| 243 | + short-summary: The name of the ChangeRecord resource. |
| 244 | + - name: --status |
| 245 | + short-summary: "Updated status: Initialized, InProgress, Completed, Failed, Cancelled, Paused, or Skipped." |
| 246 | + - name: --comments |
| 247 | + short-summary: Add or update comments about this stage progression. |
| 248 | + examples: |
| 249 | + - name: Mark a stage as completed |
| 250 | + text: |- |
| 251 | + az changesafety stageprogression update --change-record-name my-changerecord -n canary-progression --status Completed --comments "Canary validation passed" |
| 252 | + - name: Mark a stage as failed |
| 253 | + text: |- |
| 254 | + az changesafety stageprogression update --change-record-name my-changerecord -n prod-progression --status Failed --comments "Deployment rollback triggered" |
| 255 | +""" |
| 256 | + |
| 257 | +helps['changesafety stageprogression show'] = """ |
| 258 | + type: command |
| 259 | + short-summary: Show details for a StageProgression resource. |
| 260 | + examples: |
| 261 | + - name: Show a StageProgression |
| 262 | + text: |- |
| 263 | + az changesafety stageprogression show --change-record-name my-changerecord -n canary-progression |
| 264 | +""" |
| 265 | + |
| 266 | +helps['changesafety stageprogression delete'] = """ |
| 267 | + type: command |
| 268 | + short-summary: Delete a StageProgression resource. |
| 269 | + examples: |
| 270 | + - name: Delete a StageProgression |
| 271 | + text: |- |
| 272 | + az changesafety stageprogression delete --change-record-name my-changerecord -n canary-progression --yes |
| 273 | +""" |
| 274 | + |
| 275 | +helps['changesafety stageprogression list'] = """ |
| 276 | + type: command |
| 277 | + short-summary: List StageProgression resources for a ChangeRecord. |
| 278 | + examples: |
| 279 | + - name: List all StageProgressions for a ChangeRecord |
| 280 | + text: |- |
| 281 | + az changesafety stageprogression list --change-record-name my-changerecord |
| 282 | +""" |
0 commit comments