[Monitor] az monitor log-analytics workspace linked-storage: supports…

… BYOS features (#13187)

* finish code

recording

finish tests

* address comments and rerun tests

* refine logic

* address comments

* fix style

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

@@ -119,3 +119,7 @@ def cf_log_analytics_workspace_linked_service(cli_ctx, _):
 
 def cf_log_analytics_cluster(cli_ctx, _):
     return _log_analytics_client_factory(cli_ctx).clusters
+
+
+def cf_log_analytics_linked_storage(cli_ctx, _):
+    return _log_analytics_client_factory(cli_ctx).linked_storage_accounts

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

@@ -1103,6 +1103,60 @@
     text: az monitor log-analytics workspace linked-service wait -n cluster -g MyResourceGroup --workspace-name MyWorkspace --created
 """
 
+helps['monitor log-analytics workspace linked-storage'] = """
+type: group
+short-summary: Manage linked storage account for log analytics workspace.
+"""
+
+helps['monitor log-analytics workspace linked-storage create'] = """
+type: command
+short-summary: Create some linked storage accounts for log analytics workspace.
+examples:
+  - name: Create two linked storage accounts for a log analytics workspace
+    text: az monitor log-analytics workspace linked-storage create --type AzureWatson -g MyResourceGroup --workspace-name MyWorkspace --storage-accounts SA1 SA2
+"""
+
+helps['monitor log-analytics workspace linked-storage delete'] = """
+type: command
+short-summary: Delete all linked storage accounts with specific data source type for log analytics workspace.
+examples:
+  - name: Delete all linked storage accounts with a specific type for a log analytics workspace
+    text: az monitor log-analytics workspace linked-storage delete --type AzureWatson -g MyResourceGroup --workspace-name MyWorkspace
+"""
+
+helps['monitor log-analytics workspace linked-storage add'] = """
+type: command
+short-summary: Add some linked storage accounts with specific data source type for log analytics workspace.
+examples:
+  - name: Add two linked storage accounts for a log analytics workspace
+    text: az monitor log-analytics workspace linked-storage add --type AzureWatson -g MyResourceGroup --workspace-name MyWorkspace --storage-accounts SA1 SA2
+"""
+
+helps['monitor log-analytics workspace linked-storage remove'] = """
+type: command
+short-summary: Remove some linked storage accounts with specific data source type for log analytics workspace
+examples:
+  - name: Remove two linked storage accounts for a log analytics workspace
+    text: az monitor log-analytics workspace linked-storage remove --type AzureWatson -g MyResourceGroup --workspace-name MyWorkspace --storage-accounts SA1 SA2.
+"""
+
+helps['monitor log-analytics workspace linked-storage list'] = """
+type: command
+short-summary: List all linked storage accounts for a log analytics workspace.
+examples:
+  - name: List all linked storage accounts for a log analytics workspace
+    text: az monitor log-analytics workspace linked-storage list -g MyResourceGroup --workspace-name MyWorkspace
+
+"""
+
+helps['monitor log-analytics workspace linked-storage show'] = """
+type: command
+short-summary: List all linked storage accounts with specific data source type for a log analytics workspace.
+examples:
+  - name: Show all linked storage accounts with a specific type for a log analytics workspace
+    text: az monitor log-analytics workspace linked-storage show --type AzureWatson -g MyResourceGroup --workspace-name MyWorkspace
+"""
+
 helps['monitor log-profiles'] = """
 type: group
 short-summary: Manage log profiles.

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

@@ -16,7 +16,7 @@
 from azure.cli.command_modules.monitor.util import get_operator_map, get_aggregation_map
 from azure.cli.command_modules.monitor.validators import (
     process_webhook_prop, validate_autoscale_recurrence, validate_autoscale_timegrain, get_action_group_validator,
-    get_action_group_id_validator, validate_metric_dimension)
+    get_action_group_id_validator, validate_metric_dimension, validate_storage_accounts_name_or_id)
 
 from knack.arguments import CLIArgumentType
 
