Microsoft.PowerBI (stable:2016-01-29)

2025/09/26 • 12 new, 12 deleted methods

WorkspaceCollections_getByName (new)
Description :  Retrieves an existing Power BI Workspace Collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_create (new)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Create workspace collection request ,
Required: True ,
}
{
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_update (new)
Description :  Update an existing Power BI Workspace Collection with the specified properties.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Update workspace collection request ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_delete (new)
Description :  Delete a Power BI Workspace Collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_checkNameAvailability (new)
Description :  Verify the specified Power BI Workspace Collection name is valid and not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Azure location ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Check name availability request ,
Required: True ,
}
{
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Specifies a Boolean value that indicates whether the specified Power BI Workspace Collection name is available to use. ,
Required: False ,
}
boolean ,
reason:
{
Description: Reason why the workspace collection name cannot be used. ,
Enum:
{
Unavailable: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_listByResourceGroup (new)
Description :  Retrieves all existing Power BI workspace collections in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_listBySubscription (new)
Description :  Retrieves all existing Power BI workspace collections in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/workspaceCollections
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_getAccessKeys (new)
Description :  Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/listKeys
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Access key 1 ,
Required: False ,
}
string ,
key2:
{
Description: Access key 2 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_regenerateKey (new)
Description :  Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/regenerateKey
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Access key to regenerate ,
Required: True ,
}
{
keyName:
{
Description: Key name ,
Enum:
{
key1: No description available. ,
key2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
key1:
{
Description: Access key 1 ,
Required: False ,
}
string ,
key2:
{
Description: Access key 2 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
getAvailableOperations (new)
Description :  Indicates which operations can be performed by the Power BI Resource Provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.PowerBI/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
name:
{
Description: 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. ,
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Description: 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. ,
Required: False ,
}
string ,
resource:
{
Description: 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. ,
Required: False ,
}
string ,
operation:
{
Description: 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. ,
Required: False ,
}
string ,
description:
{
Description: 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. ,
Required: False ,
}
string ,
origin:
{
Description: 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' ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
Workspaces_List (new)
Description :  Retrieves all existing Power BI workspaces in the specified workspace collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/workspaces
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: Workspace id ,
Required: False ,
}
string ,
name:
{
Description: Workspace name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Property bag ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_migrate (new)
Description :  Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Workspace migration request ,
Required: True ,
}
{
targetResourceGroup:
{
Description: Name of the resource group the Power BI workspace collections will be migrated to. ,
Required: False ,
}
string ,
resources:
{
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_getByName (removed)
Description :  Retrieves an existing Power BI Workspace Collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_create (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Create workspace collection request ,
Required: True ,
}
{
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_update (removed)
Description :  Update an existing Power BI Workspace Collection with the specified properties.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Update workspace collection request ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_delete (removed)
Description :  Delete a Power BI Workspace Collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_checkNameAvailability (removed)
Description :  Verify the specified Power BI Workspace Collection name is valid and not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Azure location ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Check name availability request ,
Required: True ,
}
{
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Specifies a Boolean value that indicates whether the specified Power BI Workspace Collection name is available to use. ,
Required: False ,
}
boolean ,
reason:
{
Description: Reason why the workspace collection name cannot be used. ,
Enum:
{
Unavailable: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_listByResourceGroup (removed)
Description :  Retrieves all existing Power BI workspace collections in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_listBySubscription (removed)
Description :  Retrieves all existing Power BI workspace collections in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/workspaceCollections
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: Resource id ,
Required: False ,
}
string ,
name:
{
Description: Workspace collection name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Azure location ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: SKU name ,
Enum:
{
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: SKU tier ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_getAccessKeys (removed)
Description :  Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/listKeys
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Access key 1 ,
Required: False ,
}
string ,
key2:
{
Description: Access key 2 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_regenerateKey (removed)
Description :  Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/regenerateKey
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Access key to regenerate ,
Required: True ,
}
{
keyName:
{
Description: Key name ,
Enum:
{
key1: No description available. ,
key2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
key1:
{
Description: Access key 1 ,
Required: False ,
}
string ,
key2:
{
Description: Access key 2 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
getAvailableOperations (removed)
Description :  Indicates which operations can be performed by the Power BI Resource Provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.PowerBI/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
name:
{
Description: 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. ,
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Description: 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. ,
Required: False ,
}
string ,
resource:
{
Description: 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. ,
Required: False ,
}
string ,
operation:
{
Description: 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. ,
Required: False ,
}
string ,
description:
{
Description: 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. ,
Required: False ,
}
string ,
origin:
{
Description: 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' ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
Workspaces_List (removed)
Description :  Retrieves all existing Power BI workspaces in the specified workspace collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/workspaces
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
workspaceCollectionName:
{
Description: Power BI Embedded Workspace Collection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: Workspace id ,
Required: False ,
}
string ,
name:
{
Description: Workspace name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Property bag ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}
WorkspaceCollections_migrate (removed)
Description :  Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Description: Workspace migration request ,
Required: True ,
}
{
targetResourceGroup:
{
Description: Name of the resource group the Power BI workspace collections will be migrated to. ,
Required: False ,
}
string ,
resources:
{
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
}
,
]
,
}