Microsoft Azure

Azure Powerbiembedded

Client to manage your Power BI Embedded workspace collections and retrieve workspaces.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Client to manage your Power BI Embedded workspace collections and retrieve workspaces.

Endpoints 12

WorkspaceCollections

  • GETWorkspaceCollections_getByName/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.PowerBI/workspaceCollections/:workspaceCollectionName?api-version=stringRetrieves an existing Power BI Workspace Collection.
  • PUTWorkspaceCollections_create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.PowerBI/workspaceCollections/:workspaceCollectionName?api-version=stringCreates a new Power BI Workspace Collection with the specified properties. A Power BI Workspace Collection contains one or more workspaces, and can be used to…
  • DELETEWorkspaceCollections_delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.PowerBI/workspaceCollections/:workspaceCollectionName?api-version=stringDelete a Power BI Workspace Collection.
  • PATCHWorkspaceCollections_update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.PowerBI/workspaceCollections/:workspaceCollectionName?api-version=stringUpdate an existing Power BI Workspace Collection with the specified properties.
  • POSTWorkspaceCollections_checkNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.PowerBI/locations/:location/checkNameAvailability?api-version=stringVerify the specified Power BI Workspace Collection name is valid and not already in use.
  • GETWorkspaceCollections_listByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.PowerBI/workspaceCollections?api-version=stringRetrieves all existing Power BI workspace collections in the specified resource group.
  • GETWorkspaceCollections_listBySubscription/subscriptions/:subscriptionId/providers/Microsoft.PowerBI/workspaceCollections?api-version=stringRetrieves all existing Power BI workspace collections in the specified subscription.
  • POSTWorkspaceCollections_getAccessKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.PowerBI/workspaceCollections/:workspaceCollectionName/listKeys?api-version=stringRetrieves the primary and secondary access keys for the specified Power BI Workspace Collection.
  • POSTWorkspaceCollections_regenerateKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.PowerBI/workspaceCollections/:workspaceCollectionName/regenerateKey?api-version=stringRegenerates the primary or secondary access key for the specified Power BI Workspace Collection.
  • POSTWorkspaceCollections_migrate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/moveResources?api-version=stringMigrates an existing Power BI Workspace Collection to a different resource group and/or subscription.

Operations

  • GETgetAvailableOperations/providers/Microsoft.PowerBI/operations?api-version=stringIndicates which operations can be performed by the Power BI Resource Provider.

Workspaces

  • GETWorkspaces_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.PowerBI/workspaceCollections/:workspaceCollectionName/workspaces?api-version=stringRetrieves all existing Power BI workspaces in the specified workspace collection.

API details

Base URL
https://management.azure.com
Authentication
None declared in the description
Operations
12 operations on 9 pathsGET 5POST 4PUT 1PATCH 1DELETE 1
Main resources
WorkspaceCollections 10Operations 1Workspaces 1
Response formats
application/json
Description format
Swagger 2.0, API version 2016-01-29

How to test the Azure Powerbiembedded in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Powerbiembedded collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “WorkspaceCollections_getByName” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.PowerBI/workspaceCollections/:workspaceCollectionName?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Powerbiembedded?

Client to manage your Power BI Embedded workspace collections and retrieve workspaces. It is listed under Developer tools and has 12 endpoints.

Who publishes the Azure Powerbiembedded?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Powerbiembedded?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Powerbiembedded?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Azure Powerbiembedded have?

12 operations on 9 paths (5 GET, 4 POST, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are WorkspaceCollections, Operations, Workspaces.

Is forking the Azure Powerbiembedded free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.