capacities

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

Overview

Name	capacities
Type	Resource
Id	azure.powerbi_dedicated.capacities

Fields

The following fields are returned by SELECT queries:

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.
location	string	Location of the PowerBI Dedicated resource.
properties	object	Properties of the provision operation request.
sku	object	The SKU of the PowerBI Dedicated capacity resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Key-value pairs of additional resource provisioning properties.
type	string	The type of the PowerBI Dedicated resource.

list

Name	Datatype	Description
id	string	An identifier that represents the PowerBI Dedicated resource.
name	string	The name of the PowerBI Dedicated resource.
location	string	Location of the PowerBI Dedicated resource.
properties	object	Properties of the provision operation request.
sku	object	The SKU of the PowerBI Dedicated capacity resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Key-value pairs of additional resource provisioning properties.
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_by_resource_group	select	resourceGroupName, subscriptionId		Gets all the Dedicated capacities for the given resource group.
list	select	subscriptionId		Lists all the Dedicated capacities for the given subscription.
create	insert	resourceGroupName, dedicatedCapacityName, subscriptionId, data__sku		Provisions the specified Dedicated capacity based on the configuration specified in the request.
update	update	resourceGroupName, dedicatedCapacityName, subscriptionId		Updates the current state of the specified Dedicated capacity.
delete	delete	resourceGroupName, dedicatedCapacityName, subscriptionId		Deletes the specified Dedicated capacity.
suspend	exec	resourceGroupName, dedicatedCapacityName, subscriptionId		Suspends operation of the specified dedicated capacity instance.
resume	exec	resourceGroupName, dedicatedCapacityName, subscriptionId		Resumes operation of the specified Dedicated capacity instance.
check_name_availability	exec	location, subscriptionId		Check the name availability in the target location.

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
dedicatedCapacityName	string	The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
location	string	The region name which the operation will lookup into.
resourceGroupName	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.
subscriptionId	string	A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

list_by_resource_group

Gets all the Dedicated capacities for the given resource group.

SELECT
id,
name,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.powerbi_dedicated.capacities
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all the Dedicated capacities for the given subscription.

SELECT
id,
name,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.powerbi_dedicated.capacities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.powerbi_dedicated.capacities (
data__sku,
data__properties,
data__location,
data__tags,
data__systemData,
resourceGroupName,
dedicatedCapacityName,
subscriptionId
)
SELECT 
'{{ sku }}' /* required */,
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ systemData }}',
'{{ resourceGroupName }}',
'{{ dedicatedCapacityName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: capacities
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the capacities resource.
    - name: dedicatedCapacityName
      value: string
      description: Required parameter for the capacities resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the capacities resource.
    - name: sku
      value: object
      description: |
        The SKU of the PowerBI Dedicated capacity resource.
    - name: properties
      value: object
      description: |
        Properties of the provision operation request.
    - name: location
      value: string
      description: |
        Location of the PowerBI Dedicated resource.
    - name: tags
      value: object
      description: |
        Key-value pairs of additional resource provisioning properties.
    - name: systemData
      value: object
      description: |
        Metadata pertaining to creation and last modification of the resource.

UPDATE examples

update

Updates the current state of the specified Dedicated capacity.

UPDATE azure.powerbi_dedicated.capacities
SET 
data__sku = '{{ sku }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND dedicatedCapacityName = '{{ dedicatedCapacityName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified Dedicated capacity.

DELETE FROM azure.powerbi_dedicated.capacities
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND dedicatedCapacityName = '{{ dedicatedCapacityName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

suspend

Suspends operation of the specified dedicated capacity instance.

EXEC azure.powerbi_dedicated.capacities.suspend 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dedicatedCapacityName='{{ dedicatedCapacityName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

resume

Resumes operation of the specified Dedicated capacity instance.

EXEC azure.powerbi_dedicated.capacities.resume 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dedicatedCapacityName='{{ dedicatedCapacityName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

check_name_availability

Check the name availability in the target location.

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