🔬
EmbedFAST: Technical Documentation
  • EmbedFAST: Technical Documentation
  • Version updates
    • Version 2.0
  • Redeploying for version updates
  • Setting up
    • Prerequisites
      • Set up Power BI
      • Set up Azure
      • Install PowerShell modules
      • Install Azure CLI
      • Install Bicep CLI
      • Set up the Integrated Development Environment (IDE)
    • Pre-deployment
      • App registration for EmbedFAST API Auth
        • Create an app registration
        • Add API permissions
        • Add a scope
        • Create an app role
      • App registration for Power BI Service
        • Create an app registration
        • Add API permissions
          • Microsoft Graph
          • Power BI Service
        • Power BI capacity administrator
      • Microsoft Entra security group
      • Power BI Tenant settings
      • Capacity settings
    • Deployment
      • Deploy from Azure Marketplace
      • Manual deployment
    • Post-deployment
      • Add the redirect URIs
      • Assign admin roles
      • Generate a token using Postman
        • App + user token
        • App-only token
      • Launch the web app
  • RESOURCES
    • EmbedFAST architecture
    • User API documentation
      • Asset
        • Asset - Retrieves assets
      • Bookmark
        • Bookmark - Retrieves bookmarks for a specific report
        • Bookmark - Creates a bookmark for a report
        • Bookmark - Retrieves details of a specific bookmark
        • Bookmark - Updates a bookmark's details
        • Bookmark - Deletes a bookmark for a report
        • Bookmark - Retrieves bookmarks for a report
        • Bookmark - Creates a shared bookmark for a report
        • Bookmark - Removes user access from a bookmark
      • Branding Detail
        • Branding Detail - Retrieves branding-related details
      • Dashboard
        • Dashboard - Retrieves a list of dashboards
        • Dashboard - Retrieves details of a specific dashboard
        • Dashboard - Deletes a dashboard by its ID
      • Dataset
        • Dataset - Retrieves a list of datasets
        • Dataset - Retrieves details of a dataset by its ID
        • Dataset - Deletes a dataset by its ID
      • Embed Token
        • Embed Token - Generates an embed token for reports
        • Embed Token - Generates an embed token for a dashboard
        • Embed Token - Generates an embed token for creating datasets
        • Embed Token - Generates an embed token for all assets
      • Export
        • Export - Retrieves the status of export-related details for a report
        • Export - Initiates the export process of a report
        • Export - Provides a downloadable stream for a report
        • Export - Provides a downloadable report with a specified filename
        • Export - Retrieves details of previous exports
      • Report
        • Report - Retrieves a list of reports or paginated reports by type
        • Report - Retrieves details of a specific report by ID
        • Report - Clones a report by ID with provided details
        • Report - Deletes a Power BI report by ID
        • Report - Saves a Power BI report by ID into the application
        • Report - Retrieves a list of shared or paginated reports for the user
        • Report - Shares a report with a user
        • Report - Retrieves users for sharing a report
        • Report - Un-shares a report with a user
      • Report Subscription
        • Report Subscription - Retrieves subscriptions by report by ID
        • Report Subscription - Creates a subscription by report ID
        • Report Subscription - Updates a subscription
        • Report Subscription - Deletes a subscription
        • Report Subscription - Sends an email for a subscription
      • Theme
        • Theme - Retrieves themes for a tenant
        • Theme - Retrieves details of a theme for a tenant
      • User Detail
        • User Detail - Retrieves users for a tenant
        • User Detail - Updates current user preferences
    • Admin API documentation
      • Branding Detail
        • Branding Detail - Retrieves brand details
        • Branding Detail - Creates brand details
        • Branding Detail - Updates brand details
        • Branding Detail - Deletes brand details
      • Capacity
        • Capacity - Retrieves a list of capacities
        • Capacity - Retrieves capacities for a resource group
        • Capacity - Starts a paused capacity
        • Capacity - Pauses a running capacity
        • Capacity - Assigns a capacity to a tenant
        • Capacity - Unassigns a capacity from a tenant
        • Capacity - Refreshes capacities for all tenants
        • Capacity - Refreshes capacities for a specific tenant
      • Clean Up
        • Clean Up - Cleans up old and unnecessary database entries
      • Group
        • Group - Retrieves groups for a tenant
        • Group - Creates a group for a tenant
        • Group - Retrieves details of a group for a tenant
        • Group - Updates a group for a tenant
        • Group - Deletes a group for a tenant
        • Group - Retrieves users for a group
        • Group - Removes users from a group
        • Group - Adds users to a group
        • Group - Retrieves assets for a group
        • Group - Revokes access to assets for a group
        • Group - Assigns access to assets for a group
        • Group - Updates access permissions for an asset in a group
      • Role
        • Role - Retrieves roles from the system
        • Role - Creates a new role
        • Role - Updates an existing role
        • Role - Deletes a role by ID
      • Tenant
        • Tenant - Refreshes asset details for a tenant
        • Tenant - Retrieves asset details for a tenant
        • Tenant - Retrieves a list of tenants
        • Tenant - Creates a new tenant
        • Tenant - Retrieves details of a tenant
        • Tenant - Updates the name of a tenant
        • Tenant - Deletes a tenant
        • Tenant - Retrieves users for a tenant
        • Tenant - Updates the default theme for a tenant
        • Tenant - Onboards a workspace as a tenant
        • Tenant - Onboards users to a tenant
        • Tenant - Retrieves available workspaces for onboarding
        • Tenant - Checks tenant name availability
        • Tenant - Checks updated tenant name availability
        • Tenant - Binds a dataset to a report for a tenant
        • Tenant - Retrieves a tenant's bound report and dataset
        • Tenant - Retrieves a list of a tenant's bound reports and datasets
        • Tenant - Retrieves users with tenant-level roles
        • Tenant - Assigns tenant-level access to a user
        • Tenant - Updates tenant-level user access
        • Tenant - Revokes tenant-level user access
        • Tenant - Retrieves user details for onboarding
        • Tenant - Adds report parameters to a report
        • Tenant - Updates report parameters for a report
        • Tenant - Deletes report parameters from a report
        • Tenant - Refreshes a dataset
      • Theme
        • Theme - Retrieves a list of themes for a tenant
        • Theme - Creates a new theme
        • Theme - Retrieves details of a theme by ID
        • Theme - Updates a theme by ID
        • Theme - Deletes a theme by ID
        • Theme - Assigns themes to a tenant
        • Theme - Unassigns themes from a tenant
        • Theme - Duplicates a theme with a new name
      • Trace
        • Trace - Records trace information
      • User
        • User - Retrieves user details by ID
        • User - Deletes a user
        • User - Retrieves a list of users with filters
        • User - Creates a new user with assigned assets
        • User - Assigns assets and a tenant to a user
        • User - Updates a dynamic dataset for a user
        • User - Deletes a dynamic dataset for a user
        • User - Revokes assets and tenant from a user
      • Workspace
        • Workspace - Retrieves users with workspace access
        • Workspace - Adds a user to a workspace
        • Workspace - Updates user access to a workspace
        • Workspace - Revokes user access from a workspace
    • Free app upgrades/updates
    • Best practices for resource handling
    • FAQ
Powered by GitBook
On this page
  • Redeploying the app
  • Load the SQL update script and PowerShell file to Visual Studio Code 
  • Open a terminal window
  • Executing the PowerShell script while bypassing the execution policy
  • Enter your subscription ID
  • Enter your tenant ID
  • Log into Azure through the PowerShell pop-up window
  • Enter your managed resource group name
  • Enter your application name

Redeploying for version updates

Note: Follow these steps to update your EmbedFAST to the latest version. These instructions are intended for current EmbedFAST users.

Redeploying the app

  1. Log in to your Azure portal and locate the resource group where your resources are deployed.

  2. Select Settings from the left pane and click on Deployments.

  3. Select the specific deployment you wish to redeploy, then click on Redeploy.

  4. Fill in the required fields of the form:

    • Subscription: Choose your subscription.

    • Resource Group: Select the appropriate resource group.

    • Region: Select the relevant region.

    • Name: Enter your application name.

    • SKU Value: Enter your pricing plan.

    • SQL Admin Name: Provide the SQL admin username.

    • DB Password: Enter the database password.

    • Location: Ensure this matches the selected region

  5. Select Review + Create.

  6. Review the details and select Create.

Load the SQL update script and PowerShell file to Visual Studio Code 

  1. Extract the folder and open it in Visual Studio Code (VS Code).

Open a terminal window

From the top menu bar, select Terminal -> New Terminal to access the PowerShell terminal window.

Executing the PowerShell script while bypassing the execution policy

This step is required to bypass an execution policy that doesn't allow the ZIP file to work with the PowerShell scripts.

  1. Execute command “powershell -ExecutionPolicy Bypass -File ".\UpdateHubConfig.ps1"” in the terminal. This command will execute a PowerShell script named "UpdateHubConfig.ps1" while bypassing the execution policy.

  2. The system 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:

  1. Select the desired resource group from the list where you want to deploy your resources.

  2. Copy the subscription ID as shown below.

  3. In the PowerShell terminal, 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.

Log into Azure through the PowerShell pop-up window

Choose an account to log into Azure with.

Enter your managed resource group name

  1. Find and select the managed application as shown in the image below:

  2. Copy the name of the managed resource group.

  3. Paste/enter the managed resource group name in the PowerShell terminal like the previous steps.

Enter your application name

PreviousVersion 2.0NextPrerequisites

Last updated 6 months ago

Download the .

Type “Subscriptions" in the search bar and select said option as it appears.

Once on the page, you will see a list of resource groups displayed. Select the resource group that you have created earlier in the section.

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 search bar and select said option as it appears.

Provide the name of your app (as selected in the ).

SQL update script files
Azure portal
Azure portal
previous step
prerequisites
earlier