Skip to content

Commit f22a398

Browse files
authored
Merge pull request #177274 from zeinab-mk/zeinam-purview2
updated self-hosted ir article
2 parents c01355e + 18bb89e commit f22a398

File tree

7 files changed

+111
-7
lines changed

7 files changed

+111
-7
lines changed

articles/purview/how-to-create-and-manage-collections.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: viseshag
66
ms.service: purview
77
ms.subservice: purview-data-map
88
ms.topic: how-to
9-
ms.date: 08/18/2021
9+
ms.date: 10/22/2021
1010
ms.custom: template-how-to
1111
---
1212

@@ -90,14 +90,28 @@ You will need to be a collection admin in order to create a collection. If you a
9090

9191
:::image type="content" source="./media/how-to-create-and-manage-collections/filter-collections.png" alt-text="Screenshot of Purview studio collection window, with the filter above the collections highlighted." border="true":::
9292

93-
1. Select **Refresh** in Root collections contextual menu to reload the collection list.
93+
1. Select **Refresh** in Root collection's contextual menu to reload the collection list.
9494

9595
:::image type="content" source="./media/how-to-create-and-manage-collections/refresh-collections.png" alt-text="Screenshot of Purview studio collection window, with the button next to the Resource name selected, and the refresh button highlighted." border="true":::
9696

9797
1. Select **Refresh** in collection detail page to reload the single collection.
9898

9999
:::image type="content" source="./media/how-to-create-and-manage-collections/refresh-single-collection.png" alt-text="Screenshot of Purview studio collection window, with the refresh button under the collection window highlighted." border="true":::
100100

101+
### Delete a collection
102+
103+
You will need to be a collection admin in order to delete a collection. If you are not sure, follow the guide above to check permissions. Collection can be deleted only if no child collections, assets, data sources or scans are associated with it.
104+
105+
1. Select **Delete** from the collection detail page.
106+
107+
:::image type="content" source="./media/how-to-create-and-manage-collections/delete-collections.png" alt-text="Screenshot of Purview studio window to delete a collection" border="true":::
108+
109+
2. Select **Confirm** when prompted, **Are you sure you want to delete this collection?**
110+
111+
:::image type="content" source="./media/how-to-create-and-manage-collections/delete-collection-confirmation.png" alt-text="Screenshot of Purview studio window showing confirmation message to delete a collection" border="true":::
112+
113+
3. Verify deletion of the collection from your Purview Data Map.
114+
101115
## Add roles and restrict access through collections
102116

