capacities

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

Overview

Name	capacities
Type	Resource
Id	azure.power_bi_dedicated.capacities

Fields

The following fields are returned by SELECT queries:

list_skus_for_capacity

Name	Datatype	Description
value	array	The collection of available SKUs for existing resources.

list_by_resource_group

Name	Datatype	Description
id	string	An identifier that represents the PowerBI Dedicated resource.
name	string	The name of the PowerBI Dedicated resource.
administration	object	A collection of Dedicated capacity administrators.
friendlyName	string	Capacity name.
location	string	Location of the PowerBI Dedicated resource. Required.
mode	string	Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More _. Known values are: "Gen1" and "Gen2".
provisioningState	string	The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. Known values are: "Deleting", "Succeeded", "Failed", "Paused", "Suspended", "Provisioning", "Updating", "Suspending", "Pausing", "Resuming", "Preparing", and "Scaling".
sku	object	The SKU of the PowerBI Dedicated capacity resource. Required.
state	string	The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. Known values are: "Deleting", "Succeeded", "Failed", "Paused", "Suspended", "Provisioning", "Updating", "Suspending", "Pausing", "Resuming", "Preparing", and "Scaling".
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Key-value pairs of additional resource provisioning properties.
tenantId	string	Tenant ID for the capacity. Used for creating Pro Plus capacity.
type	string	The type of the PowerBI Dedicated resource.

check_name_availability

Name	Datatype	Description
message	string	The detailed message of the request unavailability.
nameAvailable	boolean	Indicator of availability of the capacity name.
reason	string	The reason of unavailability.

list

Name	Datatype	Description
id	string	An identifier that represents the PowerBI Dedicated resource.
name	string	The name of the PowerBI Dedicated resource.
administration	object	A collection of Dedicated capacity administrators.
friendlyName	string	Capacity name.
location	string	Location of the PowerBI Dedicated resource. Required.
mode	string	Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More _. Known values are: "Gen1" and "Gen2".
provisioningState	string	The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. Known values are: "Deleting", "Succeeded", "Failed", "Paused", "Suspended", "Provisioning", "Updating", "Suspending", "Pausing", "Resuming", "Preparing", and "Scaling".
sku	object	The SKU of the PowerBI Dedicated capacity resource. Required.
state	string	The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. Known values are: "Deleting", "Succeeded", "Failed", "Paused", "Suspended", "Provisioning", "Updating", "Suspending", "Pausing", "Resuming", "Preparing", and "Scaling".
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Key-value pairs of additional resource provisioning properties.
tenantId	string	Tenant ID for the capacity. Used for creating Pro Plus capacity.
type	string	The type of the PowerBI Dedicated resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_skus_for_capacity	select	resource_group_name, dedicated_capacity_name, subscription_id		Lists eligible SKUs for a PowerBI Dedicated resource.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all the Dedicated capacities for the given resource group.
check_name_availability	select	location, subscription_id		Check the name availability in the target location.
list	select	subscription_id		Lists all the Dedicated capacities for the given subscription.
create	insert	resource_group_name, dedicated_capacity_name, subscription_id, location, sku		Provisions the specified Dedicated capacity based on the configuration specified in the request.
update	update	resource_group_name, dedicated_capacity_name, subscription_id		Updates the current state of the specified Dedicated capacity.
delete	delete	resource_group_name, dedicated_capacity_name, subscription_id		Deletes the specified Dedicated capacity.
list_skus	exec	subscription_id		Lists eligible SKUs for PowerBI Dedicated resource provider.
get_details	exec	resource_group_name, dedicated_capacity_name, subscription_id		Gets details about the specified dedicated capacity.
suspend	exec	resource_group_name, dedicated_capacity_name, subscription_id		Suspends operation of the specified dedicated capacity instance.
resume	exec	resource_group_name, dedicated_capacity_name, subscription_id		Resumes operation of the specified Dedicated capacity instance.

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
dedicated_capacity_name	string	The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. Required.
location	string	The region name which the operation will lookup into. Required.
resource_group_name	string	The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90. Required.
subscription_id	string

SELECT examples

list_skus_for_capacity

Lists eligible SKUs for a PowerBI Dedicated resource.

SELECT
value
FROM azure.power_bi_dedicated.capacities
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dedicated_capacity_name = '{{ dedicated_capacity_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all the Dedicated capacities for the given resource group.

SELECT
id,
name,
administration,
friendlyName,
location,
mode,
provisioningState,
sku,
state,
systemData,
tags,
tenantId,
type
FROM azure.power_bi_dedicated.capacities
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

Check the name availability in the target location.

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

list

Lists all the Dedicated capacities for the given subscription.

SELECT
id,
name,
administration,
friendlyName,
location,
mode,
provisioningState,
sku,
state,
systemData,
tags,
tenantId,
type
FROM azure.power_bi_dedicated.capacities
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Provisions the specified Dedicated capacity based on the configuration specified in the request.

INSERT INTO azure.power_bi_dedicated.capacities (
location,
tags,
systemData,
sku,
properties,
resource_group_name,
dedicated_capacity_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ systemData }}',
'{{ sku }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ dedicated_capacity_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: capacities
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the capacities resource.
  - name: dedicated_capacity_name
    value: "{{ dedicated_capacity_name }}"
    description: Required parameter for the capacities resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the capacities resource.
  - name: location
    value: "{{ location }}"
    description: |
      Location of the PowerBI Dedicated resource. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Key-value pairs of additional resource provisioning properties.
  - name: systemData
    description: |
      Metadata pertaining to creation and last modification of the resource.
    value:
      createdBy: "{{ createdBy }}"
      createdByType: "{{ createdByType }}"
      createdAt: "{{ createdAt }}"
      lastModifiedBy: "{{ lastModifiedBy }}"
      lastModifiedByType: "{{ lastModifiedByType }}"
      lastModifiedAt: "{{ lastModifiedAt }}"
  - name: sku
    description: |
      Represents the SKU name and Azure pricing tier for PowerBI Dedicated capacity resource. All required parameters must be populated in order to send to server.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      capacity: {{ capacity }}
  - name: properties
    value:
      administration:
        members:
          - "{{ members }}"
      mode: "{{ mode }}"

UPDATE examples

update

Updates the current state of the specified Dedicated capacity.

UPDATE azure.power_bi_dedicated.capacities
SET 
sku = '{{ sku }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dedicated_capacity_name = '{{ dedicated_capacity_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified Dedicated capacity.

DELETE FROM azure.power_bi_dedicated.capacities
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dedicated_capacity_name = '{{ dedicated_capacity_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_skus

Lists eligible SKUs for PowerBI Dedicated resource provider.

EXEC azure.power_bi_dedicated.capacities.list_skus 
@subscription_id='{{ subscription_id }}' --required
;

get_details

Gets details about the specified dedicated capacity.

EXEC azure.power_bi_dedicated.capacities.get_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@dedicated_capacity_name='{{ dedicated_capacity_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

suspend

Suspends operation of the specified dedicated capacity instance.

EXEC azure.power_bi_dedicated.capacities.suspend 
@resource_group_name='{{ resource_group_name }}' --required, 
@dedicated_capacity_name='{{ dedicated_capacity_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

resume

Resumes operation of the specified Dedicated capacity instance.

EXEC azure.power_bi_dedicated.capacities.resume 
@resource_group_name='{{ resource_group_name }}' --required, 
@dedicated_capacity_name='{{ dedicated_capacity_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;