Merge dev changes

HISTORY.rst

@@ -3,6 +3,14 @@
 Release History
 ===============
 
+0.10.15
++++++++++++++++
+
+**IoT Central updates**
+
+* Adds support for listing device groups
+* Adds support for listing roles and get role by id
+
 0.10.14
 +++++++++++++++
 

azext_iot/_factory.py

@@ -52,10 +52,8 @@ def iot_service_provisioning_factory(cli_ctx, *_):
         service_client (IotDpsClient): operational resource for
             working with IoT Hub Device Provisioning Service.
     """
-    from azure.cli.core.commands.client_factory import get_mgmt_service_client
-    from azure.mgmt.iothubprovisioningservices.iot_dps_client import IotDpsClient
-
-    return get_mgmt_service_client(cli_ctx, IotDpsClient)
+    from azure.cli.command_modules.iot._client_factory import iot_service_provisioning_factory
+    return iot_service_provisioning_factory(cli_ctx=cli_ctx)
 
 
 class SdkResolver(object):

azext_iot/_params.py

@@ -92,11 +92,15 @@ def load_arguments(self, _):
             validator=mode2_iot_login_handler,
             help="This command supports an entity connection string with rights to perform action. "
             'Use to avoid session login via "az login". '
-            "If both an entity connection string and name are provided the connection string takes priority.",
+            "If both an entity connection string and name are provided the connection string takes priority. "
+            "Required if --hub-name is not provided.",
+            arg_group="IoT Hub Identifier"
         )
         context.argument("resource_group_name", arg_type=resource_group_name_type)
         context.argument(
-            "hub_name", options_list=["--hub-name", "-n"], arg_type=hub_name_type
+            "hub_name", options_list=["--hub-name", "-n"], arg_type=hub_name_type,
+            help="IoT Hub name. Required if --login is not provided.",
+            arg_group="IoT Hub Identifier"
         )
         context.argument(
             "device_id", options_list=["--device-id", "-d"], help="Target Device."
@@ -320,7 +324,8 @@ def load_arguments(self, _):
             "start_time",
             options_list=["--start-time", "--start"],
             help="The scheduled start of the job in ISO 8601 date time format. "
-            "If no start time is provided, the job is queued for asap execution.",
+            "If no start time is provided, the job is queued for asap execution. "
+            "Using a custom start time that's in the past may cause the operation to fail.",
         )
         context.argument(
             "ttl",

azext_iot/central/_help.py

@@ -36,6 +36,8 @@ def load_central_help():
     _load_central_users_help()
     _load_central_api_token_help()
     _load_central_device_templates_help()
+    _load_central_device_groups_help()
+    _load_central_roles_help()
     _load_central_monitors_help()
     _load_central_command_help()
     _load_central_compute_device_key()
@@ -429,6 +431,63 @@ def _load_central_device_templates_help():
     """
 
 
+def _load_central_device_groups_help():
+    helps[
+        "iot central device-group"
+    ] = """
+        type: group
+        short-summary: Manage and configure IoT Central device groups
+    """
+
+    helps[
+        "iot central device-group list"
+    ] = """
+        type: command
+        short-summary: Get the list of device groups for an IoT Central application.
+
+        examples:
+        - name: List device groups in an application
+          text: >
+            az iot central device-group list
+            --app-id {appid}
+    """
+
+
+def _load_central_roles_help():
+    helps[
+        "iot central role"
+    ] = """
+        type: group
+        short-summary: Manage and configure IoT Central roles
+    """
+
+    helps[
+        "iot central role list"
+    ] = """
+        type: command
+        short-summary: Get the list of roles for an IoT Central application.
+
+        examples:
+        - name: List roles in an application
+          text: >
+            az iot central role list
+            --app-id {appid}
+    """
+
+    helps[
+        "iot central role show"
+    ] = """
+    type: command
+    short-summary: Get the details of a role by ID
+    examples:
+      - name: Get details of role
+        text: >
+          az iot central role show
+          --app-id {appid}
+          --role-id {roleId}
+    """
+
+
 def _load_central_monitors_help():
 
     helps[

azext_iot/central/command_map.py

@@ -17,6 +17,14 @@
     operations_tmpl="azext_iot.central.commands_device_template#{}"
 )
 
+central_device_groups_ops = CliCommandType(
+    operations_tmpl="azext_iot.central.commands_device_group#{}"
+)
+
+central_roles_ops = CliCommandType(
+    operations_tmpl="azext_iot.central.commands_role#{}"
+)
+
 central_device_twin_ops = CliCommandType(
     operations_tmpl="azext_iot.central.commands_device_twin#{}"
 )
@@ -103,6 +111,17 @@ def load_central_commands(self, _):
         cmd_group.command("create", "create_device_template")
         cmd_group.command("delete", "delete_device_template")
 
+    with self.command_group(
+        "iot central device-group", command_type=central_device_groups_ops, is_preview=True
+    ) as cmd_group:
+        cmd_group.command("list", "list_device_groups")
+
+    with self.command_group(
+        "iot central role", command_type=central_roles_ops, is_preview=True
+    ) as cmd_group:
+        cmd_group.show_command("show", "get_role")
+        cmd_group.command("list", "list_roles")
+
     with self.command_group(
         "iot central device twin", command_type=central_device_twin_ops,
     ) as cmd_group:

azext_iot/central/commands_device_group.py

@@ -0,0 +1,21 @@
+# coding=utf-8
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# Dev note - think of this as a controller
+
+from azext_iot.constants import CENTRAL_ENDPOINT
+from azext_iot.central.providers.preview import CentralDeviceGroupProviderPreview
+from azext_iot.central.models.enum import ApiVersion
+
+
+def list_device_groups(
+    cmd,
+    app_id: str,
+    token=None,
+    central_dns_suffix=CENTRAL_ENDPOINT,
+    api_version=ApiVersion.preview.value,
+):
+    provider = CentralDeviceGroupProviderPreview(cmd=cmd, app_id=app_id, token=token)
+    return provider.list_device_groups(central_dns_suffix=central_dns_suffix)

azext_iot/central/commands_role.py

@@ -0,0 +1,35 @@
+# coding=utf-8
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# Dev note - think of this as a controller
+
+from azext_iot.constants import CENTRAL_ENDPOINT
+from azext_iot.central.providers.preview import CentralRoleProviderPreview
+from azext_iot.central.models.enum import ApiVersion
+
+
+def get_role(
+    cmd,
+    app_id: str,
+    role_id: str,
+    token=None,
+    central_dns_suffix=CENTRAL_ENDPOINT,
+    api_version=ApiVersion.preview.value,
+):
+    provider = CentralRoleProviderPreview(cmd=cmd, app_id=app_id, token=token)
+
+    return provider.get_role(role_id=role_id, central_dns_suffix=central_dns_suffix)
+
+
+def list_roles(
+    cmd,
+    app_id: str,
+    token=None,
+    central_dns_suffix=CENTRAL_ENDPOINT,
+    api_version=ApiVersion.preview.value,
+):
+    provider = CentralRoleProviderPreview(cmd=cmd, app_id=app_id, token=token)
+
+    return provider.list_roles(central_dns_suffix=central_dns_suffix)

azext_iot/central/models/__init__.py

@@ -8,12 +8,16 @@
 from azext_iot.central.models.devicetwin import DeviceTwin
 from azext_iot.central.models.templatepreview import TemplatePreview
 from azext_iot.central.models.templatev1 import TemplateV1
+from azext_iot.central.models.deviceGroupPreview import DeviceGroupPreview
+from azext_iot.central.models.rolePreview import RolePreview
 
 
 __all__ = [
     "DevicePreview",
+    "DeviceGroupPreview",
     "DeviceV1",
     "DeviceTwin",
     "TemplatePreview",
     "TemplateV1",
+    "RolePreview"
 ]

azext_iot/central/models/deviceGroupPreview.py

@@ -0,0 +1,11 @@
+# coding=utf-8
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+class DeviceGroupPreview:
+    def __init__(self, group: dict):
+        self.display_name = group.get("displayName")
+        self.id = group.get("id")
+        pass

azext_iot/central/models/rolePreview.py

@@ -0,0 +1,11 @@
+# coding=utf-8
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+class RolePreview:
+    def __init__(self, device: dict):
+        self.display_name = device.get("displayName")
+        self.id = device.get("id")
+        pass

azext_iot/central/params.py

@@ -215,3 +215,10 @@ def load_central_arguments(self, _):
             options_list=["--module-id", "-m"],
             help="Provide IoT Edge Module ID if the device type is IoT Edge.",
         )
+
+    with self.argument_context("iot central role") as context:
+        context.argument(
+            "role_id",
+            options_list=["--role-id", "-r"],
+            help="Provide a unique identifier for the role"
+        )

azext_iot/central/providers/preview/__init__.py

@@ -17,10 +17,19 @@
 from azext_iot.central.providers.preview.api_token_provider_preview import (
     CentralApiTokenProviderPreview,
 )
+from azext_iot.central.providers.preview.device_group_provider_preview import (
+    CentralDeviceGroupProviderPreview
+)
+from azext_iot.central.providers.preview.role_provider_preview import (
+    CentralRoleProviderPreview
+)
 
 __all__ = [
     "CentralDeviceProviderPreview",
     "CentralDeviceTemplateProviderPreview",
     "CentralUserProviderPreview",
     "CentralApiTokenProviderPreview",
+    "CentralDeviceGroupProviderPreview",
+    "CentralRoleProviderPreview"
+
 ]

azext_iot/central/providers/preview/device_group_provider_preview.py

@@ -0,0 +1,48 @@
+# coding=utf-8
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+
+from typing import List
+from azext_iot.central.models.deviceGroupPreview import DeviceGroupPreview
+from knack.log import get_logger
+from azext_iot.constants import CENTRAL_ENDPOINT
+from azext_iot.central import services as central_services
+from azext_iot.central.models.enum import ApiVersion
+
+logger = get_logger(__name__)
+
+
+class CentralDeviceGroupProviderPreview:
+    def __init__(self, cmd, app_id: str, token=None):
+        """
+        Provider for device groups APIs
+
+        Args:
+            cmd: command passed into az
+            app_id: name of app (used for forming request URL)
+            token: (OPTIONAL) authorization token to fetch device details from IoTC.
+                MUST INCLUDE type (e.g. 'SharedAccessToken ...', 'Bearer ...')
+                Useful in scenarios where user doesn't own the app
+                therefore AAD token won't work, but a SAS token generated by owner will
+        """
+        self._cmd = cmd
+        self._app_id = app_id
+        self._token = token
+        self._device_groups = {}
+
+    def list_device_groups(self, central_dns_suffix=CENTRAL_ENDPOINT) -> List[DeviceGroupPreview]:
+        device_groups = central_services.device_group.list_device_groups(
+            cmd=self._cmd,
+            app_id=self._app_id,
+            token=self._token,
+            central_dns_suffix=central_dns_suffix,
+            api_version=ApiVersion.preview.value,
+        )
+
+        # add to cache
+        self._device_groups.update({device_group.id: device_group for device_group in device_groups})
+
+        return self._device_groups