Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. powerbi
  5. Embedded

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.powerbi.Embedded

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a PowerBI Embedded.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleEmbedded = new azure.powerbi.Embedded("example", {
    name: "examplepowerbi",
    location: example.location,
    resourceGroupName: example.name,
    skuName: "A1",
    administrators: ["azsdktest@microsoft.com"],
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_embedded = azure.powerbi.Embedded("example",
    name="examplepowerbi",
    location=example.location,
    resource_group_name=example.name,
    sku_name="A1",
    administrators=["azsdktest@microsoft.com"])

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/powerbi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = powerbi.NewEmbedded(ctx, "example", &powerbi.EmbeddedArgs{
			Name:              pulumi.String("examplepowerbi"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			SkuName:           pulumi.String("A1"),
			Administrators: pulumi.StringArray{
				pulumi.String("azsdktest@microsoft.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleEmbedded = new Azure.PowerBI.Embedded("example", new()
    {
        Name = "examplepowerbi",
        Location = example.Location,
        ResourceGroupName = example.Name,
        SkuName = "A1",
        Administrators = new[]
        {
            "azsdktest@microsoft.com",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.powerbi.Embedded;
import com.pulumi.azure.powerbi.EmbeddedArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleEmbedded = new Embedded("exampleEmbedded", EmbeddedArgs.builder()
            .name("examplepowerbi")
            .location(example.location())
            .resourceGroupName(example.name())
            .skuName("A1")
            .administrators("azsdktest@microsoft.com")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleEmbedded:
    type: azure:powerbi:Embedded
    name: example
    properties:
      name: examplepowerbi
      location: ${example.location}
      resourceGroupName: ${example.name}
      skuName: A1
      administrators:
        - azsdktest@microsoft.com

    Create Embedded Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Embedded(name: string, args: EmbeddedArgs, opts?: CustomResourceOptions);
    @overload
def Embedded(resource_name: str,
             args: EmbeddedArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Embedded(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             administrators: Optional[Sequence[str]] = None,
             resource_group_name: Optional[str] = None,
             sku_name: Optional[str] = None,
             location: Optional[str] = None,
             mode: Optional[str] = None,
             name: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)
    func NewEmbedded(ctx *Context, name string, args EmbeddedArgs, opts ...ResourceOption) (*Embedded, error)
    public Embedded(string name, EmbeddedArgs args, CustomResourceOptions? opts = null)
    public Embedded(String name, EmbeddedArgs args)
public Embedded(String name, EmbeddedArgs args, CustomResourceOptions options)

    type: azure:powerbi:Embedded
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EmbeddedArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EmbeddedArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EmbeddedArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmbeddedArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmbeddedArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var embeddedResource = new Azure.PowerBI.Embedded("embeddedResource", new()
{
    Administrators = new[]
    {
        "string",
    },
    ResourceGroupName = "string",
    SkuName = "string",
    Location = "string",
    Mode = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := powerbi.NewEmbedded(ctx, "embeddedResource", &powerbi.EmbeddedArgs{
	Administrators: pulumi.StringArray{
		pulumi.String("string"),
	},
	ResourceGroupName: pulumi.String("string"),
	SkuName:           pulumi.String("string"),
	Location:          pulumi.String("string"),
	Mode:              pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var embeddedResource = new Embedded("embeddedResource", EmbeddedArgs.builder()
    .administrators("string")
    .resourceGroupName("string")
    .skuName("string")
    .location("string")
    .mode("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    embedded_resource = azure.powerbi.Embedded("embeddedResource",
    administrators=["string"],
    resource_group_name="string",
    sku_name="string",
    location="string",
    mode="string",
    name="string",
    tags={
        "string": "string",
    })

    const embeddedResource = new azure.powerbi.Embedded("embeddedResource", {
    administrators: ["string"],
    resourceGroupName: "string",
    skuName: "string",
    location: "string",
    mode: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:powerbi:Embedded
properties:
    administrators:
        - string
    location: string
    mode: string
    name: string
    resourceGroupName: string
    skuName: string
    tags:
        string: string

    Embedded Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Embedded resource accepts the following input properties:

    Administrators List<string>
    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.
    ResourceGroupName string
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    SkuName string
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Mode string
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    Name string
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Administrators []string
    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.
    ResourceGroupName string
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    SkuName string
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Mode string
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    Name string
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    administrators List<String>
    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.
    resourceGroupName String
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    skuName String
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mode String
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    name String
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    administrators string[]
    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.
    resourceGroupName string
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    skuName string
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mode string
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    name string
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    administrators Sequence[str]
    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.
    resource_group_name str
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    sku_name str
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mode str
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    name str
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    administrators List<String>
    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.
    resourceGroupName String
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    skuName String
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mode String
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    name String
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Embedded resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Embedded Resource

    Get an existing Embedded resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EmbeddedState, opts?: CustomResourceOptions): Embedded
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        administrators: Optional[Sequence[str]] = None,
        location: Optional[str] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sku_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Embedded
    func GetEmbedded(ctx *Context, name string, id IDInput, state *EmbeddedState, opts ...ResourceOption) (*Embedded, error)
    public static Embedded Get(string name, Input<string> id, EmbeddedState? state, CustomResourceOptions? opts = null)
    public static Embedded get(String name, Output<String> id, EmbeddedState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Administrators List<string>
    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.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Mode string
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    Name string
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    SkuName string
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Administrators []string
    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.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Mode string
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    Name string
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    SkuName string
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    administrators List<String>
    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.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mode String
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    name String
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    skuName String
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    administrators string[]
    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.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mode string
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    name string
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    skuName string
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    administrators Sequence[str]
    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.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mode str
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    name str
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    sku_name str
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    administrators List<String>
    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.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mode String
    Sets the PowerBI Embedded's mode. Possible values include: Gen1, Gen2. Defaults to Gen1. Changing this forces a new resource to be created.
    name String
    The name of the PowerBI Embedded. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.
    skuName String
    Sets the PowerBI Embedded's pricing level's SKU. Possible values include: A1, A2, A3, A4, A5, A6.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Import

    PowerBI Embedded can be imported using the resource id, e.g.

    $ pulumi import azure:powerbi/embedded:Embedded example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.PowerBIDedicated/capacities/capacity1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure