Skip to content

azurermStreamAnalyticsOutputPowerbi

Manages a Stream Analytics Output powerBI.

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 dataAzurermResourceGroupExample =
  new azurerm.dataAzurermResourceGroup.DataAzurermResourceGroup(
    this,
    "example",
    {
      name: "example-resources",
    }
  );
const dataAzurermStreamAnalyticsJobExample =
  new azurerm.dataAzurermStreamAnalyticsJob.DataAzurermStreamAnalyticsJob(
    this,
    "example_1",
    {
      name: "example-job",
      resource_group_name: dataAzurermResourceGroupExample.name,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
dataAzurermStreamAnalyticsJobExample.overrideLogicalId("example");
const azurermStreamAnalyticsOutputPowerbiExample =
  new azurerm.streamAnalyticsOutputPowerbi.StreamAnalyticsOutputPowerbi(
    this,
    "example_2",
    {
      dataset: "example-dataset",
      group_id: "00000000-0000-0000-0000-000000000000",
      group_name: "some-group-name",
      name: "output-to-powerbi",
      stream_analytics_job_id: dataAzurermStreamAnalyticsJobExample.id,
      table: "example-table",
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermStreamAnalyticsOutputPowerbiExample.overrideLogicalId("example");

Arguments Reference

The following arguments are supported:

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

  • streamAnalyticsJobId - (Required) The ID of the Stream Analytics Job. Changing this forces a new resource to be created.

  • dataset - (Required) The name of the Power BI dataset.

  • table - (Required) The name of the Power BI table under the specified dataset.

  • groupId - (Required) The ID of the Power BI group, this must be a valid UUID.

  • groupName - (Required) The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.

  • tokenUserPrincipalName - (Optional) The user principal name (UPN) of the user that was used to obtain the refresh token.

  • tokenUserDisplayName - (Optional) The user display name of the user that was used to obtain the refresh token.

Timeouts

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

  • create - (Defaults to 30 minutes) Used when creating the Stream Analytics Output for PowerBI.
  • read - (Defaults to 5 minutes) Used when retrieving the Stream Analytics Output for PowerBI.
  • update - (Defaults to 30 minutes) Used when updating the Stream Analytics Output for PowerBI.
  • delete - (Defaults to 30 minutes) Used when deleting the Stream Analytics Output for PowerBI.

Import

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

terraform import azurerm_stream_analytics_output_powerbi.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.StreamAnalytics/streamingJobs/job1/outputs/output1