@@ -339,6 +339,11 @@ def load_arguments(self, _):
         c.argument('workspace_name', options_list=['--workspace-name', '-n'], help="Name of the Log Analytics Workspace.")
         c.ignore('sku')
         c.argument('retention_time', help="The workspace data retention in days.", type=int, default=30)
+        from azure.mgmt.loganalytics.models import PublicNetworkAccessType
+        c.argument('public_network_access_for_ingestion', options_list=['--ingestion-access'], help='The public network access type to access workspace ingestion.',
+                   arg_type=get_enum_type(PublicNetworkAccessType))
+        c.argument('public_network_access_for_query', options_list=['--query-access'], help='The public network access type to access workspace query.',
+                   arg_type=get_enum_type(PublicNetworkAccessType))
 
     with self.argument_context('monitor log-analytics workspace pack') as c:
         c.argument('intelligence_pack_name', options_list=['--name', '-n'])
@@ -371,6 +376,16 @@ def load_arguments(self, _):
         c.argument('key_version', help='The version of the key associated with the Log Analytics cluster.')
     # endregion
 
+    # region Log Analytics Linked Storage Account
+    with self.argument_context('monitor log-analytics workspace linked-storage') as c:
+        from azure.mgmt.loganalytics.models import DataSourceType
+        c.argument('data_source_type', help='Data source type for the linked storage account.',
+                   options_list=['--type'], arg_type=get_enum_type(DataSourceType))
+        c.argument('storage_account_ids', nargs='+', options_list=['--storage-accounts'],
+                   help='List of Name or ID of Azure Storage Account.',
+                   validator=validate_storage_accounts_name_or_id)
+    # endregion
+
     # region monitor clone
     with self.argument_context('monitor clone') as c:
         c.argument('source_resource', help="Resource ID of the source resource.")

src/azure-cli/azure/cli/command_modules/monitor/commands.py

@@ -17,7 +17,7 @@ def load_command_table(self, _):
         cf_log_analytics_workspace_intelligence_packs, cf_log_analytics_cluster,
         cf_log_analytics_workspace_linked_service, cf_diagnostics_category,
         cf_private_link_resources, cf_private_link_scoped_resources,
-        cf_private_link_scopes, cf_private_endpoint_connections)
+        cf_private_link_scopes, cf_private_endpoint_connections, cf_log_analytics_linked_storage)
     from ._exception_handler import monitor_exception_handler, missing_resource_handler
     from .transformers import (action_group_list_table)
     from .validators import process_autoscale_create_namespace, validate_private_endpoint_connection_id,\
@@ -229,6 +229,18 @@ def load_command_table(self, _):
         exception_handler=monitor_exception_handler
     )
 
