How to create and configure Azure Integration Runtime

APPLIES TO: yesAzure Data Factory yesAzure Synapse Analytics (Preview)

The Integration Runtime (IR) is the compute infrastructure used by Azure Data Factory to provide data integration capabilities across different network environments. For more information about IR, see Integration runtime.

Azure IR provides a fully managed compute to natively perform data movement and dispatch data transformation activities to compute services like HDInsight. It is hosted in Azure environment and supports connecting to resources in public network environment with public accessible endpoints.

This document introduces how you can create and configure Azure Integration Runtime.

Note

This article has been updated to use the new Azure PowerShell Az module. You can still use the AzureRM module, which will continue to receive bug fixes until at least December 2020. To learn more about the new Az module and AzureRM compatibility, see Introducing the new Azure PowerShell Az module. For Az module installation instructions, see Install Azure PowerShell.

Default Azure IR

By default, each data factory has an Azure IR in the backend that supports operations on cloud data stores and compute services in public network. The location of that Azure IR is auto-resolve. If connectVia property is not specified in the linked service definition, the default Azure IR is used. You only need to explicitly create an Azure IR when you would like to explicitly define the location of the IR, or if you would like to virtually group the activity executions on different IRs for management purpose.

Create Azure IR

To create and set up an Azure IR, you can use the following procedures.

Create an Azure IR via Azure PowerShell

Integration Runtime can be created using the Set-AzDataFactoryV2IntegrationRuntime PowerShell cmdlet. To create an Azure IR, you specify the name, location, and type to the command. Here is a sample command to create an Azure IR with location set to "West Europe":

Set-AzDataFactoryV2IntegrationRuntime -DataFactoryName "SampleV2DataFactory1" -Name "MySampleAzureIR" -ResourceGroupName "ADFV2SampleRG" -Type Managed -Location "West Europe"

For Azure IR, the type must be set to Managed. You do not need to specify compute details because it is fully managed elastically in cloud. Specify compute details like node size and node count when you would like to create Azure-SSIS IR. For more information, see Create and Configure Azure-SSIS IR.

You can configure an existing Azure IR to change its location using the Set-AzDataFactoryV2IntegrationRuntime PowerShell cmdlet. For more information about the location of an Azure IR, see Introduction to integration runtime.

Create an Azure IR via Azure Data Factory UI

Use the following steps to create an Azure IR using Azure Data Factory UI.

  1. On the Let's get started page of Azure Data Factory UI, select the Author tab on the left pane.

    The home page Author button

  2. Select Connections at the bottom of the left pane, and select Integration runtimes in the Connections window. Select +New.

    Create an integration runtime

  3. On the Integration runtime setup page, select Azure, Self-Hosted, and then select Continue.

  4. On the following page, select Azure to create an Azure IR, and then select Continue. Create an integration runtime

  5. Enter a name for your Azure IR, and select Create. Create an Azure IR

  6. You'll see a pop-up notification when the creation completes. On the Integration runtimes page, make sure that you see the newly created IR in the list.

Use Azure IR

Once an Azure IR is created, you can reference it in your Linked Service definition. Below is a sample of how you can reference the Azure Integration Runtime created above from an Azure Storage Linked Service:

{
    "name": "MyStorageLinkedService",
    "properties": {
      "type": "AzureStorage",
      "typeProperties": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myaccountname;AccountKey=..."
      },
      "connectVia": {
        "referenceName": "MySampleAzureIR",
        "type": "IntegrationRuntimeReference"
      }   
    }
}

Next steps

See the following articles on how to create other types of integration runtimes: