[Synapse] Add integration runtime related cmdlets (Azure#15498)

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

@@ -54,6 +54,38 @@ def cf_synapse_client_ipfirewallrules_factory(cli_ctx, *_):
     return cf_synapse(cli_ctx).ip_firewall_rules
 
 
+def cf_synapse_client_integrationruntimes_factory(cli_ctx, *_):
+    return cf_synapse(cli_ctx).integration_runtimes
+
+
+def cf_synapse_client_integrationruntimeauthkeys_factory(cli_ctx, *_):
+    return cf_synapse(cli_ctx).integration_runtime_auth_keys
+
+
+def cf_synapse_client_integrationruntimemonitoringdata_factory(cli_ctx, *_):
+    return cf_synapse(cli_ctx).integration_runtime_monitoring_data
+
+
+def cf_synapse_client_integrationruntimenodes_factory(cli_ctx, *_):
+    return cf_synapse(cli_ctx).integration_runtime_nodes
+
+
+def cf_synapse_client_integrationruntimenodeipaddress_factory(cli_ctx, *_):
+    return cf_synapse(cli_ctx).integration_runtime_node_ip_address
+
+
+def cf_synapse_client_integrationruntimecredentials_factory(cli_ctx, *_):
+    return cf_synapse(cli_ctx).integration_runtime_credentials
+
+
+def cf_synapse_client_integrationruntimeconnectioninfos_factory(cli_ctx, *_):
+    return cf_synapse(cli_ctx).integration_runtime_connection_infos
+
+
+def cf_synapse_client_integrationruntimestatus_factory(cli_ctx, *_):
+    return cf_synapse(cli_ctx).integration_runtime_status
+
+
 def cf_synapse_client_operations_factory(cli_ctx, *_):
     return cf_synapse(cli_ctx).operations
 

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

@@ -1346,3 +1346,177 @@
         az synapse notebook delete --workspace-name testsynapseworkspace \\
           --name testnotebook
 """
+
+helps['synapse integration-runtime'] = """
+type: group
+short-summary: Manage Synapse's integration runtimes.
+"""
+
+helps['synapse integration-runtime create'] = """
+type: command
+short-summary: Create an integration runtime.
+examples:
+  - name: Create an integration runtime.
+    text: |-
+        az synapse integration-runtime create --workspace-name testsynapseworkspace --resource-group rg \\
+          --name testintegrationruntime --type Managed
+"""
+
+helps['synapse integration-runtime update'] = """
+type: command
+short-summary: Update an integration runtime.
+examples:
+  - name: Update an integration runtime.
+    text: |-
+        az synapse integration-runtime update --workspace-name testsynapseworkspace --resource-group rg \\
+          --name testintegrationruntime --auto-update On --update-delay-offset '\"PT03H\"'
+"""
+
+helps['synapse integration-runtime show'] = """
+type: command
+short-summary: Get an integration runtime.
+examples:
+  - name: Get an integration runtime.
+    text: |-
+        az synapse integration-runtime show --workspace-name testsynapseworkspace --resource-group rg \\
+          --name testintegrationruntime
+"""
+
+helps['synapse integration-runtime list'] = """
+type: command
+short-summary: List integration runtimes.
+examples:
+  - name: List integration runtimes.
+    text: |-
+        az synapse integration-runtime list --workspace-name testsynapseworkspace --resource-group rg
+"""
+
+helps['synapse integration-runtime delete'] = """
+type: command
+short-summary: Delete an integration runtime.
+examples:
+  - name: Delete an integration runtime.
+    text: |-
+        az synapse integration-runtime delete --workspace-name testsynapseworkspace --resource-group rg \\
+          --name testintegrationruntime
+"""
+
+helps['synapse integration-runtime wait'] = """
+type: command
+short-summary: Place the CLI in a waiting state until a condition of a integration runtime is met.
+"""
+
+helps['synapse integration-runtime upgrade'] = """
+type: command
+short-summary: Upgrade self-hosted integration runtime.
+examples:
+  - name: Upgrade self-hosted integration runtime.
+    text: |-
+        az synapse integration-runtime upgrade --workspace-name testsynapseworkspace --resource-group rg \\
+          --name testintegrationruntime
+"""
+
+helps['synapse integration-runtime list-auth-key'] = """
+type: command
+short-summary: Get keys for a self-hosted integration runtime.
+examples:
+  - name: Get keys for a self-hosted integration runtime.
+    text: |-
+        az synapse integration-runtime list-auth-key --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime
+"""
+
+helps['synapse integration-runtime regenerate-auth-key'] = """
+type: command
+short-summary: Regenerate self-hosted integration runtime key.
+examples:
+  - name: Regenerate self-hosted integration runtime key.
+    text: |-
+        az synapse integration-runtime regenerate-auth-key --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime --key-name authKey1
+"""
+
+helps['synapse integration-runtime get-monitoring-data'] = """
+type: command
+short-summary: Get metric data for a self-hosted integration runtime.
+examples:
+  - name: Get metric data for a self-hosted integration runtime.
+    text: |-
+        az synapse integration-runtime get-monitoring-data --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime
+"""
+
+helps['synapse integration-runtime sync-credentials'] = """
+type: command
+short-summary: Synchronize credentials among integration runtime nodes.
+examples:
+  - name: Synchronize credentials among integration runtime nodes.
+    text: |-
+        az synapse integration-runtime sync-credentials --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime
+"""
+
+helps['synapse integration-runtime get-connection-info'] = """
+type: command
+short-summary: Get the integration runtime connection infomation.
+examples:
+  - name: Get the integration runtime connection infomation.
+    text: |-
+        az synapse integration-runtime get-connection-info --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime
+"""
+
+helps['synapse integration-runtime get-status'] = """
+type: command
+short-summary: Gets detailed status information for an integration runtime.
+examples:
+  - name: Gets detailed status information for an integration runtime.
+    text: |-
+        az synapse integration-runtime get-status --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime
+"""
+
+helps['synapse integration-runtime-node'] = """
+type: group
+short-summary: Manage Synapse's self-hosted integration runtime nodes.
+"""
+
+helps['synapse integration-runtime-node show'] = """
+type: command
+short-summary: Get self-hosted integration runtime node information.
+examples:
+  - name: Get self-hosted integration runtime node information.
+    text: |-
+        az synapse integration-runtime-node show --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime --node-name testnode
+"""
+
+helps['synapse integration-runtime-node update'] = """
+type: command
+short-summary: Update self-hosted integration runtime node.
+examples:
+  - name: Update self-hosted integration runtime node.
+    text: |-
+        az synapse integration-runtime-node update --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime --node-name testnode
+"""
+
+helps['synapse integration-runtime-node delete'] = """
+type: command
+short-summary: Remove a self-hosted integration runtime node.
+examples:
+  - name: Remove a self-hosted integration runtime node.
+    text: |-
+        az synapse integration-runtime-node delete --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime --node-name testnode
+"""
+
+helps['synapse integration-runtime-node get-ip-address'] = """
+type: command
+short-summary: Get self-hosted integration runtime node ip.
+examples:
+  - name: Get self-hosted integration runtime node ip.
+    text: |-
+        az synapse integration-runtime-node get-ip-address --workspace-name testsynapseworkspace --resource-group rg \\
+          --name selfhostedintegrationruntime --node-name testnode
+"""

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

@@ -600,3 +600,50 @@ def load_arguments(self, _):
     with self.argument_context('synapse notebook delete') as c:
         c.argument('workspace_name', arg_type=workspace_name_arg_type)
         c.argument('notebook_name', arg_type=name_type, help='The notebook name.')
+
+    # synapse integration runtime
+    with self.argument_context('synapse integration-runtime') as c:
+        c.argument('workspace_name', arg_type=workspace_name_arg_type, id_part='name')
+
+    for scope in ['list', 'list-auth-key', 'wait']:
+        with self.argument_context('synapse integration-runtime ' + scope) as c:
+            c.argument('workspace_name', arg_type=workspace_name_arg_type, id_part=None)
+
+    for scope in ['list-auth-key', 'wait']:
+        with self.argument_context('synapse integration-runtime ' + scope) as c:
+            c.argument('integration_runtime_name', arg_type=name_type, help='The integration runtime name.', id_part=None)
+
+    for scope in ['show', 'create', 'delete', 'wait', 'update', 'upgrade', 'regenerate-auth-key', 'get-monitoring-data', 'sync-credentials', 'get-connection-info', 'get-status']:
+        with self.argument_context('synapse integration-runtime ' + scope) as c:
+            c.argument('integration_runtime_name', arg_type=name_type, help='The integration runtime name.', id_part='child_name_1')
+
+    with self.argument_context('synapse integration-runtime create') as c:
+        c.argument('integration_runtime_type', options_list=['--type'], arg_type=get_enum_type(['Managed', 'SelfHosted']), help='The integration runtime type.')
+        c.argument('description', help='The integration runtime description.')
+        c.argument('if_match', help='ETag of the integration runtime entity. Should only be specified for update, for '
+                   'which it should match existing entity or can be * for unconditional update.')
+        # Managed
+        c.argument('location', arg_group='Managed', help='The integration runtime location.')
+        c.argument('compute_type', arg_group='Managed', arg_type=get_enum_type(['General', 'MemoryOptimized', 'ComputeOptimized']),
+                   help='Compute type of the data flow cluster which will execute data flow job.')
+        c.argument('core_count', arg_group='Managed', help='Core count of the data flow cluster which will execute data flow job.')
+        c.argument('time_to_live', arg_group='Managed', help='Time to live (in minutes) setting of the data flow cluster which will execute data flow job.')
+
+    with self.argument_context('synapse integration-runtime update') as c:
+        c.argument('auto_update', arg_type=get_enum_type(['On', 'Off']), help='Enable or disable the self-hosted integration runtime auto-update.')
+        c.argument('update_delay_offset', help='The time of the day for the self-hosted integration runtime auto-update.')
+
+    with self.argument_context('synapse integration-runtime regenerate-auth-key') as c:
+        c.argument('key_name', arg_type=get_enum_type(['authKey1', 'authKey2']), help='The name of the authentication key to regenerate.')
+
+    with self.argument_context('synapse integration-runtime-node') as c:
+        c.argument('workspace_name', arg_type=workspace_name_arg_type, id_part='name')
+        c.argument('integration_runtime_name', arg_type=name_type, help='The integration runtime name.', id_part='child_name_1')
+
+    for scope in ['show', 'update', 'delete', 'get-ip-address']:
+        with self.argument_context('synapse integration-runtime-node ' + scope) as c:
+            c.argument('node_name', help='The integration runtime node name.')
+
+    with self.argument_context('synapse integration-runtime-node update') as c:
+        c.argument('concurrent_jobs_limit', options_list=['--concurrent-jobs'], help='The number of concurrent jobs permitted to '
+                   'run on the integration runtime node. Values between 1 and maxConcurrentJobs are allowed.')

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

@@ -20,6 +20,14 @@ def load_command_table(self, _):
     from ._client_factory import cf_synapse_client_sqlpool_blob_auditing_policies_factory
     from ._client_factory import cf_synapse_client_workspace_aad_admins_factory
     from ._client_factory import cf_synapse_client_sqlserver_blob_auditing_policies_factory
+    from ._client_factory import cf_synapse_client_integrationruntimes_factory
+    from ._client_factory import cf_synapse_client_integrationruntimeauthkeys_factory
+    from ._client_factory import cf_synapse_client_integrationruntimemonitoringdata_factory
+    from ._client_factory import cf_synapse_client_integrationruntimenodeipaddress_factory
+    from ._client_factory import cf_synapse_client_integrationruntimenodes_factory
+    from ._client_factory import cf_synapse_client_integrationruntimecredentials_factory
+    from ._client_factory import cf_synapse_client_integrationruntimeconnectioninfos_factory
+    from ._client_factory import cf_synapse_client_integrationruntimestatus_factory
 
     def get_custom_sdk(custom_module, client_factory):
         return CliCommandType(
@@ -81,6 +89,38 @@ def get_custom_sdk(custom_module, client_factory):
         operations_tmpl='azure.mgmt.synapse.operations#IpFirewallRulesOperations.{}',
         client_factory=cf_synapse_client_ipfirewallrules_factory)
 
+    synapse_integrationruntimes_sdk = CliCommandType(
+        operations_tmpl='azure.mgmt.synapse.operations#IntegrationRuntimesOperations.{}',
+        client_factory=cf_synapse_client_integrationruntimes_factory)
+
+    synapse_integrationruntimeauthkeys_sdk = CliCommandType(
+        operations_tmpl='azure.mgmt.synapse.operations#IntegrationRuntimeAuthKeysOperations.{}',
+        client_factory=cf_synapse_client_integrationruntimeauthkeys_factory)
+
+    synapse_integrationruntimemonitoringdata_sdk = CliCommandType(
+        operations_tmpl='azure.mgmt.synapse.operations#IntegrationRuntimeMonitoringDataOperations.{}',
+        client_factory=cf_synapse_client_integrationruntimemonitoringdata_factory)
+
+    synapse_integrationruntimenodes_sdk = CliCommandType(
+        operations_tmpl='azure.mgmt.synapse.operations#IntegrationRuntimeNodesOperations.{}',
+        client_factory=cf_synapse_client_integrationruntimenodes_factory)
+
+    synapse_integrationruntimenodeipaddress_sdk = CliCommandType(
+        operations_tmpl='azure.mgmt.synapse.operations#IntegrationRuntimeNodeIpAddressOperations.{}',
+        client_factory=cf_synapse_client_integrationruntimenodeipaddress_factory)
+
+    synapse_integrationruntimecredentials_sdk = CliCommandType(
+        operations_tmpl='azure.mgmt.synapse.operations#IntegrationRuntimeCredentialsOperations.{}',
+        client_factory=cf_synapse_client_integrationruntimecredentials_factory)
+
+    synapse_integrationruntimeconnectioninfos_sdk = CliCommandType(
+        operations_tmpl='azure.mgmt.synapse.operations#IntegrationRuntimeConnectionInfosOperations.{}',
+        client_factory=cf_synapse_client_integrationruntimeconnectioninfos_factory)
+
+    synapse_integrationruntimestatus_sdk = CliCommandType(
+        operations_tmpl='azure.mgmt.synapse.operations#IntegrationRuntimeStatusOperations.{}',
+        client_factory=cf_synapse_client_integrationruntimestatus_factory)
+
     synapse_spark_session_sdk = CliCommandType(
         operations_tmpl='azure.synapse.spark.operations#SparkSessionOperations.{}',
         client_factory=None)
@@ -247,6 +287,38 @@ def get_custom_sdk(custom_module, client_factory):
         g.command('delete', 'delete', confirmation=True, supports_no_wait=True)
         g.wait_command('wait')
 
+    # Management Plane Commands --IntegrationRuntime
+    with self.command_group('synapse integration-runtime', command_type=synapse_integrationruntimes_sdk,
+                            custom_command_type=get_custom_sdk('integrationruntime', cf_synapse_client_integrationruntimes_factory),
+                            client_factory=cf_synapse_client_integrationruntimes_factory) as g:
+        g.command('list', 'list_by_workspace')
+        g.show_command('show', 'get')
+        g.custom_command('create', 'create', supports_no_wait=True)
+        g.command('delete', 'delete', confirmation=True, supports_no_wait=True)
+        g.command('update', 'update')
+        g.command('upgrade', 'upgrade')
+        g.command('list-auth-key', 'list', command_type=synapse_integrationruntimeauthkeys_sdk,
+                  client_factory=cf_synapse_client_integrationruntimeauthkeys_factory)
+        g.command('regenerate-auth-key', 'regenerate', command_type=synapse_integrationruntimeauthkeys_sdk,
+                  client_factory=cf_synapse_client_integrationruntimeauthkeys_factory)
+        g.command('get-monitoring-data', 'list', command_type=synapse_integrationruntimemonitoringdata_sdk,
+                  client_factory=cf_synapse_client_integrationruntimemonitoringdata_factory)
+        g.command('sync-credentials', 'sync', command_type=synapse_integrationruntimecredentials_sdk,
+                  client_factory=cf_synapse_client_integrationruntimecredentials_factory)
+        g.command('get-connection-info', 'get', command_type=synapse_integrationruntimeconnectioninfos_sdk,
+                  client_factory=cf_synapse_client_integrationruntimeconnectioninfos_factory)
+        g.command('get-status', 'get', command_type=synapse_integrationruntimestatus_sdk,
+                  client_factory=cf_synapse_client_integrationruntimestatus_factory)
+        g.wait_command('wait')
+
+    with self.command_group('synapse integration-runtime-node', command_type=synapse_integrationruntimenodes_sdk,
+                            client_factory=cf_synapse_client_integrationruntimenodes_factory) as g:
+        g.show_command('show', 'get')
+        g.command('update', 'update')
+        g.command('delete', 'delete', confirmation=True)
+        g.command('get-ip-address', 'get', command_type=synapse_integrationruntimenodeipaddress_sdk,
+                  client_factory=cf_synapse_client_integrationruntimenodeipaddress_factory)
+
     # Data Plane Commands --Spark batch opertions
     with self.command_group('synapse spark job', command_type=synapse_spark_batch_sdk,
                             custom_command_type=get_custom_sdk('spark', None)) as g:

src/azure-cli/azure/cli/command_modules/synapse/operations/integrationruntime.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=unused-argument
+from azure.cli.core.util import sdk_no_wait
+from azure.mgmt.synapse.models import IntegrationRuntime
+
+
+def create(cmd, client, resource_group_name, workspace_name, integration_runtime_name, integration_runtime_type,
+           description=None, if_match=None, location='AutoResolve', compute_type='General',
+           core_count=8, time_to_live=0, no_wait=False):
+    properties = {}
+    properties['type'] = integration_runtime_type
+    properties['description'] = description
+    if integration_runtime_type == 'Managed':
+        properties['typeProperties'] = {}
+        properties['typeProperties']['computeProperties'] = {}
+        properties['typeProperties']['computeProperties']['location'] = location
+        properties['typeProperties']['computeProperties']['dataFlowProperties'] = {}
+        properties['typeProperties']['computeProperties']['dataFlowProperties']['computeType'] = compute_type
+        properties['typeProperties']['computeProperties']['dataFlowProperties']['coreCount'] = core_count
+        properties['typeProperties']['computeProperties']['dataFlowProperties']['timeToLive'] = time_to_live
+    properties = IntegrationRuntime.from_dict(properties)
+    return sdk_no_wait(no_wait, client.create, resource_group_name, workspace_name,
+                       integration_runtime_name, properties, if_match)