Skip to content

[Workload-Orchestration] Updated response schema for review and tsv list calls to include l1l2 state properties #9284

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.

Sign up for GitHub

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

Merged
kairu-ms merged 5 commits into from
Oct 16, 2025
Merged

[Workload-Orchestration] Updated response schema for review and tsv list calls to include l1l2 state properties #9284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
994e4e5
Updated review and tsv list commands to include l1l2 in response
ayush-ms Oct 10, 2025
4e9ad4b
Hide unnecessary properties in response for review and tsv list
ayush-ms Oct 10, 2025
7215564
latestActionTriggeredBy spell fix
ayush-ms Oct 10, 2025
b16901b
CLI history and version update
ayush-ms Oct 10, 2025
81386ea
added separate response builder for 202 response
ayush-ms Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/workload-orchestration/HISTORY.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
Release History
===============

4.1.0
++++++
* Added currentStage and latestActionTriggeredBy fields in response of below commands:
* ``az workload-orchestration target review`` - Post request to review configuration.
* ``az workload-orchestration target solution-revision-list`` - List all revisions of a solution deployed on a target.

4.0.0
++++++
* Added new bulk management commands:
Expand Down
233 changes: 179 additions & 54 deletions ...rkload_orchestration/aaz/latest/workload_orchestration/target/_review_solution_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,21 +76,6 @@ def _build_arguments_schema(cls, *args, **kwargs):
max_length=24,
),
)
# Remove these parameters (v2025_06_01)
# _args_schema.solution_template = AAZStrArg(
# options=["--solution-name","--solution-template-name"],
# arg_group="Body",
# help="Solution Template Name",
# required=True,
# )
# _args_schema.solution_template_version = AAZStrArg(
# options=["--solution-version","--solution-template-version"],
# arg_group="Body",
# help="Solution Template Version Name",
# required=True,
# )

# Add new parameter (v2025_06_01)
_args_schema.solution_template_version_id = AAZStrArg(
options=["--solution-template-version-id"],
arg_group="Body",
Expand All @@ -109,6 +94,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
def _build_args_solution_dependency_parameter_create(cls, _schema):
if cls._args_solution_dependency_parameter_create is not None:
_schema.dependencies = cls._args_solution_dependency_parameter_create.dependencies
_schema.solution_instance_name = cls._args_solution_dependency_parameter_create.solution_instance_name
_schema.solution_template_id = cls._args_solution_dependency_parameter_create.solution_template_id
_schema.solution_template_version = cls._args_solution_dependency_parameter_create.solution_template_version
_schema.solution_version_id = cls._args_solution_dependency_parameter_create.solution_version_id
Expand All @@ -122,6 +108,14 @@ def _build_args_solution_dependency_parameter_create(cls, _schema):
options=["dependencies"],
help="Solution dependencies",
)
solution_dependency_parameter_create.solution_instance_name = AAZStrArg(
options=["solution-instance-name"],
help="Solution Instance Name",
fmt=AAZStrArgFormat(
pattern="^(?!v-)(?!.*-v-)[a-zA-Z0-9]([-a-zA-Z0-9]*[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([-a-zA-Z0-9]*[a-zA-Z0-9])?)*$",
max_length=24,
),
)
solution_dependency_parameter_create.solution_template_id = AAZStrArg(
options=["solution-template-id"],
help="Solution Template Id",
Expand All @@ -144,6 +138,7 @@ def _build_args_solution_dependency_parameter_create(cls, _schema):
cls._build_args_solution_dependency_parameter_create(dependencies.Element)

_schema.dependencies = cls._args_solution_dependency_parameter_create.dependencies
_schema.solution_instance_name = cls._args_solution_dependency_parameter_create.solution_instance_name
_schema.solution_template_id = cls._args_solution_dependency_parameter_create.solution_template_id
_schema.solution_template_version = cls._args_solution_dependency_parameter_create.solution_template_version
_schema.solution_version_id = cls._args_solution_dependency_parameter_create.solution_version_id
Expand Down Expand Up @@ -176,7 +171,7 @@ def __call__(self, *args, **kwargs):
return self.client.build_lro_polling(
self.ctx.args.no_wait,
session,
self.on_200,
self.on_202,
self.on_error,
lro_options={"final-state-via": "location"},
path_format_arguments=self.url_parameters,
Expand Down Expand Up @@ -257,11 +252,6 @@ def content(self):
)
_builder.set_prop("solutionDependencies", AAZListType, ".solution_dependencies")
_builder.set_prop("solutionInstanceName", AAZStrType, ".solution_instance_name")
# Remove these properties (v2025_06_01)
# _builder.set_prop("solutionTemplate", AAZStrType, ".solution_template", typ_kwargs={"flags": {"required": True}})
# _builder.set_prop("solutionTemplateVersion", AAZStrType, ".solution_template_version", typ_kwargs={"flags": {"required": True}})

# Add new property (v2025_06_01)
_builder.set_prop("solutionTemplateVersionId", AAZStrType, ".solution_template_version_id", typ_kwargs={"flags": {"required": True}})

solution_dependencies = _builder.get(".solutionDependencies")
Expand All @@ -278,6 +268,14 @@ def on_200(self, session):
schema_builder=self._build_schema_on_200
)

def on_202(self, session):
data = self.deserialize_http_content(session)
self.ctx.set_var(
"instance",
data["properties"],
schema_builder=self._build_schema_on_200
)

_schema_on_200 = None

@classmethod
Expand All @@ -295,20 +293,10 @@ def _build_schema_on_200(cls):
_schema_on_200.extended_location = AAZObjectType(
serialized_name="extendedLocation",
)

_schema_on_200.resourceId = AAZStrType(
serialized_name="resourceId",
flags={"read_only": True},
)
_schema_on_200.status = AAZStrType(
flags={"read_only": True},
)
_schema_on_200.startTime = AAZStrType(
serialized_name="startTime",
_schema_on_200.id = AAZStrType(
flags={"read_only": True},
)
_schema_on_200.endTime = AAZStrType(
serialized_name="endTime",
_schema_on_200.name = AAZStrType(
flags={"read_only": True},
)
_schema_on_200.properties = AAZObjectType()
Expand All @@ -329,66 +317,87 @@ def _build_schema_on_200(cls):
)

properties = cls._schema_on_200.properties
properties.properties = AAZObjectType()
properties.extendedLocation = AAZObjectType(
serialized_name="extendedLocation",
properties.action_type = AAZStrType(
serialized_name="actionType",
flags={"read_only": True},
)
properties.eTag = AAZStrType(
serialized_name="eTag",
properties.configuration = AAZStrType(
flags={"read_only": True},
)
properties.current_stage = AAZObjectType(
serialized_name="currentStage",
flags={"read_only": True},
)
properties.id = AAZStrType(
_ReviewSolutionVersionHelper._build_schema_stage_map_read(properties.current_stage)
properties.error_details = AAZObjectType(
serialized_name="errorDetails",
flags={"read_only": True},
)
properties.name = AAZStrType(
_ReviewSolutionVersionHelper._build_schema_error_detail_read(properties.error_details)
properties.external_validation_id = AAZStrType(
serialized_name="externalValidationId",
flags={"read_only": True},
)
properties.type = AAZStrType(
properties.latest_action_triggered_by = AAZStrType(
serialized_name="latestActionTriggeredBy",
flags={"read_only": True},
)

nested_properties = properties.properties
nested_properties.configuration = AAZStrType(
properties.latest_action_tracking_uri = AAZStrType(
serialized_name="latestActionTrackingUri",
flags={"read_only": True},
)
nested_properties.provisioning_state = AAZStrType(
properties.provisioning_state = AAZStrType(
serialized_name="provisioningState",
flags={"read_only": True},
)
nested_properties.review_id = AAZStrType(
properties.review_id = AAZStrType(
serialized_name="reviewId",
flags={"read_only": True},
)
nested_properties.revision = AAZIntType(
properties.revision = AAZIntType(
flags={"read_only": True},
)
nested_properties.solution_dependencies = AAZListType(
properties.solution_dependencies = AAZListType(
serialized_name="solutionDependencies",
flags={"read_only": True},
)
nested_properties.solution_instance_name = AAZStrType(
properties.solution_instance_name = AAZStrType(
serialized_name="solutionInstanceName",
flags={"read_only": True},
)
nested_properties.solution_template_version_id = AAZStrType(
properties.solution_template_version_id = AAZStrType(
serialized_name="solutionTemplateVersionId",
flags={"read_only": True},
)
nested_properties.specification = AAZFreeFormDictType(
properties.specification = AAZDictType(
flags={"required": True},
)
nested_properties.state = AAZStrType(
# properties.stages = AAZListType(
# flags={"read_only": True},
# )
properties.state = AAZStrType(
flags={"read_only": True},
)
nested_properties.target_display_name = AAZStrType(
properties.target_display_name = AAZStrType(
serialized_name="targetDisplayName",
flags={"read_only": True},
)
properties.target_level_configuration = AAZStrType(
serialized_name="targetLevelConfiguration",
flags={"read_only": True},
)

solution_dependencies = nested_properties.solution_dependencies
solution_dependencies = cls._schema_on_200.properties.solution_dependencies
solution_dependencies.Element = AAZObjectType()
_ReviewSolutionVersionHelper._build_schema_solution_dependency_read(solution_dependencies.Element)

specification = cls._schema_on_200.properties.specification
specification.Element = AAZAnyType()

# stages = cls._schema_on_200.properties.stages
# stages.Element = AAZObjectType()
# _ReviewSolutionVersionHelper._build_schema_stage_map_read(stages.Element)

system_data = cls._schema_on_200.system_data
system_data.created_at = AAZStrType(
serialized_name="createdAt",
Expand Down Expand Up @@ -420,6 +429,7 @@ def _build_schema_solution_dependency_parameter_create(cls, _builder):
if _builder is None:
return
_builder.set_prop("dependencies", AAZListType, ".dependencies")
_builder.set_prop("solutionInstanceName", AAZStrType, ".solution_instance_name")
_builder.set_prop("solutionTemplateId", AAZStrType, ".solution_template_id")
_builder.set_prop("solutionTemplateVersion", AAZStrType, ".solution_template_version")
_builder.set_prop("solutionVersionId", AAZStrType, ".solution_version_id")
Expand All @@ -429,12 +439,71 @@ def _build_schema_solution_dependency_parameter_create(cls, _builder):
if dependencies is not None:
cls._build_schema_solution_dependency_parameter_create(dependencies.set_elements(AAZObjectType, "."))

_schema_error_detail_read = None

@classmethod
def _build_schema_error_detail_read(cls, _schema):
if cls._schema_error_detail_read is not None:
_schema.additional_info = cls._schema_error_detail_read.additional_info
_schema.code = cls._schema_error_detail_read.code
_schema.details = cls._schema_error_detail_read.details
_schema.message = cls._schema_error_detail_read.message
_schema.target = cls._schema_error_detail_read.target
return

cls._schema_error_detail_read = _schema_error_detail_read = AAZObjectType(
flags={"read_only": True}
)

error_detail_read = _schema_error_detail_read
error_detail_read.additional_info = AAZListType(
serialized_name="additionalInfo",
flags={"read_only": True},
)
error_detail_read.code = AAZStrType(
flags={"read_only": True},
)
error_detail_read.details = AAZListType(
flags={"read_only": True},
)
error_detail_read.message = AAZStrType(
flags={"read_only": True},
)
error_detail_read.target = AAZStrType(
flags={"read_only": True},
)

additional_info = _schema_error_detail_read.additional_info
additional_info.Element = AAZObjectType()

_element = _schema_error_detail_read.additional_info.Element
_element.info = AAZDictType(
flags={"read_only": True},
)
_element.type = AAZStrType(
flags={"read_only": True},
)

info = _schema_error_detail_read.additional_info.Element.info
info.Element = AAZAnyType()

details = _schema_error_detail_read.details
details.Element = AAZObjectType()
cls._build_schema_error_detail_read(details.Element)

_schema.additional_info = cls._schema_error_detail_read.additional_info
_schema.code = cls._schema_error_detail_read.code
_schema.details = cls._schema_error_detail_read.details
_schema.message = cls._schema_error_detail_read.message
_schema.target = cls._schema_error_detail_read.target

_schema_solution_dependency_read = None

@classmethod
def _build_schema_solution_dependency_read(cls, _schema):
if cls._schema_solution_dependency_read is not None:
_schema.dependencies = cls._schema_solution_dependency_read.dependencies
_schema.solution_instance_name = cls._schema_solution_dependency_read.solution_instance_name
_schema.solution_template_version_id = cls._schema_solution_dependency_read.solution_template_version_id
_schema.solution_version_id = cls._schema_solution_dependency_read.solution_version_id
_schema.target_id = cls._schema_solution_dependency_read.target_id
Expand All @@ -444,6 +513,9 @@ def _build_schema_solution_dependency_read(cls, _schema):

solution_dependency_read = _schema_solution_dependency_read
solution_dependency_read.dependencies = AAZListType()
solution_dependency_read.solution_instance_name = AAZStrType(
serialized_name="solutionInstanceName",
)
solution_dependency_read.solution_template_version_id = AAZStrType(
serialized_name="solutionTemplateVersionId",
flags={"required": True},
Expand All @@ -462,9 +534,62 @@ def _build_schema_solution_dependency_read(cls, _schema):
cls._build_schema_solution_dependency_read(dependencies.Element)

_schema.dependencies = cls._schema_solution_dependency_read.dependencies
_schema.solution_instance_name = cls._schema_solution_dependency_read.solution_instance_name
_schema.solution_template_version_id = cls._schema_solution_dependency_read.solution_template_version_id
_schema.solution_version_id = cls._schema_solution_dependency_read.solution_version_id
_schema.target_id = cls._schema_solution_dependency_read.target_id

_schema_stage_map_read = None

@classmethod
def _build_schema_stage_map_read(cls, _schema):
if cls._schema_stage_map_read is not None:
_schema.child_stages = cls._schema_stage_map_read.child_stages
_schema.display_state = cls._schema_stage_map_read.display_state
_schema.end_time = cls._schema_stage_map_read.end_time
# _schema.stage = cls._schema_stage_map_read.stage
_schema.start_time = cls._schema_stage_map_read.start_time
# _schema.status = cls._schema_stage_map_read.status
return

cls._schema_stage_map_read = _schema_stage_map_read = AAZObjectType(
flags={"read_only": True}
)

stage_map_read = _schema_stage_map_read
stage_map_read.child_stages = AAZListType(
serialized_name="childStages",
flags={"read_only": True},
)
stage_map_read.display_state = AAZStrType(
serialized_name="displayState",
flags={"read_only": True},
)
stage_map_read.end_time = AAZStrType(
serialized_name="endTime",
flags={"read_only": True},
)
# stage_map_read.stage = AAZStrType(
# flags={"read_only": True},
# )
stage_map_read.start_time = AAZStrType(
serialized_name="startTime",
flags={"read_only": True},
)
# stage_map_read.status = AAZStrType(
# flags={"read_only": True},
# )

child_stages = _schema_stage_map_read.child_stages
child_stages.Element = AAZObjectType()
cls._build_schema_stage_map_read(child_stages.Element)

_schema.child_stages = cls._schema_stage_map_read.child_stages
_schema.display_state = cls._schema_stage_map_read.display_state
_schema.end_time = cls._schema_stage_map_read.end_time
# _schema.stage = cls._schema_stage_map_read.stage
_schema.start_time = cls._schema_stage_map_read.start_time
# _schema.status = cls._schema_stage_map_read.status


__all__ = ["ReviewSolutionVersion"]
Loading
Loading