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

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

Methods

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

INSERT example

Use the following StackQL query and manifest file to create a new workspace_collections resource.

All Properties

/*+ create */
INSERT INTO azure.powerbi_embedded.workspace_collections (
resourceGroupName,
subscriptionId,
workspaceCollectionName,
location,
tags,
sku
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceCollectionName }}',
'{{ location }}',
'{{ tags }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string

UPDATE example

Updates a workspace_collections resource.

/*+ update */
UPDATE azure.powerbi_embedded.workspace_collections
SET 
tags = '{{ tags }}',
sku = '{{ sku }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceCollectionName = '{{ workspaceCollectionName }}';

DELETE example

Deletes the specified workspace_collections resource.

/*+ delete */
DELETE FROM azure.powerbi_embedded.workspace_collections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceCollectionName = '{{ workspaceCollectionName }}';