🔬
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
  • General questions
  • Plan-specific questions
  • Basic Tier
  • Premium Tier
  1. RESOURCES

FAQ

General questions

What is the significance of the offer being 'transactable'?

Being 'transactable' means that you can now purchase and manage subscriptions for this offer directly through Azure Marketplace. This streamlines your purchasing and billing processes.

What plans are available for this offer?

Our offer includes two plans to suit different needs: the Basic Tier and the Premium Tier.

How do I choose the right plan for me?

Choose the best plan for you by comparing the tier’s features and resources with your specific requirements and budget.

Plan-specific questions

Basic Tier

What features and resources are included in the Basic Tier?

  • Application access: You get a single instance of the application.

  • Installation: Complete installation setup is included.

  • User capacity: There is no limit on the number of users.

  • Updates: Free upgrades to the application are included.

What are the limitations of the Basic Tier?

  • Number of instances: The Basic Tier allows only a single instance of the application.

  • Technical support: Unlike the Premium Tier, the Basic Tier does not include dedicated technical support hours or live support options like phone or email assistance.

Premium Tier

General information

What additional features and resources are included in the Premium Tier?

  • Multiple application instances: Unlike the Basic Tier, the Premium Tier allows for unlimited instances of the application, offering greater flexibility and scalability.

  • Additional support: The plan includes technical support hours from 7 AM to 5 PM ET, Monday through Friday, and live support options via phone or email, providing comprehensive assistance.

  • Complete installation setup: Like the Basic Tier, a complete installation setup is included.

  • Unlimited users: There's no limit on the number of users, accommodating large teams and organizations.

  • Free upgrades: The plan also includes free upgrades, ensuring access to the latest features and improvements.

Who is the Premium Tier best suited for?

  • Large enterprises and organizations: Ideal for larger businesses needing multiple instances of the application.

  • Global companies: Ideal for multinational corporations needing round-the-clock support and a scalable solution to cater to a global user base.

  • Growth-focused organizations: Businesses aiming to scale rapidly will benefit from the unlimited application instances and user capacity.

  • High-demand environments: Perfect for settings where constant access to the latest features is crucial.

  • Businesses with complex operations: Organizations with multifaceted operational needs that require robust, customizable solutions.

  • Data-intensive sectors: Well-suited for sectors like finance or healthcare, where large volumes of data require secure, reliable, and efficient management.

Purchasing and billing

How do I purchase the EmbedFAST?

  1. Select a plan type from the drop-down menu and select Create.

  2. Follow the on-screen instructions and fill out the information required to finalize your purchase.

How will I be billed for my subscription?

Your subscription charges will be included on your monthly Azure invoice, listed under your overall Azure service usage

Can I change my plan post-purchase?

Yes, you have the flexibility to upgrade or downgrade your plan at any time through the Azure portal.

Subscription management

How do I manage my subscription?

Access and manage your subscription directly via the Azure portal, using a similar interface and process as with other Azure services.

How do I add or remove users?

Adding users:

Users can be added to the application using the admin API. To add a user, use the POST method at the /users endpoint. Provide the Azure Entra IDs of the users with specific asset details of a logical tenant.

Removing users:

To remove users, use the DELETE method at the /users endpoint. Simply include the user's Azure Entra ID to delete the user from the system.

How can I get support?

Additional information

What are the technical requirements for using this offer?

  1. Set up Power BI and Azure:

    • Azure subscription: An active Azure subscription is required.

    • Azure owner role: Assign yourself the "Owner" role in the Azure subscription for full permissions.

    • Resource group in Azure: Create a resource group within the Azure subscription where all related resources will be deployed.

  2. Set up the Integrated Development Environment (IDE):

    • IDE or text editor: It's recommended to use Visual Studio Code (VS Code) for its support of Bicep syntax and development experience.

    • Bicep development environment: Set up an environment for working with Bicep scripts.

    • Windows PowerShell: Install Windows PowerShell for executing deployment scripts.

    • Windows PowerShell Extension: Install the PowerShell Extension in VS Code for script execution.

    • Bicep CLI: Install the Bicep Command-Line Interface tool for working with Bicep files.

    • Azure CLI: Install the Azure Command-Line Interface for executing Azure commands in PowerShell.

    • PowerShell configuration: Configure PowerShell to install Azure and SQL-related modules.

Are there any data privacy or compliance considerations?

PreviousBest practices for resource handling

Last updated 1 month ago

Explore the full range of features offered by the Basic Tier by visiting the .

Discover how the Premium Tier can better meet your needs with its expanded features on the .

Learn about the Premium Tier’s complete list of features and resources on the .

Contact to learn more about how EmbedFAST’s Premium Tier can empower your organization today.

Navigate to the offer page in .

For more help, please refer to our detailed that outlines the process step-by-step.

For more assistance, contact .

Contact us at for detailed inquiries and support requests.

Power BI capacity: Ensure at least one embedded or premium Power BI capacity is available. Follow the steps provided in our to create a capacity if needed.

For detailed information and step-by-step guidance on these prerequisites, please refer to our .

We strictly adhere to the details listed in our . This includes not storing any Personally Identifiable Information (PII) as it is held in the customer's tenant. Although data privacy protection is not enabled by default, we strongly advise the use of encryption and masking for PII columns. This approach provides an extra security layer and ensures compliance with applicable data privacy laws. Encrypting and masking sensitive data mitigates the risk of unauthorized access and helps meet data protection regulations.

EmbedFAST website
EmbedFAST website
EmbedFAST website
Sales@MAQSoftware.com
Azure Marketplace
technical documentation
Sales@MAQSoftware.com
Sales@MAQSoftware.com
technical documentation
technical documentation
Privacy Statement