1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. powerbi

Module powerbi

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource Embedded

class Embedded extends CustomResource

Manages a PowerBI Embedded.

Example Usage

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

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

constructor

new Embedded(name: string, args: EmbeddedArgs, opts?: pulumi.CustomResourceOptions)

Create a Embedded resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EmbeddedState, opts?: pulumi.CustomResourceOptions): Embedded

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Embedded

Returns true if the given object is an instance of Embedded. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property administrators

public administrators: pulumi.Output<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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

The name of the PowerBI Embedded. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.

property skuName

public skuName: pulumi.Output<string>;

Sets the PowerBI Embedded’s pricing level’s SKU. Possible values include: A1, A2, A3, A4, A5, A6.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface EmbeddedArgs

interface EmbeddedArgs

The set of arguments for constructing a Embedded resource.

property administrators

administrators: pulumi.Input<pulumi.Input<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.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the PowerBI Embedded. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.

property skuName

skuName: pulumi.Input<string>;

Sets the PowerBI Embedded’s pricing level’s SKU. Possible values include: A1, A2, A3, A4, A5, A6.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface EmbeddedState

interface EmbeddedState

Input properties used for looking up and filtering Embedded resources.

property administrators

administrators?: pulumi.Input<pulumi.Input<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.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the PowerBI Embedded. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group where the PowerBI Embedded should be created. Changing this forces a new resource to be created.

property skuName

skuName?: pulumi.Input<string>;

Sets the PowerBI Embedded’s pricing level’s SKU. Possible values include: A1, A2, A3, A4, A5, A6.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.