workspace_collections

Creates, updates, deletes, gets or lists a workspace_collections resource.

Overview

Name	workspace_collections
Type	Resource
Id	azure.powerbi_embedded.workspace_collections

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	subscriptionId, resourceGroupName, workspaceCollectionName		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.
update	update	subscriptionId, resourceGroupName, workspaceCollectionName		Update an existing Power BI Workspace Collection with the specified properties.
delete	delete	subscriptionId, resourceGroupName, workspaceCollectionName		Delete a Power BI Workspace Collection.
check_name_availability	exec	subscriptionId, location		Verify the specified Power BI Workspace Collection name is valid and not already in use.
regenerate_key	exec	subscriptionId, resourceGroupName, workspaceCollectionName		Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.
migrate	exec	subscriptionId, resourceGroupName		Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
location	string	Azure location
resourceGroupName	string	Azure resource group
subscriptionId	string	Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
workspaceCollectionName	string	Power BI Embedded Workspace Collection name

INSERT examples

create

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.

INSERT INTO azure.powerbi_embedded.workspace_collections (
data__location,
data__tags,
data__sku,
subscriptionId,
resourceGroupName,
workspaceCollectionName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceCollectionName }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_collections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_collections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_collections resource.
    - name: workspaceCollectionName
      value: string
      description: Required parameter for the workspace_collections resource.
    - name: location
      value: string
      description: |
        Azure location
    - name: tags
      value: object
    - name: sku
      value: object

UPDATE examples

update

Update an existing Power BI Workspace Collection with the specified properties.

UPDATE azure.powerbi_embedded.workspace_collections
SET 
data__tags = '{{ tags }}',
data__sku = '{{ sku }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceCollectionName = '{{ workspaceCollectionName }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Delete a Power BI Workspace Collection.

DELETE FROM azure.powerbi_embedded.workspace_collections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceCollectionName = '{{ workspaceCollectionName }}' --required
;

Lifecycle Methods

check_name_availability

Verify the specified Power BI Workspace Collection name is valid and not already in use.

EXEC azure.powerbi_embedded.workspace_collections.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

regenerate_key

Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.

EXEC azure.powerbi_embedded.workspace_collections.regenerate_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceCollectionName='{{ workspaceCollectionName }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;

migrate

Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.

EXEC azure.powerbi_embedded.workspace_collections.migrate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"targetResourceGroup": "{{ targetResourceGroup }}", 
"resources": "{{ resources }}"
}'
;