Merge pull request Azure#10540 from liubing-microsoft/liubing/express-custom-setup-support

Add Express Custom Setup support by Powershell

Author: msJinLei

src/DataFactory/DataFactoryV2.Test/ScenarioTests/IntegrationRuntimeTests.ps1

@@ -143,6 +143,33 @@ function Test-SsisAzure-IntegrationRuntime
         $secpasswd = ConvertTo-SecureString $catalogAdminPassword -AsPlainText -Force
         $mycreds = New-Object System.Management.Automation.PSCredential($catalogAdminUsername, $secpasswd)
 
+		# Prepare express custom setup
+		# Create setup for cmdkey
+		$targetName = 'fakeserver'
+		$userName = 'fakeuser'
+		$password = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString('fakepassword')
+		$setup1 = New-Object Microsoft.Azure.Management.DataFactory.Models.CmdkeySetup($targetName, $userName, $password)
+
+		# Create setup for environment variable
+		$variableName = 'name'
+		$variableValue = 'value'
+		$setup2 = New-Object Microsoft.Azure.Management.DataFactory.Models.EnvironmentVariableSetup($variableName, $variableValue)
+
+		# Create setup for 3rd party component without license Key
+		$componentName1 = 'componentName1'
+		$setup3 = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($componentName1)
+
+		# Create setup for 3rd party component with license Key
+		$componentName2 = 'componentName2'
+		$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString('fakelicensekey')
+		$setup4 = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($componentName2, $licenseKey)
+
+		$setups = New-Object System.Collections.ArrayList
+		$setups.Add($setup1)
+		$setups.Add($setup2)
+		$setups.Add($setup3)
+		$setups.Add($setup4)
+
         $actual = Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName $rgname `
             -DataFactoryName $dfname `
             -Name $irname `
@@ -159,6 +186,7 @@ function Test-SsisAzure-IntegrationRuntime
             -Edition Enterprise `
             -DataProxyIntegrationRuntimeName $proxyIrName `
             -DataProxyStagingLinkedServiceName $lsname `
+            -ExpressCustomSetup $setups `
             -Force
 
         $expected = Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName $rgname `

src/DataFactory/DataFactoryV2/Changelog.md

@@ -19,6 +19,7 @@
 -->
 ## Upcoming Release
 * Update ADF .Net SDK version to 4.4.0
+* Add parameter "ExpressCustomSetup" for "Set-AzureRmDataFactoryV2IntegrationRuntime" cmd to enable setup configurations and 3rd party components without custom setup script.
 
 ## Version 1.4.1
 * Update ADF .Net SDK version to 4.3.0

src/DataFactory/DataFactoryV2/Constants.cs

@@ -140,6 +140,8 @@ internal static class Constants
 
         public const string HelpIntegrationRuntimeEdition = "The edition for SSIS integration runtime which could be Standard or Enterprise, default is Standard if it is not specified.";
 
+        public const string HelpIntegrationRuntimeExpressCustomSetup = "The express custom setup for SSIS integration runtime which could be used to setup configurations and 3rd party components without custom setup script.";
+
         public const string HelpIntegrationRuntimeDataProxyIntegrationRuntimeName = "The Self-Hosted Integration Runtime name which is used as a proxy.";
 
         public const string HelpIntegrationRuntimeDataProxyStagingLinkedServiceName = "The Azure Blob Storage Linked Service name that references the staging data store to be used when moving data between Self-Hosted and Azure-SSIS Integration Runtime.";

src/DataFactory/DataFactoryV2/IntegrationRuntimes/SetAzureDataFactoryIntegrationRuntimeCommand.cs

@@ -279,6 +279,21 @@ public class SetAzureDataFactoryIntegrationRuntimeCommand : IntegrationRuntimeCm
             IgnoreCase = true)]
         public string Edition { get; set; }
 
+        [Parameter(
+            ParameterSetName = ParameterSetNames.ByIntegrationRuntimeName,
+            Mandatory = false,
+            HelpMessage = Constants.HelpIntegrationRuntimeExpressCustomSetup)]
+        [Parameter(
+            ParameterSetName = ParameterSetNames.ByResourceId,
+            Mandatory = false,
+            HelpMessage = Constants.HelpIntegrationRuntimeExpressCustomSetup)]
+        [Parameter(
+            ParameterSetName = ParameterSetNames.ByIntegrationRuntimeObject,
+            Mandatory = false,
+            HelpMessage = Constants.HelpIntegrationRuntimeExpressCustomSetup)]
+        [ValidateNotNullOrEmpty]
+        public System.Collections.ArrayList ExpressCustomSetup { get; set; }
+
         [Parameter(
             ParameterSetName = ParameterSetNames.ByIntegrationRuntimeName,
             Mandatory = false,
@@ -724,6 +739,20 @@ private void HandleManagedIntegrationRuntime(ManagedIntegrationRuntime integrati
                 };
             }
 
+            if (ExpressCustomSetup != null && ExpressCustomSetup.ToArray().Length > 0)
+            {
+                if (integrationRuntime.SsisProperties == null)
+                {
+                    integrationRuntime.SsisProperties = new IntegrationRuntimeSsisProperties();
+                }
+                System.Collections.Generic.IList<CustomSetupBase> setups = new System.Collections.Generic.List<CustomSetupBase>();
+                foreach (CustomSetupBase setup in ExpressCustomSetup)
+                {
+                    setups.Add(setup);
+                }
+                integrationRuntime.SsisProperties.ExpressCustomSetupProperties = setups;
+            }
+
             if (!string.IsNullOrEmpty(DataProxyIntegrationRuntimeName))
             {
                 if (integrationRuntime.SsisProperties == null)

src/DataFactory/DataFactoryV2/Models/PSManagedIntegrationRuntime.cs

@@ -72,5 +72,7 @@ public PSManagedIntegrationRuntime(
         public string DataProxyStagingPath => ManagedIntegrationRuntime.SsisProperties?.DataProxyProperties?.Path;
 
         public string Edition => ManagedIntegrationRuntime.SsisProperties?.Edition;
+
+        public System.Collections.Generic.IList<CustomSetupBase> ExpressCustomSetup => ManagedIntegrationRuntime.SsisProperties?.ExpressCustomSetupProperties;
     }
 }

src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2IntegrationRuntime.md

@@ -21,6 +21,7 @@ Set-AzDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactor
  [-Edition <String>] [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>]
  [-DataProxyIntegrationRuntimeName <String>] [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>]
  [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-ExpressCustomSetup <ArrayList>]
 ```
 
 ### ByResourceId
@@ -31,7 +32,7 @@ Set-AzDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-Type <String>] [-
  [-SetupScriptContainerSasUri <String>] [-Edition <String>] [-MaxParallelExecutionsPerNode <Int32>]
  [-DataProxyIntegrationRuntimeName <String>] [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>]
  [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] [-DefaultProfile <IAzureContextContainer>]
- [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-WhatIf] [-Confirm] [<CommonParameters>] [-ExpressCustomSetup <ArrayList>]
 ```
 
 ### ByLinkedIntegrationRuntimeResourceId
@@ -57,6 +58,7 @@ Set-AzDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-Ty
  [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>]  [-DataProxyIntegrationRuntimeName <String>]
  [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>] [-AuthKey <SecureString>] [-Force]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-ExpressCustomSetup <ArrayList>]
 ```
 
 ### ByLinkedIntegrationRuntimeObject