Skip to content

{Compute} az vm/vmss create: Add new param --schedule-profile-start and --minimum-commitment-days to support future capacity reservation #34031

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
Julie Zhu (yanzhudd) merged 7 commits into from
Sep 7, 2026
Merged

{Compute} az vm/vmss create: Add new param --schedule-profile-start and --minimum-commitment-days to support future capacity reservation #34031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d003c29
Generate capacity reservation aaz 2026-04-01
william051200 Sep 1, 2026
884d693
Add test case
william051200 Sep 1, 2026
d737842
Revert aaz capacity reservation update
william051200 Sep 4, 2026
1a0e392
Update argument option
william051200 Sep 4, 2026
e28b277
Update test case
william051200 Sep 4, 2026
e435f1e
Merge remote-tracking branch 'origin/dev' into fcr
william051200 Sep 4, 2026
dd81f5e
Update test case and record test case
william051200 Sep 4, 2026
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
96 changes: 91 additions & 5 deletions src/azure-cli/azure/cli/command_modules/vm/aaz/latest/capacity/reservation/_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,15 @@ class Create(AAZCommand):

:example: Create a capacity reservation with specific capacity and zones.
az capacity reservation create -c ReservationGroupName -n ReservationName -l centraluseuap -g MyResourceGroup --sku Standard_A1_v2 --capacity 5 --zone 1 --tags key=val

