Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.PowerBIDedicated/capacities
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 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) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Power BI Dedicated Capacity | AVM Resource Module for Power BI Dedicated Capacity |
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"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.PowerBIDedicated/capacities
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-01-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 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) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.PowerBIDedicated/capacities' |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure 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"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
administration = {
members = [
"string"
]
}
mode = "string"
}
sku = {
capacity = int
name = "string"
tier = "string"
}
}
}
Property Values
Microsoft.PowerBIDedicated/capacities
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 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) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.PowerBIDedicated/capacities@2021-01-01" |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform Samples
A basic example of deploying PowerBI Embedded.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
azurerm = {
source = "hashicorp/azurerm"
}
}
}
provider "azurerm" {
features {
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
data "azurerm_client_config" "current" {
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "capacity" {
type = "Microsoft.PowerBIDedicated/capacities@2021-01-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
administration = {
members = [
data.azurerm_client_config.current.object_id,
]
}
mode = "Gen2"
}
sku = {
name = "A1"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}