auto_scale_vcores

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

Overview

Name	auto_scale_vcores
Type	Resource
Id	azure.powerbi_dedicated.auto_scale_vcores

Fields

The following fields are returned by SELECT queries:

get

OK. The operation was successful.

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 an auto scale v-core resource.
sku	object	The SKU of the auto scale v-core 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_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 an auto scale v-core resource.
sku	object	The SKU of the auto scale v-core 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_by_subscription

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 an auto scale v-core resource.
sku	object	The SKU of the auto scale v-core 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
get	select	subscriptionId, resourceGroupName, vcoreName		Gets details about the specified auto scale v-core.
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets all the auto scale v-cores for the given resource group.
list_by_subscription	select	subscriptionId		Lists all the auto scale v-cores for the given subscription.
create	insert	subscriptionId, resourceGroupName, vcoreName, data__sku		Provisions the specified auto scale v-core based on the configuration specified in the request.
update	update	subscriptionId, resourceGroupName, vcoreName		Updates the current state of the specified auto scale v-core.
delete	delete	subscriptionId, resourceGroupName, vcoreName		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
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.
vcoreName	string	The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63.

SELECT examples

get

Gets details about the specified auto scale v-core.

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

list_by_resource_group

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

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

list_by_subscription

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

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

INSERT examples

create

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

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

Manifest

# Description fields are for documentation purposes
- name: auto_scale_vcores
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the auto_scale_vcores resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the auto_scale_vcores resource.
    - name: vcoreName
      value: string
      description: Required parameter for the auto_scale_vcores resource.
    - name: sku
      value: object
      description: |
        The SKU of the auto scale v-core resource.
    - name: properties
      value: object
      description: |
        Properties of an auto scale v-core resource.
    - 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 auto scale v-core.

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

DELETE examples

delete

Deletes the specified auto scale v-core.

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