Skip to content

Commit 49cbf72

Browse files
author
Henry Dai
committed
fix stageMap parameters
1 parent f6a9e0b commit 49cbf72

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

src/azure-changesafety/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,16 @@ az changesafety stagemap create \
4949
--stages "[{name:Canary,sequence:1},{name:Production,sequence:2}]"
5050
```
5151

52+
Create a StageMap with configurable parameters:
53+
```bash
54+
# Parameters use AAZ shorthand: paramName.{string|number|array|object}.property=value
55+
# Use --parameters paramName.string="??" to explore available properties
56+
az changesafety stagemap create \
57+
--stage-map-name parameterized-rollout \
58+
--stages "[{name:Canary,sequence:1},{name:Production,sequence:2}]" \
59+
--parameters region.string.default-value=westus batchSize.number.default-value=10
60+
```
61+
5262
### ChangeRecord Examples
5363
Create a ChangeRecord for a manual touch operation (e.g., delete a Traffic Manager profile):
5464
```bash

src/azure-changesafety/azext_changesafety/_help.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,13 +138,22 @@
138138
short-summary: >
139139
Array of stage definitions. Each stage requires a name and sequence number.
140140
Use shorthand syntax or JSON format.
141+
- name: --parameters
142+
short-summary: >
143+
Optional parameters schema for the StageMap. Define parameters that can be
144+
passed when referencing this StageMap from a ChangeRecord. Use AAZ shorthand
145+
syntax: paramName.{string|number|array|object}.default-value=value.
146+
Run with --parameters paramName.string="??" to see available properties.
141147
examples:
142148
- name: Create a simple two-stage StageMap
143149
text: |-
144150
az changesafety stagemap create --subscription 00000000-0000-0000-0000-000000000000 --stage-map-name rolloutStageMap --stages "[{name:Canary,sequence:1},{name:Production,sequence:2}]"
145151
- name: Create a StageMap with three stages
146152
text: |-
147153
az changesafety stagemap create --subscription 00000000-0000-0000-0000-000000000000 --stage-map-name regional-rollout --stages "[{name:WestUS,sequence:1},{name:EastUS,sequence:2},{name:Global,sequence:3}]"
154+
- name: Create a StageMap with parameters
155+
text: |-
156+
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
148157
"""
149158

150159
helps['changesafety stagemap update'] = """

0 commit comments

Comments
 (0)