Skip to content
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.

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

[Compute] az vm/vmss create: Support OS disk encryption for Confidential VM #22650

Merged
merged 17 commits into from
Jun 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion src/azure-cli/azure/cli/command_modules/vm/_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ def load_arguments(self, _):

enable_vtpm_type = CLIArgumentType(arg_type=get_three_state_flag(), min_api='2020-12-01', help='Enable vTPM.')
enable_secure_boot_type = CLIArgumentType(arg_type=get_three_state_flag(), min_api='2020-12-01', help='Enable secure boot.')
security_type = CLIArgumentType(arg_type=get_enum_type(['TrustedLaunch']), min_api='2020-12-01', help='Specify if the VM is Trusted Launch enabled. See https://docs.microsoft.com/azure/virtual-machines/trusted-launch.')
security_type = CLIArgumentType(arg_type=get_enum_type(self.get_models('SecurityTypes')), min_api='2020-12-01', help='Specify the security type of the virtual machine.')
gallery_image_name_type = CLIArgumentType(options_list=['--gallery-image-definition', '-i'], help='The name of the community gallery image definition from which the image versions are to be listed.', id_part='child_name_2')
gallery_image_name_version_type = CLIArgumentType(options_list=['--gallery-image-version', '-e'], help='The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch>', id_part='child_name_3')
public_gallery_name_type = CLIArgumentType(help='The public name of community gallery.', id_part='child_name_1')
Expand Down Expand Up @@ -954,6 +954,8 @@ def load_arguments(self, _):
c.argument('edge_zone', edge_zone_type)
c.argument('accept_term', action='store_true', help="Accept the license agreement and privacy statement.")
c.argument('disable_integrity_monitoring', action='store_true', min_api='2020-12-01', help='Disable the default behavior of installing guest attestation extension and enabling System Assigned Identity for Trusted Launch enabled VMs and VMSS.')
c.argument('os_disk_security_encryption_type', arg_type=get_enum_type(self.get_models('SecurityEncryptionTypes')), min_api='2021-11-01', help='Specify the encryption type of the OS managed disk.')
c.argument('os_disk_secure_vm_disk_encryption_set', min_api='2021-11-01', help='Specify the customer managed disk encryption set resource ID or name for the managed disk that is used for customer managed key encrypted Confidential VM OS disk and VM guest blob.')

with self.argument_context(scope, arg_group='Authentication') as c:
c.argument('generate_ssh_keys', action='store_true', help='Generate SSH public and private key files if missing. The keys will be stored in the ~/.ssh directory')
Expand Down
84 changes: 82 additions & 2 deletions src/azure-cli/azure/cli/command_modules/vm/_template_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,8 @@ def build_vm_resource( # pylint: disable=too-many-locals, too-many-statements,
encryption_at_host=None, dedicated_host_group=None, enable_auto_update=None, patch_mode=None,
enable_hotpatching=None, platform_fault_domain=None, security_type=None, enable_secure_boot=None,
enable_vtpm=None, count=None, edge_zone=None, os_disk_delete_option=None, user_data=None,
capacity_reservation_group=None, enable_hibernation=None, v_cpus_available=None, v_cpus_per_core=None):
capacity_reservation_group=None, enable_hibernation=None, v_cpus_available=None, v_cpus_per_core=None,
os_disk_security_encryption_type=None, os_disk_secure_vm_disk_encryption_set=None):

os_caching = disk_info['os'].get('caching')

