Skip to content

Commit 8eee902

Browse files
authored
Merge pull request #248486 from spelluru/asapbimsi0816
updated steps, screenshots
2 parents 604fd02 + caeb219 commit 8eee902

File tree

6 files changed

+32
-32
lines changed

6 files changed

+32
-32
lines changed
Loading
Loading
Loading
Loading
17.7 KB
Loading

articles/stream-analytics/powerbi-output-managed-identity.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,40 @@ ms.custom: devx-track-arm-template
66
author: enkrumah
77
ms.author: ebnkruma
88
ms.topic: how-to
9-
ms.date: 05/30/2021
9+
ms.date: 08/16/2023
1010
---
1111

1212
# Use Managed Identity to authenticate your Azure Stream Analytics job to Power BI
1313

14-
[Managed Identity authentication](../active-directory/managed-identities-azure-resources/overview.md) for output to Power BI gives Stream Analytics jobs direct access to a workspace within your Power BI account. This feature allows for deployments of Stream Analytics jobs to be fully automated, since it is no longer required for a user to interactively log in to Power BI via the Azure portal. Additionally, long running jobs that write to Power BI are now better supported, since you will not need to periodically reauthorize the job.
14+
[Managed Identity authentication](../active-directory/managed-identities-azure-resources/overview.md) for output to Power BI gives Stream Analytics jobs direct access to a workspace within your Power BI account. This feature allows for deployments of Stream Analytics jobs to be fully automated, since it's no longer required for a user to interactively sign in to Power BI via the Azure portal. Additionally, long running jobs that write to Power BI are now better supported, since you won't need to periodically reauthorize the job.
1515

1616
This article shows you how to enable Managed Identity for the Power BI output(s) of a Stream Analytics job through the Azure portal and through an Azure Resource Manager deployment.
1717

1818
## Prerequisites
1919

20-
The following are required for using this feature:
20+
You must have the following prerequisites before you use this feature:
2121