:example: Create a Future capacity reservation.
az capacity reservation create -c ReservationGroupName -n ReservationName -g MyResourceGroup --sku Standard_A1_v2 --capacity 5 --schedule-profile-start 2026-12-01T12:00:00Z --minimum-commitment-days 30
Comment on lines +26 to +27
"""

_aaz_info = {
"version": "2024-11-01",
"version": "2026-04-01",
"resources": [
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/capacityreservationgroups/{}/capacityreservations/{}", "2024-11-01"],
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/capacityreservationgroups/{}/capacityreservations/{}", "2026-04-01"],
]
}

Expand Down Expand Up @@ -90,6 +93,25 @@ def _build_arguments_schema(cls, *args, **kwargs):
zone = cls._args_schema.zone
zone.Element = AAZStrArg()

# define Arg Group "ScheduleProfile"

_args_schema = cls._args_schema
_args_schema.end = AAZStrArg(
options=["--end"],
arg_group="ScheduleProfile",
help="The required end date for Block capacity reservations. Must be after the start date, with a duration of either 1–14 whole days or 3–26 whole weeks. Example: 2025-06-28.",
)
_args_schema.minimum_commitment_days = AAZIntArg(
options=["--min-commitment-days", "--minimum-commitment-days"],
arg_group="ScheduleProfile",
help="The minimum number of days after the start date before a committed Future capacity reservation can be updated or deleted. The service supplies a default when this value is omitted.",
)
_args_schema.schedule_profile_start = AAZStrArg(
options=["--schedule-profile-start"],
arg_group="ScheduleProfile",
help="The start date and time of a Future capacity reservation. The value must be at least 7 days and at most 6 months in the future. Example: 2026-08-01T12:00:00Z.",
)

# define Arg Group "Sku"

_args_schema = cls._args_schema
Expand Down Expand Up @@ -134,7 +156,7 @@ def __call__(self, *args, **kwargs):
session,
self.on_200_201,
self.on_error,
lro_options={"final-state-via": "azure-async-operation"},
lro_options={"final-state-via": "location"},
path_format_arguments=self.url_parameters,
)
if session.http_response.status_code in [200, 201]:
Expand All @@ -143,7 +165,7 @@ def __call__(self, *args, **kwargs):
session,
self.on_200_201,
self.on_error,
lro_options={"final-state-via": "azure-async-operation"},
lro_options={"final-state-via": "location"},
path_format_arguments=self.url_parameters,
)

Expand Down Expand Up @@ -190,7 +212,7 @@ def url_parameters(self):
def query_parameters(self):
parameters = {
**self.serialize_query_param(
"api-version", "2024-11-01",
"api-version", "2026-04-01",
required=True,
),
}
Expand All @@ -216,10 +238,21 @@ def content(self):
typ_kwargs={"flags": {"required": True, "client_flatten": True}}
)
_builder.set_prop("location", AAZStrType, ".location", typ_kwargs={"flags": {"required": True}})
_builder.set_prop("properties", AAZObjectType, typ_kwargs={"flags": {"client_flatten": True}})
_builder.set_prop("sku", AAZObjectType, ".", typ_kwargs={"flags": {"required": True}})
_builder.set_prop("tags", AAZDictType, ".tags")
_builder.set_prop("zones", AAZListType, ".zone")

properties = _builder.get(".properties")
if properties is not None:
properties.set_prop("scheduleProfile", AAZObjectType)

schedule_profile = _builder.get(".properties.scheduleProfile")
if schedule_profile is not None:
schedule_profile.set_prop("end", AAZStrType, ".end")
schedule_profile.set_prop("minimumCommitmentDays", AAZIntType, ".minimum_commitment_days")
schedule_profile.set_prop("start", AAZStrType, ".schedule_profile_start")

sku = _builder.get(".sku")
if sku is not None:
sku.set_prop("capacity", AAZIntType, ".capacity")
Expand Down Expand Up @@ -268,6 +301,10 @@ def _build_schema_on_200_201(cls):
_schema_on_200_201.sku = AAZObjectType(
flags={"required": True},
)
_schema_on_200_201.system_data = AAZObjectType(
serialized_name="systemData",
flags={"read_only": True},
)
_schema_on_200_201.tags = AAZDictType()
_schema_on_200_201.type = AAZStrType(
flags={"read_only": True},
Expand Down Expand Up @@ -295,6 +332,9 @@ def _build_schema_on_200_201(cls):
serialized_name="reservationId",
flags={"read_only": True},
)
properties.schedule_profile = AAZObjectType(
serialized_name="scheduleProfile",
)
properties.time_created = AAZStrType(
serialized_name="timeCreated",
flags={"read_only": True},
Expand All @@ -305,11 +345,19 @@ def _build_schema_on_200_201(cls):
)

instance_view = cls._schema_on_200_201.properties.instance_view
instance_view.reservation_state_info = AAZObjectType(
serialized_name="reservationStateInfo",
)
instance_view.statuses = AAZListType()
instance_view.utilization_info = AAZObjectType(
serialized_name="utilizationInfo",
)

reservation_state_info = cls._schema_on_200_201.properties.instance_view.reservation_state_info
reservation_state_info.reservation_state = AAZStrType(
serialized_name="reservationState",
)

statuses = cls._schema_on_200_201.properties.instance_view.statuses
statuses.Element = AAZObjectType()

Expand All @@ -327,15 +375,33 @@ def _build_schema_on_200_201(cls):
serialized_name="currentCapacity",
flags={"read_only": True},
)
utilization_info.used_reserved_count_by_subscription = AAZDictType(
serialized_name="usedReservedCountBySubscription",
flags={"read_only": True},
)
utilization_info.virtual_machines_allocated = AAZListType(
serialized_name="virtualMachinesAllocated",
flags={"read_only": True},
)

used_reserved_count_by_subscription = cls._schema_on_200_201.properties.instance_view.utilization_info.used_reserved_count_by_subscription
used_reserved_count_by_subscription.Element = AAZIntType()

virtual_machines_allocated = cls._schema_on_200_201.properties.instance_view.utilization_info.virtual_machines_allocated
virtual_machines_allocated.Element = AAZObjectType()
_CreateHelper._build_schema_sub_resource_read_only_read(virtual_machines_allocated.Element)

schedule_profile = cls._schema_on_200_201.properties.schedule_profile
schedule_profile.end = AAZStrType()
schedule_profile.minimum_commitment_days = AAZIntType(
serialized_name="minimumCommitmentDays",
)
schedule_profile.modifiable_until = AAZStrType(
serialized_name="modifiableUntil",
flags={"read_only": True},
)
schedule_profile.start = AAZStrType()

virtual_machines_associated = cls._schema_on_200_201.properties.virtual_machines_associated
virtual_machines_associated.Element = AAZObjectType()
_CreateHelper._build_schema_sub_resource_read_only_read(virtual_machines_associated.Element)
Expand All @@ -345,6 +411,26 @@ def _build_schema_on_200_201(cls):
sku.name = AAZStrType()
sku.tier = AAZStrType()

system_data = cls._schema_on_200_201.system_data
system_data.created_at = AAZStrType(
serialized_name="createdAt",
)
system_data.created_by = AAZStrType(
serialized_name="createdBy",
)
system_data.created_by_type = AAZStrType(
serialized_name="createdByType",
)
system_data.last_modified_at = AAZStrType(
serialized_name="lastModifiedAt",
)
system_data.last_modified_by = AAZStrType(
serialized_name="lastModifiedBy",
)
system_data.last_modified_by_type = AAZStrType(
serialized_name="lastModifiedByType",
)

tags = cls._schema_on_200_201.tags
tags.Element = AAZStrType()

Expand Down
67 changes: 64 additions & 3 deletions src/azure-cli/azure/cli/command_modules/vm/aaz/latest/capacity/reservation/_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ class List(AAZCommand):
"""

_aaz_info = {
"version": "2024-11-01",
"version": "2026-04-01",
"resources": [
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/capacityreservationgroups/{}/capacityreservations", "2024-11-01"],
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/capacityreservationgroups/{}/capacityreservations", "2026-04-01"],
]
}

Expand Down Expand Up @@ -53,6 +53,11 @@ def _build_arguments_schema(cls, *args, **kwargs):
_args_schema.resource_group = AAZResourceGroupNameArg(
required=True,
)
_args_schema.expand = AAZStrArg(
options=["--expand"],
help="The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.",
enum={"virtualMachineScaleSetVMs/$ref": "virtualMachineScaleSetVMs/$ref", "virtualMachines/$ref": "virtualMachines/$ref"},
)
return cls._args_schema

def _execute_operations(self):
Expand Down Expand Up @@ -121,7 +126,10 @@ def url_parameters(self):
def query_parameters(self):
parameters = {
**self.serialize_query_param(
"api-version", "2024-11-01",
"$expand", self.ctx.args.expand,
),
**self.serialize_query_param(
"api-version", "2026-04-01",
required=True,
),
}
Expand Down Expand Up @@ -180,6 +188,10 @@ def _build_schema_on_200(cls):
_element.sku = AAZObjectType(
flags={"required": True},
)
_element.system_data = AAZObjectType(
serialized_name="systemData",
flags={"read_only": True},
)
_element.tags = AAZDictType()
_element.type = AAZStrType(
flags={"read_only": True},
Expand Down Expand Up @@ -207,6 +219,9 @@ def _build_schema_on_200(cls):
serialized_name="reservationId",
flags={"read_only": True},
)
properties.schedule_profile = AAZObjectType(
serialized_name="scheduleProfile",
)
properties.time_created = AAZStrType(
serialized_name="timeCreated",
flags={"read_only": True},
Expand All @@ -217,11 +232,19 @@ def _build_schema_on_200(cls):
)

instance_view = cls._schema_on_200.value.Element.properties.instance_view
instance_view.reservation_state_info = AAZObjectType(
serialized_name="reservationStateInfo",
)
instance_view.statuses = AAZListType()
instance_view.utilization_info = AAZObjectType(
serialized_name="utilizationInfo",
)

reservation_state_info = cls._schema_on_200.value.Element.properties.instance_view.reservation_state_info
reservation_state_info.reservation_state = AAZStrType(
serialized_name="reservationState",
)

statuses = cls._schema_on_200.value.Element.properties.instance_view.statuses
statuses.Element = AAZObjectType()

Expand All @@ -239,15 +262,33 @@ def _build_schema_on_200(cls):
serialized_name="currentCapacity",
flags={"read_only": True},
)
utilization_info.used_reserved_count_by_subscription = AAZDictType(
serialized_name="usedReservedCountBySubscription",
flags={"read_only": True},
)
utilization_info.virtual_machines_allocated = AAZListType(
serialized_name="virtualMachinesAllocated",
flags={"read_only": True},
)

used_reserved_count_by_subscription = cls._schema_on_200.value.Element.properties.instance_view.utilization_info.used_reserved_count_by_subscription
used_reserved_count_by_subscription.Element = AAZIntType()

virtual_machines_allocated = cls._schema_on_200.value.Element.properties.instance_view.utilization_info.virtual_machines_allocated
virtual_machines_allocated.Element = AAZObjectType()
_ListHelper._build_schema_sub_resource_read_only_read(virtual_machines_allocated.Element)

schedule_profile = cls._schema_on_200.value.Element.properties.schedule_profile
schedule_profile.end = AAZStrType()
schedule_profile.minimum_commitment_days = AAZIntType(
serialized_name="minimumCommitmentDays",
)
schedule_profile.modifiable_until = AAZStrType(
serialized_name="modifiableUntil",
flags={"read_only": True},
)
schedule_profile.start = AAZStrType()

virtual_machines_associated = cls._schema_on_200.value.Element.properties.virtual_machines_associated
virtual_machines_associated.Element = AAZObjectType()
_ListHelper._build_schema_sub_resource_read_only_read(virtual_machines_associated.Element)
Expand All @@ -257,6 +298,26 @@ def _build_schema_on_200(cls):
sku.name = AAZStrType()
sku.tier = AAZStrType()

system_data = cls._schema_on_200.value.Element.system_data
system_data.created_at = AAZStrType(
serialized_name="createdAt",
)
system_data.created_by = AAZStrType(
serialized_name="createdBy",
)
system_data.created_by_type = AAZStrType(
serialized_name="createdByType",
)
system_data.last_modified_at = AAZStrType(
serialized_name="lastModifiedAt",
)
system_data.last_modified_by = AAZStrType(
serialized_name="lastModifiedBy",
)
system_data.last_modified_by_type = AAZStrType(
serialized_name="lastModifiedByType",
)

tags = cls._schema_on_200.value.Element.tags
tags.Element = AAZStrType()

Expand Down
Loading
Loading