+    log_analytics_linked_storage_sdk = CliCommandType(
+        operations_tmpl='azure.mgmt.loganalytics.operations#LinkedStorageAccountsOperations.{}',
+        client_factory=cf_log_analytics_linked_storage,
+        exception_handler=monitor_exception_handler
+    )
+
+    log_analytics_linked_storage_custom = CliCommandType(
+        operations_tmpl='azure.cli.command_modules.monitor.operations.log_analytics_linked_storage_account#{}',
+        client_factory=cf_log_analytics_linked_storage,
+        exception_handler=monitor_exception_handler
+    )
+
     monitor_general_custom = CliCommandType(
         operations_tmpl='azure.cli.command_modules.monitor.operations.general_operations#{}',
         client_factory=cf_metric_alerts,
@@ -345,7 +357,7 @@ def load_command_table(self, _):
         g.command('enable', 'enable')
         g.command('disable', 'disable')
 
-    with self.command_group('monitor log-analytics workspace linked-service', log_analytics_workspace_linked_service_sdk, custom_command_type=log_analytics_workspace_linked_service_custom) as g:
+    with self.command_group('monitor log-analytics workspace linked-service', log_analytics_workspace_linked_service_sdk, custom_command_type=log_analytics_workspace_linked_service_custom, is_preview=True) as g:
         g.custom_command('create', 'create_log_analytics_workspace_linked_service', supports_no_wait=True)
         g.generic_update_command('update', custom_func_name='update_log_analytics_workspace_linked_service', supports_no_wait=True)
         g.show_command('show', 'get')
@@ -361,28 +373,36 @@ def load_command_table(self, _):
         g.custom_command('list', 'list_log_analytics_clusters')
         g.wait_command('wait')
 
-    with self.command_group('monitor', metric_alert_sdk, custom_command_type=monitor_general_custom, is_preview=True) as g:
-        g.custom_command('clone', 'clone_existed_settings')
+    with self.command_group('monitor log-analytics workspace linked-storage', log_analytics_linked_storage_sdk, custom_command_type=log_analytics_linked_storage_custom, is_preview=True) as g:
+        g.command('create', 'create_or_update')
+        g.custom_command('add', 'add_log_analytics_workspace_linked_storage_accounts')
+        g.custom_command('remove', 'remove_log_analytics_workspace_linked_storage_accounts')
+        g.command('delete', 'delete', confirmation=True)
+        g.show_command('show', 'get')
+        g.command('list', 'list_by_workspace')
+
+    with self.command_group('monitor', metric_alert_sdk, custom_command_type=monitor_general_custom) as g:
+        g.custom_command('clone', 'clone_existed_settings', is_preview=True)
 
-    with self.command_group('monitor private-link-scope', private_link_scopes_sdk, custom_command_type=private_link_scope_custom) as g:
+    with self.command_group('monitor private-link-scope', private_link_scopes_sdk, custom_command_type=private_link_scope_custom, is_preview=True) as g:
         g.custom_show_command('show', 'show_private_link_scope')
         g.custom_command('list', 'list_private_link_scope')
         g.custom_command('create', 'create_private_link_scope')
         g.custom_command('update', 'update_private_link_scope')
         g.custom_command('delete', 'delete_private_link_scope', confirmation=True)
 
-    with self.command_group('monitor private-link-scope scoped-resource', private_link_scoped_resources_sdk, custom_command_type=private_link_scope_custom) as g:
+    with self.command_group('monitor private-link-scope scoped-resource', private_link_scoped_resources_sdk, custom_command_type=private_link_scope_custom, is_preview=True) as g:
         g.custom_show_command('show', 'show_private_link_scope_resource', client_factory=cf_private_link_scoped_resources)
         g.custom_command('list', 'list_private_link_scope_resource', client_factory=cf_private_link_scoped_resources)
         g.custom_command('create', 'create_private_link_scope_resource', client_factory=cf_private_link_scoped_resources)
         g.custom_command('delete', 'delete_private_link_scope_resource', client_factory=cf_private_link_scoped_resources, confirmation=True)
 
-    with self.command_group('monitor private-link-scope private-link-resource', private_link_resources_sdk, custom_command_type=private_link_scope_custom) as g:
+    with self.command_group('monitor private-link-scope private-link-resource', private_link_resources_sdk, custom_command_type=private_link_scope_custom, is_preview=True) as g:
         g.custom_show_command('show', 'show_private_link_resource', client_factory=cf_private_link_resources)
         from azure.cli.core.commands.transform import gen_dict_to_list_transform
         g.custom_command('list', 'list_private_link_resource', client_factory=cf_private_link_resources, transform=gen_dict_to_list_transform(key="value"))
 
-    with self.command_group('monitor private-link-scope private-endpoint-connection', private_endpoint_connections_sdk, custom_command_type=private_link_scope_custom) as g:
+    with self.command_group('monitor private-link-scope private-endpoint-connection', private_endpoint_connections_sdk, custom_command_type=private_link_scope_custom, is_preview=True) as g:
         g.custom_show_command('show', 'show_private_endpoint_connection', client_factory=cf_private_endpoint_connections,
                               validator=validate_private_endpoint_connection_id)
         g.custom_command('list', 'list_private_endpoint_connection', client_factory=cf_private_endpoint_connections)

src/azure-cli/azure/cli/command_modules/monitor/operations/log_analytics_linked_storage_account.py

@@ -0,0 +1,31 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+
+def add_log_analytics_workspace_linked_storage_accounts(client, resource_group_name, workspace_name,
+                                                        data_source_type, storage_account_ids):
+    linked_storage_accounts = client.get(resource_group_name=resource_group_name,
+                                         workspace_name=workspace_name,
+                                         data_source_type=data_source_type)
+    linked_storage_accounts.storage_account_ids.extend(storage_account_ids)
+    return client.create_or_update(resource_group_name=resource_group_name,
+                                   workspace_name=workspace_name,
+                                   data_source_type=data_source_type,
+                                   storage_account_ids=linked_storage_accounts.storage_account_ids)
+
+
+def remove_log_analytics_workspace_linked_storage_accounts(client, resource_group_name, workspace_name,
+                                                           data_source_type, storage_account_ids):
+    linked_storage_accounts = client.get(resource_group_name=resource_group_name,
+                                         workspace_name=workspace_name,
+                                         data_source_type=data_source_type)
+    storage_account_ids_set = set(str.lower(storage_account_id) for storage_account_id in storage_account_ids)
+    for existed_storage_account_id in linked_storage_accounts.storage_account_ids:
+        if str.lower(existed_storage_account_id) in storage_account_ids_set:
+            linked_storage_accounts.storage_account_ids.remove(existed_storage_account_id)
+    return client.create_or_update(resource_group_name=resource_group_name,
+                                   workspace_name=workspace_name,
+                                   data_source_type=data_source_type,
+                                   storage_account_ids=linked_storage_accounts.storage_account_ids)

src/azure-cli/azure/cli/command_modules/monitor/operations/log_analytics_workspace.py

@@ -6,25 +6,33 @@
 
 
 def create_log_analytics_workspace(cmd, client, resource_group_name, workspace_name, location=None, tags=None,
-                                   sku=WorkspaceSkuNameEnum.per_gb2018.value, retention_time=None):
+                                   sku=WorkspaceSkuNameEnum.per_gb2018.value, retention_time=None,
+                                   public_network_access_for_query=None, public_network_access_for_ingestion=None):
     from azure.mgmt.loganalytics.models import Workspace, WorkspaceSku
     from azure.cli.core.commands import LongRunningOperation
     workspace_client = client
     sku = WorkspaceSku(name=sku)
     workspace_instance = Workspace(location=location,
                                    tags=tags,
                                    sku=sku,
-                                   retention_in_days=retention_time)
+                                   retention_in_days=retention_time,
+                                   public_network_access_for_query=public_network_access_for_query,
+                                   public_network_access_for_ingestion=public_network_access_for_ingestion)
     return LongRunningOperation(cmd.cli_ctx)(workspace_client.create_or_update(resource_group_name,
                                                                                workspace_name,
                                                                                workspace_instance))
 
 
-def update_log_analytics_workspace(instance, tags=None, retention_time=None):
+def update_log_analytics_workspace(instance, tags=None, retention_time=None,
+                                   public_network_access_for_query=None, public_network_access_for_ingestion=None):
     if tags is not None:
         instance.tags = tags
     if retention_time is not None:
         instance.retention_in_days = retention_time
+    if public_network_access_for_query is not None:
+        instance.public_network_access_for_query = public_network_access_for_query
+    if public_network_access_for_ingestion is not None:
+        instance.public_network_access_for_ingestion = public_network_access_for_ingestion
     return instance