Skip to content

azurermPowerbiEmbedded

Manages a PowerBI Embedded.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "example-resources",
  }
);
const azurermPowerbiEmbeddedExample =
  new azurerm.powerbiEmbedded.PowerbiEmbedded(this, "example_1", {
    administrators: ["azsdktest@microsoft.com"],
    location: azurermResourceGroupExample.location,
    name: "examplepowerbi",
    resource_group_name: azurermResourceGroupExample.name,
    sku_name: "A1",
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermPowerbiEmbeddedExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • name - (Required) The name of the PowerBI Embedded. Changing this forces a new resource to be created.

  • resourceGroupName - (Required) The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.

  • location - (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • skuName - (Required) Sets the PowerBI Embedded's pricing level's SKU. Possible values include: a1, a2, a3, a4, a5, a6.

  • administrators - (Required) A set of administrator user identities, which manages the Power BI Embedded and must be a member user or a service principal in your AAD tenant.

  • mode - (Optional) Sets the PowerBI Embedded's mode. Possible values include: gen1, gen2. Defaults to gen1. Changing this forces a new resource to be created.

  • tags - (Optional) A mapping of tags to assign to the resource.

Attributes Reference

The following attributes are exported:

  • id - The ID of the PowerBI Embedded.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the PowerBI Embedded instance.
  • update - (Defaults to 30 minutes) Used when updating the PowerBI Embedded instance.
  • read - (Defaults to 5 minutes) Used when retrieving the PowerBI Embedded instance.
  • delete - (Defaults to 30 minutes) Used when deleting the PowerBI Embedded instance.

Import

PowerBI Embedded can be imported using the resourceId, e.g.

terraform import azurerm_powerbi_embedded.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.PowerBIDedicated/capacities/capacity1