103117
Since permissions are managed through collections in Purview, it is important to understand the roles and what permissions they will give your users. A user granted permissions on a collection will have access to sources and assets associated with that collection, as well as inherit permissions to subcollections. Inheritance [can be restricted](#restrict-inheritance), but is allowed by default.
@@ -135,7 +149,7 @@ All assigned roles apply to sources, assets, and other objects within the collec
135149

136150
:::image type="content" source="./media/how-to-create-and-manage-collections/remove-role-assignment.png" alt-text="Screenshot of Purview studio collection window, with the role assignments tab selected, and the x button beside one of the names highlighted." border="true":::
137151

138-
1. Select **Confirm** if youre sure to remove the user.
152+
1. Select **Confirm** if you're sure to remove the user.
139153

140154
:::image type="content" source="./media/how-to-create-and-manage-collections/confirm-remove.png" alt-text="Screenshot of a confirmation pop-up, with the confirm button highlighted." border="true":::
141155

@@ -146,7 +160,7 @@ Collection permissions are inherited automatically from the parent collection. F
146160
Once you restrict inheritance, you will need to add users directly to the restricted collection to grant them access.
147161

148162
1. Navigate to the collection where you want to restrict inheritance and select the **Role assignments** tab.
149-
1. Select **Restrict inherited permissions** and select **Restrict access** in the popup dialog to remove inherited permissions from this collection and any subcollections. Note that collection admin permissions wont be affected.
163+
1. Select **Restrict inherited permissions** and select **Restrict access** in the popup dialog to remove inherited permissions from this collection and any subcollections. Note that collection admin permissions won't be affected.
150164

151165
:::image type="content" source="./media/how-to-create-and-manage-collections/restrict-access-inheritance.png" alt-text="Screenshot of Purview studio collection window, with the role assignments tab selected, and the restrict inherited permissions slide button highlighted." border="true":::
152166

@@ -196,7 +210,7 @@ Assets and sources are also associated with collections. During a scan, if the s
196210

197211
:::image type="content" source="./media/how-to-create-and-manage-collections/no-access.png" alt-text="Screenshot of Purview studio asset window where the user has no permissions, and has no access to information or options." border="true":::
198212

199-
1. If you have the read permission to one collection but dont have the write permission, you can browse the asset details page, but the following operations are disabled:
213+
1. If you have the read permission to one collection but don't have the write permission, you can browse the asset details page, but the following operations are disabled:
200214
* Edit the asset. The **Edit** button will be disabled.
201215
* Delete the asset. The **Delete** button will be disabled.
202216
* Move asset to another collection. The ellipsis button on the right-top corner of Collection path section will be hidden.

articles/purview/manage-integration-runtimes.md

Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: viseshag
66
ms.service: purview
77
ms.subservice: purview-data-map
88
ms.topic: how-to
9-
ms.date: 09/27/2021
9+
ms.date: 10/22/2021
1010
---
1111

1212
# Create and manage a self-hosted integration runtime
@@ -77,6 +77,61 @@ To create and set up a self-hosted integration runtime, use the following proced
7777

7878
:::image type="content" source="media/manage-integration-runtimes/successfully-registered.png" alt-text="successfully registered.":::
7979

80+
### Configure proxy server settings
81+
82+
If you select the **Use system proxy** option for the HTTP proxy, the self-hosted integration runtime uses the proxy settings in diahost.exe.config and diawp.exe.config. When these files specify no proxy, the self-hosted integration runtime connects to the cloud service directly without going through a proxy. The following procedure provides instructions for updating the diahost.exe.config file:
83+
84+
1. In File Explorer, make a safe copy of C:\Program Files\Microsoft Integration Runtime\5.0\Shared\diahost.exe.config as a backup of the original file.
85+
1. Open Notepad running as administrator.
86+
1. In Notepad, open the text file C:\Program Files\Microsoft Integration Runtime\5.0\Shared\diahost.exe.config.
87+
1. Find the default **system.net** tag as shown in the following code:
88+
89+
```xml
90+
<system.net>
91+
<defaultProxy useDefaultCredentials="true" />
92+
</system.net>
93+
```
94+
95+
You can then add proxy server details as shown in the following example:
96+
97+
```xml
98+
<system.net>
99+
<defaultProxy enabled="true">
100+
<proxy bypassonlocal="true" proxyaddress="http://proxy.domain.org:8888/" />
101+
</defaultProxy>
102+
</system.net>
103+
```
104+
105+
The proxy tag allows additional properties to specify required settings like `scriptLocation`. See [\<proxy\> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/proxy-element-network-settings) for syntax.
106+
107+
```xml
108+
<proxy autoDetect="true|false|unspecified" bypassonlocal="true|false|unspecified" proxyaddress="uriString" scriptLocation="uriString" usesystemdefault="true|false|unspecified "/>
109+
```
110+
111+
1. Save the configuration file in its original location. Then restart the self-hosted integration runtime host service, which picks up the changes.
112+
113+
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**.
114+
115+
If the service doesn't start, you likely added incorrect XML tag syntax in the application configuration file that you edited.
116+
117+
> [!IMPORTANT]
118+
> Don't forget to update both diahost.exe.config and diawp.exe.config.
119+
120+
You also need to make sure that Microsoft Azure is in your company's allowlist. You can download the list of valid Azure IP addresses. IP Ranges for each cloud, broken down by region and by the tagged services in that cloud are now available on MS Download:
121+
- Public: https://www.microsoft.com/download/details.aspx?id=56519
122+
123+
### Possible symptoms for issues related to the firewall and proxy server
124+
125+
If you see error messages like the following ones, the likely reason is improper configuration of the firewall or proxy server. Such configuration prevents the self-hosted integration runtime from connecting to Azure managed storage accounts or data sources. To ensure that your firewall and proxy server are properly configured, refer to the previous section.
126+
127+
- 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."
128+
- 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:
129+
130+
```output
131+
Unable to connect to the remote server
132+
A component of Integration Runtime has become unresponsive and restarts automatically. Component name: Integration Runtime (Self-hosted).
133+
```
134+
80135
## Networking requirements
81136

82137
Your self-hosted integration runtime machine will need to connect to several resources to work correctly:
@@ -136,6 +191,41 @@ When scanning Parquet files using the Self-hosted IR, the service locates the Ja
136191
- **To use JRE**: The 64-bit IR requires 64-bit JRE. You can find it from [here](https://go.microsoft.com/fwlink/?LinkId=808605).
137192
- **To use OpenJDK**: It's supported since IR version 3.13. Package the jvm.dll with all other required assemblies of OpenJDK into Self-hosted IR machine, and set system environment variable JAVA_HOME accordingly.
138193

194+
## Proxy server considerations
195+
196+
If your corporate network environment uses a proxy server to access the internet, configure the self-hosted integration runtime to use appropriate proxy settings. You can set the proxy during the initial registration phase.
197+
198+
:::image type="content" source="media/manage-integration-runtimes/self-hosted-proxy.png" alt-text="Specify the proxy":::
199+
200+
When configured, the self-hosted integration runtime uses the proxy server to connect to the cloud service's source and destination (which use the HTTP or HTTPS protocol). This is why you select **Change link** during initial setup.
201+
202+
:::image type="content" source="media/manage-integration-runtimes/set-http-proxy.png" alt-text="Set the proxy":::
203+
204+
There are three configuration options:
205+
206+
- **Do not use proxy**: The self-hosted integration runtime doesn't explicitly use any proxy to connect to cloud services.
207+
- **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.
208+
- **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.
209+
210+
The integration runtime host service restarts automatically after you save the updated proxy settings.
211+
212+
After you register the self-hosted integration runtime, if you want to view or update proxy settings, use Microsoft Integration Runtime Configuration Manager.
213+
214+
1. Open **Microsoft Integration Runtime Configuration Manager**.
215+
3. Under **HTTP Proxy**, select the **Change** link to open the **Set HTTP Proxy** dialog box.
216+
4. Select **Next**. You then see a warning that asks for your permission to save the proxy setting and restart the integration runtime host service.
217+
218+
You can use the configuration manager tool to view and update the HTTP proxy.
219+
220+
> [!NOTE]
221+
> If you set up a proxy server with NTLM authentication, the integration runtime host service runs under the domain account. If you later change the password for the domain account, remember to update the configuration settings for the service and restart the service. Because of this requirement, we suggest that you access the proxy server by using a dedicated domain account that doesn't require you to update the password frequently.
222+
223+
## Installation best practices
224+
225+
You can install the self-hosted integration runtime by downloading a Managed Identity setup package from [Microsoft Download Center](https://www.microsoft.com/download/details.aspx?id=39717).
226+
227+
- Configure a power plan on the host machine for the self-hosted integration runtime so that the machine doesn't hibernate. If the host machine hibernates, the self-hosted integration runtime goes offline.
228+
- Regularly back up the credentials associated with the self-hosted integration runtime.
139229

140230
## Next steps
141231

6.73 KB
Loading
76.8 KB
Loading
24.8 KB
Loading
11.1 KB
Loading

articles/purview/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ items:
8080
href: concept-account-upgrade.md
8181
- name: How-to guides
8282
items:
83-
- name: Create and manage collections
83+
- name: Manage collections
8484
href: how-to-create-and-manage-collections.md
8585
- name: Manage sources
8686
items:

0 commit comments

Comments
 (0)