[Breadth Coverage] Log Analytics Solution

.github/CODEOWNERS

@@ -107,3 +107,5 @@
 /src/account/ @zikalino
 
 /src/datashare/ @fengzhou-msft
+
+/src/log-analytics-solution/ @zhoxing-ms

src/log-analytics-solution/HISTORY.rst

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

src/log-analytics-solution/README.md

@@ -0,0 +1,56 @@
+# Azure CLI log-analytics-solution Extension #
+This package is for the 'log-analytics-solution' extension, i.e. 'az monitor log-analytics solution'
+
+### How to use ###
+Install this extension using the below CLI command
+```
+az extension add --name log-analytics-solution
+```
+
+### Included Features
+#### Log Analytics Solution Management:
+Manage Log Analytics Solution: [more info](https://docs.microsoft.com/en-us/azure/azure-monitor/insights/solutions) \
+*Examples:*
+
+##### Create a log-analytics solution for the plan product of OMSGallery/Containers
+```
+az monitor log-analytics solution create \
+    --resource-group MyResourceGroup \
+    --name Containers({SolutionName}) \
+    --plan-publisher Microsoft \
+    --plan-product "OMSGallery/Containers" \
+    --workspace "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/ \
+    Microsoft.OperationalInsights/workspaces/{WorkspaceName}" \
+    --tags key=value
+```
+
+##### Update a log-analytics solution
+```
+ az monitor log-analytics solution update \
+    --resource-group MyResourceGroup \
+    --name SolutionName \
+    --tags key=value
+```
+
+##### Delete a log-analytics solution
+```
+az monitor log-analytics solution delete --resource-group MyResourceGroup --name SolutionName
+```
+
+##### Get details about the specified log-analytics solution
+```
+az monitor log-analytics solution show --resource-group MyResourceGroup --name SolutionName
+```
+
+##### List all of the log-analytics solutions in the specified subscription or resource group
+```
+az monitor log-analytics solution list
+```
+```
+az monitor log-analytics solution list --subscription MySubscription
+```
+```
+az monitor log-analytics solution list --resource-group MyResourceGroup
+```
+
+If you have issues, please give feedback by opening an issue at https://github.com/Azure/azure-cli-extensions/issues.

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

src/log-analytics-solution/azext_log_analytics_solution/_client_factory.py

@@ -0,0 +1,15 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+
+def cf_log_analytics_solution(cli_ctx, *_):
+    from azure.cli.core.commands.client_factory import get_mgmt_service_client
+    from .vendored_sdks.operationsmanagement import OperationsManagementClient
+    return get_mgmt_service_client(cli_ctx, OperationsManagementClient, provider_name="Microsoft.OperationsManagement",
+                                   resource_type="solutions", resource_name="")
+
+
+def cf_solutions(cli_ctx, *_):
+    return cf_log_analytics_solution(cli_ctx, *_).solutions

src/log-analytics-solution/azext_log_analytics_solution/_help.py

@@ -0,0 +1,71 @@
+# 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['monitor log-analytics solution'] = """
+    type: group
+    short-summary: Commands to manage monitor log-analytics solution.
+"""
+
+helps['monitor log-analytics solution create'] = """
+    type: command
+    short-summary: Create a log-analytics solution.
+    examples:
+      - name: Create a log-analytics solution for the plan product of OMSGallery/Containers
+        text: |-
+               az monitor log-analytics solution create --resource-group MyResourceGroup \\
+               --name Containers({SolutionName}) --tags key=value \\
+               --plan-publisher Microsoft --plan-product "OMSGallery/Containers" \\
+               --workspace "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/ \\
+               Microsoft.OperationalInsights/workspaces/{WorkspaceName}"
+"""
+
+helps['monitor log-analytics solution update'] = """
+    type: command
+    short-summary:  Update an existing log-analytics solution.
+    examples:
+      - name: Update a log-analytics solution
+        text: |-
+               az monitor log-analytics solution update --resource-group MyResourceGroup \\
+               --name SolutionName --tags key=value
+"""
+
+helps['monitor log-analytics solution delete'] = """
+    type: command
+    short-summary: Delete a log-analytics solution.
+    examples:
+      - name: Delete a log-analytics solution
+        text: |-
+               az monitor log-analytics solution delete --resource-group MyResourceGroup --name SolutionName
+"""
+
+helps['monitor log-analytics solution show'] = """
+    type: command
+    short-summary: Get details about the specified log-analytics solution.
+    examples:
+      - name: Get a log-analytics solution
+        text: |-
+               az monitor log-analytics solution show --resource-group MyResourceGroup --name SolutionName
+"""
+
+helps['monitor log-analytics solution list'] = """
+    type: command
+    short-summary: List all of the log-analytics solutions in the specified subscription or resource group
+    examples:
+      - name: List all log-analytics solutions in the current subscription
+        text: |-
+               az monitor log-analytics solution list
+      - name: List all log-analytics solutions in a subscription
+        text: |-
+               az monitor log-analytics solution list --subscription MySubscription
+      - name: List all log-analytics solutions in a resource group
+        text: |-
+               az monitor log-analytics solution list --resource-group MyResourceGroup
+"""

src/log-analytics-solution/azext_log_analytics_solution/_params.py

@@ -0,0 +1,43 @@
+# --------------------------------------------------------------------------------------------
+# 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,
+    resource_group_name_type
+)
+from ._validators import validate_workspace_resource_id
+from knack.arguments import CLIArgumentType
+
+solution_name = CLIArgumentType(options_list=['--name', '-n'],
+                                 help='Name of the log-analytics solution. For Microsoft published solution it '
+                                      'should be in the format of solutionType(workspaceName). SolutionType part is '
+                                      'case sensitive. For third party solution, it can be anything.')
+
+
+def load_arguments(self, _):
+
+    with self.argument_context('monitor log-analytics solution create') as c:
+        c.ignore('location')
+        c.argument('solution_name', solution_name)
+        c.argument('tags', tags_type)
+        c.argument('plan_publisher', help='Publisher name of the plan for solution. For gallery solution, it is Microsoft.')
+        c.argument('plan_product', help='Product name of the plan for solution. '
+                                        'For Microsoft published gallery solution it should be in the format of OMSGallery/<solutionType>. This is case sensitive.')
+        c.argument('workspace_resource_id', options_list=['--workspace', '-w'],
+                   validator=validate_workspace_resource_id,
+                   help='The name or resource ID of the log analytics workspace with which the solution will be linked.')
+
+    with self.argument_context('monitor log-analytics solution update') as c:
+        c.argument('solution_name', solution_name)
+        c.argument('tags', tags_type)
+
+    with self.argument_context('monitor log-analytics solution delete') as c:
+        c.argument('solution_name', solution_name)
+
+    with self.argument_context('monitor log-analytics solution show') as c:
+        c.argument('solution_name', solution_name)

src/log-analytics-solution/azext_log_analytics_solution/_validators.py

@@ -0,0 +1,37 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+from msrestazure.tools import is_valid_resource_id, parse_resource_id
+from knack.util import CLIError
+from azure.mgmt.loganalytics import LogAnalyticsManagementClient
+from azure.cli.core.commands.client_factory import get_mgmt_service_client, get_subscription_id
+from msrestazure.tools import resource_id
+
+
+def validate_workspace_resource_id(cmd, namespace):
+
+    if namespace.workspace_resource_id:
+        # If the workspace_resource_id is invalid, use it as a workspace name to splice the workspace_resource_id
+        if not is_valid_resource_id(namespace.workspace_resource_id):
+            namespace.workspace_resource_id = resource_id(
+                subscription=get_subscription_id(cmd.cli_ctx),
+                resource_group=namespace.resource_group_name,
+                namespace='microsoft.OperationalInsights',
+                type='workspaces',
+                name=namespace.workspace_resource_id
+            )
+
+        if not is_valid_resource_id(namespace.workspace_resource_id):
+            raise CLIError('usage error: --workspace is invalid, it must be name of resource id of workspace')
+
+        # Determine whether the workspace already exists
+        workspace_param = parse_resource_id(namespace.workspace_resource_id)
+        if workspace_param['resource_group'] != namespace.resource_group_name:
+            raise CLIError('usage error: workspace and solution must be under the same resource group')
+
+        workspaces_client = get_mgmt_service_client(cmd.cli_ctx, LogAnalyticsManagementClient).workspaces
+        workspaces = workspaces_client.get(workspace_param['resource_group'], workspace_param['resource_name'])
+
+        # The location of solution is the same as the location of the workspace
+        namespace.location = workspaces.location

src/log-analytics-solution/azext_log_analytics_solution/azext_metadata.json

@@ -0,0 +1,4 @@
+{
+    "azext.isExperimental": true,
+    "azext.minCliCoreVersion": "2.3.0"
+}

src/log-analytics-solution/azext_log_analytics_solution/commands.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.
+# --------------------------------------------------------------------------------------------
+
+# pylint: disable=line-too-long
+# pylint: disable=too-many-lines
+# pylint: disable=too-many-statements
+# pylint: disable=too-many-locals
+from azure.cli.core.commands import CliCommandType
+from ._client_factory import cf_solutions
+
+
+def load_command_table(self, _):
+
+    log_analytics_solution_solutions = CliCommandType(
+        operations_tmpl='azext_log_analytics_solution.vendored_sdks.operationsmanagement.operations._solutions_operations#SolutionsOperations.{}',
+        client_factory=cf_solutions)
+
+    with self.command_group('monitor log-analytics solution', log_analytics_solution_solutions,
+                            client_factory=cf_solutions, is_experimental=True) as g:
+        g.custom_command('create', 'create_monitor_log_analytics_solution', supports_no_wait=True)
+        g.custom_command('update', 'update_monitor_log_analytics_solution', supports_no_wait=True)
+        g.custom_command('delete', 'delete_monitor_log_analytics_solution', supports_no_wait=True, confirmation=True)
+        g.custom_show_command('show', 'get_monitor_log_analytics_solution')
+        g.custom_command('list', 'list_monitor_log_analytics_solution')

src/log-analytics-solution/azext_log_analytics_solution/custom.py

@@ -0,0 +1,68 @@
+# --------------------------------------------------------------------------------------------
+# 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-statements
+# pylint: disable=too-many-lines
+# pylint: disable=too-many-locals
+# pylint: disable=unused-argument
+
+from azure.cli.core.util import sdk_no_wait
+
+
+def create_monitor_log_analytics_solution(client,
+                                          resource_group_name,
+                                          solution_name,
+                                          plan_publisher,
+                                          plan_product,
+                                          workspace_resource_id,
+                                          location,
+                                          tags=None,
+                                          no_wait=False):
+
+    body = {
+        'location': location,
+        'tags': tags,
+        'properties': {
+            "workspace_resource_id": workspace_resource_id
+        },
+        "plan": {
+            "name": solution_name,
+            "product": plan_product,
+            "publisher": plan_publisher,
+            "promotion_code": ""
+        }
+    }
+
+    return sdk_no_wait(no_wait, client.create_or_update, resource_group_name=resource_group_name,
+                       solution_name=solution_name, parameters=body)
+
+
+def update_monitor_log_analytics_solution(client,
+                                          resource_group_name,
+                                          solution_name,
+                                          tags=None,
+                                          no_wait=False):
+
+    return sdk_no_wait(no_wait, client.update, resource_group_name=resource_group_name,
+                       solution_name=solution_name, tags=tags)
+
+
+def delete_monitor_log_analytics_solution(client,
+                                          resource_group_name,
+                                          solution_name,
+                                          no_wait=False):
+    return sdk_no_wait(no_wait, client.delete, resource_group_name=resource_group_name, solution_name=solution_name)
+
+
+def get_monitor_log_analytics_solution(client,
+                                       resource_group_name,
+                                       solution_name):
+    return client.get(resource_group_name=resource_group_name, solution_name=solution_name)
+
+
+def list_monitor_log_analytics_solution(client, resource_group_name=None):
+    if resource_group_name:
+        return client.list_by_resource_group(resource_group_name=resource_group_name)
+    return client.list_by_subscription()

src/log-analytics-solution/azext_log_analytics_solution/tests/__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/log-analytics-solution/azext_log_analytics_solution/tests/latest/__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/log-analytics-solution/azext_log_analytics_solution/tests/latest/log_analytics.json

@@ -0,0 +1,11 @@
+{
+    "features": {
+      "legacy": "0",
+      "searchVersion": "1"
+    },
+    "retentionInDays": "7",
+    "sku": {
+      "name": "free"
+    },
+    "source": "Azure"
+}