Skip to content

Commit cc02ea5

Browse files
committed
Updated for creating IR via ADF UI
1 parent 80629ed commit cc02ea5

File tree

7 files changed

+65
-37
lines changed

7 files changed

+65
-37
lines changed

articles/data-factory/create-azure-integration-runtime.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: data-factory
77
ms.workload: data-services
88

99
ms.topic: conceptual
10-
ms.date: 01/15/2018
10+
ms.date: 03/13/2020
1111
author: nabhishek
1212
ms.author: abnarain
1313
manager: anandsub
@@ -24,8 +24,12 @@ This document introduces how you can create and configure Azure Integration Runt
2424
## Default Azure IR
2525
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.
2626

27-
## Create Azure IR
28-
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":
27+
## Setting up an Azure IR
28+
29+
To create and set up an Azure IR, you can use the following procedures.
30+
31+
### Create an Azure IR via Azure PowerShell
32+
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":
2933

3034
```powershell
3135
Set-AzDataFactoryV2IntegrationRuntime -DataFactoryName "SampleV2DataFactory1" -Name "MySampleAzureIR" -ResourceGroupName "ADFV2SampleRG" -Type Managed -Location "West Europe"
@@ -34,9 +38,30 @@ For Azure IR, the type must be set to **Managed**. You do not need to specify co
3438

3539
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](concepts-integration-runtime.md).
3640

41+
### Create an Azure IR via Azure Data Factory UI
42+
Use the following steps to create an Azure IR using Azure Data Factory UI.
43+
44+
1. On the **Let's get started** page of Azure Data Factory UI, select the **Author** tab on the left pane.
45+
46+
![The home page Author button](media/doc-common-process/get-started-page-author-button.png)
47+
48+
1. Select **Connections** at the bottom of the left pane, and select **Integration runtimes** in the **Connections** window. Select **+New**.
49+
50+
![Create an integration runtime](media/create-azure-integration-runtime/new-integration-runtime.png)
51+
52+
1. On the **Integration runtime setup** page, select **Azure, Self-Hosted**, and then select **Continue**.
53+
54+
1. On the following page, select **Azure** to create an Azure IR, and then select **Continue**.
55+
![Create an integration runtime](media/create-azure-integration-runtime/new-azure-ir.png)
56+
57+
1. Enter a name for your Azure IR, and select **Create**.
58+
![Create an Azure IR](media/create-azure-integration-runtime/create-azure-ir.png)
59+
60+
1. 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.
61+
3762
## Use Azure IR
3863

39-
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:
64+
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:
4065

4166
```json
4267
{

articles/data-factory/create-self-hosted-integration-runtime.md

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,19 @@ To create and set up a self-hosted integration runtime, use the following proced
3131

3232
1. You can use Azure PowerShell for this task. Here is an example:
3333

34-
```powershell
35-
Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $selfHostedIntegrationRuntimeName -Type SelfHosted -Description "selfhosted IR description"
36-
```
34+
```powershell
35+
Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $selfHostedIntegrationRuntimeName -Type SelfHosted -Description "selfhosted IR description"
36+
```
3737
3838
2. [Download](https://www.microsoft.com/download/details.aspx?id=39717) and install the self-hosted integration runtime on a local machine.
3939
4040
3. Retrieve the authentication key and register the self-hosted integration runtime with the key. Here is a PowerShell example:
4141
42-
```powershell
42+
```powershell
4343
44-
Get-AzDataFactoryV2IntegrationRuntimeKey -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $selfHostedIntegrationRuntimeName
44+
Get-AzDataFactoryV2IntegrationRuntimeKey -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $selfHostedIntegrationRuntimeName
4545
46-
```
46+
```
4747
4848
### Create a self-hosted IR via Azure Data Factory UI
4949
@@ -57,11 +57,14 @@ Use the following steps to create a self-hosted IR using Azure Data Factory UI.
5757
5858
![Create an integration runtime](media/create-self-hosted-integration-runtime/new-integration-runtime.png)
5959
60-
1. On the **Integration runtime setup** window, select **Perform data movement and dispatch activities to external computes**, and select **Continue**.
60+
1. On the **Integration runtime setup** page, select **Azure, Self-Hosted**, and then select **Continue**.
61+
62+
1. On the following page, select **Self-Hosted** to create a Self-Hosted IR, and then select **Continue**.
63+
![Create a selfhosted IR](media/create-self-hosted-integration-runtime/new-selfhosted-ir.png)
6164
6265
1. Enter a name for your IR, and select **Create**.
6366
64-
1. Select the link under **Option 1** to open the express setup on your computer. Or follow the steps under **Option 2** to set up manually. The following instructions are based on manual setup:
67+
1. On the **Integration runtime setup** page, select the link under **Option 1** to open the express setup on your computer. Or follow the steps under **Option 2** to set up manually. The following instructions are based on manual setup:
6568
6669
![Integration runtime setup](media/create-self-hosted-integration-runtime/integration-runtime-setting-up.png)
6770
@@ -71,7 +74,7 @@ Use the following steps to create a self-hosted IR using Azure Data Factory UI.
7174
7275
1. On the **Register Integration Runtime (Self-hosted)** page, paste the key you saved earlier, and select **Register**.
7376
74-
![Register the integration runtime](media/create-self-hosted-integration-runtime/register-integration-runtime.png)
77+
![Register the integration runtime](media/create-self-hosted-integration-runtime/register-integration-runtime.png)
7578
7679
1. On the **New Integration Runtime (Self-hosted) Node** page, select **Finish**.
7780
@@ -157,7 +160,7 @@ Here is a high-level summary of the data-flow steps for copying with a self-host
157160

158161
Installation of the self-hosted integration runtime on a domain controller isn't supported.
159162
- .NET Framework 4.6.1 or later is required. If you're installing the self-hosted integration runtime on a Windows 7 machine, install .NET Framework 4.6.1 or later. See [.NET Framework System Requirements](/dotnet/framework/get-started/system-requirements) for details.
160-
- The recommended minimum configuration for the self-hosted integration runtime machine is a 2-GHz processor with four cores, 8 GB of RAM, and 80 GB of available hard drive space.
163+
- The recommended minimum configuration for the self-hosted integration runtime machine is a 2-GHz processor with 4 cores, 8 GB of RAM, and 80 GB of available hard drive space.
161164
- If the host machine hibernates, the self-hosted integration runtime doesn't respond to data requests. Configure an appropriate power plan on the computer before you install the self-hosted integration runtime. If the machine is configured to hibernate, the self-hosted integration runtime installer prompts with a message.
162165
- You must be an administrator on the machine to successfully install and configure the self-hosted integration runtime.
163166
- Copy-activity runs happen with a specific frequency. Processor and RAM usage on the machine follows the same pattern with peak and idle times. Resource usage also depends heavily on the amount of data that is moved. When multiple copy jobs are in progress, you see resource usage go up during peak times.
@@ -185,9 +188,9 @@ You can install the self-hosted integration runtime by downloading an MSI setup
185188
1. Select **Finish** to complete installation.
186189
1. Get the authentication key by using PowerShell. Here's a PowerShell example for retrieving the authentication key:
187190

188-
```powershell
189-
Get-AzDataFactoryV2IntegrationRuntimeKey -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $selfHostedIntegrationRuntime
190-
```
191+
```powershell
192+
Get-AzDataFactoryV2IntegrationRuntimeKey -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $selfHostedIntegrationRuntime
193+
```
191194
192195
1. On the **Register Integration Runtime (Self-hosted)** window of Microsoft Integration Runtime Configuration Manager running on your machine, take the following steps:
193196
@@ -343,7 +346,7 @@ There are three configuration options:
343346
344347
- **Do not use proxy**: The self-hosted integration runtime doesn't explicitly use any proxy to connect to cloud services.
345348
- **Use system proxy**: The self-hosted integration runtime uses the proxy setting that is configured in diahost.exe.config and diawp.exe.config. If these files specify no proxy configuration, the self-hosted integration runtime connects to the cloud service directly without going through a proxy.
346-
- **Use custom proxy**: Configure the HTTP proxy setting to use for the self-hosted integration runtime, instead of using configurations in diahost.exe.config and diawp.exe.config. **Address** and **Port** values are required. **User Name** and **Password** values are optional, depending on your proxys authentication setting. All settings are encrypted with Windows DPAPI on the self-hosted integration runtime and stored locally on the machine.
349+
- **Use custom proxy**: Configure the HTTP proxy setting to use for the self-hosted integration runtime, instead of using configurations in diahost.exe.config and diawp.exe.config. **Address** and **Port** values are required. **User Name** and **Password** values are optional, depending on your proxy's authentication setting. All settings are encrypted with Windows DPAPI on the self-hosted integration runtime and stored locally on the machine.
347350
348351
The integration runtime host service restarts automatically after you save the updated proxy settings.
349352
@@ -370,26 +373,26 @@ If you select the **Use system proxy** option for the HTTP proxy, the self-hoste
370373
1. In Notepad, open the text file C:\Program Files\Microsoft Integration Runtime\3.0\Shared\diahost.exe.config.
371374
1. Find the default **system.net** tag as shown in the following code:
372375
373-
```xml
374-
<system.net>
375-
<defaultProxy useDefaultCredentials="true" />
376-
</system.net>
377-
```
378-
You can then add proxy server details as shown in the following example:
376+
```xml
377+
<system.net>
378+
<defaultProxy useDefaultCredentials="true" />
379+
</system.net>
380+
```
381+
You can then add proxy server details as shown in the following example:
379382
380-
```xml
381-
<system.net>
383+
```xml
384+
<system.net>
382385
<defaultProxy enabled="true">
383386
<proxy bypassonlocal="true" proxyaddress="http://proxy.domain.org:8888/" />
384387
</defaultProxy>
385-
</system.net>
386-
```
388+
</system.net>
389+
```
387390
388-
The proxy tag allows additional properties to specify required settings like `scriptLocation`. See [\<proxy\> Element (Network Settings)](https://msdn.microsoft.com/library/sa91de1e.aspx) for syntax.
391+
The proxy tag allows additional properties to specify required settings like `scriptLocation`. See [\<proxy\> Element (Network Settings)](https://msdn.microsoft.com/library/sa91de1e.aspx) for syntax.
389392
390-
```xml
391-
<proxy autoDetect="true|false|unspecified" bypassonlocal="true|false|unspecified" proxyaddress="uriString" scriptLocation="uriString" usesystemdefault="true|false|unspecified "/>
392-
```
393+
```xml
394+
<proxy autoDetect="true|false|unspecified" bypassonlocal="true|false|unspecified" proxyaddress="uriString" scriptLocation="uriString" usesystemdefault="true|false|unspecified "/>
395+
```
393396
1. Save the configuration file in its original location. Then restart the self-hosted integration runtime host service, which picks up the changes.
394397
395398
To restart the service, use the services applet from Control Panel. Or from Integration Runtime Configuration Manager, select the **Stop Service** button, and then select **Start Service**.
@@ -399,7 +402,7 @@ If you select the **Use system proxy** option for the HTTP proxy, the self-hoste
399402
> [!IMPORTANT]
400403
> Don't forget to update both diahost.exe.config and diawp.exe.config.
401404
402-
You also need to make sure that Microsoft Azure is in your companys allow list. You can download the list of valid Azure IP addresses from [Microsoft Download Center](https://www.microsoft.com/download/details.aspx?id=41653).
405+
You also need to make sure that Microsoft Azure is in your company's allow list. You can download the list of valid Azure IP addresses from [Microsoft Download Center](https://www.microsoft.com/download/details.aspx?id=41653).
403406
404407
### Possible symptoms for issues related to the firewall and proxy server
405408
@@ -408,10 +411,10 @@ If you see error messages like the following ones, the likely reason is improper
408411
* When you try to register the self-hosted integration runtime, you receive the following error message: "Failed to register this Integration Runtime node! Confirm that the Authentication key is valid and the integration service host service is running on this machine."
409412
* When you open Integration Runtime Configuration Manager, you see a status of **Disconnected** or **Connecting**. When you view Windows event logs, under **Event Viewer** > **Application and Services Logs** > **Microsoft Integration Runtime**, you see error messages like this one:
410413
411-
```
412-
Unable to connect to the remote server
413-
A component of Integration Runtime has become unresponsive and restarts automatically. Component name: Integration Runtime (Self-hosted).
414-
```
414+
```
415+
Unable to connect to the remote server
416+
A component of Integration Runtime has become unresponsive and restarts automatically. Component name: Integration Runtime (Self-hosted).
417+
```
415418
416419
### Enable remote access from an intranet
417420
105 KB
Loading
93.3 KB
Loading
43.6 KB
Loading
-19.6 KB
Loading
96.5 KB
Loading

0 commit comments

Comments
 (0)