[ARM] `az stack`: Update to API version `2024-03-01` and add `validate` subcommand

[kalbert312]

Related command

Description

Testing Guide

History Notes

[Component Name 1] BREAKING CHANGE: az command a: Make some customer-facing breaking change [Component Name 2] az command b: Add some customer-facing feature

---

This checklist is used to make sure that common guidelines for a pull request are followed.

• [ ] The PR title and description has followed the guideline in Submitting Pull Requests.

• [ ] I adhere to the Command Guidelines.

• [ ] I adhere to the Error Handling Guidelines.

[azure-client-tools-bot-prd[bot]]

️✔️AzureCLI-FullTest

️✔️acr

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️acs

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️advisor

️✔️latest

️✔️3.11

️✔️3.9

️✔️ams

️✔️latest

️✔️3.11

️✔️3.9

️✔️apim

️✔️latest

️✔️3.11

️✔️3.9

️✔️appconfig

️✔️latest

️✔️3.11

️✔️3.9

️✔️appservice

️✔️latest

️✔️3.11

️✔️3.9

️✔️aro

️✔️latest

️✔️3.11

️✔️3.9

️✔️backup

️✔️latest

️✔️3.11

️✔️3.9

️✔️batch

️✔️latest

️✔️3.11

️✔️3.9

️✔️batchai

️✔️latest

️✔️3.11

️✔️3.9

️✔️billing

️✔️latest

️✔️3.11

️✔️3.9

️✔️botservice

️✔️latest

️✔️3.11

️✔️3.9

️✔️cdn

️✔️latest

️✔️3.11

️✔️3.9

️✔️cloud

️✔️latest

️✔️3.11

️✔️3.9

️✔️cognitiveservices

️✔️latest

️✔️3.11

️✔️3.9

️✔️compute_recommender

️✔️latest

️✔️3.11

️✔️3.9

️✔️config

️✔️latest

️✔️3.11

️✔️3.9

️✔️configure

️✔️latest

️✔️3.11

️✔️3.9

️✔️consumption

️✔️latest

️✔️3.11

️✔️3.9

️✔️container

️✔️latest

️✔️3.11

️✔️3.9

️✔️containerapp

️✔️latest

️✔️3.11

️✔️3.9

️✔️core

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️cosmosdb

️✔️latest

️✔️3.11

️✔️3.9

️✔️databoxedge

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️dla

️✔️latest

️✔️3.11

️✔️3.9

️✔️dls

️✔️latest

️✔️3.11

️✔️3.9

️✔️dms

️✔️latest

️✔️3.11

️✔️3.9

️✔️eventgrid

️✔️latest

️✔️3.11

️✔️3.9

️✔️eventhubs

️✔️latest

️✔️3.11

️✔️3.9

️✔️feedback

️✔️latest

️✔️3.11

️✔️3.9

️✔️find

️✔️latest

️✔️3.11

️✔️3.9

️✔️hdinsight

️✔️latest

️✔️3.11

️✔️3.9

️✔️identity

️✔️latest

️✔️3.11

️✔️3.9

️✔️iot

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️keyvault

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️kusto

️✔️latest

️✔️3.11

️✔️3.9

️✔️lab

️✔️latest

️✔️3.11

️✔️3.9

️✔️managedservices

️✔️latest

️✔️3.11

️✔️3.9

️✔️maps

️✔️latest

️✔️3.11

️✔️3.9

️✔️marketplaceordering

️✔️latest

️✔️3.11

️✔️3.9

️✔️monitor

️✔️latest

️✔️3.11

️✔️3.9

️✔️mysql

️✔️latest

️✔️3.11

️✔️3.9

️✔️netappfiles

️✔️latest

️✔️3.11

️✔️3.9

️✔️network

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️policyinsights

️✔️latest

️✔️3.11

️✔️3.9

️✔️privatedns

️✔️latest

️✔️3.11

️✔️3.9

️✔️profile

️✔️latest

️✔️3.11

️✔️3.9

️✔️rdbms

️✔️latest

️✔️3.11

️✔️3.9

️✔️redis

️✔️latest

️✔️3.11

️✔️3.9

️✔️relay

️✔️latest

️✔️3.11

️✔️3.9

️✔️resource

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️role

️✔️latest

️✔️3.11

️✔️3.9

️✔️search

️✔️latest

️✔️3.11

️✔️3.9

️✔️security

️✔️latest

️✔️3.11

️✔️3.9

️✔️servicebus

️✔️latest

️✔️3.11

️✔️3.9

️✔️serviceconnector

️✔️latest

️✔️3.11

️✔️3.9

️✔️servicefabric

️✔️latest

️✔️3.11

