[Breadth Coverage] Support Databox in Azure CLI cmdlets (#1344)

* Support Databox in Azure CLI cmdlets

.github/CODEOWNERS

@@ -92,5 +92,6 @@
 
 /src/blueprint/ @fengzhou-msft
 
-/src/hpc-cache/ @qianwens
+/src/databox/ @jsntcy
 
+/src/hpc-cache/ @qianwens

src/databox/HISTORY.rst

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

src/databox/README.md

@@ -0,0 +1,83 @@
+# Azure CLI DataBox Extension #
+This is a extension for DataBox features.
+
+### How to use ###
+Install this extension using the below CLI command
+```
+az extension add --name databox
+```
+
+### Included Features
+#### Manage DataBox jobs:
+
+
+##### Create a DataBox job.
+
+```
+az databox job create \
+    --resource-group rg \
+    --name job_name \ 
+    --location westus \
+    --sku DataBox \
+    --contact-name contact_name \
+    --phone phone \
+    --email-list email_list \
+    --street-address1 street_address1 \
+    --city Redmond \
+    --state-or-province state_or_province \
+    --country US \
+    --postal-code postal_code \
+    --company-name company_name \
+    --storage-account storage_account_1 storage_account_2 \
+    --staging-storage-account staging_storage_account \
+    --resource-group-for-managed-disk rg-for-managed-disk
+```
+
+##### Update a DataBox job.
+```
+az databox job update \
+    --resource-group rg \
+    --name job_name \
+    --contact-name contact_name \
+    --email-list email_list
+```
+
+##### Get the information for a given job.
+```
+az databox job show \
+    --resource-group rg \
+    --name job_name
+```
+
+##### List all the jobs under the given resource group or the given subscription
+```
+az databox job list
+```
+```
+az databox job list \
+    --resource-group rg
+```
+
+##### List the credentials for a given job.
+```
+az databox job list-credentials \
+    --resource-group rg \
+    --name job_name
+```
+
+##### Cancel a job.
+```
+az databox job cancel \
+    --resource-group rg \
+    --name job_name \
+    --reason reason
+```
+
+##### Delete a job.
+```
+az databox job delete \
+    --resource-group rg \
+    --name job_name
+```
+
+If you have issues, please give feedback by opening an issue at https://github.com/Azure/azure-cli-extensions/issues.

src/databox/azext_databox/__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 azext_databox._help  # pylint: disable=unused-import
+
+
+class DataBoxCommandsLoader(AzCommandsLoader):
+
+    def __init__(self, cli_ctx=None):
+        from azure.cli.core.commands import CliCommandType
+        from azext_databox._client_factory import cf_databox
+        databox_custom = CliCommandType(
+            operations_tmpl='azext_databox.custom#{}',
+            client_factory=cf_databox)
+        super(DataBoxCommandsLoader, self).__init__(cli_ctx=cli_ctx,
+                                                    custom_command_type=databox_custom)
+
+    def load_command_table(self, args):
+        from azext_databox.commands import load_command_table
+        load_command_table(self, args)
+        return self.command_table
+
+    def load_arguments(self, command):
+        from azext_databox._params import load_arguments
+        load_arguments(self, command)
+
+
+COMMAND_LOADER_CLS = DataBoxCommandsLoader

src/databox/azext_databox/_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_databox(cli_ctx, *_):
+    from azure.cli.core.commands.client_factory import get_mgmt_service_client
+    from azext_databox.vendored_sdks.databox import DataBoxManagementClient
+    return get_mgmt_service_client(cli_ctx, DataBoxManagementClient)
+
+
+def cf_jobs(cli_ctx, *_):
+    return cf_databox(cli_ctx).jobs

src/databox/azext_databox/_help.py

@@ -0,0 +1,101 @@
+# 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.
+# --------------------------------------------------------------------------------------------
+
+# pylint: disable=too-many-lines
+# pylint: disable=line-too-long
+from knack.help_files import helps  # pylint: disable=unused-import
+
+
+helps['databox job'] = """
+    type: group
+    short-summary: Commands to manage databox job.
+"""
+
+helps['databox job create'] = """
+    type: command
+    short-summary: Create a new job with the specified parameters.
+    examples:
+      - name: Create a databox job to use both storage account and managed disk as data destination.
+        text: |-
+               az databox job create --resource-group "SdkRg4981" --name "SdkJob3971" --location \\
+               "westus" --sku "DataBox" --contact-name "Public SDK Test" \\
+               --phone "1234567890" --email-list "[email protected]" \\
+               --street-address1 "16 TOWNSEND ST" --street-address2 "Unit 1" --city "San Francisco"  \\
+               --state-or-province "CA" --country "US" --postal-code "94107" --company-name "Microsoft" \\
+               --storage-account sa1 sa2 --staging-storage-account sa \\
+               --resource-group-for-managed-disk /subscriptions/sub/resourceGroups/rg
+
+      - name: Create a databoxdisk job to use storage account as data destination.
+        text: |-
+               az databox job create --resource-group "SdkRg4981" --name "SdkJob3971" --location \\
+               "westus" --sku "DataBoxDisk" --expected-data-size 1 --contact-name "Public SDK Test" \\
+               --phone "1234567890" --email-list "[email protected]" --street-address1 "16 TOWNSEND ST" \\
+               --street-address2 "Unit 1" --city "San Francisco" --state-or-province "CA" --country "US" \\
+               --postal-code "94107" --company-name "Microsoft" --storage-account sa1
+"""
+
+helps['databox job update'] = """
+    type: command
+    short-summary: Update an existing job with the specified parameters.
+    examples:
+      - name: Update the job "SdkJob3971" with the specified parameters.
+        text: |-
+               az databox job update --resource-group "SdkRg4981" --name "SdkJob3971" \\
+               --contact-name "Update Job" --phone "1234567890" \\
+               --email-list "[email protected]" \\
+               --street-address1 "16 TOWNSEND ST" \\
+               --city "San Francisco" --state-or-province "CA" \\
+               --country "US" --postal-code "94107" \\
+               --company-name "Microsoft" \\
+"""
+
+helps['databox job delete'] = """
+    type: command
+    short-summary: Delete a job.
+    examples:
+      - name: Delete the job "SdkJob3971" in resource group "SdkRg4981".
+        text: |-
+               az databox job delete --resource-group "SdkRg4981" --name "SdkJob3971"
+"""
+
+helps['databox job show'] = """
+    type: command
+    short-summary: Get information about the specified job.
+    examples:
+      - name: Get the information about the job "SdkJob3971".
+        text: |-
+               az databox job show --resource-group "SdkRg4981" --name "SdkJob3971"
+"""
+
+helps['databox job list'] = """
+    type: command
+    short-summary: List all the jobs available under the given resource group or the given subscription.
+    examples:
+      - name: List all the jobs available under the current subscription.
+        text: |-
+               az databox job list
+      - name: List all the jobs available under the resource group "SdkRg4981".
+        text: |-
+               az databox job list --resource-group "SdkRg4981"
+"""
+
+helps['databox job cancel'] = """
+    type: command
+    short-summary: Cancel a job.
+    examples:
+      - name: Cancel the job "SdkJob3971" under resource group "SdkRg4981".
+        text: |-
+               az databox job cancel --resource-group "SdkRg4981" --name "SdkJob3971" --reason "CancelTest"
+"""
+
+helps['databox job list-credentials'] = """
+    type: command
+    short-summary: List the unencrypted secrets related to the job.
+    examples:
+      - name: List the unencrypted secrets related to the job "TJ-636646322037905056".
+        text: |-
+               az databox job list-credentials --resource-group "bvttoolrg6" --name "TJ-636646322037905056"
+"""

src/databox/azext_databox/_params.py

@@ -0,0 +1,75 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# pylint: disable=line-too-long
+# pylint: disable=too-many-lines
+# pylint: disable=too-many-statements
+
+from azure.cli.core.commands.parameters import (
+    tags_type,
+    get_enum_type,
+    get_location_type
+)
+from azure.cli.core.commands.validators import get_default_location_from_resource_group
+from knack.arguments import CLIArgumentType
+
+
+def load_arguments(self, _):
+    storage_accounts_type = CLIArgumentType(help='Space-separated list of the destination storage account. It can be the name or resource ID of storage account.', arg_group='Storage Account', nargs='+')
+    staging_storage_account_type = CLIArgumentType(help='The name or ID of the destination storage account that can be used to copy the vhd for staging.', arg_group='Managed Disk')
+    resource_group_for_managed_disk_type = CLIArgumentType(help='The name or ID of the destination resource group where the Compute disks should be created.', arg_group='Managed Disk')
+    job_name_type = CLIArgumentType(options_list=['--name', '-n'], help='The name of the job resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only')
+
+    with self.argument_context('databox job create') as c:
+        c.argument('job_name', job_name_type)
+        c.argument('location', arg_type=get_location_type(self.cli_ctx), default=None,
+                   validator=get_default_location_from_resource_group)
+        c.argument('tags', tags_type)
+        c.argument('sku', arg_type=get_enum_type(['DataBox', 'DataBoxDisk', 'DataBoxHeavy']),
+                   help='The sku type of DataBox.')
+        c.argument('expected_data_size', type=int, help='The expected size of the data which needs to be transferred in this job, in terabytes.The maximum usable capacity is up to 35 TB. This is only needed when sku is DataBoxDisk.')
+        c.argument('contact_name', help='Contact name of the person.', arg_group='Contact Details')
+        c.argument('phone', help='Phone number of the contact person.', arg_group='Contact Details')
+        c.argument('mobile', help='Mobile number of the contact person.', arg_group='Contact Details')
+        c.argument('email_list', help='Space-separated list of Email addresses to be notified about job progress.', arg_group='Contact Details', nargs='+')
+        c.argument('street_address1', help='Street Address line 1.', arg_group='Shipping Address')
+        c.argument('street_address2', help='Street Address line 2.', arg_group='Shipping Address')
+        c.argument('street_address3', help='Street Address line 3.', arg_group='Shipping Address')
+        c.argument('city', help='Name of the City.', arg_group='Shipping Address')
+        c.argument('state_or_province', help='Name of the State or Province.', arg_group='Shipping Address')
+        c.argument('country', help='Name of the Country. Ex: US', arg_group='Shipping Address')
+        c.argument('postal_code', help='Postal code.', arg_group='Shipping Address')
+        c.argument('company_name', help='Name of the company.', arg_group='Shipping Address')
+        c.extra('storage_accounts', arg_type=storage_accounts_type)
+        c.extra('staging_storage_account', arg_type=staging_storage_account_type)
+        c.extra('resource_group_for_managed_disk', arg_type=resource_group_for_managed_disk_type)
+        c.ignore('destination_account_details')
+
+    with self.argument_context('databox job update') as c:
+        c.argument('job_name', job_name_type)
+        c.argument('contact_name', help='Contact name of the person.', arg_group='Contact Details')
+        c.argument('phone', help='Phone number of the contact person.', arg_group='Contact Details')
+        c.argument('mobile', help='Mobile number of the contact person.', arg_group='Contact Details')
+        c.argument('email_list', help='List of Email addresses to be notified about job progress.', arg_group='Contact Details', nargs='+')
+        c.argument('street_address1', help='Street Address line 1.', arg_group='Shipping Address')
+        c.argument('street_address2', help='Street Address line 2.', arg_group='Shipping Address')
+        c.argument('street_address3', help='Street Address line 3.', arg_group='Shipping Address')
+        c.argument('city', help='Name of the City.', arg_group='Shipping Address')
+        c.argument('state_or_province', help='Name of the State or Province.', arg_group='Shipping Address')
+        c.argument('country', help='Name of the Country. Ex: US', arg_group='Shipping Address')
+        c.argument('postal_code', help='Postal code.', arg_group='Shipping Address')
+        c.argument('company_name', help='Name of the company.', arg_group='Shipping Address')
+
+    with self.argument_context('databox job delete') as c:
+        c.argument('job_name', job_name_type)
+
+    with self.argument_context('databox job show') as c:
+        c.argument('job_name', job_name_type)
+
+    with self.argument_context('databox job cancel') as c:
+        c.argument('job_name', job_name_type)
+        c.argument('reason', help='Reason for cancellation.')
+
+    with self.argument_context('databox job list-credentials') as c:
+        c.argument('job_name', job_name_type)