2222
- A Power BI account with a [Pro license](/power-bi/service-admin-purchasing-power-bi-pro).
23-
24-
- An upgraded workspace within your Power BI account. See [Power BI's announcement](https://powerbi.microsoft.com/blog/announcing-new-workspace-experience-general-availability-ga/) of this feature for more details.
23+
- An upgraded workspace within your Power BI account. For more information, see [Power BI's announcement](https://powerbi.microsoft.com/blog/announcing-new-workspace-experience-general-availability-ga/).
2524

2625
## Create a Stream Analytics job using the Azure portal
2726

28-
1. Create a new Stream Analytics job or open an existing job in the Azure portal. From the menu bar located on the left side of the screen, select **Managed Identity** located under **Configure**. Ensure that "Use System-assigned Managed Identity" is selected and then select the **Save** button on the bottom of the screen.
27+
1. Create a new Stream Analytics job or open an existing job in the Azure portal.
28+
1. From the menu bar located on the left side of the screen, select **Managed Identity** located under **Settings**.
2929

30-
![Configure Stream Analytics managed identity](./media/common/stream-analytics-enable-managed-identity.png)
30+
:::image type="content" source="./media/stream-analytics-powerbi-output-managed-identity/managed-identity-select-button.png" alt-text="Screenshot showing the Managed Identity page with Select identity button selected." lightbox="./media/stream-analytics-powerbi-output-managed-identity/managed-identity-select-button.png":::
31+
1. On the **Select identity** page, select **System assigned identity*** or **User assigned identity**. If you select the latter option, specify the managed identity you want to use. Then, select **Save**.
3132

33+
:::image type="content" source="./media/stream-analytics-powerbi-output-managed-identity/system-assigned-identity.png" alt-text="Screenshot showing the Select identity page with System assigned identity selected." lightbox="./media/stream-analytics-powerbi-output-managed-identity/system-assigned-identity.png":::
34+
1. On the **Managed identity** page, confirm that you see the **Principal ID** and **Principal name** assigned to your Stream Analytics job. The principal name should be same as your Stream Analytics job name.
3235
2. Before configuring the output, give the Stream Analytics job access to your Power BI workspace by following the directions in the [Give the Stream Analytics job access to your Power BI workspace](#give-the-stream-analytics-job-access-to-your-power-bi-workspace) section of this article.
36+
3. Navigate to the **Outputs** section of your Stream Analytic's job, select **+ Add**, and then choose **Power BI**. Then, select the **Authorize** button and sign in with your Power BI account.
3337

34-
3. Navigate to the **Outputs** section of your Stream Analytic's job, select **+ Add**, and then choose **Power BI**. Then, select the **Authorize** button and log in with your Power BI account.
35-
36-
![Authorize with Power BI account](./media/stream-analytics-powerbi-output-managed-identity/stream-analytics-authorize-powerbi.png)
38+
[ ![Authorize with Power BI account](./media/stream-analytics-powerbi-output-managed-identity/stream-analytics-authorize-powerbi.png) ](./media/stream-analytics-powerbi-output-managed-identity/stream-analytics-authorize-powerbi.png#lightbox)
3739

3840
4. Once authorized, a dropdown list will be populated with all of the workspaces you have access to. Select the workspace that you authorized in the previous step. Then select **Managed Identity** as the "Authentication mode". Finally, select the **Save** button.
3941

40-
![Configure Power BI output with Managed Identity](./media/stream-analytics-powerbi-output-managed-identity/stream-analytics-configure-powerbi-with-managed-id.png)
42+
:::image type="content" source="./media/stream-analytics-powerbi-output-managed-identity/stream-analytics-configure-powerbi-with-managed-id.png" alt-text="Screenshot showing the Power BI output configuration with Managed identity authentication mode selected." lightbox="./media/stream-analytics-powerbi-output-managed-identity/stream-analytics-configure-powerbi-with-managed-id.png":::
4143

4244
## Azure Resource Manager deployment
4345

@@ -144,7 +146,7 @@ Azure Resource Manager allows you to fully automate the deployment of your Strea
144146
}
145147
```
146148

147-
If you plan to use the Power BI REST API to add the Stream Analytics job to your Power BI workspace, make note of the returned "principalId".
149+
If you plan to use the Power BI REST API to add the Stream Analytics job to your Power BI workspace, make note of the returned `principalId`.
148150

149151
3. Now that the job is created, continue to the [Give the Stream Analytics job access to your Power BI workspace](#give-the-stream-analytics-job-access-to-your-power-bi-workspace) section of this article.
150152

@@ -156,15 +158,15 @@ Now that the Stream Analytics job has been created, it can be given access to a
156158
### Use the Power BI UI
157159

158160
> [!Note]
159-
> In order to add the Stream Analytics job to your Power BI workspace using the UI, you also have to enable service principal access in the **Developer settings** in the Power BI admin portal. See [Get started with a service principal](/power-bi/developer/embed-service-principal) for more details.
161+
> In order to add the Stream Analytics job to your Power BI workspace using the UI, you also have to enable service principal access in the **Developer settings** in the Power BI admin portal. For more information, see [Get started with a service principal](/power-bi/developer/embed-service-principal).
160162

161-
1. Navigate to the workspace's access settings. See this article for more details: [Give access to your workspace](/power-bi/service-create-the-new-workspaces#give-access-to-your-workspace).
163+
1. Navigate to the workspace's access settings. For more information, see [Give access to your workspace](/power-bi/service-create-the-new-workspaces#give-access-to-your-workspace).
162164

163165
2. Type the name of your Stream Analytics job in the text box and select **Contributor** as the access level.
164166

165167
3. Select **Add** and close the pane.
166168

167-
![Add Stream Analytics job to Power BI workspace](./media/stream-analytics-powerbi-output-managed-identity/stream-analytics-add-job-to-powerbi-workspace.png)
169+
[ ![Add Stream Analytics job to Power BI workspace](./media/stream-analytics-powerbi-output-managed-identity/stream-analytics-add-job-to-powerbi-workspace.png) ](./media/stream-analytics-powerbi-output-managed-identity/stream-analytics-add-job-to-powerbi-workspace.png#lightbox)
168170

169171
### Use the Power BI PowerShell cmdlets
170172

@@ -173,21 +175,19 @@ Now that the Stream Analytics job has been created, it can be given access to a
173175
> [!Important]
174176
> Please ensure you are using version 1.0.821 or later of the cmdlets.
175177

176-
```powershell
177-
Install-Module -Name MicrosoftPowerBIMgmt
178-
```
179-
180-
2. Log in to Power BI.
181-
182-
```powershell
183-
Login-PowerBI
184-
```
178+
```powershell
179+
Install-Module -Name MicrosoftPowerBIMgmt
180+
```
181+
2. Sign in to Power BI.
185182

183+
```powershell
184+
Login-PowerBI
185+
```
186186
3. Add your Stream Analytics job as a Contributor to the workspace.
187187

188-
```powershell
189-
Add-PowerBIWorkspaceUser -WorkspaceId <group-id> -PrincipalId <principal-id> -PrincipalType App -AccessRight Contributor
190-
```
188+
```powershell
189+
Add-PowerBIWorkspaceUser -WorkspaceId <group-id> -PrincipalId <principal-id> -PrincipalType App -AccessRight Contributor
190+
```
191191

192192
### Use the Power BI REST API
193193

@@ -208,7 +208,7 @@ Request Body
208208

209209
### Use a Service Principal to grant permission for an ASA job's Managed Identity
210210

211-
For automated deployments, using an interactive login to give an ASA job access to a Power BI workspace is not possible. This can be done be using service principal to grant permission for an ASA job's managed identity. This is possible using PowerShell:
211+
For automated deployments, using an interactive sign-in to give an ASA job access to a Power BI workspace isn't possible. It can be done using service principal to grant permission for an ASA job's managed identity. This is possible using PowerShell:
212212

213213
```powershell
214214
Connect-PowerBIServiceAccount -ServicePrincipal -TenantId "<tenant-id>" -CertificateThumbprint "<thumbprint>" -ApplicationId "<app-id>"
@@ -217,18 +217,18 @@ Add-PowerBIWorkspaceUser -WorkspaceId <group-id> -PrincipalId <principal-id> -Pr
217217

218218
## Remove Managed Identity
219219

220-
The Managed Identity created for a Stream Analytics job is deleted only when the job is deleted. There is no way to delete the Managed Identity without deleting the job. If you no longer want to use the Managed Identity, you can change the authentication method for the output. The Managed Identity will continue to exist until the job is deleted, and will be used if you decide to used Managed Identity authentication again.
220+
The Managed Identity created for a Stream Analytics job is deleted only when the job is deleted. There's no way to delete the Managed Identity without deleting the job. If you no longer want to use the Managed Identity, you can change the authentication method for the output. The Managed Identity will continue to exist until the job is deleted, and will be used if you decide to used Managed Identity authentication again.
221221

222222
## Limitations
223223
Below are the limitations of this feature:
224224

225-
- Classic Power BI workspaces are not supported.
225+
- Classic Power BI workspaces aren't supported.
226226

227227
- Azure accounts without Azure Active Directory.
228228

229-
- Multi-tenant access is not supported. The Service principal created for a given Stream Analytics job must reside in the same Azure Active Directory tenant in which the job was created, and cannot be used with a resource that resides in a different Azure Active Directory tenant.
229+
- Multi-tenant access isn't supported. The Service principal created for a given Stream Analytics job must reside in the same Azure Active Directory tenant in which the job was created, and can't be used with a resource that resides in a different Azure Active Directory tenant.
230230

231-
- [User Assigned Identity](../active-directory/managed-identities-azure-resources/overview.md) is not supported. This means you are not able to enter your own service principal to be used by their Stream Analytics job. The service principal must be generated by Azure Stream Analytics.
231+
- [User Assigned Identity](../active-directory/managed-identities-azure-resources/overview.md) isn't supported. This means you aren't able to enter your own service principal to be used by their Stream Analytics job. The service principal must be generated by Azure Stream Analytics.
232232

233233
## Next steps
234234

0 commit comments

Comments
 (0)