-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Henrydai/implement changesafety crud for 2026-01-01-preview after changeRecord renaming #9357
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
henryzdai
wants to merge
45
commits into
Azure:main
Choose a base branch
from
henryzdai:henrydai/implementChangeStateCRUD0901
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
45 commits
Select commit
Hold shift + click to select a range
06f5f1e
Add stub code
74a3d0f
Fix parsing
b80cda8
Fix parsing
add68de
Fix displaying
1f12482
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
aeb58e6
Fix commands
1636d5d
Add tests
b9696af
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
b26a3b2
Fix style
1a9b886
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
ea95cc0
Rename cli extension module name
6e4bdaa
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
bdeffae
Fix linter
c50dfe8
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
78286dd
Fix linter
421d339
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
56b725b
Fix linter
d03e382
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
964371c
Fix module name
34d2514
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
3f5b4d7
add test scenarios
f0d9bdc
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
1578369
Fix style
7274b10
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
6c8d92c
Add service name
ee776c6
Add stageprogression and stagemap
aa3b9bd
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
8dd8743
Update alias
d02017a
Update ChangeRecord name
871d9b4
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
bf2565b
Address comments
e52f0b2
Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…
0201ab5
Update comments
74531c8
Update CLI to rename changeRecords for 2026-01-01-repview
094e6bf
Update CLI to rename changeRecords for 2026-01-01-repview
8abf613
Fix custom
e067473
Merge remote-tracking branch 'other-repo/feature/changesafety-api-202…
6dc6162
Fix issues
46f52a7
Merge remote-tracking branch 'other-repo/feature/changesafety-api-202…
2d96cae
fix stageMap parameters
0b2a75d
Merge remote-tracking branch 'other-repo/feature/changesafety-api-202…
589a9ca
Update changesafety docs, help text, and test recording
2bbf4b8
Merge remote-tracking branch 'other-repo/feature/changesafety-api-202…
fece976
Merge branch 'main' of https://github.com/henryzdai/azure-cli-extensi…
59b29a0
Address PR review: add stageprogression help docs, stagevariables exa…
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| .. :changelog: | ||
|
|
||
| Release History | ||
| =============== | ||
|
|
||
| 1.0.0b1 | ||
| ++++++ | ||
| * Initial release. | ||
| * Manage ChangeRecord, StageMap, and StageProgression resources (API version ``2026-01-01-preview``). | ||
| * Custom ``--targets`` parsing with key=value shorthand (e.g., ``resourceId=...,operation=DELETE``). | ||
| * ``--stagemap-name`` shortcut to reference a StageMap by name. | ||
| * Default scheduling: ``anticipatedStartTime`` defaults to now, ``anticipatedEndTime`` to +8 hours. | ||
| * Supports ``--acquire-policy-token`` and ``--change-reference`` for guarded resource operations. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| # Azure CLI Change Safety Extension | ||
| Azure CLI extension for managing Change Safety resources. This includes `ChangeRecord`, `StageMap`, and `StageProgression` resources for coordinating, tracking, and safely deploying changes across your Azure environment. | ||
henryzdai marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Installation | ||
| ```bash | ||
| az extension add --source <path-to-extension-dist> --yes | ||
| # or install the latest published build | ||
| az extension add --name azure-changesafety | ||
| ``` | ||
|
|
||
| ## Commands | ||
|
|
||
| ### ChangeRecord | ||
| ```bash | ||
| az changesafety changerecord create # Create a ChangeRecord for one or more targets. | ||
| az changesafety changerecord update # Update metadata, rollout settings, or scheduling. | ||
| az changesafety changerecord delete # Delete a ChangeRecord resource. | ||
| az changesafety changerecord show # Display details for a ChangeRecord resource. | ||
| az changesafety changerecord list # List ChangeRecord resources. | ||
| ``` | ||
|
|
||
| ### StageMap | ||
| ```bash | ||
| az changesafety stagemap create # Create a StageMap defining rollout stages. | ||
| az changesafety stagemap update # Update StageMap stages. | ||
| az changesafety stagemap delete # Delete a StageMap resource. | ||
| az changesafety stagemap show # Display details for a StageMap resource. | ||
| az changesafety stagemap list # List StageMap resources. | ||
| ``` | ||
|
|
||
| ### StageProgression | ||
| ```bash | ||
| az changesafety stageprogression create # Create a StageProgression to track stage execution. | ||
| az changesafety stageprogression update # Update StageProgression status or comments. | ||
| az changesafety stageprogression delete # Delete a StageProgression resource. | ||
| az changesafety stageprogression show # Display details for a StageProgression resource. | ||
| az changesafety stageprogression list # List StageProgression resources for a ChangeRecord. | ||
| ``` | ||
|
|
||
| Run `az changesafety -h` to see full command groups and examples. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### StageMap Examples | ||
| Create a two-stage StageMap for rollout: | ||
| ```bash | ||
| az changesafety stagemap create \ | ||
| --stage-map-name rolloutStageMap \ | ||
| --stages "[{name:Canary,sequence:1},{name:Production,sequence:2}]" | ||
| ``` | ||
|
|
||
| Create a StageMap with configurable parameters: | ||
| ```bash | ||
| # Parameters use AAZ shorthand: paramName.{string|number|array|object}.property=value | ||
| # Use --parameters paramName.string="??" to explore available properties | ||
| az changesafety stagemap create \ | ||
| --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 | ||
| ``` | ||
|
|
||
| ### ChangeRecord Examples | ||
| Create a ChangeRecord for a manual touch operation (e.g., delete a Traffic Manager profile): | ||
| ```bash | ||
henryzdai marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| az changesafety changerecord create \ | ||
| -g MyResourceGroup \ | ||
| -n delete-trafficmanager \ | ||
| --change-type ManualTouch \ | ||
| --rollout-type Hotfix \ | ||
| --targets "resourceId=/subscriptions/<subId>/resourceGroups/MyResourceGroup/providers/Microsoft.Network/trafficManagerProfiles/myProfile,operation=DELETE" \ | ||
| --description "Delete Traffic Manager profile for maintenance" | ||
| ``` | ||
|
|
||
| Create a ChangeRecord for an app deployment with a StageMap reference: | ||
| ```bash | ||
henryzdai marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| az changesafety changerecord create \ | ||
| -g MyResourceGroup \ | ||
| -n changerecord-webapp-rollout \ | ||
| --change-type AppDeployment \ | ||
| --rollout-type Normal \ | ||
| --targets "resourceId=/subscriptions/<subId>/resourceGroups/MyResourceGroup/providers/Microsoft.Web/sites/myApp,operation=PUT" \ | ||
| --stagemap-name rolloutStageMap \ | ||
| --links name=Runbook uri=https://contoso.com/runbook | ||
| ``` | ||
|
|
||
| > **Scope:** When `-g` is omitted, the ChangeRecord is created at subscription scope. Use `-g` to scope it to a specific resource group. | ||
|
|
||
| Update the ChangeRecord and add a comment: | ||
| ```bash | ||
| az changesafety changerecord update \ | ||
| -g MyResourceGroup \ | ||
| -n changerecord-webapp-rollout \ | ||
| --comments "Deployment validated in canary region" | ||
| ``` | ||
|
|
||
| ### StageProgression Examples | ||
| Create a StageProgression for the Canary stage: | ||
| ```bash | ||
| az changesafety stageprogression create \ | ||
| --change-record-name changerecord-webapp-rollout \ | ||
| -n canary-progression \ | ||
| --stage-reference Canary \ | ||
| --status InProgress | ||
| ``` | ||
|
|
||
| Update StageProgression to mark stage as completed: | ||
| ```bash | ||
| az changesafety stageprogression update \ | ||
| --change-record-name changerecord-webapp-rollout \ | ||
| -n canary-progression \ | ||
| --status Completed \ | ||
| --comments "Canary validation passed" | ||
| ``` | ||
|
|
||
| ## Additional Information | ||
| - View command documentation: `az changesafety -h` | ||
| - Remove the extension when no longer needed: `az extension remove --name azure-changesafety` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| from azure.cli.core import AzCommandsLoader | ||
| from azext_changesafety._help import helps # pylint: disable=unused-import | ||
| # Import custom to apply AZ_HELP patches for StageMap commands | ||
| from azext_changesafety import custom as _custom # pylint: disable=unused-import | ||
|
|
||
|
|
||
| class ChangeRecordCommandsLoader(AzCommandsLoader): | ||
|
|
||
| def __init__(self, cli_ctx=None): | ||
| from azure.cli.core.commands import CliCommandType | ||
| custom_command_type = CliCommandType( | ||
| operations_tmpl='azext_changesafety.custom#{}') | ||
| super().__init__(cli_ctx=cli_ctx, | ||
| custom_command_type=custom_command_type) | ||
|
|
||
| def load_command_table(self, args): | ||
| from azext_changesafety.commands import load_command_table | ||
| from azure.cli.core.aaz import load_aaz_command_table | ||
| try: | ||
| from . import aaz | ||
| except ImportError: | ||
| aaz = None | ||
| if aaz: | ||
| load_aaz_command_table( | ||
| loader=self, | ||
| aaz_pkg_name=aaz.__name__, | ||
| args=args | ||
| ) | ||
| load_command_table(self, args) | ||
| return self.command_table | ||
|
|
||
| def load_arguments(self, command): | ||
| from azext_changesafety._params import load_arguments | ||
| load_arguments(self, command) | ||
|
|
||
|
|
||
| COMMAND_LOADER_CLS = ChangeRecordCommandsLoader |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.