Microsoft.PowerBIDedicated capacities
Bicep resource definition
The capacities resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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' = {
location: 'string'
name: 'string'
properties: {
administration: {
members: [
'string'
]
}
mode: 'string'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
systemData: {
createdAt: 'string'
createdBy: 'string'
createdByType: 'string'
lastModifiedAt: 'string'
lastModifiedBy: 'string'
lastModifiedByType: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
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' |
DedicatedCapacityAdministrators
| Name | Description | Value |
|---|---|---|
| members | An array of administrator user identities. | string[] |
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' |
Microsoft.PowerBIDedicated/capacities
| Name | Description | Value |
|---|---|---|
| location | Location of the PowerBI Dedicated resource. | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z][a-z0-9]*$ (required) |
| properties | Properties of the provision operation request. | DedicatedCapacityProperties |
| sku | The SKU of the PowerBI Dedicated capacity resource. | CapacitySku (required) |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ResourceTags
| Name | Description | Value |
|---|
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' |
ARM template resource definition
The capacities resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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",
"properties": {
"administration": {
"members": [ "string" ]
},
"mode": "string"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"systemData": {
"createdAt": "string",
"createdBy": "string",
"createdByType": "string",
"lastModifiedAt": "string",
"lastModifiedBy": "string",
"lastModifiedByType": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
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' |
DedicatedCapacityAdministrators
| Name | Description | Value |
|---|---|---|
| members | An array of administrator user identities. | string[] |
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' |
Microsoft.PowerBIDedicated/capacities
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-01-01' |
| location | Location of the PowerBI Dedicated resource. | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z][a-z0-9]*$ (required) |
| properties | Properties of the provision operation request. | DedicatedCapacityProperties |
| sku | The SKU of the PowerBI Dedicated capacity resource. | CapacitySku (required) |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.PowerBIDedicated/capacities' |
ResourceTags
| Name | Description | Value |
|---|
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 |
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 with operations that target:
- 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"
sku = {
capacity = int
name = "string"
tier = "string"
}
systemData = {
createdAt = "string"
createdBy = "string"
createdByType = "string"
lastModifiedAt = "string"
lastModifiedBy = "string"
lastModifiedByType = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
administration = {
members = [
"string"
]
}
mode = "string"
}
})
}
Property values
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' |
DedicatedCapacityAdministrators
| Name | Description | Value |
|---|---|---|
| members | An array of administrator user identities. | string[] |
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' |
Microsoft.PowerBIDedicated/capacities
| Name | Description | Value |
|---|---|---|
| location | Location of the PowerBI Dedicated resource. | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z][a-z0-9]*$ (required) |
| properties | Properties of the provision operation request. | DedicatedCapacityProperties |
| sku | The SKU of the PowerBI Dedicated capacity resource. | CapacitySku (required) |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.PowerBIDedicated/capacities@2021-01-01" |
ResourceTags
| Name | Description | Value |
|---|
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' |