Custom Interactive Cluster Configuration
Additional Integration Runtime Setup
Overview
This guide describes how clients and the Managed Services team work together to:
- Create additional Azure Data Factory Integration Runtimes (IRs)
- Grant the required permissions to Empower Data Factories
- Configure Empower to route specific data source types through those IRs
Client Responsibilities
Create a New Integration Runtime (IR)
- In Azure Data Factory, navigate to the IR host Data Factory.
- Click New under Integration runtimes.
- Provide a unique name, select the desired Type, and then click Create.
- Assign the Contributor role to each Empower Azure Data Factory instance (i.e., the System Assigned Managed Identity of the ADF) that is intended to use the Integration Runtime.
- The role assignment must be applied at the Integration Runtime resource scope.
- Alternatively, you can run the following PowerShell command:
New-AzRoleAssignment `
-ObjectId <ADF-Managed-Identity-ObjectId> ` # MSI of the Data Factory that needs access
-RoleDefinitionName 'Contributor' `
-Scope <IntegrationRuntimeResourceId>- Provide the name of the IR you created to your Managed Services team, along with which connectors / data sources you need it for.
Managed Services Responsibilities
-
Once the client has created their IR and provided you with the name, continue with the standard steps in the Integration Runtime Setup Docs to install the IR on their target VM.
-
In some cases, the client may have already completed the steps outlined in Create a New Integration Runtime (IR) as well as those in the Integration Runtime Setup Docs.
-
Update the client's configuration to associate the new IR to the requested data source types.
Configuration in <environment>_env_config.json
<environment>_env_config.jsonUse the format in the example below to add integration_runtimes_config in <environment>_env_config.json.
integration_runtimes_config = [
{
# This is the default Emp-OnPrem-IR which always exists. Do not modify or remove this entry.
"ir_resource_id": "/subscriptions/{default-subscription-id}/resourceGroups/{default-rg-name}/providers/Microsoft.DataFactory/factories/{default-ir-host-factory-name}/integrationRuntimes/Emp-OnPrem-IR",
"datasourcetype": []
},
{
# First additional IR — Integration Runtime resource ID as provided by the client
"ir_resource_id": "/subscriptions/{client-subscription-id}/resourceGroups/{client-rg-name}/providers/Microsoft.DataFactory/factories/{client-ir-host-factory-name}/integrationRuntimes/Emp-Cloud-IR",
"datasourcetype": [ # Include only the required data source types for that IR.
"AZUREMYSQL",
"AZUREPOSTGRESQL",
"DB2",
"MSSQL",
"ORACLE",
"POSTGRESQL",
"SAPHANA",
"ODBC",
"MARIADB",
"WORKDAY"
]
},
{
# Second additional IR — repeat this block for each further IR required
"ir_resource_id": "/subscriptions/{client-subscription-id}/resourceGroups/{client-rg-name}/providers/Microsoft.DataFactory/factories/{client-ir-host-factory-name}/integrationRuntimes/{ir-name}",
"datasourcetype": [ # Include only the required data source types for that IR.
"ORACLE",
"MSSQL"
]
}
]Supported Data Source Types
Only the following datasourcetype values are accepted:
AZUREMYSQLAZUREPOSTGRESQLDB2MSSQLORACLEPOSTGRESQLSAPHANAODBCMARIADBWORKDAY
Notes
- Use
AutoResolveIntegrationRuntimeasir_resource_idto target the AutoResolve integration runtime. - Otherwise, provide the full Integration Runtime resource ID using the format:
/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.DataFactory/factories/{factory-name}/integrationRuntimes/{ir-name}- For the product default
Emp-OnPrem-IR, required permissions for Empower Data Factories are handled as part of the standard product deployment.
Summary
- Clients create the IR and assign Contributor on the IR to all relevant Empower ADF identities.
- Managed Services install the IR (per product docs) and update
integration_runtimes_configso Empower routes the correct data sources through the new IR.
Updated about 1 month ago
