Client library for Power BI Embedded Management Client
npm install --save @datafire/azure_powerbiembedded
let azure_powerbiembedded = require('@datafire/azure_powerbiembedded').create();
.then(data => {
console.log(data);
});
Client to manage your Power BI Embedded workspace collections and retrieve workspaces.
Indicates which operations can be performed by the Power BI Resource Provider.
azure_powerbiembedded.getAvailableOperations({
"api-version": ""
}, context)
- input
object
- api-version required
string
: Client Api Version.
- api-version required
- output OperationList
Verify the specified Power BI Workspace Collection name is valid and not already in use.
azure_powerbiembedded.WorkspaceCollections_checkNameAvailability({
"subscriptionId": "",
"location": "",
"api-version": "",
"body": {}
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - location required
string
: Azure location - api-version required
string
: Client Api Version. - body required CheckNameRequest
- subscriptionId required
- output CheckNameResponse
Retrieves all existing Power BI workspace collections in the specified subscription.
azure_powerbiembedded.WorkspaceCollections_listBySubscription({
"subscriptionId": "",
"api-version": ""
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string
: Client Api Version.
- subscriptionId required
- output WorkspaceCollectionList
Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.
azure_powerbiembedded.WorkspaceCollections_migrate({
"subscriptionId": "",
"resourceGroupName": "",
"api-version": "",
"body": {}
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Azure resource group - api-version required
string
: Client Api Version. - body required MigrateWorkspaceCollectionRequest
- subscriptionId required
Output schema unknown
Retrieves all existing Power BI workspace collections in the specified resource group.
azure_powerbiembedded.WorkspaceCollections_listByResourceGroup({
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Azure resource group - api-version required
string
: Client Api Version.
- subscriptionId required
- output WorkspaceCollectionList
Delete a Power BI Workspace Collection.
azure_powerbiembedded.WorkspaceCollections_delete({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceCollectionName": "",
"api-version": ""
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Azure resource group - workspaceCollectionName required
string
: Power BI Embedded Workspace Collection name - api-version required
string
: Client Api Version.
- subscriptionId required
Output schema unknown
Retrieves an existing Power BI Workspace Collection.
azure_powerbiembedded.WorkspaceCollections_getByName({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceCollectionName": "",
"api-version": ""
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Azure resource group - workspaceCollectionName required
string
: Power BI Embedded Workspace Collection name - api-version required
string
: Client Api Version.
- subscriptionId required
- output WorkspaceCollection
Update an existing Power BI Workspace Collection with the specified properties.
azure_powerbiembedded.WorkspaceCollections_update({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceCollectionName": "",
"api-version": "",
"body": {}
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Azure resource group - workspaceCollectionName required
string
: Power BI Embedded Workspace Collection name - api-version required
string
: Client Api Version. - body required UpdateWorkspaceCollectionRequest
- subscriptionId required
- output WorkspaceCollection
Creates 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 provision keys that provide API access to those workspaces.
azure_powerbiembedded.WorkspaceCollections_create({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceCollectionName": "",
"api-version": "",
"body": {}
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Azure resource group - workspaceCollectionName required
string
: Power BI Embedded Workspace Collection name - api-version required
string
: Client Api Version. - body required CreateWorkspaceCollectionRequest
- subscriptionId required
- output WorkspaceCollection
Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.
azure_powerbiembedded.WorkspaceCollections_getAccessKeys({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceCollectionName": "",
"api-version": ""
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Azure resource group - workspaceCollectionName required
string
: Power BI Embedded Workspace Collection name - api-version required
string
: Client Api Version.
- subscriptionId required
Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.
azure_powerbiembedded.WorkspaceCollections_regenerateKey({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceCollectionName": "",
"api-version": "",
"body": {}
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Azure resource group - workspaceCollectionName required
string
: Power BI Embedded Workspace Collection name - api-version required
string
: Client Api Version. - body required WorkspaceCollectionAccessKey
- subscriptionId required
Retrieves all existing Power BI workspaces in the specified workspace collection.
azure_powerbiembedded.Workspaces_List({
"subscriptionId": "",
"resourceGroupName": "",
"workspaceCollectionName": "",
"api-version": ""
}, context)
- input
object
- subscriptionId required
string
: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Azure resource group - workspaceCollectionName required
string
: Power BI Embedded Workspace Collection name - api-version required
string
: Client Api Version.
- subscriptionId required
- output WorkspaceList
- AzureSku
object
- name required
string
(values: S1): SKU name - tier required
string
(values: Standard): SKU tier
- name required
- CheckNameRequest
object
- name
string
: Workspace collection name - type
string
: Resource type
- name
- CheckNameResponse
object
- message
string
: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. - nameAvailable
boolean
: Specifies a Boolean value that indicates whether the specified Power BI Workspace Collection name is available to use. - reason
string
(values: Unavailable, Invalid): Reason why the workspace collection name cannot be used.
- message
- CreateWorkspaceCollectionRequest
object
- location
string
: Azure location - sku AzureSku
- tags
object
- location
- Display
object
- description
string
: The localized friendly description for the operation as shown to the user. This description should be thorough, yet concise. It will be used in tool-tips and detailed views. - operation
string
: The localized friendly name for the operation as shown to the user. This name should be concise (to fit in drop downs), but clear (self-documenting). Use Title Casing and include the entity/resource to which it applies. - origin
string
: The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is 'user,system' - provider
string
: The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with "Microsoft" for 1st party services. - resource
string
: The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the "name" section.
- description
- Error
object
- code
string
- details
array
- items ErrorDetail
- message
string
- target
string
- code
- ErrorDetail
object
- code
string
- message
string
- target
string
- code
- MigrateWorkspaceCollectionRequest
object
- resources
array
- items
string
- items
- targetResourceGroup
string
: Name of the resource group the Power BI workspace collections will be migrated to.
- resources
- Operation
object
- display Display
- name
string
: The name of the operation being performed on this particular object. This name should match the action name that appears in RBAC / the event service.
- OperationList
object
- value
array
- items Operation
- value
- UpdateWorkspaceCollectionRequest
object
- sku AzureSku
- tags
object
- Workspace
object
- id
string
: Workspace id - name
string
: Workspace name - properties
object
: Property bag - type
string
: Resource type
- id
- WorkspaceCollection
object
- id
string
: Resource id - location
string
: Azure location - name
string
: Workspace collection name - properties
object
: Properties - sku AzureSku
- tags
object
- type
string
: Resource type
- id
- WorkspaceCollectionAccessKey
object
- keyName
string
(values: key1, key2): Key name
- keyName
- WorkspaceCollectionAccessKeys
object
- key1
string
: Access key 1 - key2
string
: Access key 2
- key1
- WorkspaceCollectionList
object
- value
array
- items WorkspaceCollection
- value
- WorkspaceList
object
- value
array
- items Workspace
- value