{Compute} az vm boot-diagnostics get-boot-log-uris: Migrate to aaz (#31049)

Author: Jing-song

src/azure-cli/azure/cli/command_modules/vm/aaz/latest/vm/boot_diagnostics/__cmd_group.py

@@ -0,0 +1,23 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+#
+# Code generated by aaz-dev-tools
+# --------------------------------------------------------------------------------------------
+
+# pylint: skip-file
+# flake8: noqa
+
+from azure.cli.core.aaz import *
+
+
+@register_command_group(
+    "vm boot-diagnostics",
+)
+class __CMDGroup(AAZCommandGroup):
+    """Troubleshoot the startup of an Azure Virtual Machine.         Use this feature to troubleshoot boot failures for custom or platform images.
+    """
+    pass
+
+
+__all__ = ["__CMDGroup"]

src/azure-cli/azure/cli/command_modules/vm/aaz/latest/vm/boot_diagnostics/__init__.py

@@ -0,0 +1,12 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+#
+# Code generated by aaz-dev-tools
+# --------------------------------------------------------------------------------------------
+
+# pylint: skip-file
+# flake8: noqa
+
+from .__cmd_group import *
+from ._get_boot_log_uris import *

src/azure-cli/azure/cli/command_modules/vm/aaz/latest/vm/boot_diagnostics/_get_boot_log_uris.py

@@ -0,0 +1,179 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+#
+# Code generated by aaz-dev-tools
+# --------------------------------------------------------------------------------------------
+
+# pylint: skip-file
+# flake8: noqa
+
+from azure.cli.core.aaz import *
+
+
+@register_command(
+    "vm boot-diagnostics get-boot-log-uris",
+)
+class GetBootLogUris(AAZCommand):
+    """Get SAS URIs for a virtual machine's boot diagnostic
+
+    :example: Get SAS URIs for a virtual machine's boot diagnostic logs.
+        az vm boot-diagnostics get-boot-log-uris -g MyResourceGroup -n MyVirtualMachine
+    """
+
+    _aaz_info = {
+        "version": "2024-07-01",
+        "resources": [
+            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachines/{}/retrievebootdiagnosticsdata", "2024-07-01"],
+        ]
+    }
+
+    def _handler(self, command_args):
+        super()._handler(command_args)
+        self._execute_operations()
+        return self._output()
+
+    _args_schema = None
+
+    @classmethod
+    def _build_arguments_schema(cls, *args, **kwargs):
+        if cls._args_schema is not None:
+            return cls._args_schema
+        cls._args_schema = super()._build_arguments_schema(*args, **kwargs)
+
+        # define Arg Group ""
+
+        _args_schema = cls._args_schema
+        _args_schema.resource_group = AAZResourceGroupNameArg(
+            required=True,
+        )
+        _args_schema.name = AAZStrArg(
+            options=["-n", "--name"],
+            help="The name of the Virtual Machine. You can configure the default using `az configure --defaults vm=<name>`.",
+            required=True,
+            id_part="name",
+        )
+        _args_schema.expire = AAZIntArg(
+            options=["--expire"],
+            help="Expiration duration in minutes for the SAS URIs with a value between 1 to                           1440 minutes. If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes.",
+        )
+        return cls._args_schema
+
+    def _execute_operations(self):
+        self.pre_operations()
+        self.VirtualMachinesRetrieveBootDiagnosticsData(ctx=self.ctx)()
+        self.post_operations()
+
+    @register_callback
+    def pre_operations(self):
+        pass
+
+    @register_callback
+    def post_operations(self):
+        pass
+
+    def _output(self, *args, **kwargs):
+        result = self.deserialize_output(self.ctx.vars.instance, client_flatten=True)
+        return result
+
+    class VirtualMachinesRetrieveBootDiagnosticsData(AAZHttpOperation):
+        CLIENT_TYPE = "MgmtClient"
+
+        def __call__(self, *args, **kwargs):
+            request = self.make_request()
+            session = self.client.send_request(request=request, stream=False, **kwargs)
+            if session.http_response.status_code in [200]:
+                return self.on_200(session)
+
+            return self.on_error(session.http_response)
+
+        @property
+        def url(self):
+            return self.client.format_url(
+                "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData",
+                **self.url_parameters
+            )
+
+        @property
+        def method(self):
+            return "POST"
+
+        @property
+        def error_format(self):
+            return "ODataV4Format"
+
+        @property
+        def url_parameters(self):
+            parameters = {
+                **self.serialize_url_param(
+                    "resourceGroupName", self.ctx.args.resource_group,
+                    required=True,
+                ),
+                **self.serialize_url_param(
+                    "subscriptionId", self.ctx.subscription_id,
+                    required=True,
+                ),
+                **self.serialize_url_param(
+                    "vmName", self.ctx.args.name,
+                    required=True,
+                ),
+            }
+            return parameters
+
+        @property
+        def query_parameters(self):
+            parameters = {
+                **self.serialize_query_param(
+                    "sasUriExpirationTimeInMinutes", self.ctx.args.expire,
+                ),
+                **self.serialize_query_param(
+                    "api-version", "2024-07-01",
+                    required=True,
+                ),
+            }
+            return parameters
+
+        @property
+        def header_parameters(self):
+            parameters = {
+                **self.serialize_header_param(
+                    "Accept", "application/json",
+                ),
+            }
+            return parameters
+
+        def on_200(self, session):
+            data = self.deserialize_http_content(session)
+            self.ctx.set_var(
+                "instance",
+                data,
+                schema_builder=self._build_schema_on_200
+            )
+
+        _schema_on_200 = None
+
+        @classmethod
+        def _build_schema_on_200(cls):
+            if cls._schema_on_200 is not None:
+                return cls._schema_on_200
+
+            cls._schema_on_200 = AAZObjectType()
+
+            _schema_on_200 = cls._schema_on_200
+            _schema_on_200.console_screenshot_blob_uri = AAZStrType(
+                serialized_name="consoleScreenshotBlobUri",
+                flags={"read_only": True},
+            )
+            _schema_on_200.serial_console_log_blob_uri = AAZStrType(
+                serialized_name="serialConsoleLogBlobUri",
+                flags={"read_only": True},
+            )
+
+            return cls._schema_on_200
+
+
+class _GetBootLogUrisHelper:
+    """Helper class for GetBootLogUris"""
+
+
+__all__ = ["GetBootLogUris"]

src/azure-cli/azure/cli/command_modules/vm/commands.py

@@ -345,7 +345,6 @@ def load_command_table(self, _):
         g.custom_command('disable', 'disable_boot_diagnostics')
         g.custom_command('enable', 'enable_boot_diagnostics')
         g.custom_command('get-boot-log', 'get_boot_log')
-        g.custom_command('get-boot-log-uris', 'get_boot_log_uris', min_api='2020-06-01')
 
     with self.command_group('vm diagnostics', compute_vm_sdk) as g:
         g.custom_command('set', 'set_diagnostics_extension')

src/azure-cli/azure/cli/command_modules/vm/custom.py

@@ -47,6 +47,7 @@
 from ._client_factory import (_compute_client_factory, cf_vm_image_term)
 
 from .aaz.latest.vm.disk import AttachDetachDataDisk
+from .aaz.latest.vm import Update as UpdateVM
 
 from .generated.custom import *  # noqa: F403, pylint: disable=unused-wildcard-import,wildcard-import
 try:
@@ -1836,33 +1837,57 @@ def create_av_set(cmd, availability_set_name, resource_group_name, platform_faul
 
 
 # region VirtualMachines BootDiagnostics
-def disable_boot_diagnostics(cmd, resource_group_name, vm_name):
-    vm = get_vm_to_update(cmd, resource_group_name, vm_name)
-    diag_profile = vm.diagnostics_profile
-    if not (diag_profile and diag_profile.boot_diagnostics and diag_profile.boot_diagnostics.enabled):
-        return
+class DisableBootDiagnostics(UpdateVM):
+    def pre_instance_update(self, instance):
+        from azure.cli.core.aaz import has_value
+        diag_profile = False if not has_value(instance.properties.diagnostics_profile) else (
+            instance.properties.diagnostics_profile)
+        if not (diag_profile and has_value(diag_profile.boot_diagnostics) and
+                diag_profile.boot_diagnostics.enabled.to_serialized_data()):
+            return
+        boot_diag = {'enabled': False, 'storage_uri': None}
+        instance.properties.diagnostics_profile = {'boot_diagnostics': boot_diag}
 
-    diag_profile.boot_diagnostics.enabled = False
-    diag_profile.boot_diagnostics.storage_uri = None
-    set_vm(cmd, vm, ExtensionUpdateLongRunningOperation(cmd.cli_ctx, 'disabling boot diagnostics', 'done'))
 
+def disable_boot_diagnostics(cmd, resource_group_name, vm_name):
+    ExtensionUpdateLongRunningOperation(cmd.cli_ctx, 'enabling boot diagnostics', 'done')(
+        DisableBootDiagnostics(cli_ctx=cmd.cli_ctx)(command_args={
+            'resource_group': resource_group_name,
+            'vm_name': vm_name
+        })
+    )
 
-def enable_boot_diagnostics(cmd, resource_group_name, vm_name, storage=None):
-    from azure.cli.command_modules.vm._vm_utils import get_storage_blob_uri
-    vm = get_vm_to_update(cmd, resource_group_name, vm_name)
-    storage_uri = None
-    if storage:
-        storage_uri = get_storage_blob_uri(cmd.cli_ctx, storage)
 
-    DiagnosticsProfile, BootDiagnostics = cmd.get_models('DiagnosticsProfile', 'BootDiagnostics')
+class EnableBootDiagnostics(UpdateVM):
+    @classmethod
+    def _build_arguments_schema(cls, *args, **kwargs):
+        from azure.cli.core.aaz import AAZStrArg
+        args_schema = super()._build_arguments_schema(*args, **kwargs)
+        args_schema.storage = AAZStrArg(
+            options=["--storage"],
+            help="Storage account"
+        )
+        return args_schema
+
+    def pre_instance_update(self, instance):
+        from azure.cli.core.aaz import has_value
+        from azure.cli.command_modules.vm._vm_utils import get_storage_blob_uri
+        args = self.ctx.args
+        storage_uri = None
+        if has_value(args.storage):
+            storage_uri = get_storage_blob_uri(self.cli_ctx, args.storage.to_serialized_data())
+        boot_diag = {'enabled': True, 'storage_uri': storage_uri}
+        instance.properties.diagnostics_profile = {'boot_diagnostics': boot_diag}
 
-    boot_diag = BootDiagnostics(enabled=True, storage_uri=storage_uri)
-    if vm.diagnostics_profile is None:
-        vm.diagnostics_profile = DiagnosticsProfile(boot_diagnostics=boot_diag)
-    else:
-        vm.diagnostics_profile.boot_diagnostics = boot_diag
 
-    set_vm(cmd, vm, ExtensionUpdateLongRunningOperation(cmd.cli_ctx, 'enabling boot diagnostics', 'done'))
+def enable_boot_diagnostics(cmd, resource_group_name, vm_name, storage=None):
+    ExtensionUpdateLongRunningOperation(cmd.cli_ctx, 'enabling boot diagnostics', 'done')(
+        EnableBootDiagnostics(cli_ctx=cmd.cli_ctx)(command_args={
+            'resource_group': resource_group_name,
+            'vm_name': vm_name,
+            'storage': storage
+        })
+    )
 
 
 class BootLogStreamWriter:  # pylint: disable=too-few-public-methods
@@ -1946,12 +1971,6 @@ def get_boot_log(cmd, resource_group_name, vm_name):
 
     # our streamwriter not seekable, so no parallel.
     storage_client.get_blob_to_stream(container, blob, BootLogStreamWriter(sys.stdout), max_connections=1)
-
-
-def get_boot_log_uris(cmd, resource_group_name, vm_name, expire=None):
-    client = _compute_client_factory(cmd.cli_ctx)
-    return client.virtual_machines.retrieve_boot_diagnostics_data(
-        resource_group_name, vm_name, sas_uri_expiration_time_in_minutes=expire)
 # endregion