text: # --------------------------------------------------------------------------------------------
  # Copyright (c) Microsoft Corporation. All rights reserved.
  # Licensed under the MIT License. See License.txt in the project root for license information.
  # --------------------------------------------------------------------------------------------
  # pylint: disable=no-self-use,no-member,line-too-long,too-few-public-methods
  
  from __future__ import print_function
  from enum import Enum
  from knack.util import CLIError
  from azure.cli.core.commands import LongRunningOperation
  
  from azure.mgmt.iothub.models import (IotHubSku,
                                        AccessRights,
                                        IotHubDescription,
                                        IotHubSkuInfo,
                                        SharedAccessSignatureAuthorizationRule,
                                        IotHubProperties,
                                        EventHubProperties,
                                        EnrichmentProperties,
                                        RoutingEventHubProperties,
                                        RoutingServiceBusQueueEndpointProperties,
                                        RoutingServiceBusTopicEndpointProperties,
                                        RoutingStorageContainerProperties,
                                        RouteProperties,
                                        RoutingMessage,
                                        TestRouteInput,
                                        TestAllRoutesInput)
  
  
  from azure.mgmt.iothubprovisioningservices.models import (ProvisioningServiceDescription,
                                                            IotDpsPropertiesDescription,
                                                            IotHubDefinitionDescription,
                                                            IotDpsSkuInfo,
                                                            IotDpsSku,
                                                            SharedAccessSignatureAuthorizationRuleAccessRightsDescription)
  
  from azure.cli.command_modules.iot.mgmt_iot_hub_device.lib.iot_hub_device_client import IotHubDeviceClient
  from azure.cli.command_modules.iot.sas_token_auth import SasTokenAuthentication
  from azure.cli.command_modules.iot.shared import EndpointType, EncodingFormat, RenewKeyType
  from ._constants import PNP_ENDPOINT
  from ._client_factory import resource_service_factory, get_pnp_client
  from ._utils import open_certificate, get_auth_header, generateKey
  
  
  # CUSTOM TYPE
  class KeyType(Enum):
      primary = 'primary'
      secondary = 'secondary'
  
  
  # This is a work around to simplify the permission parameter for access policy creation, and also align with the other
  # command modules.
  # The original AccessRights enum is a combination of below four basic access rights.
  # In order to avoid asking for comma- & space-separated strings from the user, a space-separated list is supported for
  # assigning multiple permissions.
  # The underlying IoT SDK should handle this. However it isn't right now. Remove this after it is fixed in IoT SDK.
  class SimpleAccessRights(Enum):
      registry_read = AccessRights.registry_read.value
      registry_write = AccessRights.registry_write.value
      service_connect = AccessRights.service_connect.value
      device_connect = AccessRights.device_connect.value
  
  
  # CUSTOM METHODS FOR DPS
  def iot_dps_list(client, resource_group_name=None):
      if resource_group_name is None:
          return client.iot_dps_resource.list_by_subscription()
      return client.iot_dps_resource.list_by_resource_group(resource_group_name)
  
  
  def iot_dps_get(client, dps_name, resource_group_name=None):
      if resource_group_name is None:
          return _get_iot_dps_by_name(client, dps_name, resource_group_name)
      return client.iot_dps_resource.get(dps_name, resource_group_name)
  
  
  def iot_dps_create(cmd, client, dps_name, resource_group_name, location=None, sku=IotDpsSku.s1.value, unit=1):
      cli_ctx = cmd.cli_ctx
      _check_dps_name_availability(client.iot_dps_resource, dps_name)
      location = _ensure_location(cli_ctx, resource_group_name, location)
      dps_property = IotDpsPropertiesDescription()
      dps_description = ProvisioningServiceDescription(location=location,
                                                       properties=dps_property,
                                                       sku=IotDpsSkuInfo(name=sku, capacity=unit))
      return client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description)
  
  
  def iot_dps_update(client, dps_name, parameters, resource_group_name):
      return client.iot_dps_resource.create_or_update(resource_group_name, dps_name, parameters)
  
  
  def iot_dps_delete(client, dps_name, resource_group_name):
      return client.iot_dps_resource.delete(dps_name, resource_group_name)
  
  
  # DPS access policy methods
  def iot_dps_access_policy_list(client, dps_name, resource_group_name):
      iot_dps_get(client, dps_name, resource_group_name)
      return client.iot_dps_resource.list_keys(dps_name, resource_group_name)
  
  
  def iot_dps_access_policy_get(client, dps_name, resource_group_name, access_policy_name):
      iot_dps_get(client, dps_name, resource_group_name)
      return client.iot_dps_resource.list_keys_for_key_name(dps_name, access_policy_name, resource_group_name)
  
  
  def iot_dps_access_policy_create(cmd, client, dps_name, resource_group_name, access_policy_name, rights, primary_key=None, secondary_key=None, no_wait=False):
      dps_access_policies = []
      dps_access_policies.extend(iot_dps_access_policy_list(client, dps_name, resource_group_name))
      if _is_policy_existed(dps_access_policies, access_policy_name):
          raise CLIError("Access policy {0} already existed.".format(access_policy_name))
  
      access_policy_rights = _convert_rights_to_access_rights(rights)
      dps_access_policies.append(SharedAccessSignatureAuthorizationRuleAccessRightsDescription(
          key_name=access_policy_name, rights=access_policy_rights, primary_key=primary_key, secondary_key=secondary_key))
  
      dps = iot_dps_get(client, dps_name, resource_group_name)
      dps_property = IotDpsPropertiesDescription(iot_hubs=dps.properties.iot_hubs,
                                                 allocation_policy=dps.properties.allocation_policy,
                                                 authorization_policies=dps_access_policies)
      dps_description = ProvisioningServiceDescription(location=dps.location, properties=dps_property, sku=dps.sku)
  
      if no_wait:
          return client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description)
      LongRunningOperation(cmd.cli_ctx)(client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description))
      return iot_dps_access_policy_get(client, dps_name, resource_group_name, access_policy_name)
  
  
  def iot_dps_access_policy_update(cmd, client, dps_name, resource_group_name, access_policy_name, primary_key=None, secondary_key=None, rights=None, no_wait=False):
      dps_access_policies = []
      dps_access_policies.extend(iot_dps_access_policy_list(client, dps_name, resource_group_name))
  
      if not _is_policy_existed(dps_access_policies, access_policy_name):
          raise CLIError("Access policy {0} doesn't exist.".format(access_policy_name))
  
      for policy in dps_access_policies:
          if policy.key_name == access_policy_name:
              if primary_key is not None:
                  policy.primary_key = primary_key
              if secondary_key is not None:
                  policy.secondary_key = secondary_key
              if rights is not None:
                  policy.rights = _convert_rights_to_access_rights(rights)
  
      dps = iot_dps_get(client, dps_name, resource_group_name)
      dps_property = IotDpsPropertiesDescription(iot_hubs=dps.properties.iot_hubs,
                                                 allocation_policy=dps.properties.allocation_policy,
                                                 authorization_policies=dps_access_policies)
      dps_description = ProvisioningServiceDescription(location=dps.location, properties=dps_property, sku=dps.sku)
  
      if no_wait:
          return client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description)
      LongRunningOperation(cmd.cli_ctx)(client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description))
      return iot_dps_access_policy_get(client, dps_name, resource_group_name, access_policy_name)
  
  
  def iot_dps_access_policy_delete(cmd, client, dps_name, resource_group_name, access_policy_name, no_wait=False):
      dps_access_policies = []
      dps_access_policies.extend(iot_dps_access_policy_list(client, dps_name, resource_group_name))
      if not _is_policy_existed(dps_access_policies, access_policy_name):
          raise CLIError("Access policy {0} doesn't existed.".format(access_policy_name))
      updated_policies = [p for p in dps_access_policies if p.key_name.lower() != access_policy_name.lower()]
  
      dps = iot_dps_get(client, dps_name, resource_group_name)
      dps_property = IotDpsPropertiesDescription(iot_hubs=dps.properties.iot_hubs,
                                                 allocation_policy=dps.properties.allocation_policy,
                                                 authorization_policies=updated_policies)
      dps_description = ProvisioningServiceDescription(location=dps.location, properties=dps_property, sku=dps.sku)
  
      if no_wait:
          return client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description)
      LongRunningOperation(cmd.cli_ctx)(client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description))
      return iot_dps_access_policy_list(client, dps_name, resource_group_name)
  
  
  # DPS linked hub methods
  def iot_dps_linked_hub_list(client, dps_name, resource_group_name):
      dps = iot_dps_get(client, dps_name, resource_group_name)
      return dps.properties.iot_hubs
  
  
  def iot_dps_linked_hub_get(client, dps_name, resource_group_name, linked_hub):
      dps = iot_dps_get(client, dps_name, resource_group_name)
      for hub in dps.properties.iot_hubs:
          if hub.name == linked_hub:
              return hub
      raise CLIError("Linked hub '{0}' does not exist. Use 'iot dps linked-hub show to see all linked hubs.".format(linked_hub))
  
  
  def iot_dps_linked_hub_create(cmd, client, dps_name, resource_group_name, connection_string, location, apply_allocation_policy=None, allocation_weight=None, no_wait=False):
      dps_linked_hubs = []
      dps_linked_hubs.extend(iot_dps_linked_hub_list(client, dps_name, resource_group_name))
  
      # Hack due to DPS Swagger/SDK issue
      # In the newer API version the name parameter is required
      # however in the SDK name is read-only/assigned to None
      client.api_version = '2017-11-15'
      dps_linked_hubs.append(IotHubDefinitionDescription(connection_string=connection_string,
                                                         location=location,
                                                         apply_allocation_policy=apply_allocation_policy,
                                                         allocation_weight=allocation_weight))
  
      dps = iot_dps_get(client, dps_name, resource_group_name)
      dps_property = IotDpsPropertiesDescription(iot_hubs=dps_linked_hubs,
                                                 allocation_policy=dps.properties.allocation_policy,
                                                 authorization_policies=dps.properties.authorization_policies)
      dps_description = ProvisioningServiceDescription(location=dps.location, properties=dps_property, sku=dps.sku)
  
      if no_wait:
          return client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description)
      LongRunningOperation(cmd.cli_ctx)(client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description))
      return iot_dps_linked_hub_list(client, dps_name, resource_group_name)
  
  
  def iot_dps_linked_hub_update(cmd, client, dps_name, resource_group_name, linked_hub, apply_allocation_policy=None, allocation_weight=None, no_wait=False):
      dps_linked_hubs = []
      dps_linked_hubs.extend(iot_dps_linked_hub_list(client, dps_name, resource_group_name))
      if not _is_linked_hub_existed(dps_linked_hubs, linked_hub):
          raise CLIError("Access policy {0} doesn't existed.".format(linked_hub))
  
      for hub in dps_linked_hubs:
          if hub.name == linked_hub:
              if apply_allocation_policy is not None:
                  hub.apply_allocation_policy = apply_allocation_policy
              if allocation_weight is not None:
                  hub.allocation_weight = allocation_weight
  
      dps = iot_dps_get(client, dps_name, resource_group_name)
      dps_property = IotDpsPropertiesDescription(iot_hubs=dps_linked_hubs,
                                                 allocation_policy=dps.properties.allocation_policy,
                                                 authorization_policies=dps.properties.authorization_policies)
      dps_description = ProvisioningServiceDescription(location=dps.location, properties=dps_property, sku=dps.sku)
  
      if no_wait:
          return client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description)
      LongRunningOperation(cmd.cli_ctx)(client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description))
      return iot_dps_linked_hub_get(client, dps_name, resource_group_name, linked_hub)
  
  
  def iot_dps_linked_hub_delete(cmd, client, dps_name, resource_group_name, linked_hub, no_wait=False):
      dps_linked_hubs = []
      dps_linked_hubs.extend(iot_dps_linked_hub_list(client, dps_name, resource_group_name))
      if not _is_linked_hub_existed(dps_linked_hubs, linked_hub):
          raise CLIError("Linked hub {0} doesn't existed.".format(linked_hub))
      updated_hub = [p for p in dps_linked_hubs if p.name.lower() != linked_hub.lower()]
  
      dps = iot_dps_get(client, dps_name, resource_group_name)
      dps_property = IotDpsPropertiesDescription(iot_hubs=updated_hub,
                                                 allocation_policy=dps.properties.allocation_policy,
                                                 authorization_policies=dps.properties.authorization_policies)
      dps_description = ProvisioningServiceDescription(location=dps.location, properties=dps_property, sku=dps.sku)
  
      if no_wait:
          return client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description)
      LongRunningOperation(cmd.cli_ctx)(client.iot_dps_resource.create_or_update(resource_group_name, dps_name, dps_description))
      return iot_dps_linked_hub_list(client, dps_name, resource_group_name)
  
  
  # DPS certificate methods
  def iot_dps_certificate_list(client, dps_name, resource_group_name):
      return client.dps_certificate.list(resource_group_name, dps_name)
  
  
  def iot_dps_certificate_get(client, dps_name, resource_group_name, certificate_name):
      return client.dps_certificate.get(certificate_name, resource_group_name, dps_name)
  
  
  def iot_dps_certificate_create(client, dps_name, resource_group_name, certificate_name, certificate_path):
      cert_list = client.dps_certificate.list(resource_group_name, dps_name)
      for cert in cert_list.value:
          if cert.name == certificate_name:
              raise CLIError("Certificate '{0}' already exists. Use 'iot dps certificate update'"
                             " to update an existing certificate.".format(certificate_name))
      certificate = open_certificate(certificate_path)
      if not certificate:
          raise CLIError("Error uploading certificate '{0}'.".format(certificate_path))
      return client.dps_certificate.create_or_update(resource_group_name, dps_name, certificate_name, None, certificate)
  
  
  def iot_dps_certificate_update(client, dps_name, resource_group_name, certificate_name, certificate_path, etag):
      cert_list = client.dps_certificate.list(resource_group_name, dps_name)
      for cert in cert_list.value:
          if cert.name == certificate_name:
              certificate = open_certificate(certificate_path)
              if not certificate:
                  raise CLIError("Error uploading certificate '{0}'.".format(certificate_path))
              return client.dps_certificate.create_or_update(resource_group_name, dps_name, certificate_name, etag, certificate)
      raise CLIError("Certificate '{0}' does not exist. Use 'iot dps certificate create' to create a new certificate."
                     .format(certificate_name))
  
  
  def iot_dps_certificate_delete(client, dps_name, resource_group_name, certificate_name, etag):
      return client.dps_certificate.delete(resource_group_name, etag, dps_name, certificate_name)
  
  
  def iot_dps_certificate_gen_code(client, dps_name, resource_group_name, certificate_name, etag):
      return client.dps_certificate.generate_verification_code(certificate_name, etag, resource_group_name, dps_name)
  
  
  def iot_dps_certificate_verify(client, dps_name, resource_group_name, certificate_name, certificate_path, etag):
      certificate = open_certificate(certificate_path)
      if not certificate:
          raise CLIError("Error uploading certificate '{0}'.".format(certificate_path))
      return client.dps_certificate.verify_certificate(certificate_name, etag, resource_group_name, dps_name,
                                                       None, None, None, None, None, None, None, None, certificate)
  
  
  # CUSTOM METHODS
  def iot_hub_certificate_list(client, hub_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.certificates.list_by_iot_hub(resource_group_name, hub_name)
  
  
  def iot_hub_certificate_get(client, hub_name, certificate_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.certificates.get(resource_group_name, hub_name, certificate_name)
  
  
  def iot_hub_certificate_create(client, hub_name, certificate_name, certificate_path, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      # Get list of certs
      cert_list = client.certificates.list_by_iot_hub(resource_group_name, hub_name)
      for cert in cert_list.value:
          if cert.name == certificate_name:
              raise CLIError("Certificate '{0}' already exists. Use 'iot hub certificate update'"
                             " to update an existing certificate.".format(certificate_name))
      certificate = open_certificate(certificate_path)
      if not certificate:
          raise CLIError("Error uploading certificate '{0}'.".format(certificate_path))
      return client.certificates.create_or_update(resource_group_name, hub_name, certificate_name, None, certificate)
  
  
  def iot_hub_certificate_update(client, hub_name, certificate_name, certificate_path, etag, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      cert_list = client.certificates.list_by_iot_hub(resource_group_name, hub_name)
      for cert in cert_list.value:
          if cert.name == certificate_name:
              certificate = open_certificate(certificate_path)
              if not certificate:
                  raise CLIError("Error uploading certificate '{0}'.".format(certificate_path))
              return client.certificates.create_or_update(resource_group_name, hub_name, certificate_name, etag, certificate)
      raise CLIError("Certificate '{0}' does not exist. Use 'iot hub certificate create' to create a new certificate."
                     .format(certificate_name))
  
  
  def iot_hub_certificate_delete(client, hub_name, certificate_name, etag, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.certificates.delete(resource_group_name, hub_name, certificate_name, etag)
  
  
  def iot_hub_certificate_gen_code(client, hub_name, certificate_name, etag, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.certificates.generate_verification_code(resource_group_name, hub_name, certificate_name, etag)
  
  
  def iot_hub_certificate_verify(client, hub_name, certificate_name, certificate_path, etag, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      certificate = open_certificate(certificate_path)
      if not certificate:
          raise CLIError("Error uploading certificate '{0}'.".format(certificate_path))
      return client.certificates.verify(resource_group_name, hub_name, certificate_name, etag, certificate)
  
  
  def iot_hub_create(cmd, client, hub_name, resource_group_name, location=None, sku=IotHubSku.f1.value, unit=1, partition_count=2):
      cli_ctx = cmd.cli_ctx
      _check_name_availability(client.iot_hub_resource, hub_name)
      location = _ensure_location(cli_ctx, resource_group_name, location)
      sku = IotHubSkuInfo(name=sku, capacity=unit)
  
      event_hub_dic = {}
      event_hub_dic['events'] = EventHubProperties(retention_time_in_days=1, partition_count=partition_count)
      properties = IotHubProperties(event_hub_endpoints=event_hub_dic)
      hub_description = IotHubDescription(location=location,
                                          sku=sku,
                                          properties=properties)
      return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, hub_description)
  
  
  def _check_name_availability(iot_hub_resource, hub_name):
      name_availability = iot_hub_resource.check_name_availability(hub_name)
      if name_availability is not None and not name_availability.name_available:
          raise CLIError(name_availability.message)
  
  
  def iot_hub_get(client, hub_name, resource_group_name=None):
      if resource_group_name is None:
          return _get_iot_hub_by_name(client, hub_name)
      return client.iot_hub_resource.get(resource_group_name, hub_name)
  
  
  def iot_hub_list(client, resource_group_name=None):
      if resource_group_name is None:
          return client.iot_hub_resource.list_by_subscription()
      return client.iot_hub_resource.list_by_resource_group(resource_group_name)
  
  
  def iot_hub_update(client, hub_name, parameters, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, parameters, {'IF-MATCH': parameters.etag})
  
  
  def iot_hub_delete(client, hub_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.delete(resource_group_name, hub_name)
  
  
  # pylint: disable=inconsistent-return-statements
  def iot_hub_show_connection_string(client, hub_name=None, resource_group_name=None, policy_name='iothubowner',
                                     key_type=KeyType.primary.value, show_all=False):
      if hub_name is None:
          hubs = iot_hub_list(client, resource_group_name)
          if hubs is None:
              raise CLIError("No IoT Hub found.")
  
          def conn_str_getter(h):
              return _get_hub_connection_string(client, h.name, h.additional_properties['resourcegroup'], policy_name, key_type, show_all)
          return [{'name': h.name, 'connectionString': conn_str_getter(h)} for h in hubs]
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      conn_str = _get_hub_connection_string(client, hub_name, resource_group_name, policy_name, key_type, show_all)
      return {'connectionString': conn_str if show_all else conn_str[0]}
  
  
  def _get_hub_connection_string(client, hub_name, resource_group_name, policy_name, key_type, show_all):
      policies = []
      if show_all:
          policies.extend(iot_hub_policy_list(client, hub_name, resource_group_name))
      else:
          policies.append(iot_hub_policy_get(client, hub_name, policy_name, resource_group_name))
      # Intermediate fix to support domains beyond azure-devices.netproperty
      hub = _get_iot_hub_by_name(client, hub_name)
      hostname = hub.properties.host_name
      conn_str_template = 'HostName={};SharedAccessKeyName={};SharedAccessKey={}'
      return [conn_str_template.format(hostname,
                                       p.key_name,
                                       p.secondary_key if key_type == KeyType.secondary else p.primary_key) for p in policies]
  
  
  def iot_hub_sku_list(client, hub_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.get_valid_skus(resource_group_name, hub_name)
  
  
  def iot_hub_consumer_group_create(client, hub_name, consumer_group_name, resource_group_name=None, event_hub_name='events'):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.create_event_hub_consumer_group(resource_group_name, hub_name, event_hub_name, consumer_group_name)
  
  
  def iot_hub_consumer_group_list(client, hub_name, resource_group_name=None, event_hub_name='events'):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.list_event_hub_consumer_groups(resource_group_name, hub_name, event_hub_name)
  
  
  def iot_hub_consumer_group_get(client, hub_name, consumer_group_name, resource_group_name=None, event_hub_name='events'):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.get_event_hub_consumer_group(resource_group_name, hub_name, event_hub_name, consumer_group_name)
  
  
  def iot_hub_consumer_group_delete(client, hub_name, consumer_group_name, resource_group_name=None, event_hub_name='events'):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.delete_event_hub_consumer_group(resource_group_name, hub_name, event_hub_name, consumer_group_name)
  
  
  def iot_hub_policy_list(client, hub_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.list_keys(resource_group_name, hub_name)
  
  
  def iot_hub_policy_get(client, hub_name, policy_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.get_keys_for_key_name(resource_group_name, hub_name, policy_name)
  
  
  def iot_hub_policy_create(client, hub_name, policy_name, permissions, resource_group_name=None):
      rights = _convert_perms_to_access_rights(permissions)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      policies = []
      policies.extend(iot_hub_policy_list(client, hub_name, hub.additional_properties['resourcegroup']))
      if _is_policy_existed(policies, policy_name):
          raise CLIError("Policy {0} already existed.".format(policy_name))
      policies.append(SharedAccessSignatureAuthorizationRule(key_name=policy_name, rights=rights))
      hub.properties.authorization_policies = policies
      return client.iot_hub_resource.create_or_update(hub.additional_properties['resourcegroup'], hub_name, hub, {'IF-MATCH': hub.etag})
  
  
  def iot_hub_policy_delete(client, hub_name, policy_name, resource_group_name=None):
      import copy
      hub = iot_hub_get(client, hub_name, resource_group_name)
      policies = iot_hub_policy_list(client, hub_name, hub.additional_properties['resourcegroup'])
      if not _is_policy_existed(copy.deepcopy(policies), policy_name):
          raise CLIError("Policy {0} not found.".format(policy_name))
      updated_policies = [p for p in policies if p.key_name.lower() != policy_name.lower()]
      hub.properties.authorization_policies = updated_policies
      return client.iot_hub_resource.create_or_update(hub.additional_properties['resourcegroup'], hub_name, hub, {'IF-MATCH': hub.etag})
  
  
  def iot_hub_policy_key_renew(cmd, client, hub_name, policy_name, regenerate_key, resource_group_name=None, no_wait=False):
      hub = iot_hub_get(client, hub_name, resource_group_name)
      policies = []
      policies.extend(iot_hub_policy_list(client, hub_name, hub.additional_properties['resourcegroup']))
      if not _is_policy_existed(policies, policy_name):
          raise CLIError("Policy {0} not found.".format(policy_name))
      updated_policies = [p for p in policies if p.key_name.lower() != policy_name.lower()]
      requested_policy = [p for p in policies if p.key_name.lower() == policy_name.lower()]
      if regenerate_key == RenewKeyType.Primary.value:
          requested_policy[0].primary_key = generateKey()
      if regenerate_key == RenewKeyType.Secondary.value:
          requested_policy[0].secondary_key = generateKey()
      if regenerate_key == RenewKeyType.Swap.value:
          temp = requested_policy[0].primary_key
          requested_policy[0].primary_key = requested_policy[0].secondary_key
          requested_policy[0].secondary_key = temp
      updated_policies.append(SharedAccessSignatureAuthorizationRule(key_name=requested_policy[0].key_name,
                                                                     rights=requested_policy[0].rights,
                                                                     primary_key=requested_policy[0].primary_key,
                                                                     secondary_key=requested_policy[0].secondary_key))
      hub.properties.authorization_policies = updated_policies
      if no_wait:
          return client.iot_hub_resource.create_or_update(hub.additional_properties['resourcegroup'], hub_name, hub, {'IF-MATCH': hub.etag})
      LongRunningOperation(cmd.cli_ctx)(client.iot_hub_resource.create_or_update(hub.additional_properties['resourcegroup'], hub_name, hub, {'IF-MATCH': hub.etag}))
      return iot_hub_policy_get(client, hub_name, policy_name, resource_group_name)
  
  
  def _is_policy_existed(policies, policy_name):
      policy_set = {p.key_name.lower() for p in policies}
      return policy_name.lower() in policy_set
  
  
  def iot_hub_job_list(client, hub_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.list_jobs(resource_group_name, hub_name)
  
  
  def iot_hub_job_get(client, hub_name, job_id, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.get_job(resource_group_name, hub_name, job_id)
  
  
  def iot_hub_job_cancel(client, hub_name, job_id, resource_group_name=None):
      device_client = _get_device_client(client, resource_group_name, hub_name, '')
      return device_client.cancel_job(job_id)
  
  
  def iot_hub_get_quota_metrics(client, hub_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      iotHubQuotaMetricCollection = []
      iotHubQuotaMetricCollection.extend(client.iot_hub_resource.get_quota_metrics(resource_group_name, hub_name))
      for quotaMetric in iotHubQuotaMetricCollection:
          if quotaMetric.name == 'TotalDeviceCount':
              quotaMetric.max_value = 'Unlimited'
      return iotHubQuotaMetricCollection
  
  
  def iot_hub_get_stats(client, hub_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      return client.iot_hub_resource.get_stats(resource_group_name, hub_name)
  
  
  def iot_hub_routing_endpoint_create(client, hub_name, endpoint_name, endpoint_type,
                                      endpoint_resource_group, endpoint_subscription_id,
                                      connection_string, container_name=None, encoding=None,
                                      resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      if EndpointType.EventHub.value == endpoint_type.lower():
          hub.properties.routing.endpoints.event_hubs.append(
              RoutingEventHubProperties(
                  connection_string=connection_string,
                  name=endpoint_name,
                  subscription_id=endpoint_subscription_id,
                  resource_group=endpoint_resource_group
              )
          )
      elif EndpointType.ServiceBusQueue.value == endpoint_type.lower():
          hub.properties.routing.endpoints.service_bus_queues.append(
              RoutingServiceBusQueueEndpointProperties(
                  connection_string=connection_string,
                  name=endpoint_name,
                  subscription_id=endpoint_subscription_id,
                  resource_group=endpoint_resource_group
              )
          )
      elif EndpointType.ServiceBusTopic.value == endpoint_type.lower():
          hub.properties.routing.endpoints.service_bus_topics.append(
              RoutingServiceBusTopicEndpointProperties(
                  connection_string=connection_string,
                  name=endpoint_name,
                  subscription_id=endpoint_subscription_id,
                  resource_group=endpoint_resource_group
              )
          )
      elif EndpointType.AzureStorageContainer.value == endpoint_type.lower():
          if not container_name:
              raise CLIError("Container name is required.")
          hub.properties.routing.endpoints.storage_containers.append(
              RoutingStorageContainerProperties(
                  connection_string=connection_string,
                  name=endpoint_name,
                  subscription_id=endpoint_subscription_id,
                  resource_group=endpoint_resource_group,
                  container_name=container_name,
                  encoding=encoding.lower() if encoding else EncodingFormat.AVRO.value
              )
          )
      return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, hub, {'IF-MATCH': hub.etag})
  
  
  def iot_hub_routing_endpoint_list(client, hub_name, endpoint_type=None, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      if not endpoint_type:
          return hub.properties.routing.endpoints
      if EndpointType.EventHub.value == endpoint_type.lower():
          return hub.properties.routing.endpoints.event_hubs
      if EndpointType.ServiceBusQueue.value == endpoint_type.lower():
          return hub.properties.routing.endpoints.service_bus_queues
      if EndpointType.ServiceBusTopic.value == endpoint_type.lower():
          return hub.properties.routing.endpoints.service_bus_topics
      if EndpointType.AzureStorageContainer.value == endpoint_type.lower():
          return hub.properties.routing.endpoints.storage_containers
  
  
  def iot_hub_routing_endpoint_show(client, hub_name, endpoint_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      for event_hub in hub.properties.routing.endpoints.event_hubs:
          if event_hub.name.lower() == endpoint_name.lower():
              return event_hub
      for service_bus_queue in hub.properties.routing.endpoints.service_bus_queues:
          if service_bus_queue.name.lower() == endpoint_name.lower():
              return service_bus_queue
      for service_bus_topic in hub.properties.routing.endpoints.service_bus_topics:
          if service_bus_topic.name.lower() == endpoint_name.lower():
              return service_bus_topic
      for storage_container in hub.properties.routing.endpoints.storage_containers:
          if storage_container.name.lower() == endpoint_name.lower():
              return storage_container
      raise CLIError("No endpoint found.")
  
  
  def iot_hub_routing_endpoint_delete(client, hub_name, endpoint_name=None, endpoint_type=None, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      hub.properties.routing.endpoints = _delete_routing_endpoints(endpoint_name, endpoint_type, hub.properties.routing.endpoints)
      return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, hub, {'IF-MATCH': hub.etag})
  
  
  def iot_hub_route_create(client, hub_name, route_name, source_type, endpoint_name, enabled=None, condition=None,
                           resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      hub.properties.routing.routes.append(
          RouteProperties(
              source=source_type,
              name=route_name,
              endpoint_names=endpoint_name.split(),
              condition=('true' if condition is None else condition),
              is_enabled=(True if enabled is None else enabled)
          )
      )
      return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, hub, {'IF-MATCH': hub.etag})
  
  
  def iot_hub_route_list(client, hub_name, source_type=None, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      if source_type:
          return [route for route in hub.properties.routing.routes if route.source.lower() == source_type.lower()]
      return hub.properties.routing.routes
  
  
  def iot_hub_route_show(client, hub_name, route_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      for route in hub.properties.routing.routes:
          if route.name.lower() == route_name.lower():
              return route
      raise CLIError("No route found.")
  
  
  def iot_hub_route_delete(client, hub_name, route_name=None, source_type=None, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      if not route_name and not source_type:
          hub.properties.routing.routes = []
      if route_name:
          hub.properties.routing.routes = [route for route in hub.properties.routing.routes
                                           if route.name.lower() != route_name.lower()]
      if source_type:
          hub.properties.routing.routes = [route for route in hub.properties.routing.routes
                                           if route.source.lower() != source_type.lower()]
      return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, hub, {'IF-MATCH': hub.etag})
  
  
  def iot_hub_route_update(client, hub_name, route_name, source_type=None, endpoint_name=None, enabled=None,
                           condition=None, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      updated_route = next((route for route in hub.properties.routing.routes
                            if route.name.lower() == route_name.lower()), None)
      if updated_route:
          updated_route.source = updated_route.source if source_type is None else source_type
          updated_route.endpoint_names = updated_route.endpoint_names if endpoint_name is None else endpoint_name.split()
          updated_route.condition = updated_route.condition if condition is None else condition
          updated_route.is_enabled = updated_route.is_enabled if enabled is None else enabled
      else:
          raise CLIError("No route found.")
      return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, hub, {'IF-MATCH': hub.etag})
  
  
  def iot_hub_route_test(client, hub_name, route_name=None, source_type=None, body=None, app_properties=None,
                         system_properties=None, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      route_message = RoutingMessage(
          body=body,
          app_properties=app_properties,
          system_properties=system_properties
      )
  
      if route_name:
          route = iot_hub_route_show(client, hub_name, route_name, resource_group_name)
          test_route_input = TestRouteInput(
              message=route_message,
              twin=None,
              route=route
          )
          return client.iot_hub_resource.test_route(test_route_input, hub_name, resource_group_name)
      test_all_routes_input = TestAllRoutesInput(
          routing_source=source_type,
          message=route_message,
          twin=None
      )
      return client.iot_hub_resource.test_all_routes(test_all_routes_input, hub_name, resource_group_name)
  
  
  def iot_message_enrichment_create(client, hub_name, key, value, endpoints, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      if hub.properties.routing.enrichments is None:
          hub.properties.routing.enrichments = []
      hub.properties.routing.enrichments.append(EnrichmentProperties(key=key, value=value, endpoint_names=endpoints))
      return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, hub, {'IF-MATCH': hub.etag})
  
  
  def iot_message_enrichment_update(client, hub_name, key, value, endpoints, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      to_update = next((endpoint for endpoint in hub.properties.routing.enrichments if endpoint.key == key), None)
      if to_update:
          to_update.key = key
          to_update.value = value
          to_update.endpoint_names = endpoints
          return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, hub, {'IF-MATCH': hub.etag})
      raise CLIError('No message enrichment with that key exists')
  
  
  def iot_message_enrichment_delete(client, hub_name, key, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      to_remove = next((endpoint for endpoint in hub.properties.routing.enrichments if endpoint.key == key), None)
      if to_remove:
          hub.properties.routing.enrichments.remove(to_remove)
          return client.iot_hub_resource.create_or_update(resource_group_name, hub_name, hub, {'IF-MATCH': hub.etag})
      raise CLIError('No message enrichment with that key exists')
  
  
  def iot_message_enrichment_list(client, hub_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      return hub.properties.routing.enrichments
  
  
  def iot_hub_devicestream_show(client, hub_name, resource_group_name=None):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      hub = iot_hub_get(client, hub_name, resource_group_name)
      return hub.properties.device_streams
  
  
  def iot_hub_manual_failover(cmd, client, hub_name, failover_region, resource_group_name=None, no_wait=False):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      if no_wait:
          return client.iot_hub.manual_failover(hub_name, resource_group_name, failover_region)
      LongRunningOperation(cmd.cli_ctx)(client.iot_hub.manual_failover(hub_name, resource_group_name, failover_region))
      return iot_hub_get(client, hub_name, resource_group_name)
  
  
  def pnp_create_repository(cmd, client, repo_name, repo_endpoint=PNP_ENDPOINT):
      return _pnp_create_update_repository(cmd, client, repo_endpoint, repo_name)
  
  
  def pnp_update_repository(cmd, client, repo_id, repo_name, repo_endpoint=PNP_ENDPOINT):
      return _pnp_create_update_repository(cmd, client, repo_endpoint, repo_name, repo_id)
  
  
  def pnp_list_repository(cmd, client, repo_endpoint=PNP_ENDPOINT):
      headers = get_auth_header(cmd)
      return get_pnp_client(repo_endpoint).get_repositories_async(api_version=client.api_version, custom_headers=headers)
  
  
  def pnp_get_repository(cmd, client, repo_id, repo_endpoint=PNP_ENDPOINT):
      headers = get_auth_header(cmd)
      return get_pnp_client(repo_endpoint).get_repository_async(repo_id, api_version=client.api_version, custom_headers=headers)
  
  
  def pnp_delete_repository(cmd, client, repo_id, repo_endpoint=PNP_ENDPOINT):
      headers = get_auth_header(cmd)
      return get_pnp_client(repo_endpoint).delete_repository_async(repo_id, api_version=client.api_version, custom_headers=headers)
  
  
  def pnp_track_provision_status(cmd, client, repo_id, track_id, repo_endpoint=PNP_ENDPOINT):
      headers = get_auth_header(cmd)
      return get_pnp_client(repo_endpoint).get_provision_status(repo_id, track_id, api_version=client.api_version, custom_headers=headers)
  
  
  def pnp_create_key(cmd, client, repo_id, user_role, repo_endpoint=PNP_ENDPOINT):
      return _pnp_create_update_authkeys(cmd, client, repo_endpoint, repo_id, user_role)
  
  
  def pnp_update_key(cmd, client, repo_id, key_id, user_role, repo_endpoint=PNP_ENDPOINT):
      return _pnp_create_update_authkeys(cmd, client, repo_endpoint, repo_id, user_role, key_id)
  
  
  def pnp_list_key(cmd, client, repo_id, repo_endpoint=PNP_ENDPOINT):
      headers = get_auth_header(cmd)
      return get_pnp_client(repo_endpoint).get_keys_async(repository_id=repo_id, api_version=client.api_version, custom_headers=headers)
  
  
  def pnp_get_key(cmd, client, repo_id, key_id, repo_endpoint=PNP_ENDPOINT):
      headers = get_auth_header(cmd)
      return get_pnp_client(repo_endpoint).get_key_async(repo_id, key_id, api_version=client.api_version, custom_headers=headers)
  
  
  def pnp_delete_key(cmd, client, repo_id, key_id, repo_endpoint=PNP_ENDPOINT):
      headers = get_auth_header(cmd)
      return get_pnp_client(repo_endpoint).delete_key_async(key_id, repo_id, api_version=client.api_version, custom_headers=headers)
  
  
  def _pnp_create_update_repository(cmd, client, repo_endpoint, repo_name, repo_id=None):
      from .digitaltwinrepositoryprovisioningservice.models import RepositoryUpsertRequestProperties
      headers = get_auth_header(cmd)
      repositoryUpsertRequestProperties = RepositoryUpsertRequestProperties(id=repo_id, name=repo_name)
      return get_pnp_client(repo_endpoint).create_or_update_repository_async(api_version=client.api_version,
                                                                             properties=repositoryUpsertRequestProperties,
                                                                             custom_headers=headers)
  
  
  def _pnp_create_update_authkeys(cmd, client, repo_endpoint, repo_id, user_role, key_id=None):
      from .digitaltwinrepositoryprovisioningservice.models import RepositoryKeyRequestProperties
      headers = get_auth_header(cmd)
      repositoryKeyRequestProperties = RepositoryKeyRequestProperties(id=key_id, user_role=user_role)
      return get_pnp_client(repo_endpoint).create_or_update_key_async(repository_id=repo_id,
                                                                      api_version=client.api_version,
                                                                      properties=repositoryKeyRequestProperties,
                                                                      custom_headers=headers)
  
  
  def _get_device_client(client, resource_group_name, hub_name, device_id):
      resource_group_name = _ensure_resource_group_name(client, resource_group_name, hub_name)
      # Intermediate fix to support domains beyond azure-devices.net
      hub = _get_iot_hub_by_name(client, hub_name)
      base_url = hub.properties.host_name
      uri = '{0}/devices/{1}'.format(base_url, device_id)
      access_policy = iot_hub_policy_get(client, hub_name, 'iothubowner', resource_group_name)
      creds = SasTokenAuthentication(uri, access_policy.key_name, access_policy.primary_key)
      return IotHubDeviceClient(creds, client.iot_hub_resource.config.subscription_id, base_url='https://' + base_url).iot_hub_devices
  
  
  def _get_iot_hub_by_name(client, hub_name):
      all_hubs = iot_hub_list(client)
      if all_hubs is None:
          raise CLIError("No IoT Hub found in current subscription.")
      try:
          target_hub = next(x for x in all_hubs if hub_name.lower() == x.name.lower())
      except StopIteration:
          raise CLIError("No IoT Hub found with name {} in current subscription.".format(hub_name))
      return target_hub
  
  
  def _ensure_location(cli_ctx, resource_group_name, location):
      if location is None:
          resource_group_client = resource_service_factory(cli_ctx).resource_groups
          return resource_group_client.get(resource_group_name).location
      return location
  
  
  def _ensure_resource_group_name(client, resource_group_name, hub_name):
      if resource_group_name is None:
          return _get_iot_hub_by_name(client, hub_name).additional_properties['resourcegroup']
      return resource_group_name
  
  
  # Convert permission list to AccessRights from IoT SDK.
  def _convert_perms_to_access_rights(perm_list):
      perm_set = set(perm_list)  # remove duplicate
      sorted_perm_list = sorted(perm_set)
      perm_key = '_'.join(sorted_perm_list)
      access_rights_mapping = {
          'registryread': AccessRights.registry_read,
          'registrywrite': AccessRights.registry_write,
          'serviceconnect': AccessRights.service_connect,
          'deviceconnect': AccessRights.device_connect,
          'registryread_registrywrite': AccessRights.registry_read_registry_write,
          'registryread_serviceconnect': AccessRights.registry_read_service_connect,
          'deviceconnect_registryread': AccessRights.registry_read_device_connect,
          'registrywrite_serviceconnect': AccessRights.registry_write_service_connect,
          'deviceconnect_registrywrite': AccessRights.registry_write_device_connect,
          'deviceconnect_serviceconnect': AccessRights.service_connect_device_connect,
          'registryread_registrywrite_serviceconnect': AccessRights.registry_read_registry_write_service_connect,
          'deviceconnect_registryread_registrywrite': AccessRights.registry_read_registry_write_device_connect,
          'deviceconnect_registryread_serviceconnect': AccessRights.registry_read_service_connect_device_connect,
          'deviceconnect_registrywrite_serviceconnect': AccessRights.registry_write_service_connect_device_connect,
          'deviceconnect_registryread_registrywrite_serviceconnect': AccessRights.registry_read_registry_write_service_connect_device_connect
      }
      return access_rights_mapping[perm_key]
  
  
  def _is_linked_hub_existed(hubs, hub_name):
      hub_set = {h.name.lower() for h in hubs}
      return hub_name.lower() in hub_set
  
  
  def _get_iot_dps_by_name(client, dps_name, resource_group=None):
      all_dps = iot_dps_list(client, resource_group)
      if all_dps is None:
          raise CLIError("No DPS found in current subscription.")
      try:
          target_dps = next(x for x in all_dps if dps_name.lower() == x.name.lower())
      except StopIteration:
          raise CLIError("No DPS found with name {} in current subscription.".format(dps_name))
      return target_dps
  
  
  def _check_dps_name_availability(iot_dps_resource, dps_name):
      name_availability = iot_dps_resource.check_provisioning_service_name_availability(dps_name)
      if name_availability is not None and not name_availability.name_available:
          raise CLIError(name_availability.message)
  
  
  def _convert_rights_to_access_rights(right_list):
      right_set = set(right_list)  # remove duplicate
      return ",".join(list(right_set))
  
  
  def _delete_routing_endpoints(endpoint_name, endpoint_type, endpoints):
      if endpoint_type:
          if EndpointType.ServiceBusQueue.value == endpoint_type.lower():
              endpoints.service_bus_queues = []
          elif EndpointType.ServiceBusTopic.value == endpoint_type.lower():
              endpoints.service_bus_topics = []
          elif EndpointType.AzureStorageContainer.value == endpoint_type.lower():
              endpoints.storage_containers = []
          elif EndpointType.EventHub.value == endpoint_type.lower():
              endpoints.event_hubs = []
  
      if endpoint_name:
          if any(e.name.lower() == endpoint_name.lower() for e in endpoints.service_bus_queues):
              sbq_endpoints = [e for e in endpoints.service_bus_queues if e.name.lower() != endpoint_name.lower()]
              endpoints.service_bus_queues = sbq_endpoints
          elif any(e.name.lower() == endpoint_name.lower() for e in endpoints.service_bus_topics):
              sbt_endpoints = [e for e in endpoints.service_bus_topics if e.name.lower() != endpoint_name.lower()]
              endpoints.service_bus_topics = sbt_endpoints
          elif any(e.name.lower() == endpoint_name.lower() for e in endpoints.storage_containers):
              sc_endpoints = [e for e in endpoints.storage_containers if e.name.lower() != endpoint_name.lower()]
              endpoints.storage_containers = sc_endpoints
          elif any(e.name.lower() == endpoint_name.lower() for e in endpoints.event_hubs):
              eh_endpoints = [e for e in endpoints.event_hubs if e.name.lower() != endpoint_name.lower()]
              endpoints.event_hubs = eh_endpoints
  
      if not endpoint_type and not endpoint_name:
          endpoints.service_bus_queues = []
          endpoints.service_bus_topics = []
          endpoints.storage_containers = []
          endpoints.event_hubs = []
  
      return endpoints
  