Introduce LocationBasedServices command_module

src/command_modules/azure-cli-lbs/HISTORY.rst

@@ -0,0 +1,8 @@
+.. :changelog:
+
+Release History
+===============
+
+0.1.0
++++++
+* Initial release

src/command_modules/azure-cli-lbs/MANIFEST.in

@@ -0,0 +1 @@
+include *.rst

src/command_modules/azure-cli-lbs/README.rst

@@ -0,0 +1,7 @@
+Microsoft Azure CLI 'location based services' Command Module
+====================================================
+
+This package is for the 'location based services' module.
+i.e. 'az lbs'
+
+

src/command_modules/azure-cli-lbs/__init__.py

@@ -0,0 +1,4 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------

src/command_modules/azure-cli-lbs/azure/__init__.py

@@ -0,0 +1,6 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

src/command_modules/azure-cli-lbs/azure/cli/__init__.py

@@ -0,0 +1,6 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

src/command_modules/azure-cli-lbs/azure/cli/command_modules/__init__.py

@@ -0,0 +1,6 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

src/command_modules/azure-cli-lbs/azure/cli/command_modules/lbs/__init__.py

@@ -0,0 +1,32 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from azure.cli.core import AzCommandsLoader
+
+import azure.cli.command_modules.lbs._help  # pylint: disable=unused-import
+from azure.cli.command_modules.lbs._client_factory import cf_accounts
+
+
+class LocationBasedServicesCommandsLoader(AzCommandsLoader):
+
+    def __init__(self, cli_ctx=None):
+        from azure.cli.core.commands import CliCommandType
+        custom_type = CliCommandType(
+            operations_tmpl='azure.cli.command_modules.lbs.custom#{}',
+            client_factory=cf_accounts)
+        super(LocationBasedServicesCommandsLoader, self).__init__(cli_ctx=cli_ctx,
+                                                                  custom_command_type=custom_type)
+
+    def load_command_table(self, args):
+        from azure.cli.command_modules.lbs.commands import load_command_table
+        load_command_table(self, args)
+        return self.command_table
+
+    def load_arguments(self, command):
+        from azure.cli.command_modules.lbs._params import load_arguments
+        load_arguments(self, command)
+
+
+COMMAND_LOADER_CLS = LocationBasedServicesCommandsLoader

src/command_modules/azure-cli-lbs/azure/cli/command_modules/lbs/_client_factory.py

@@ -0,0 +1,14 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+
+def cf_lbs(cli_ctx, *_):
+    from azure.cli.core.commands.client_factory import get_mgmt_service_client
+    from azure.mgmt.locationbasedservices import Client
+    return get_mgmt_service_client(cli_ctx, Client)
+
+
+def cf_accounts(cli_ctx, *_):
+    return cf_lbs(cli_ctx).accounts

src/command_modules/azure-cli-lbs/azure/cli/command_modules/lbs/_help.py

@@ -0,0 +1,57 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from knack.help_files import helps
+
+helps['lbs'] = """
+    type: group
+    short-summary: Manage Azure Location Based Services accounts.
+"""
+
+helps['lbs account'] = """
+    type: group
+    short-summary: Commands to manage Azure Location Based Services accounts.
+"""
+
+helps['lbs account key'] = """
+    type: group
+    short-summary: Commands to manage Azure Location Based Services account keys.
+"""
+
+helps['lbs account show'] = """
+    type: command
+    short-summary: Show a Location Based Services account.
+"""
+
+helps['lbs account list'] = """
+    type: command
+    short-summary: Show all Location Based Services accounts in a Subscription or in a Resource Group.
+"""
+
+helps['lbs account create'] = """
+    type: command
+    short-summary: Create a Location Based Services account.
+    long-summary: |
+        Create a Location Based Services account. A Location Based Services account holds the keys which allow access to the Location Based Services REST APIs.
+"""
+
+helps['lbs account delete'] = """
+    type: command
+    short-summary: Delete a Location Based Services account.
+"""
+
+helps['lbs account key list'] = """
+    type: command
+    short-summary: List the keys to use with the Location Based Services APIs.
+    long-summary: |
+        List the keys to use with the Location Based Services APIs. A key is used to authenticate and authorize access to the Location Based Services REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.
+"""
+
+helps['lbs account key regenerate'] = """
+    type: command
+    short-summary: Regenerate either the primary or secondary key for use with the Location Based Services APIs.
+    long-summary: |
+        Regenerate either the primary or secondary key for use with the Location Based Services APIs. The old key will stop working immediately.
+"""

src/command_modules/azure-cli-lbs/azure/cli/command_modules/lbs/_params.py

@@ -0,0 +1,46 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from knack.arguments import CLIArgumentType
+
+from azure.cli.core.commands.parameters import (
+    get_enum_type,
+    get_resource_name_completion_list,
+    resource_group_name_type,
+    tags_type)
+
+from azure.cli.command_modules.lbs.validators import validate_account_name
+from azure.mgmt.locationbasedservices.models.client_enums import KeyType
+
+
+def load_arguments(self, _):
+    # Argument Definition
+    lbs_name_type = CLIArgumentType(options_list=['--account-name', '-n'],
+                                    completer=get_resource_name_completion_list(
+                                        'Microsoft.LocationBasedServices/accounts'),
+                                    help='The name of the Location Based Services Account',
+                                    validator=validate_account_name)
+
+    # Parameter Registration
+    with self.argument_context('lbs') as c:
+        c.argument('resource_group_name',
+                   arg_type=resource_group_name_type,
+                   help='Resource group name')
+        c.argument('account_name',
+                   arg_type=lbs_name_type)
+
+    with self.argument_context('lbs account create') as c:
+        c.argument('sku_name',
+                   options_list=['--sku', '-s'],
+                   help='The name of the SKU, in standard format (such as S0).',
+                   arg_type=get_enum_type(['S0']),
+                   required=False)
+        c.argument('tags',
+                   arg_type=tags_type)
+
+    with self.argument_context('lbs account key regenerate') as c:
+        c.argument('key_type',
+                   options_list=['--type', '-t'],
+                   arg_type=get_enum_type(KeyType))

src/command_modules/azure-cli-lbs/azure/cli/command_modules/lbs/commands.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.
+# --------------------------------------------------------------------------------------------
+
+from azure.cli.core.commands import CliCommandType
+from azure.cli.command_modules.lbs._client_factory import cf_accounts
+
+
+def load_command_table(self, _):
+    mgmt_type = CliCommandType(
+        operations_tmpl='azure.mgmt.locationbasedservices.operations.accounts_operations#AccountsOperations.{}',
+        client_factory=cf_accounts)
+
+    with self.command_group('lbs account', mgmt_type) as g:
+        g.command('show', 'get')
+        g.custom_command('list', 'list_accounts')
+        g.custom_command('create', 'create')
+        g.command('delete', 'delete')
+
+    with self.command_group('lbs account key', mgmt_type) as g:
+        g.command('regenerate', 'regenerate_keys')
+        g.command('list', 'list_keys')

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

@@ -0,0 +1,62 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from azure.mgmt.locationbasedservices.models import LocationBasedServicesAccountCreateParameters, Sku
+
+
+# pylint: disable=line-too-long
+def create(client, resource_group_name, account_name, sku_name='S0', tags=None, custom_headers=None,
+           raw=False):
+    """Create a Location Based Services Account. A Location Based
+    Services Account holds the keys which allow access to the Location
+    Based Services REST APIs.
+
+    :param resource_group_name: The name of the Azure Resource Group.
+    :type resource_group_name: str
+    :param account_name: The name of the Location Based Services Account.
+    :type account_name: str
+    :param sku_name: The name of the SKU, in standard format (such as S0).
+    :type sku_name: str
+    :param tags: Gets or sets a list of key value pairs that describe the
+     resource. These tags can be used in viewing and grouping this resource
+     (across resource groups). A maximum of 15 tags can be provided for a
+     resource. Each tag must have a key no greater than 128 characters and
+     value no greater than 256 characters.
+    :type tags: dict[str, str]
+    :param dict custom_headers: headers that will be added to the request
+    :param bool raw: returns the direct response alongside the
+     deserialized response
+    :return: LocationBasedServicesAccount or ClientRawResponse if raw=true
+    :rtype:
+     ~azure.mgmt.locationbasedservices.models.LocationBasedServicesAccount
+     or ~msrest.pipeline.ClientRawResponse
+    :raises:
+     :class:`ErrorException<azure.mgmt.locationbasedservices.models.ErrorException>`
+    """
+
+    sku = Sku(sku_name)
+    lbs_account_create_params = LocationBasedServicesAccountCreateParameters('global', sku, tags)
+    return client.create_or_update(resource_group_name, account_name, lbs_account_create_params, custom_headers, raw)
+
+
+def list_accounts(client, resource_group_name=None, custom_headers=None, raw=False):
+    """Get all Location Based Services Accounts in a Resource Group OR in a Subscription.
+
+    :param resource_group_name: The name of the Azure Resource Group.
+    :type resource_group_name: str
+    :param dict custom_headers: headers that will be added to the request
+    :param bool raw: returns the direct response alongside the
+     deserialized response
+    :param operation_config: :ref:`Operation configuration
+     overrides<msrest:optionsforoperations>`.
+    :return: An iterator like instance of LocationBasedServicesAccount
+    :rtype:
+     ~azure.mgmt.locationbasedservices.models.LocationBasedServicesAccountPaged[~azure.mgmt.locationbasedservices.models.LocationBasedServicesAccount]
+    :raises:
+     :class:`ErrorException<azure.mgmt.locationbasedservices.models.ErrorException>`
+    """
+    if resource_group_name is None:
+        return client.list_by_subscription(custom_headers, raw)
+    return client.list_by_resource_group(resource_group_name, custom_headers, raw)

src/command_modules/azure-cli-lbs/azure/cli/command_modules/lbs/tests/__init__.py

@@ -0,0 +1,6 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

src/command_modules/azure-cli-lbs/azure/cli/command_modules/lbs/tests/latest/__init__.py

@@ -0,0 +1,6 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

src/command_modules/azure-cli-lbs/azure/cli/command_modules/lbs/validators.py

@@ -0,0 +1,26 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+import re
+
+from knack.util import CLIError
+
+ACCOUNT_NAME_MIN_LENGTH = 2
+ACCOUNT_NAME_MAX_LENGTH = 64
+ACCOUNT_NAME_REGEX = re.compile("^[a-zA-Z0-9][a-zA-Z0-9_.-]*$")
+
+
+def validate_account_name(namespace):
+    """ Validates account name."""
+    account_name = namespace.account_name
+    char_len = len(account_name)
+
+    if not ACCOUNT_NAME_MIN_LENGTH <= char_len <= ACCOUNT_NAME_MAX_LENGTH:
+        raise CLIError("Input account-name is invalid. Account name character length must be between 2 and 64.")
+    if not re.match(ACCOUNT_NAME_REGEX, account_name):
+        raise CLIError("Input account-name is invalid. Allowed regex: " + ACCOUNT_NAME_REGEX.pattern +
+                       "\nFirst character must be alphanumeric." +
+                       "\nSubsequent character(s) must be any combination of alphanumeric, underscore (_), " +
+                       "period (.), or hyphen (-).")