Microsoft.PowerBIDedicated capacities

Bicep resource definition

The capacities resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.PowerBIDedicated/capacities resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.PowerBIDedicated/capacities@2021-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  properties: {
    administration: {
      members: [
        'string'
      ]
    }
    mode: 'string'
  }
  systemData: {
    createdAt: 'string'
    createdBy: 'string'
    createdByType: 'string'
    lastModifiedAt: 'string'
    lastModifiedBy: 'string'
    lastModifiedByType: 'string'
  }
}

Property values

capacities

Name Description Value
name The resource name string (required)
location Location of the PowerBI Dedicated resource. string (required)
tags Key-value pairs of additional resource provisioning properties. Dictionary of tag names and values. See Tags in templates
sku The SKU of the PowerBI Dedicated capacity resource. CapacitySku (required)
properties Properties of the provision operation request. DedicatedCapacityProperties
systemData Metadata pertaining to creation and last modification of the resource. SystemData

DedicatedCapacityProperties

Name Description Value
administration A collection of Dedicated capacity administrators DedicatedCapacityAdministrators
mode Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More 'Gen1'
'Gen2'

DedicatedCapacityAdministrators

Name Description Value
members An array of administrator user identities. string[]

CapacitySku

Name Description Value
capacity The capacity of the SKU. int
name Name of the SKU level. string (required)
tier The name of the Azure pricing tier to which the SKU applies. 'AutoPremiumHost'
'PBIE_Azure'
'Premium'

SystemData

Name Description Value
createdAt The timestamp of resource creation (UTC) string
createdBy An identifier for the identity that created the resource string
createdByType The type of identity that created the resource 'Application'
'Key'
'ManagedIdentity'
'User'
lastModifiedAt The timestamp of resource last modification (UTC) string
lastModifiedBy An identifier for the identity that last modified the resource string
lastModifiedByType The type of identity that last modified the resource 'Application'
'Key'
'ManagedIdentity'
'User'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Power BI Embedded capacity

Deploy to Azure
This template creates a Power BI capacity in Azure, which simplifies how ISVs and developers use Power BI capabilities with embedded analytics.

ARM template resource definition

The capacities resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.PowerBIDedicated/capacities resource, add the following JSON to your template.

{
  "type": "Microsoft.PowerBIDedicated/capacities",
  "apiVersion": "2021-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "administration": {
      "members": [ "string" ]
    },
    "mode": "string"
  },
  "systemData": {
    "createdAt": "string",
    "createdBy": "string",
    "createdByType": "string",
    "lastModifiedAt": "string",
    "lastModifiedBy": "string",
    "lastModifiedByType": "string"
  }
}

Property values

capacities

Name Description Value
type The resource type 'Microsoft.PowerBIDedicated/capacities'
apiVersion The resource api version '2021-01-01'
name The resource name string (required)
location Location of the PowerBI Dedicated resource. string (required)
tags Key-value pairs of additional resource provisioning properties. Dictionary of tag names and values. See Tags in templates
sku The SKU of the PowerBI Dedicated capacity resource. CapacitySku (required)
properties Properties of the provision operation request. DedicatedCapacityProperties
systemData Metadata pertaining to creation and last modification of the resource. SystemData

DedicatedCapacityProperties

Name Description Value
administration A collection of Dedicated capacity administrators DedicatedCapacityAdministrators
mode Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More 'Gen1'
'Gen2'

DedicatedCapacityAdministrators

Name Description Value
members An array of administrator user identities. string[]

CapacitySku

Name Description Value
capacity The capacity of the SKU. int
name Name of the SKU level. string (required)
tier The name of the Azure pricing tier to which the SKU applies. 'AutoPremiumHost'
'PBIE_Azure'
'Premium'

SystemData

Name Description Value
createdAt The timestamp of resource creation (UTC) string
createdBy An identifier for the identity that created the resource string
createdByType The type of identity that created the resource 'Application'
'Key'
'ManagedIdentity'
'User'
lastModifiedAt The timestamp of resource last modification (UTC) string
lastModifiedBy An identifier for the identity that last modified the resource string
lastModifiedByType The type of identity that last modified the resource 'Application'
'Key'
'ManagedIdentity'
'User'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Power BI Embedded capacity

Deploy to Azure
This template creates a Power BI capacity in Azure, which simplifies how ISVs and developers use Power BI capabilities with embedded analytics.

Terraform (AzAPI provider) resource definition

The capacities resource type can be deployed to:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.PowerBIDedicated/capacities resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.PowerBIDedicated/capacities@2021-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      administration = {
        members = [
          "string"
        ]
      }
      mode = "string"
    }
    systemData = {
      createdAt = "string"
      createdBy = "string"
      createdByType = "string"
      lastModifiedAt = "string"
      lastModifiedBy = "string"
      lastModifiedByType = "string"
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

Property values

capacities

Name Description Value
type The resource type "Microsoft.PowerBIDedicated/capacities@2021-01-01"
name The resource name string (required)
location Location of the PowerBI Dedicated resource. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Key-value pairs of additional resource provisioning properties. Dictionary of tag names and values.
sku The SKU of the PowerBI Dedicated capacity resource. CapacitySku (required)
properties Properties of the provision operation request. DedicatedCapacityProperties
systemData Metadata pertaining to creation and last modification of the resource. SystemData

DedicatedCapacityProperties

Name Description Value
administration A collection of Dedicated capacity administrators DedicatedCapacityAdministrators
mode Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More "Gen1"
"Gen2"

DedicatedCapacityAdministrators

Name Description Value
members An array of administrator user identities. string[]

CapacitySku

Name Description Value
capacity The capacity of the SKU. int
name Name of the SKU level. string (required)
tier The name of the Azure pricing tier to which the SKU applies. "AutoPremiumHost"
"PBIE_Azure"
"Premium"

SystemData

Name Description Value
createdAt The timestamp of resource creation (UTC) string
createdBy An identifier for the identity that created the resource string
createdByType The type of identity that created the resource "Application"
"Key"
"ManagedIdentity"
"User"
lastModifiedAt The timestamp of resource last modification (UTC) string
lastModifiedBy An identifier for the identity that last modified the resource string
lastModifiedByType The type of identity that last modified the resource "Application"
"Key"
"ManagedIdentity"
"User"