1. Packages
  2. Azure Classic
  3. API Docs
  4. streamanalytics
  5. OutputPowerbi

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

azure.streamanalytics.OutputPowerbi

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

    Manages a Stream Analytics Output powerBI.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.core.getResourceGroup({
        name: "example-resources",
    });
    const exampleGetJob = example.then(example => azure.streamanalytics.getJob({
        name: "example-job",
        resourceGroupName: example.name,
    }));
    const exampleOutputPowerbi = new azure.streamanalytics.OutputPowerbi("example", {
        name: "output-to-powerbi",
        streamAnalyticsJobId: exampleGetJob.then(exampleGetJob => exampleGetJob.id),
        dataset: "example-dataset",
        table: "example-table",
        groupId: "00000000-0000-0000-0000-000000000000",
        groupName: "some-group-name",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.get_resource_group(name="example-resources")
    example_get_job = azure.streamanalytics.get_job(name="example-job",
        resource_group_name=example.name)
    example_output_powerbi = azure.streamanalytics.OutputPowerbi("example",
        name="output-to-powerbi",
        stream_analytics_job_id=example_get_job.id,
        dataset="example-dataset",
        table="example-table",
        group_id="00000000-0000-0000-0000-000000000000",
        group_name="some-group-name")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/streamanalytics"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.LookupResourceGroup(ctx, &core.LookupResourceGroupArgs{
    			Name: "example-resources",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleGetJob, err := streamanalytics.LookupJob(ctx, &streamanalytics.LookupJobArgs{
    			Name:              "example-job",
    			ResourceGroupName: example.Name,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = streamanalytics.NewOutputPowerbi(ctx, "example", &streamanalytics.OutputPowerbiArgs{
    			Name:                 pulumi.String("output-to-powerbi"),
    			StreamAnalyticsJobId: pulumi.String(exampleGetJob.Id),
    			Dataset:              pulumi.String("example-dataset"),
    			Table:                pulumi.String("example-table"),
    			GroupId:              pulumi.String("00000000-0000-0000-0000-000000000000"),
    			GroupName:            pulumi.String("some-group-name"),
    		})
    		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 = Azure.Core.GetResourceGroup.Invoke(new()
        {
            Name = "example-resources",
        });
    
        var exampleGetJob = Azure.StreamAnalytics.GetJob.Invoke(new()
        {
            Name = "example-job",
            ResourceGroupName = example.Apply(getResourceGroupResult => getResourceGroupResult.Name),
        });
    
        var exampleOutputPowerbi = new Azure.StreamAnalytics.OutputPowerbi("example", new()
        {
            Name = "output-to-powerbi",
            StreamAnalyticsJobId = exampleGetJob.Apply(getJobResult => getJobResult.Id),
            Dataset = "example-dataset",
            Table = "example-table",
            GroupId = "00000000-0000-0000-0000-000000000000",
            GroupName = "some-group-name",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.CoreFunctions;
    import com.pulumi.azure.core.inputs.GetResourceGroupArgs;
    import com.pulumi.azure.streamanalytics.StreamanalyticsFunctions;
    import com.pulumi.azure.streamanalytics.inputs.GetJobArgs;
    import com.pulumi.azure.streamanalytics.OutputPowerbi;
    import com.pulumi.azure.streamanalytics.OutputPowerbiArgs;
    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) {
            final var example = CoreFunctions.getResourceGroup(GetResourceGroupArgs.builder()
                .name("example-resources")
                .build());
    
            final var exampleGetJob = StreamanalyticsFunctions.getJob(GetJobArgs.builder()
                .name("example-job")
                .resourceGroupName(example.applyValue(getResourceGroupResult -> getResourceGroupResult.name()))
                .build());
    
            var exampleOutputPowerbi = new OutputPowerbi("exampleOutputPowerbi", OutputPowerbiArgs.builder()
                .name("output-to-powerbi")
                .streamAnalyticsJobId(exampleGetJob.applyValue(getJobResult -> getJobResult.id()))
                .dataset("example-dataset")
                .table("example-table")
                .groupId("00000000-0000-0000-0000-000000000000")
                .groupName("some-group-name")
                .build());
    
        }
    }
    
    resources:
      exampleOutputPowerbi:
        type: azure:streamanalytics:OutputPowerbi
        name: example
        properties:
          name: output-to-powerbi
          streamAnalyticsJobId: ${exampleGetJob.id}
          dataset: example-dataset
          table: example-table
          groupId: 00000000-0000-0000-0000-000000000000
          groupName: some-group-name
    variables:
      example:
        fn::invoke:
          Function: azure:core:getResourceGroup
          Arguments:
            name: example-resources
      exampleGetJob:
        fn::invoke:
          Function: azure:streamanalytics:getJob
          Arguments:
            name: example-job
            resourceGroupName: ${example.name}
    

    Create OutputPowerbi Resource

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

    Constructor syntax

    new OutputPowerbi(name: string, args: OutputPowerbiArgs, opts?: CustomResourceOptions);
    @overload
    def OutputPowerbi(resource_name: str,
                      args: OutputPowerbiArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def OutputPowerbi(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      dataset: Optional[str] = None,
                      group_id: Optional[str] = None,
                      group_name: Optional[str] = None,
                      stream_analytics_job_id: Optional[str] = None,
                      table: Optional[str] = None,
                      name: Optional[str] = None,
                      token_user_display_name: Optional[str] = None,
                      token_user_principal_name: Optional[str] = None)
    func NewOutputPowerbi(ctx *Context, name string, args OutputPowerbiArgs, opts ...ResourceOption) (*OutputPowerbi, error)
    public OutputPowerbi(string name, OutputPowerbiArgs args, CustomResourceOptions? opts = null)
    public OutputPowerbi(String name, OutputPowerbiArgs args)
    public OutputPowerbi(String name, OutputPowerbiArgs args, CustomResourceOptions options)
    
    type: azure:streamanalytics:OutputPowerbi
    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 OutputPowerbiArgs
    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 OutputPowerbiArgs
    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 OutputPowerbiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OutputPowerbiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OutputPowerbiArgs
    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 outputPowerbiResource = new Azure.StreamAnalytics.OutputPowerbi("outputPowerbiResource", new()
    {
        Dataset = "string",
        GroupId = "string",
        GroupName = "string",
        StreamAnalyticsJobId = "string",
        Table = "string",
        Name = "string",
        TokenUserDisplayName = "string",
        TokenUserPrincipalName = "string",
    });
    
    example, err := streamanalytics.NewOutputPowerbi(ctx, "outputPowerbiResource", &streamanalytics.OutputPowerbiArgs{
    	Dataset:                pulumi.String("string"),
    	GroupId:                pulumi.String("string"),
    	GroupName:              pulumi.String("string"),
    	StreamAnalyticsJobId:   pulumi.String("string"),
    	Table:                  pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    	TokenUserDisplayName:   pulumi.String("string"),
    	TokenUserPrincipalName: pulumi.String("string"),
    })
    
    var outputPowerbiResource = new OutputPowerbi("outputPowerbiResource", OutputPowerbiArgs.builder()
        .dataset("string")
        .groupId("string")
        .groupName("string")
        .streamAnalyticsJobId("string")
        .table("string")
        .name("string")
        .tokenUserDisplayName("string")
        .tokenUserPrincipalName("string")
        .build());
    
    output_powerbi_resource = azure.streamanalytics.OutputPowerbi("outputPowerbiResource",
        dataset="string",
        group_id="string",
        group_name="string",
        stream_analytics_job_id="string",
        table="string",
        name="string",
        token_user_display_name="string",
        token_user_principal_name="string")
    
    const outputPowerbiResource = new azure.streamanalytics.OutputPowerbi("outputPowerbiResource", {
        dataset: "string",
        groupId: "string",
        groupName: "string",
        streamAnalyticsJobId: "string",
        table: "string",
        name: "string",
        tokenUserDisplayName: "string",
        tokenUserPrincipalName: "string",
    });
    
    type: azure:streamanalytics:OutputPowerbi
    properties:
        dataset: string
        groupId: string
        groupName: string
        name: string
        streamAnalyticsJobId: string
        table: string
        tokenUserDisplayName: string
        tokenUserPrincipalName: string
    

    OutputPowerbi Resource Properties

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

    Inputs

    The OutputPowerbi resource accepts the following input properties:

    Dataset string
    The name of the Power BI dataset.
    GroupId string
    The ID of the Power BI group, this must be a valid UUID.
    GroupName string
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    StreamAnalyticsJobId string
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    Table string
    The name of the Power BI table under the specified dataset.
    Name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    TokenUserDisplayName string
    The user display name of the user that was used to obtain the refresh token.
    TokenUserPrincipalName string
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    Dataset string
    The name of the Power BI dataset.
    GroupId string
    The ID of the Power BI group, this must be a valid UUID.
    GroupName string
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    StreamAnalyticsJobId string
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    Table string
    The name of the Power BI table under the specified dataset.
    Name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    TokenUserDisplayName string
    The user display name of the user that was used to obtain the refresh token.
    TokenUserPrincipalName string
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    dataset String
    The name of the Power BI dataset.
    groupId String
    The ID of the Power BI group, this must be a valid UUID.
    groupName String
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    streamAnalyticsJobId String
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    table String
    The name of the Power BI table under the specified dataset.
    name String
    The name of the Stream Output. Changing this forces a new resource to be created.
    tokenUserDisplayName String
    The user display name of the user that was used to obtain the refresh token.
    tokenUserPrincipalName String
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    dataset string
    The name of the Power BI dataset.
    groupId string
    The ID of the Power BI group, this must be a valid UUID.
    groupName string
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    streamAnalyticsJobId string
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    table string
    The name of the Power BI table under the specified dataset.
    name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    tokenUserDisplayName string
    The user display name of the user that was used to obtain the refresh token.
    tokenUserPrincipalName string
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    dataset str
    The name of the Power BI dataset.
    group_id str
    The ID of the Power BI group, this must be a valid UUID.
    group_name str
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    stream_analytics_job_id str
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    table str
    The name of the Power BI table under the specified dataset.
    name str
    The name of the Stream Output. Changing this forces a new resource to be created.
    token_user_display_name str
    The user display name of the user that was used to obtain the refresh token.
    token_user_principal_name str
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    dataset String
    The name of the Power BI dataset.
    groupId String
    The ID of the Power BI group, this must be a valid UUID.
    groupName String
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    streamAnalyticsJobId String
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    table String
    The name of the Power BI table under the specified dataset.
    name String
    The name of the Stream Output. Changing this forces a new resource to be created.
    tokenUserDisplayName String
    The user display name of the user that was used to obtain the refresh token.
    tokenUserPrincipalName String
    The user principal name (UPN) of the user that was used to obtain the refresh token.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OutputPowerbi 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 OutputPowerbi Resource

    Get an existing OutputPowerbi 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?: OutputPowerbiState, opts?: CustomResourceOptions): OutputPowerbi
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dataset: Optional[str] = None,
            group_id: Optional[str] = None,
            group_name: Optional[str] = None,
            name: Optional[str] = None,
            stream_analytics_job_id: Optional[str] = None,
            table: Optional[str] = None,
            token_user_display_name: Optional[str] = None,
            token_user_principal_name: Optional[str] = None) -> OutputPowerbi
    func GetOutputPowerbi(ctx *Context, name string, id IDInput, state *OutputPowerbiState, opts ...ResourceOption) (*OutputPowerbi, error)
    public static OutputPowerbi Get(string name, Input<string> id, OutputPowerbiState? state, CustomResourceOptions? opts = null)
    public static OutputPowerbi get(String name, Output<String> id, OutputPowerbiState 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:
    Dataset string
    The name of the Power BI dataset.
    GroupId string
    The ID of the Power BI group, this must be a valid UUID.
    GroupName string
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    Name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    StreamAnalyticsJobId string
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    Table string
    The name of the Power BI table under the specified dataset.
    TokenUserDisplayName string
    The user display name of the user that was used to obtain the refresh token.
    TokenUserPrincipalName string
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    Dataset string
    The name of the Power BI dataset.
    GroupId string
    The ID of the Power BI group, this must be a valid UUID.
    GroupName string
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    Name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    StreamAnalyticsJobId string
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    Table string
    The name of the Power BI table under the specified dataset.
    TokenUserDisplayName string
    The user display name of the user that was used to obtain the refresh token.
    TokenUserPrincipalName string
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    dataset String
    The name of the Power BI dataset.
    groupId String
    The ID of the Power BI group, this must be a valid UUID.
    groupName String
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    name String
    The name of the Stream Output. Changing this forces a new resource to be created.
    streamAnalyticsJobId String
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    table String
    The name of the Power BI table under the specified dataset.
    tokenUserDisplayName String
    The user display name of the user that was used to obtain the refresh token.
    tokenUserPrincipalName String
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    dataset string
    The name of the Power BI dataset.
    groupId string
    The ID of the Power BI group, this must be a valid UUID.
    groupName string
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    streamAnalyticsJobId string
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    table string
    The name of the Power BI table under the specified dataset.
    tokenUserDisplayName string
    The user display name of the user that was used to obtain the refresh token.
    tokenUserPrincipalName string
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    dataset str
    The name of the Power BI dataset.
    group_id str
    The ID of the Power BI group, this must be a valid UUID.
    group_name str
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    name str
    The name of the Stream Output. Changing this forces a new resource to be created.
    stream_analytics_job_id str
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    table str
    The name of the Power BI table under the specified dataset.
    token_user_display_name str
    The user display name of the user that was used to obtain the refresh token.
    token_user_principal_name str
    The user principal name (UPN) of the user that was used to obtain the refresh token.
    dataset String
    The name of the Power BI dataset.
    groupId String
    The ID of the Power BI group, this must be a valid UUID.
    groupName String
    The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
    name String
    The name of the Stream Output. Changing this forces a new resource to be created.
    streamAnalyticsJobId String
    The ID of the Stream Analytics Job. Changing this forces a new resource to be created.
    table String
    The name of the Power BI table under the specified dataset.
    tokenUserDisplayName String
    The user display name of the user that was used to obtain the refresh token.
    tokenUserPrincipalName String
    The user principal name (UPN) of the user that was used to obtain the refresh token.

    Import

    Stream Analytics Output to Power BI can be imported using the resource id, e.g.

    $ pulumi import azure:streamanalytics/outputPowerbi:OutputPowerbi example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.StreamAnalytics/streamingJobs/job1/outputs/output1
    

    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 Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi