Skip to content

{Compute} az vm/vmss create: Support Ephemeral OS disk with full caching with --ephemeral-os-disk-enable-full-caching #33292

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

Open
william051200 wants to merge 18 commits into
base: dev
Choose a base branch
from
+37,855 −36,042
Open

{Compute} az vm/vmss create: Support Ephemeral OS disk with full caching with --ephemeral-os-disk-enable-full-caching #33292

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
db41405
Generate aaz code for vmss create, update, show
william051200 Apr 27, 2026
c0b08a1
Generate aaz code for vm create, update, show
william051200 Apr 27, 2026
4026fc9
Add ephemeral_os_disk_enable_full_caching to vm create, vm update, vm…
william051200 Apr 28, 2026
7736c9b
Remove full caching argument from vm/ vmss update cmd
william051200 Apr 30, 2026
0ff5f9d
Add test case for vm/ vmss create with ephemeral_os_disk_full_caching…
william051200 Apr 30, 2026
7701487
Record test case
william051200 Apr 30, 2026
2d67a8f
Update help text
william051200 Apr 30, 2026
2e8762b
Merge remote-tracking branch 'origin/dev' into 32351-full-caching
william051200 May 6, 2026
bea2a57
Update recording and test case
william051200 May 7, 2026
37a461f
Update network recording
william051200 May 7, 2026
99c2b07
Update monitor recording
william051200 May 7, 2026
7d19254
Fix a bug
william051200 May 7, 2026
c9adba7
Update test case recording and test case
william051200 May 7, 2026
1e6e482
Update test case recording
william051200 May 7, 2026
2b98eb7
Update test case and recording
william051200 May 8, 2026
fb1e2e0
Update code
william051200 May 8, 2026
40861fa
Fix grammar
william051200 May 8, 2026
32fe425
Update code
william051200 May 8, 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
2 changes: 1 addition & 1 deletion ...ure/cli/command_modules/monitor/tests/latest/recordings/test_monitor_autoscale_basic.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,7 @@ interactions:
User-Agent:
- AZURECLI/2.63.0 azsdk-python-core/1.28.0 Python/3.10.11 (Windows-10-10.0.22631-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmss1\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1\"\
Expand Down
2 changes: 1 addition & 1 deletion ...ure/cli/command_modules/monitor/tests/latest/recordings/test_monitor_autoscale_fixed.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ interactions:
User-Agent:
- AZURECLI/2.60.0 azsdk-python-core/1.30.1 Python/3.10.11 (Windows-10-10.0.22631-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_fixed000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_fixed000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmss1\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_fixed000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1\"\
Expand Down
2 changes: 1 addition & 1 deletion ...and_modules/monitor/tests/latest/recordings/test_monitor_autoscale_predictive_policy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ interactions:
User-Agent:
- AZURECLI/2.63.0 azsdk-python-core/1.28.0 Python/3.10.11 (Windows-10-10.0.22631-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_predictive_policy000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_predictive_policy000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmss1\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_predictive_policy000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1\"\
Expand Down
2 changes: 1 addition & 1 deletion ...cli/command_modules/monitor/tests/latest/recordings/test_monitor_autoscale_recurring.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ interactions:
User-Agent:
- AZURECLI/2.63.0 azsdk-python-core/1.28.0 Python/3.10.11 (Windows-10-10.0.22631-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_recurring000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_recurring000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmss1\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_recurring000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1\"\
Expand Down
2 changes: 1 addition & 1 deletion ...e/cli/command_modules/monitor/tests/latest/recordings/test_monitor_autoscale_refined.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ interactions:
User-Agent:
- AZURECLI/2.63.0 azsdk-python-core/1.28.0 Python/3.10.11 (Windows-10-10.0.22631-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_refine000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_refine000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmss1\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_refine000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1\"\
Expand Down
2 changes: 1 addition & 1 deletion ..._modules/monitor/tests/latest/recordings/test_monitor_autoscale_rule_with_dimensions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ interactions:
User-Agent:
- AZURECLI/2.63.0 azsdk-python-core/1.28.0 Python/3.10.11 (Windows-10-10.0.22631-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_rule_with_dimensions000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_rule_with_dimensions000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmss1\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_rule_with_dimensions000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1\"\
Expand Down
2 changes: 1 addition & 1 deletion ...ure/cli/command_modules/monitor/tests/latest/recordings/test_monitor_autoscale_rules.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ interactions:
User-Agent:
- AZURECLI/2.63.0 azsdk-python-core/1.28.0 Python/3.10.11 (Windows-10-10.0.22631-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_rules000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_rules000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmss1\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_rules000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1\"\
Expand Down
2 changes: 1 addition & 1 deletion ...odules/monitor/tests/latest/recordings/test_monitor_autoscale_show_predictive_metric.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ interactions:
User-Agent:
- AZURECLI/2.63.0 azsdk-python-core/1.28.0 Python/3.10.11 (Windows-10-10.0.22631-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_show_predictive_metric000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_show_predictive_metric000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmss1\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_monitor_autoscale_show_predictive_metric000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1\"\
Expand Down
6 changes: 3 additions & 3 deletions ...s/network/tests/latest/recordings/test_network_watcher_packet_capture_vmss_as_target.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6342,7 +6342,7 @@ interactions:
User-Agent:
- AZURECLI/2.84.0 azsdk-python-core/1.38.0 Python/3.12.10 (Windows-11-10.0.26200-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_nw_packet_capture_vmss_as_target000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmssForPcap?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_nw_packet_capture_vmss_as_target000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmssForPcap?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmssForPcap\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_nw_packet_capture_vmss_as_target000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmssForPcap\",\r\n
Expand Down Expand Up @@ -6640,7 +6640,7 @@ interactions:
User-Agent:
- AZURECLI/2.84.0 azsdk-python-core/1.38.0 Python/3.12.10 (Windows-11-10.0.26200-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_nw_packet_capture_vmss_as_target000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmssForPcap?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_nw_packet_capture_vmss_as_target000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmssForPcap?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmssForPcap\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_nw_packet_capture_vmss_as_target000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmssForPcap\",\r\n
Expand Down Expand Up @@ -6938,7 +6938,7 @@ interactions:
User-Agent:
- AZURECLI/2.84.0 azsdk-python-core/1.38.0 Python/3.12.10 (Windows-11-10.0.26200-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_nw_packet_capture_vmss_as_target000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmssForPcap?api-version=2025-04-01
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_nw_packet_capture_vmss_as_target000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmssForPcap?api-version=2025-11-01
response:
body:
string: "{\r\n \"name\": \"vmssForPcap\",\r\n \"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_nw_packet_capture_vmss_as_target000001/providers/Microsoft.Compute/virtualMachineScaleSets/vmssForPcap\",\r\n
Expand Down
3 changes: 3 additions & 0 deletions src/azure-cli/azure/cli/command_modules/vm/_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1201,6 +1201,9 @@ def load_arguments(self, _):
help='Allows you to create an OS disk directly on the host node, providing local disk performance and faster VM/VMSS reimage time.')
c.argument('ephemeral_os_disk_placement', arg_type=ephemeral_placement_type,
help='Only applicable when used with `--ephemeral-os-disk`. Allows you to choose the Ephemeral OS disk provisioning location.')
c.argument('ephemeral_os_disk_enable_full_caching', arg_type=get_three_state_flag(),
options_list=['--ephemeral-os-disk-enable-full-caching', '--ephemeral-full-caching'],
help='Specify whether or not to enable full caching for this VM/VMSS which will cache the OS disk locally on the host and make this VM/VMSS more resilient to storage outages')
c.argument('os_disk_encryption_set', min_api='2019-07-01', help='Name or ID of disk encryption set for OS disk.')
c.argument('data_disk_encryption_sets', nargs='+', min_api='2019-07-01',
help='Names or IDs (space delimited) of disk encryption sets for data disks.')
Expand Down
1 change: 1 addition & 0 deletions src/azure-cli/azure/cli/command_modules/vm/_validators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,6 +679,7 @@ def _validate_vm_create_storage_profile(cmd, namespace, for_scale_set=False):
data_disk_cachings=namespace.data_caching,
ephemeral_os_disk=getattr(namespace, 'ephemeral_os_disk', None),
ephemeral_os_disk_placement=getattr(namespace, 'ephemeral_os_disk_placement', None),
ephemeral_os_disk_enable_full_caching=getattr(namespace, 'ephemeral_os_disk_enable_full_caching', None),
data_disk_delete_option=getattr(
namespace, 'data_disk_delete_option', None),
source_snapshots_or_disks=getattr(namespace, 'source_snapshots_or_disks', None),
Expand Down
3 changes: 3 additions & 0 deletions src/azure-cli/azure/cli/command_modules/vm/_vm_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ def normalize_disk_info(image_data_disks=None,
data_disk_sizes_gb=None, attach_data_disks=None, storage_sku=None,
os_disk_caching=None, data_disk_cachings=None, size='',
ephemeral_os_disk=False, ephemeral_os_disk_placement=None,
ephemeral_os_disk_enable_full_caching=None,
data_disk_delete_option=None, source_snapshots_or_disks=None,
source_snapshots_or_disks_size_gb=None, source_disk_restore_point=None,
source_disk_restore_point_size_gb=None):
Expand Down Expand Up @@ -204,6 +205,8 @@ def normalize_disk_info(image_data_disks=None,
os_disk_caching = 'ReadOnly'
if ephemeral_os_disk_placement:
info['os']['diffDiskSettings']['placement'] = ephemeral_os_disk_placement
if ephemeral_os_disk_enable_full_caching is not None:
info['os']['diffDiskSettings']['enableFullCaching'] = ephemeral_os_disk_enable_full_caching
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enableFullCaching appears to require Compute API version 2025-11-01 (per issue/spec), but the ARM template builder still uses apiVersion: 2025-04-01 for Microsoft.Compute/virtualMachines and virtualMachineScaleSets. As-is, adding diffDiskSettings.enableFullCaching here is likely to be rejected during template deployment. Please update the template resource apiVersion(s) to 2025-11-01 (or conditionally bump when this flag is set) so VM/VMSS create actually works.

Suggested change
info['os']['diffDiskSettings']['enableFullCaching'] = ephemeral_os_disk_enable_full_caching
raise CLIError(
'--ephemeral-os-disk-enable-full-caching requires the ARM template '
'resource apiVersion for Microsoft.Compute/virtualMachines and '
'Microsoft.Compute/virtualMachineScaleSets to be 2025-11-01 or later. '
'Update the template resource apiVersion before enabling this property.'
)

Copilot uses AI. Check for mistakes.

# add managed image data disks
for data_disk in image_data_disks:
Expand Down
Loading
Loading