Skip to content

Latest commit

 

History

History
107 lines (75 loc) · 6.66 KB

create-azure-integration-runtime.md

File metadata and controls

107 lines (75 loc) · 6.66 KB
Raw
title titleSuffix description ms.subservice ms.topic ms.date author ms.author ms.custom
Create Azure integration runtime
Azure Data Factory & Azure Synapse
Learn how to create Azure integration runtime in Azure Data Factory and Azure Synapse Analytics, which is used to copy data and dispatch transform activities.
integration-runtime
conceptual
09/26/2024
lrtoyou1223
lle
synapse

How to create and configure Azure Integration Runtime

[!INCLUDEappliesto-adf-asa-md]

The Integration Runtime (IR) is the compute infrastructure used by Azure Data Factory and Synapse pipelines 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's 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.

[!INCLUDE updated-for-az]

Default Azure IR

By default, each data factory or Synapse workspace 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 autoresolve. If connectVia property isn't 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's 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 don't need to specify compute details because it's 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 UI

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

  1. On the home page for the service, select the Manage tab from the leftmost pane.

    Azure Data Factory

    :::image type="content" source="media/create-azure-integration-runtime/get-started-page-manage-button.png" alt-text="Screenshot showing the home page Manage button.":::

    Azure Synapse

    :::image type="content" source="media/doc-common-process/get-started-page-manage-button-synapse.png" alt-text="Screenshot showing the home page Manage button.":::

  2. Select Integration runtimes on the left pane, and then select +New.

    Azure Data Factory

    :::image type="content" source="media/create-azure-integration-runtime/manage-new-integration-runtime.png" alt-text="Screenshot that highlights integration runtimes in the left pane and the +New button.":::

    Azure Synapse

    :::image type="content" source="media/doc-common-process/manage-new-integration-runtime-synapse.png" alt-text="Screenshot that highlights integration runtimes in the left pane and the +New button.":::

  3. On the Integration runtime setup page, select Azure, Self-Hosted, and then select Continue. :::image type="content" source="media/create-azure-integration-runtime/integration-runtime-setup.png" alt-text="Screenshot showing the Azure self-hosted integration runtime option.":::

  4. On the following page, select Azure to create an Azure IR, and then select Continue. :::image type="content" source="media/create-azure-integration-runtime/new-azure-integration-runtime.png" alt-text="Screenshot that shows create an Azure integration runtime.":::

  5. Enter a name for your Azure IR, and select Create. :::image type="content" source="media/create-azure-integration-runtime/create-azure-integration-runtime.png" alt-text="Screenshot that shows the final step to create the Azure integration runtime.":::

  6. You 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. :::image type="content" source="media/create-azure-integration-runtime/integration-runtime-in-the-list.png" alt-text="Screenshot showing the Azure integration runtime in the list.":::

  7. You can repair Azure integration runtime by clicking repair button if the status is shown as Limited. :::image type="content" source="media/create-azure-integration-runtime/repair-azure-integration-runtime.png" alt-text="Screenshot showing the Azure integration runtime repair.":::

Note

If you want to enable managed virtual network on Azure IR, please see How to enable managed virtual network

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"
      }   
    }
}

Related content

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