Expand Down Expand Up @@ -492,6 +493,48 @@ def _build_storage_profile():
storage_profiles['CommunityGalleryImage']['osDisk']['managedDisk']['diskEncryptionSet'] = {
'id': os_disk_encryption_set,
}
if os_disk_security_encryption_type is not None:
storage_profiles['ManagedPirImage']['osDisk']['managedDisk'].update({
zhoxing-ms marked this conversation as resolved.
Show resolved Hide resolved
'securityProfile': {
'securityEncryptionType': os_disk_security_encryption_type,
}
})
storage_profiles['ManagedCustomImage']['osDisk']['managedDisk'].update({
'securityProfile': {
'securityEncryptionType': os_disk_security_encryption_type,
}
})
storage_profiles['SharedGalleryImage']['osDisk']['managedDisk'].update({
'securityProfile': {
'securityEncryptionType': os_disk_security_encryption_type,
}
})
storage_profiles['CommunityGalleryImage']['osDisk']['managedDisk'].update({
'securityProfile': {
'securityEncryptionType': os_disk_security_encryption_type,
}
})
if os_disk_secure_vm_disk_encryption_set is not None:
storage_profiles['ManagedPirImage']['osDisk']['managedDisk']['securityProfile'].update({
'diskEncryptionSet': {
'id': os_disk_secure_vm_disk_encryption_set
}
})
storage_profiles['ManagedCustomImage']['osDisk']['managedDisk']['securityProfile'].update({
'diskEncryptionSet': {
'id': os_disk_secure_vm_disk_encryption_set
}
})
storage_profiles['SharedGalleryImage']['osDisk']['managedDisk']['securityProfile'].update({
'diskEncryptionSet': {
'id': os_disk_secure_vm_disk_encryption_set
}
})
storage_profiles['CommunityGalleryImage']['osDisk']['managedDisk']['securityProfile'].update({
'diskEncryptionSet': {
'id': os_disk_secure_vm_disk_encryption_set
}
})

profile = storage_profiles[storage_profile.name]
if os_disk_size_gb:
Expand Down Expand Up @@ -867,7 +910,8 @@ def build_vmss_resource(cmd, name, computer_name_prefix, location, tags, overpro
enable_spot_restore=None, spot_restore_timeout=None, capacity_reservation_group=None,
enable_auto_update=None, patch_mode=None, enable_agent=None, security_type=None,
enable_secure_boot=None, enable_vtpm=None, automatic_repairs_action=None, v_cpus_available=None,
v_cpus_per_core=None):
v_cpus_per_core=None, os_disk_security_encryption_type=None,
os_disk_secure_vm_disk_encryption_set=None):

# Build IP configuration
ip_configuration = {}
Expand Down Expand Up @@ -944,6 +988,18 @@ def build_vmss_resource(cmd, name, computer_name_prefix, location, tags, overpro
storage_properties['osDisk']['managedDisk']['diskEncryptionSet'] = {
'id': os_disk_encryption_set
}
if os_disk_security_encryption_type is not None:
storage_properties['osDisk']['managedDisk'].update({
'securityProfile': {
'securityEncryptionType': os_disk_security_encryption_type
}
})
if os_disk_secure_vm_disk_encryption_set is not None:
storage_properties['osDisk']['managedDisk']['securityProfile'].update({
'diskEncryptionSet': {
'id': os_disk_secure_vm_disk_encryption_set
}
})
if disk_info and disk_info['os'].get('diffDiskSettings'):
storage_properties['osDisk']['diffDiskSettings'] = disk_info['os']['diffDiskSettings']

Expand Down Expand Up @@ -975,6 +1031,18 @@ def build_vmss_resource(cmd, name, computer_name_prefix, location, tags, overpro
storage_properties['osDisk']['managedDisk']['diskEncryptionSet'] = {
'id': os_disk_encryption_set
}
if os_disk_security_encryption_type is not None:
storage_properties['osDisk']['managedDisk'].update({
'securityProfile': {
'securityEncryptionType': os_disk_security_encryption_type,
}
})
if os_disk_secure_vm_disk_encryption_set is not None:
storage_properties['osDisk']['managedDisk']['securityProfile'].update({
'diskEncryptionSet': {
'id': os_disk_secure_vm_disk_encryption_set
}
})
if storage_profile == StorageProfile.CommunityGalleryImage:
storage_properties['osDisk'] = {
'caching': os_caching,
Expand All @@ -989,6 +1057,18 @@ def build_vmss_resource(cmd, name, computer_name_prefix, location, tags, overpro
storage_properties['osDisk']['managedDisk']['diskEncryptionSet'] = {
'id': os_disk_encryption_set
}
if os_disk_security_encryption_type is not None:
storage_properties['osDisk']['managedDisk'].update({
'securityProfile': {
'securityEncryptionType': os_disk_security_encryption_type,
}
})
if os_disk_secure_vm_disk_encryption_set is not None:
storage_properties['osDisk']['managedDisk']['securityProfile'].update({
'diskEncryptionSet': {
'id': os_disk_secure_vm_disk_encryption_set
}
})

if disk_info:
data_disks = [v for k, v in disk_info.items() if k != 'os']
Expand Down
11 changes: 11 additions & 0 deletions src/azure-cli/azure/cli/command_modules/vm/_validators.py
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,17 @@ def _validate_vm_create_storage_profile(cmd, namespace, for_scale_set=False):
"the os type of this image should be {}".format(community_gallery_image_info.os_type))
namespace.os_type = community_gallery_image_info.os_type

if getattr(namespace, 'security_type', None) == 'ConfidentialVM' and \
not getattr(namespace, 'os_disk_security_encryption_type', None):
raise RequiredArgumentMissingError('usage error: "--os-disk-security-encryption-type" is required '
'when "--security-type" is specified as "ConfidentialVM"')

if getattr(namespace, 'os_disk_secure_vm_disk_encryption_set', None) and \
getattr(namespace, 'os_disk_security_encryption_type', None) != 'DiskWithVMGuestState':
raise ArgumentUsageError(
'usage error: The "--os-disk-secure-vm-disk-encryption-set" can only be passed in '
'when "--os-disk-security-encryption-type" is "DiskWithVMGuestState"')
Comment on lines +577 to +586
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add some test cases for those validation


if not namespace.os_type:
namespace.os_type = 'windows' if 'windows' in namespace.os_offer.lower() else 'linux'

Expand Down
23 changes: 19 additions & 4 deletions src/azure-cli/azure/cli/command_modules/vm/custom.py
Original file line number Diff line number Diff line change
Expand Up @@ -807,7 +807,8 @@ def create_vm(cmd, vm_name, resource_group_name, image=None, size='Standard_DS1_
enable_hotpatching=None, platform_fault_domain=None, security_type=None, enable_secure_boot=None,
enable_vtpm=None, count=None, edge_zone=None, nic_delete_option=None, os_disk_delete_option=None,
data_disk_delete_option=None, user_data=None, capacity_reservation_group=None, enable_hibernation=None,
v_cpus_available=None, v_cpus_per_core=None, accept_term=None, disable_integrity_monitoring=False):
v_cpus_available=None, v_cpus_per_core=None, accept_term=None, disable_integrity_monitoring=False,
os_disk_security_encryption_type=None, os_disk_secure_vm_disk_encryption_set=None):

from azure.cli.core.commands.client_factory import get_subscription_id
from azure.cli.core.util import random_string, hash_string
Expand Down Expand Up @@ -837,6 +838,11 @@ def create_vm(cmd, vm_name, resource_group_name, image=None, size='Standard_DS1_
os_disk_encryption_set = resource_id(
subscription=subscription_id, resource_group=resource_group_name,
namespace='Microsoft.Compute', type='diskEncryptionSets', name=os_disk_encryption_set)
if os_disk_secure_vm_disk_encryption_set is not None and\
not is_valid_resource_id(os_disk_secure_vm_disk_encryption_set):
os_disk_secure_vm_disk_encryption_set = resource_id(
subscription=subscription_id, resource_group=resource_group_name,
namespace='Microsoft.Compute', type='diskEncryptionSets', name=os_disk_secure_vm_disk_encryption_set)

if data_disk_encryption_sets is None:
data_disk_encryption_sets = []
Expand Down Expand Up @@ -1026,7 +1032,9 @@ def create_vm(cmd, vm_name, resource_group_name, image=None, size='Standard_DS1_
platform_fault_domain=platform_fault_domain, security_type=security_type, enable_secure_boot=enable_secure_boot,
enable_vtpm=enable_vtpm, count=count, edge_zone=edge_zone, os_disk_delete_option=os_disk_delete_option,
user_data=user_data, capacity_reservation_group=capacity_reservation_group,
enable_hibernation=enable_hibernation, v_cpus_available=v_cpus_available, v_cpus_per_core=v_cpus_per_core)
enable_hibernation=enable_hibernation, v_cpus_available=v_cpus_available, v_cpus_per_core=v_cpus_per_core,
os_disk_security_encryption_type=os_disk_security_encryption_type,
os_disk_secure_vm_disk_encryption_set=os_disk_secure_vm_disk_encryption_set)

vm_resource['dependsOn'] = vm_dependencies

Expand Down Expand Up @@ -2897,7 +2905,8 @@ def create_vmss(cmd, vmss_name, resource_group_name, image=None,
user_data=None, network_api_version=None, enable_spot_restore=None, spot_restore_timeout=None,
capacity_reservation_group=None, enable_auto_update=None, patch_mode=None, enable_agent=None,
security_type=None, enable_secure_boot=None, enable_vtpm=None, automatic_repairs_action=None,
v_cpus_available=None, v_cpus_per_core=None, accept_term=None, disable_integrity_monitoring=False):
v_cpus_available=None, v_cpus_per_core=None, accept_term=None, disable_integrity_monitoring=False,
os_disk_security_encryption_type=None, os_disk_secure_vm_disk_encryption_set=None):

from azure.cli.core.commands.client_factory import get_subscription_id
from azure.cli.core.util import random_string, hash_string
Expand Down Expand Up @@ -2935,6 +2944,11 @@ def create_vmss(cmd, vmss_name, resource_group_name, image=None,
os_disk_encryption_set = resource_id(
subscription=subscription_id, resource_group=resource_group_name,
namespace='Microsoft.Compute', type='diskEncryptionSets', name=os_disk_encryption_set)
if os_disk_secure_vm_disk_encryption_set is not None and\
not is_valid_resource_id(os_disk_secure_vm_disk_encryption_set):
os_disk_secure_vm_disk_encryption_set = resource_id(
subscription=subscription_id, resource_group=resource_group_name,
namespace='Microsoft.Compute', type='diskEncryptionSets', name=os_disk_secure_vm_disk_encryption_set)

if data_disk_encryption_sets is None:
data_disk_encryption_sets = []
Expand Down Expand Up @@ -3173,7 +3187,8 @@ def _get_public_ip_address_allocation(value, sku):
patch_mode=patch_mode, enable_agent=enable_agent, security_type=security_type,
enable_secure_boot=enable_secure_boot, enable_vtpm=enable_vtpm,
automatic_repairs_action=automatic_repairs_action, v_cpus_available=v_cpus_available,
v_cpus_per_core=v_cpus_per_core)
v_cpus_per_core=v_cpus_per_core, os_disk_security_encryption_type=os_disk_security_encryption_type,
os_disk_secure_vm_disk_encryption_set=os_disk_secure_vm_disk_encryption_set)

vmss_resource['dependsOn'] = vmss_dependencies

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ vmss create:
disable_integrity_monitoring:
rule_exclusions:
- option_length_too_long
os_disk_security_encryption_type:
rule_exclusions:
- option_length_too_long
os_disk_secure_vm_disk_encryption_set:
rule_exclusions:
- option_length_too_long
vmss update:
parameters:
enable_cross_zone_upgrade:
Expand Down Expand Up @@ -73,6 +79,12 @@ vm create:
disable_integrity_monitoring:
rule_exclusions:
- option_length_too_long
os_disk_security_encryption_type:
rule_exclusions:
- option_length_too_long
os_disk_secure_vm_disk_encryption_set:
rule_exclusions:
- option_length_too_long
vm unmanaged-disk attach:
parameters:
size_gb:
Expand Down
Loading