workspace_collections

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

Overview

Name	workspace_collections
Type	Resource
Id	azure.power_bi_embedded.workspace_collections

Fields

The following fields are returned by SELECT queries:

get_by_name

Name	Datatype	Description
id	string	Resource id.
name	string	Workspace collection name.
location	string	Azure location.
properties	object	Properties.
sku	object	:vartype sku: ~azure.mgmt.powerbiembedded.models.AzureSku
tags	object	Dictionary of .
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource id.
name	string	Workspace collection name.
location	string	Azure location.
properties	object	Properties.
sku	object	:vartype sku: ~azure.mgmt.powerbiembedded.models.AzureSku
tags	object	Dictionary of .
type	string	Resource type.

check_name_availability

Name	Datatype	Description
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	Reason why the workspace collection name cannot be used. Known values are: "Unavailable" and "Invalid".

list_by_subscription

Name	Datatype	Description
id	string	Resource id.
name	string	Workspace collection name.
location	string	Azure location.
properties	object	Properties.
sku	object	:vartype sku: ~azure.mgmt.powerbiembedded.models.AzureSku
tags	object	Dictionary of .
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	resource_group_name, workspace_collection_name, subscription_id		Retrieves an existing Power BI Workspace Collection.
list_by_resource_group	select	resource_group_name, subscription_id		Retrieves all existing Power BI workspace collections in the specified resource group.
check_name_availability	select	location, subscription_id		Verify the specified Power BI Workspace Collection name is valid and not already in use.
list_by_subscription	select	subscription_id		Retrieves all existing Power BI workspace collections in the specified subscription.
create	insert	resource_group_name, workspace_collection_name, subscription_id		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	resource_group_name, workspace_collection_name, subscription_id		Update an existing Power BI Workspace Collection with the specified properties.
delete	delete	resource_group_name, workspace_collection_name, subscription_id		Delete a Power BI Workspace Collection.
get_access_keys	exec	resource_group_name, workspace_collection_name, subscription_id		Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.
regenerate_key	exec	resource_group_name, workspace_collection_name, subscription_id		Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.
migrate	exec	resource_group_name, subscription_id		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. Required.
resource_group_name	string	Azure resource group. Required.
subscription_id	string
workspace_collection_name	string	Power BI Embedded Workspace Collection name. Required.

SELECT examples

get_by_name

Retrieves an existing Power BI Workspace Collection.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.power_bi_embedded.workspace_collections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_collection_name = '{{ workspace_collection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Retrieves all existing Power BI workspace collections in the specified resource group.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.power_bi_embedded.workspace_collections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

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

SELECT
message,
nameAvailable,
reason
FROM azure.power_bi_embedded.workspace_collections
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Retrieves all existing Power BI workspace collections in the specified subscription.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.power_bi_embedded.workspace_collections
WHERE subscription_id = '{{ subscription_id }}' -- required
;

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.power_bi_embedded.workspace_collections (
location,
tags,
sku,
resource_group_name,
workspace_collection_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ workspace_collection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_collections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_collections resource.
  - name: workspace_collection_name
    value: "{{ workspace_collection_name }}"
    description: Required parameter for the workspace_collections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_collections resource.
  - name: location
    value: "{{ location }}"
    description: |
      Azure location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Dictionary of .
  - name: sku
    description: |
      :vartype sku: ~azure.mgmt.powerbiembedded.models.AzureSku
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"

UPDATE examples

update

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

UPDATE azure.power_bi_embedded.workspace_collections
SET 
tags = '{{ tags }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_collection_name = '{{ workspace_collection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Delete a Power BI Workspace Collection.

DELETE FROM azure.power_bi_embedded.workspace_collections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_collection_name = '{{ workspace_collection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_access_keys

Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.

EXEC azure.power_bi_embedded.workspace_collections.get_access_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_collection_name='{{ workspace_collection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_key

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

EXEC azure.power_bi_embedded.workspace_collections.regenerate_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_collection_name='{{ workspace_collection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;

migrate

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

EXEC azure.power_bi_embedded.workspace_collections.migrate 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"targetResourceGroup": "{{ targetResourceGroup }}", 
"resources": "{{ resources }}"
}'
;