auto_scale_vcores

Creates, updates, deletes, gets or lists an auto_scale_vcores resource.

Overview

Name	auto_scale_vcores
Type	Resource
Id	azure.power_bi_dedicated.auto_scale_vcores

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	An identifier that represents the PowerBI Dedicated resource.
name	string	The name of the PowerBI Dedicated resource.
capacityLimit	integer	The maximum capacity of an auto scale v-core resource.
capacityObjectId	string	The object ID of the capacity resource associated with the auto scale v-core resource.
location	string	Location of the PowerBI Dedicated resource. Required.
provisioningState	string	The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. "Succeeded"
sku	object	The SKU of the auto scale v-core resource. Required.
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_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.
capacityLimit	integer	The maximum capacity of an auto scale v-core resource.
capacityObjectId	string	The object ID of the capacity resource associated with the auto scale v-core resource.
location	string	Location of the PowerBI Dedicated resource. Required.
provisioningState	string	The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. "Succeeded"
sku	object	The SKU of the auto scale v-core resource. Required.
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_by_subscription

Name	Datatype	Description
id	string	An identifier that represents the PowerBI Dedicated resource.
name	string	The name of the PowerBI Dedicated resource.
capacityLimit	integer	The maximum capacity of an auto scale v-core resource.
capacityObjectId	string	The object ID of the capacity resource associated with the auto scale v-core resource.
location	string	Location of the PowerBI Dedicated resource. Required.
provisioningState	string	The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. "Succeeded"
sku	object	The SKU of the auto scale v-core resource. Required.
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
get	select	resource_group_name, vcore_name, subscription_id		Gets details about the specified auto scale v-core.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all the auto scale v-cores for the given resource group.
list_by_subscription	select	subscription_id		Lists all the auto scale v-cores for the given subscription.
create	insert	resource_group_name, vcore_name, subscription_id, location, sku		Provisions the specified auto scale v-core based on the configuration specified in the request.
update	update	resource_group_name, vcore_name, subscription_id		Updates the current state of the specified auto scale v-core.
delete	delete	resource_group_name, vcore_name, subscription_id		Deletes the specified auto scale v-core.

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
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
vcore_name	string	The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63. Required.

SELECT examples

get

Gets details about the specified auto scale v-core.

SELECT
id,
name,
capacityLimit,
capacityObjectId,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.power_bi_dedicated.auto_scale_vcores
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vcore_name = '{{ vcore_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all the auto scale v-cores for the given resource group.

SELECT
id,
name,
capacityLimit,
capacityObjectId,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.power_bi_dedicated.auto_scale_vcores
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all the auto scale v-cores for the given subscription.

SELECT
id,
name,
capacityLimit,
capacityObjectId,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.power_bi_dedicated.auto_scale_vcores
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Provisions the specified auto scale v-core based on the configuration specified in the request.

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

Manifest

# Description fields are for documentation purposes
- name: auto_scale_vcores
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the auto_scale_vcores resource.
  - name: vcore_name
    value: "{{ vcore_name }}"
    description: Required parameter for the auto_scale_vcores resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the auto_scale_vcores 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: |
      The SKU of the auto scale v-core resource. Required.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      capacity: {{ capacity }}
  - name: properties
    value:
      capacityLimit: {{ capacityLimit }}
      capacityObjectId: "{{ capacityObjectId }}"

UPDATE examples

update

Updates the current state of the specified auto scale v-core.

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

DELETE examples

delete

Deletes the specified auto scale v-core.

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