️✔️3.9

️✔️signalr

️✔️latest

️✔️3.11

️✔️3.9

️✔️sql

️✔️latest

️✔️3.11

️✔️3.9

️✔️sqlvm

️✔️latest

️✔️3.11

️✔️3.9

️✔️storage

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️synapse

️✔️latest

️✔️3.11

️✔️3.9

️✔️telemetry

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️util

️✔️latest

️✔️3.11

️✔️3.9

️✔️vm

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

[azure-client-tools-bot-prd[bot]]

Hi @kalbert312, Since the current milestone time is less than 7 days, this pr will be reviewed in the next milestone.

[azure-client-tools-bot-prd[bot]]

❌AzureCLI-BreakingChangeTest

❌resource

rule	cmd_name	rule_message	suggest_message
❌ 1007 - ParaRemove	stack group create	cmd stack group create removed parameter delete_all	please add back parameter delete_all for cmd stack group create
❌ 1007 - ParaRemove	stack group create	cmd stack group create removed parameter delete_resource_groups	please add back parameter delete_resource_groups for cmd stack group create
❌ 1007 - ParaRemove	stack group create	cmd stack group create removed parameter delete_resources	please add back parameter delete_resources for cmd stack group create
❌ 1008 - ParaPropAdd	stack group create	cmd stack group create update parameter action_on_unmanage: added property required=True	please remove property required=True for parameter action_on_unmanage of cmd stack group create
❌ 1007 - ParaRemove	stack group delete	cmd stack group delete removed parameter delete_all	please add back parameter delete_all for cmd stack group delete
❌ 1007 - ParaRemove	stack group delete	cmd stack group delete removed parameter delete_resource_groups	please add back parameter delete_resource_groups for cmd stack group delete
❌ 1007 - ParaRemove	stack group delete	cmd stack group delete removed parameter delete_resources	please add back parameter delete_resources for cmd stack group delete
❌ 1008 - ParaPropAdd	stack group delete	cmd stack group delete update parameter action_on_unmanage: added property required=True	please remove property required=True for parameter action_on_unmanage of cmd stack group delete
❌ 1007 - ParaRemove	stack mg create	cmd stack mg create removed parameter delete_all	please add back parameter delete_all for cmd stack mg create
❌ 1007 - ParaRemove	stack mg create	cmd stack mg create removed parameter delete_resource_groups	please add back parameter delete_resource_groups for cmd stack mg create
❌ 1007 - ParaRemove	stack mg create	cmd stack mg create removed parameter delete_resources	please add back parameter delete_resources for cmd stack mg create
❌ 1008 - ParaPropAdd	stack mg create	cmd stack mg create update parameter action_on_unmanage: added property required=True	please remove property required=True for parameter action_on_unmanage of cmd stack mg create
❌ 1007 - ParaRemove	stack mg delete	cmd stack mg delete removed parameter delete_all	please add back parameter delete_all for cmd stack mg delete
❌ 1007 - ParaRemove	stack mg delete	cmd stack mg delete removed parameter delete_resource_groups	please add back parameter delete_resource_groups for cmd stack mg delete
❌ 1007 - ParaRemove	stack mg delete	cmd stack mg delete removed parameter delete_resources	please add back parameter delete_resources for cmd stack mg delete
❌ 1008 - ParaPropAdd	stack mg delete	cmd stack mg delete update parameter action_on_unmanage: added property required=True	please remove property required=True for parameter action_on_unmanage of cmd stack mg delete
❌ 1007 - ParaRemove	stack sub create	cmd stack sub create removed parameter delete_all	please add back parameter delete_all for cmd stack sub create
❌ 1007 - ParaRemove	stack sub create	cmd stack sub create removed parameter delete_resource_groups	please add back parameter delete_resource_groups for cmd stack sub create
❌ 1007 - ParaRemove	stack sub create	cmd stack sub create removed parameter delete_resources	please add back parameter delete_resources for cmd stack sub create
❌ 1008 - ParaPropAdd	stack sub create	cmd stack sub create update parameter action_on_unmanage: added property required=True	please remove property required=True for parameter action_on_unmanage of cmd stack sub create
❌ 1007 - ParaRemove	stack sub delete	cmd stack sub delete removed parameter delete_all	please add back parameter delete_all for cmd stack sub delete
❌ 1007 - ParaRemove	stack sub delete	cmd stack sub delete removed parameter delete_resource_groups	please add back parameter delete_resource_groups for cmd stack sub delete
❌ 1007 - ParaRemove	stack sub delete	cmd stack sub delete removed parameter delete_resources	please add back parameter delete_resources for cmd stack sub delete
❌ 1008 - ParaPropAdd	stack sub delete	cmd stack sub delete update parameter action_on_unmanage: added property required=True	please remove property required=True for parameter action_on_unmanage of cmd stack sub delete
⚠️ 1006 - ParaAdd	stack group create	cmd stack group create added parameter bypass_stack_out_of_sync_error
⚠️ 1006 - ParaAdd	stack group delete	cmd stack group delete added parameter bypass_stack_out_of_sync_error
⚠️ 1001 - CmdAdd	stack group validate	cmd stack group validate added
⚠️ 1006 - ParaAdd	stack mg create	cmd stack mg create added parameter bypass_stack_out_of_sync_error
⚠️ 1006 - ParaAdd	stack mg delete	cmd stack mg delete added parameter bypass_stack_out_of_sync_error
⚠️ 1001 - CmdAdd	stack mg validate	cmd stack mg validate added
⚠️ 1006 - ParaAdd	stack sub create	cmd stack sub create added parameter bypass_stack_out_of_sync_error
⚠️ 1006 - ParaAdd	stack sub delete	cmd stack sub delete added parameter bypass_stack_out_of_sync_error
⚠️ 1001 - CmdAdd	stack sub validate	cmd stack sub validate added

[yonzhan]

ARM

[kalbert312]

@zhoxing-ms this PR is now ready for review. This needs to make it into https://github.com/Azure/azure-cli/milestone/142

[azcloudfarmer]

Hello @zhoxing-ms and CLI Team - friendly reminder on review here. Thanks in advance!

[zhoxing-ms]

Sorry, I am super busy now. @yanzhudd Could you please help review this PR when you have time?

[azcloudfarmer]

Hello @zhoxing-ms - thank you for recommending/suggesting a second reviewer. @yanzhudd please let us know if you have any questions around this PR. We are targeting the announcement of this new service at MS BUILD conference now May 20th. We appreciate the quickness here. Thanks!

[yanzhudd]

History Notes

[ARM] BREAKING CHANGE: az stack <group/sub/mg> <create/delete>: Remove the deprecated --delete-all, --delete-resources, and --delete-resource-groups flags. Use the --action-on-unmanage <value>/--aou <value> parameter instead. There is no default behavior, so this new parameter is required. Previously with no --delete-* flags specified, the default behavior was "detachAll" which can be represented with --action-on-unmanage detachAll [ARM] az stack: Stacks commands now use stacks GA API version 2024-03-01 (was 2022-08-01-preview) [ARM] az stack <group/sub/mg> validate: Add new validate command to preform preflight validation on a stack deployment. This command accepts nearly the same parameters as the create command. See release notes for az stack <scope> create commands to see how this also now applies to the create command [ARM] az stack <group/sub> create: Validation of a stack will now occur before a stack is created or updated. This is the same operation carried out by az stack <scope> validate. This will come to az stack mg create in a future bugfix release. This is how az deployment <scope> create works currently [ARM] az stack <group/sub/mg> <create/delete>: Action on unmanage behavior for stack managed management groups can now be configured. Use --action-on-unmanage deleteAll to delete newly unmanaged management groups. All other values to --action-on-unmanage will result in detachment of newly unmanaged management groups [ARM] az stack <group/sub/mg> create: The correlation ID of the create operation is now returned as a property of the stack [ARM] az stack <group/sub/mg> <create/delete>: Add new flag --bypass-stack-out-of-sync-error/--bse that will bypass errors related to the resource list of a stack being out of sync. This is designed to be used as a fallback in the case that a stack is stuck due to these types of errors

1. It is not necessary to use <> characters in commands and parameters, e.g., use az stack group/sub/mg validate instead of az stack <group/sub/mg> validate, and use --action-on-unmanage instead of --action-on-unmanage <value>
2. For each item, please describe the change (in one sentence) as briefly as possible. If there are multiple changes, please split it into several items.
3. [] is used for customer-facing change, and {} is for non-customer-facing. Therefore, the changes like upgrading API version should use {}.

You can refer to the doc submitting pull requests for more details.

[yanzhudd]

Since this PR also updates the core module, @zhoxing-ms could you please help to review it as well?

[zhoxing-ms]

It is not necessary to use <> characters in commands and parameters, e.g., use az stack group/sub/mg validate instead of az stack <group/sub/mg> validate, and use --action-on-unmanage instead of --action-on-unmanage For each item, please describe the change (in one sentence) as briefly as possible. If there are multiple changes, please split it into several items. [] is used for customer-facing change, and {} is for non-customer-facing. Therefore, the changes like upgrading API version should use {}.

I have optimized the PR description for you, please see if it meets your expectations @kalbert312