Desktop App
Open the downloaded EmbedFASTUISDK / EmbedFASTSDKOnly setup file to start the installation process.
Click Next to proceed.
Choose the destination folder for installation and click Next .
Ensure 'Create desktop icon' is checked. Click 'Next' to initiate the installation process.
Once the installation is complete, click Finish to exit the setup.
Go to Desktop and search for EmbedFASTUISDK / EmbedFASTSDKOnly shortcut created. Double click on it to open.
It will display a variety of prompts. Provide the information as requested. More details regarding the prompts are provided below.
Enter your subscription ID
Follow the steps below to find your subscription ID:
Type “ Subscriptions " in the Azure portal search bar and select said option as it appears.
Copy the subscription ID as shown below.
In the Desktop App , paste/enter the subscription ID from the previous step.
Enter your tenant ID
Navigate to your Azure Active Directory --> Overview and copy the tenant ID as shown below. Paste/enter the ID into the PowerShell terminal.
Pre-Deployment Section
In this section, you have the option to create a Power BI Embedded Capacity, a Microsoft Entra security group, an app registration for API authentication, and an app registration for Power BI Service.
The app registrations for API authentication and Power BI Service are necessary to be created as part of the pre-deployment process.
Power BI Embedded Capacity
Ensure you have at least one embedded or premium Power BI capacity to use the EmbedFAST on. If not available, uncheck the capacity checkbox to create a capacity .
Enter capacity name-
Enter the name used to identify this resource and is displayed in the Power BI admin portal and Azure portal. The name must be unique in the selected location. Only lowercase letters and numbers may be used.
Enter capacity location-
The location where the capacity will be deployed.
Enter resource group name-
Choose a resource group. The resource group should be inside the same tenant/subscription that will be used to deploy the EmbedFAST.
Enter capcity size-
This is the Power BI Embedded Capacity size. Select the resource size (A1 to A8) that best suits your needs.
Microsoft Entra security group
Uncheck the checkbox if you want do not have a Microsoft Entra security group and wish to create one instead.
Enter group name-
Enter a name for the group.
App registration for EmbedFAST API Auth
To create an app registration, you must have one of the following Microsoft Entra roles:
Global Administrator
Cloud Application Administrator
Enter application name-
The user-facing display name for this application.
App registration for Power BI Service
Enter application name-
The user-facing display name for this application.
Enter security group name-
Enter the group name you provided earlier when creating the security group, or if you already have a security group, enter its name. The Power BI App registraton will be added as a member to this security group.
After filling in all the fields to create the necessary resources, click the Validate Resources button to validate the resource names.
If all resource names are validated successfully, click the Deploy Selected Resources button.
Log into Azure through the Browser pop-up window
Choose an account to log into Azure with.
Once the pre-deployment is successfully completed, follow the steps below:
Power BI capacity administrator
To work with Power BI Embedding, you need to add the app registration for the Power BI Service as a Power BI capacity administrator. Follow the instructions below:
Type “Power BI Embedded" in the Azure search bar and select said option as it appears.
Select the capacity name as shown below:
This will open an overview page, as shown below:
Select Power BI capacity administrators (under Settings) from the left pane.
Click on Add . An Add capacity administrators pane will appear on the right side.
Search for the app registration created for the Power BI Service. Add it and click Select to save the changes.
About admin consent
Example (select the image to view it in a larger size): In the image below, the Tenant.Read.All API displays a warning, "Not granted for ------". This means that admin consent has not been granted.
To grant admin consent:
Navigate to API permissions (under Manage).
Select Grant admin consent for ------. This will grant admin consent for all APIs that do not have the admin consent.
Once the consent is granted, the previous warning will now say "Granted for ------". The warning icon will turn into a green tick.
Add Role assignments
To work with capacities, you need to provide Contributor role to the app registration for the Power BI Service on the resource group for capacity created in the pre-deployment steps.
Follow the steps below to find the capacity resource group name:
Type “Power BI Embedded" in the Azure search bar and select said option as it appears.
Select the capacity that you will use in EmbedFAST as shown below :
Here in the overview page, you can find the capacity resource group name and copy it directly to your clipboard.
Navigate to this resource group by following the below steps:
Navigate to the Access control (IAM) section
Click on Add button and select add role assignment
Go to Priviledged administrator roles and select Contributor role and click on Next
Click on Select members
Search for your Power BI App registration and select it
Click on Review + assign and this will add the contributor role for Power BI App registration on the selected resource group.
Provide the Contributor role to Power BI App registration on the Managed resource group
This is the name of the managed resource group in your subscription where EmbedFAST’s resources are deployed. The managed resource group is created under the resource group that was created in the prerequisites section. Follow the steps below to find the name of your managed resource group:
Type “Resource groups" in the search bar and select said option as it appears.
Find and select the managed application as shown in the image below:
Copy the name of the managed resource group.
Navigate to this resource group and go to Access control (IAM) section.
Go to Priviledged administrator roles and select Contributor role and click on Next.
Click on Select members.
Search for your Power BI App registration and select it.
Click on Review + assign and this will add the contributor role for Power BI App registration on the selected resource group.
Post-Deployment section
Enter managed resource group name
This is the name of the managed resource group in your subscription where EmbedFAST’s resources will be deployed to. The managed resource group is created under the resource group that was created in the prerequisites section. Follow the steps below to find the name of your managed resource group:
Type “ Resource groups " in the Azure portal search bar and select said option as it appears.
Find and select the managed application as shown in the image below:
Copy the name of the managed resource group.
Paste/enter the managed resource group name in the Desktop App .
Enter your application name
Provide the name of your app
Enter capacity resource group name
Type “Power BI Embedded" in the Azure portal search bar and select said option as it appears.
Once on the page, you will see a list of Power BI Embedded Capacity displayed. Select the embedded capacity that you have created earlier in the section.
Copy the capacity resource group name as shown below.
In the EmbedFAST application, paste/enter the capacity resource group name from the previous step.
Enter API Auth App Registration Name
This app registration name is obtained from the overview page of the app registration previously created for the EmbedFAST API as part of the pre-deployment steps. Follow the steps below:
Type "App registrations" in the Azure portal search bar and select said option as it appears.
Click on Owned applications to see a list of applications you registered, including the ones for the API and Power BI Service done in the pre-deployment steps.
In the overview page, you can directly copy the application name to clipboard as shown below:
Enter Power BI app registration name
On the owned applications page, select the app registration you created for power bi service . You can find the name of the service principal in the top-left corner of the page.
Enter your service principal client secret
Follow the steps below to create a client secret:
Note: The client secret will only be visible at the time of creation. Take note of it and store it securely for future use for whenever the client secret is required.
Type "App registrations" in the Azure portal search bar and select said option as it appears.
Click on Owned applications to see a list of applications you registered. Search for the application created for the Power BI Service on this page.
Click on the application's name to access its details page.
Select Certificates & secrets (under Manage) from the left pane.
Click on New client secret to create a client secret.
Enter a description and select when the secret expires. Click on Add to add the client secret.
Copy the value of the newly created client secret as shown below.
Reminder: Take note of the client secret and store it securely for future use for whenever it is required. The client secret is only visible at the time of creation and will NOT be visible again.
Enter the sender email
Provide an email address. This email will be used for sending subscription emails to other users.
Enter the sender email password
Provide the password for the email address provided in the previous step.
Click the Start Post-Deployment Operation button. This will initiate a post-deployment process that performs the operations outlined below:
Add your client IPv4 address to Set Server Firewall.
Grant the necessary permissions to the service principal app registration on the Database. It will give admin access on the Database created.
Add the Power BI App service principal as an external Azure AD user.
Grant permissions to the user.
Note: If an error occurs (e.g., “Client with IP address ‘IP-Address’ is not allowed to access the server”), you have the option to manually include the IP in the server's firewall rules. Follow the steps detailed below to do so:
Type “Resource groups" in the Azure portal search bar and select said option as it appears.
Find and select the managed application as shown in the image below:
Click on the Managed resource group value on right side of the page, it will take you to the managed resource group where all the resources are deployed. /
Select the SQL server deployed with the application's name.
Select Networking (under Security) from the left pane.
Click on Add a firewall rule.
Enter the IP address that was not allowed to access the server in the Start IP and End IP fields. Select OK to save the changes.
This completes the deployment process.
Re-Deployment section
Enter your subscription ID
Follow the steps below to find your subscription ID:
Type "Subscriptions" in the search bar and select said option as it appears.
Copy the subscription ID as shown below.
In the Desktop App , paste/enter the subscription ID from the previous step.
Enter your tenant ID
Navigate to your Azure Active Directory --> Overview and copy the tenant ID as shown below. Paste/enter the ID into the PowerShell terminal.
Enter managed resource group name
This is the name of the managed resource group in your subscription where EmbedFAST’s resources are deployed. The managed resource group is created under the resource group that was created in the prerequisites section. Follow the steps below to find the name of your managed resource group:
Type "Resource groups" in the Azure portal search bar and select said option as it appears.
Find and select the managed application as shown in the image below:
Copy the name of the managed resource group.
Paste/enter the managed resource group name in the Desktop App like the previous steps.
Enter Deployment name-
Log in to your Azure portal and locate the resource group where your resources are deployed.
Select Settings from the left pane and click on Deployments .
Copy the name of the specific deployment you wish to redeploy.
Enter/enter this name in the Desktop App.
Enter App name-
Provide the same name that you used as the base name to create resources at the time of marketplace deployment.
Enter Service principal client secret-
Type "App registrations" in the Azure portal search bar and select said option as it appears.
Click on Owned applications to see a list of applications you registered. Search for the application created for the Power BI Service on this page.
Click on the application's name to access its details page.
Select Certificates & secrets (under Manage) from the left pane.
Copy the value of the client secret as shown below.
Enter API Auth App Registration Name
This app registration name is obtained from the overview page of the app registration previously created for the EmbedFAST API as part of the pre-deployment steps. Follow the steps below:
Type "App registrations" in the Azure portal search bar and select said option as it appears.
Click on Owned applications to see a list of applications you registered, including the ones for the API and Power BI Service done in the pre-deployment steps.
In the overview page, you can directly copy the application name to clipboard as shown below:
Enter Power BI app registration name
On the owned applications page, select the app registration you created for power bi service , you can find the name of your service principal at the top left corner of your page.
Click on the Redeploy button to start the redeploy process. This will redeploy the app and also update the database
Log into Azure through the Browser pop-up window
Choose an account to log into Azure with.
Click the Redeploy button. This will initiate a re- deployment process that performs the operations outlined below:
Update the solution builds
Update the database
Last updated