Use an Azure Resource Manager template to create an integration runtime

  • Article

APPLIES TO: Azure Data Factory Azure Synapse Analytics

Tip

Try out Data Factory in Microsoft Fabric, an all-in-one analytics solution for enterprises. Microsoft Fabric covers everything from data movement to data science, real-time analytics, business intelligence, and reporting. Learn how to start a new trial for free!

In this section, you use an Azure Resource Manager template to create the Azure-SSIS integration runtime in Azure Data Factory.

Sample Azure Resource Manager template

Note

For Azure-SSIS IR in Azure Synapse Analytics, use corresponding Azure Synapse Analytics ARM template Microsoft.Synapse workspaces/integrationRuntimes, and corresponding Azure Synapse Analytics PowerShell interfaces: Set-AzSynapseIntegrationRuntime (Az.Synapse), Start-AzSynapseIntegrationRuntime and Stop-AzSynapseIntegrationRuntime.

Following are steps to create an Azure-SSIS integration runtime with an Azure Resource Manager template:

  1. Create a JSON file with the following Azure Resource Manager template. Replace values in the angle brackets (placeholders) with your own values.

    {
    "contentVersion": "1.0.0.0",
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "parameters": {},
    "variables": {},
    "resources": [{
        "name": "<Specify a name for your data factory>",
        "apiVersion": "2018-06-01",
        "type": "Microsoft.DataFactory/factories",
        "location": "China East 2",
        "properties": {},
        "resources": [{
            "type": "integrationruntimes",
            "name": "<Specify a name for your Azure-SSIS IR>",
            "dependsOn": [ "<The name of the data factory you specified at the beginning>" ],
            "apiVersion": "2018-06-01",
            "properties": {
                "type": "Managed",
                "typeProperties": {
                    "computeProperties": {
                        "location": "China East 2",
                        "nodeSize": "Standard_D8_v3",
                        "numberOfNodes": 1,
                        "maxParallelExecutionsPerNode": 8
                    },
                    "ssisProperties": {
                        "catalogInfo": {
                            "catalogServerEndpoint": "<Azure SQL Database server name>.database.chinacloudapi.cn",
                            "catalogAdminUserName": "<Azure SQL Database server admin username>",
                            "catalogAdminPassword": {
                                "type": "SecureString",
                                "value": "<Azure SQL Database server admin password>"
                            },
                            "catalogPricingTier": "Basic"
                        }
                    }
                }
            }
        }]
    }]
}

  2. To deploy the Azure Resource Manager template, run the New-AzResourceGroupDeployment command as shown in the following example. In the example, ADFTutorialResourceGroup is the name of your resource group. ADFTutorialARM.json is the file that contains the JSON definition for your data factory and the Azure-SSIS IR.

    New-AzResourceGroupDeployment -Name MyARMDeployment -ResourceGroupName ADFTutorialResourceGroup -TemplateFile ADFTutorialARM.json

    This command creates your data factory and Azure-SSIS IR in it, but it doesn't start the IR.

  3. To start your Azure-SSIS IR, run the Start-AzDataFactoryV2IntegrationRuntime command:

    Start-AzDataFactoryV2IntegrationRuntime -ResourceGroupName "<Resource Group Name>" `
    -DataFactoryName "<Data Factory Name>" `
    -Name "<Azure SSIS IR Name>" `
    -Force

Note

Excluding any custom setup time, this process should finish within 5 minutes. But it might take 20-30 minutes for the Azure-SSIS IR to join a virtual network.

If you use SSISDB, the Data Factory service will connect to your database server to prepare SSISDB. It also configures permissions and settings for your virtual network, if specified, and joins your Azure-SSIS IR to the virtual network.

When you provision an Azure-SSIS IR, Access Redistributable and Azure Feature Pack for SSIS are also installed. These components provide connectivity to Excel files, Access files, and various Azure data sources, in addition to the data sources that built-in components already support. For more information about built-in/preinstalled components, see Built-in/preinstalled components on Azure-SSIS IR. For more information about additional components that you can install, see Custom setups for Azure-SSIS IR.

Related content

See other Azure-SSIS IR topics in this documentation: