Skip to content

Standardize CLI#54

Merged
atharvau merged 8 commits intomain-upstream-workload-orchestrationfrom
audapure/standardize
Jun 25, 2025
Merged

Standardize CLI#54
atharvau merged 8 commits intomain-upstream-workload-orchestrationfrom
audapure/standardize

Conversation

@atharvau
Copy link
Copy Markdown
Owner

@atharvau atharvau commented Jun 23, 2025

Azure CLI Workload Orchestration Extension 1.1.7

Overview

The Azure CLI Workload Orchestration Extension provides commands for managing Azure Workload Orchestration resources.

Breaking Changes

Added Command Aliases and Options

Many commands have been updated with additional parameter aliases and short options to improve usability.

  1. Removed Commands:

    • az workload-orchestration target delete-revision
    • az workload-orchestration target deploy
    • az workload-orchestration target deprecate
  2. Required Parameters:

    • --description is now required for:
      • az workload-orchestration config-template create
      • az workload-orchestration solution-template create
      • az workload-orchestration target create

Parameter Alias Standardization

Resource Name Parameters

Added -n and --name aliases to all resource name parameters for consistency:

File Parameter Original New
config_template version show config_template_name --config-template-name --config-template-name, -n, --name
schema version show schema_name --schema-name --schema-name, -n, --name
solution_template version show solution_template_name --solution-template-name --solution-template-name, -n, --name

Version Parameters

Changed version parameter aliases from -n/--name to -v/--version for clarity:

File Parameter Original New
config_template version show.py config_template_version_name -n, --name, --config-template-version-name -v, --version, --config-template-version-name
schema version show schema_version_name -n, --name, --schema-version-name -v, --version, --schema-version-name
solution_template version show solution_template_version_name -n, --name, --version, --solution-template-version-name -v, --version, --solution-template-version-name

This are addition to Command Changes by Group as part of standardization

Added Arguments 🆕

Global Shorthand Options

-n, --name                    # Added to all name parameters
-v, --version                # Added to all version parameters
-t, --target-name            # Added for target operations
-s, --solution-template-name  # Added for solution template operations
-f, --file                   # Added for file input parameters

Config Template Commands

Command Parameter Changes
config-template create --description Now required
config-template create --version Added -v alias
config-template delete Added example documentation
--config-template-version aliases
config-template list Added example documentation
config-template remove-version --config-template-name Added --name and -n aliases
config-template remove-version --version Added -v and --config-template-version aliases
config-template show Added example documentation
config-template version list --config-template-name Added -n and --name aliases
config-template version show --config-template-name Added -n and --name aliases
config-template version show --config-template-version-name Changed to -v and --version aliases

Configuration Commands

Command Parameter Changes
configuration download --target-name Added -t alias
configuration download --solution-template-name Added -s alias
configuration set --target-name Added -t alias
configuration set --solution-template-name Added -s alias
configuration set --file Added -f alias
configuration show --target-name Added -t alias
configuration show --solution-template-name Added -s alias

Context Commands

Command Parameter Changes
context create Updated example (removed state parameter)
context delete Added example documentation
context list Added example documentation
context list-subscriptions Added example documentation
context show Added example documentation
context site-reference delete Added example documentation
context site-reference list Added example documentation
context site-reference show Added example documentation

Diagnostic Commands

Command Parameter Changes
diagnostic delete Added example documentation
diagnostic list Added example documentation
diagnostic show Added example documentation

Schema Commands

Command Parameter Changes
schema create --schema-file Added -f alias
schema delete Added example documentation
schema list Added example documentation
schema list-subscriptions Added example documentation
schema remove-version --schema-name Added -n and --name aliases
schema remove-version --version Added -v alias
schema show Added example documentation
schema version list --schema-name Added -n and --name aliases
schema version show --schema-name Added -n and --name aliases
schema version show --schema-version-name Changed to -v and --version aliases
schema version wait --schema-name Added -n and --name aliases

Solution Template Commands

Command Parameter Changes
solution-template bulk-deploy --solution-template-name Added -n and --name aliases
solution-template bulk-deploy --solution-template-version Added -v alias
solution-template bulk-publish --solution-template-name Added -n and --name aliases
solution-template bulk-publish --solution-template-version Added -v alias
solution-template create --description Now required
solution-template create --version Added -v alias
solution-template create --config-template-file Added -f alias
solution-template delete Added example documentation
solution-template list Added example documentation
solution-template list-subscriptions Added example documentation
solution-template remove-version --solution-template-name Added -n and --name aliases
solution-template remove-version --version Added -v alias
solution-template show Added example documentation
solution-template version list --solution-template-name Added -n and --name aliases
solution-template version show --solution-template-name Added -n and --name aliases
solution-template version show --solution-template-version-name Changed to -v and --version aliases

Target Commands

Command Parameter Changes
target create --description Now required
target install --target-name Added --name and -n aliases
target list Added example documentation, added context_id property
target list-subscriptions Added example documentation, added context_id property
target publish --target-name Added --name and -n aliases
target remove-revision --target-name Added --name and -n aliases
target remove-revision --solution-version Added --version and -v aliases
target show Added example documentation, added context_id property
target uninstall --target-name Added --name and -n aliases
target update-external-validation-status --target-name Added --name and -n aliases

Removed Commands

The following commands have been removed from the extension:

Other Changes

  • Improved documentation with additional examples for most commands
  • Standardized parameter aliases across commands
  • Added context_id property to target-related command outputs

@atharvau atharvau merged commit 7fa54c5 into main-upstream-workload-orchestration Jun 25, 2025
atharvau added a commit that referenced this pull request Jul 16, 2025
* Upstream Merge

* Merge from workload-orchestration : Added Example in Description (#34)

* Merge from workload-orchestration : Fixed Example

* Fixed Example for SolutionTemplateVersion

* Made Changes for command-change CI fix'

* Reset Version 1.0.0b1

* Added Bulk and Diagnostics Back (#35)

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Added Bulk Solution Example (#36)

* Added Bulk and Diagnostics Back

* Changes

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Fixed Solution Template Linter Issue

* Added Integration Tests Framework for WorkloadOrchestration #37

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Added ServiceName  (#38)

* Added Tests

* Made Changes on ServiceName

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Added Full Target Solution Tests (#39)

* Added Tests

* Made Changes on ServiceName

* Nit Changes

* Made Changes for ContextLookup

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Added E2E workflow Tests (#40)

* Added Tests

* Made Changes on ServiceName

* Nit Changes

* Made Changes for ContextLookup

* Added complete workflow

* Add Licence

* Added License

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Added Readme (#41)

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Bulk Deployemnent LRO changes (#42)

* made changes

* Added change

* Added Changes in Test

* Added CLi Changes

* Added Setup

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Added Changes For Backward Compitablity (#43)

* Added Changes For Backward Compitablity

* Made changes

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Made changes (#44)

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Target Operations API refractoring  (#47)

* Changes I made

* Make changes

* Made chnages

* Make changes

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Stable API 2025-06-01 (#48)

* Made changes

* Made Changes

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Change in ID in Targets (#50)

* Made changes

* changes

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Remove Id and Name from Target Review  (#51)

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* final bulk (#52)

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Changes in ARG

* Added Linter Exception

* Added ITTests (#53)

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Standardize CLI (#54)

* Made Changes

* Made Changes

* Made changes

* Added Change

* Made changes

* Made changes

* Made changes

* Made Changes

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Linter FIxes and Remove Preview

* Removed Resolved from CLI

* change in version

* made changes (#55)

Co-authored-by: Atharva Udapure <audapure@microsoft.com>

* Fixed history

---------

Co-authored-by: Atharva Udapure <audapure@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant