azure.streamanalytics.OutputFunction (v4)

Azure v4.42.0 (4.x), Mar 9 26

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var examplePlan = new Azure.AppService.Plan("examplePlan", new Azure.AppService.PlanArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Kind = "FunctionApp",
            Reserved = true,
            Sku = new Azure.AppService.Inputs.PlanSkuArgs
            {
                Tier = "Dynamic",
                Size = "Y1",
            },
        });
        var exampleFunctionApp = new Azure.AppService.FunctionApp("exampleFunctionApp", new Azure.AppService.FunctionAppArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            AppServicePlanId = examplePlan.Id,
            StorageAccountName = exampleAccount.Name,
            StorageAccountAccessKey = exampleAccount.PrimaryAccessKey,
            OsType = "linux",
            Version = "~3",
        });
        var exampleJob = new Azure.StreamAnalytics.Job("exampleJob", new Azure.StreamAnalytics.JobArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            StreamingUnits = 3,
            TransformationQuery = @"    SELECT *
    INTO [YourOutputAlias]
    FROM [YourInputAlias]
",
        });
        var exampleOutputFunction = new Azure.StreamAnalytics.OutputFunction("exampleOutputFunction", new Azure.StreamAnalytics.OutputFunctionArgs
        {
            ResourceGroupName = exampleJob.ResourceGroupName,
            StreamAnalyticsJobName = exampleJob.Name,
            FunctionApp = exampleFunctionApp.Name,
            FunctionName = "examplefunctionname",
            ApiKey = "exampleapikey",
        });
    }

}

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/appservice"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/streamanalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", nil)
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		examplePlan, err := appservice.NewPlan(ctx, "examplePlan", &appservice.PlanArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Kind:              pulumi.Any("FunctionApp"),
			Reserved:          pulumi.Bool(true),
			Sku: &appservice.PlanSkuArgs{
				Tier: pulumi.String("Dynamic"),
				Size: pulumi.String("Y1"),
			},
		})
		if err != nil {
			return err
		}
		exampleFunctionApp, err := appservice.NewFunctionApp(ctx, "exampleFunctionApp", &appservice.FunctionAppArgs{
			Location:                exampleResourceGroup.Location,
			ResourceGroupName:       exampleResourceGroup.Name,
			AppServicePlanId:        examplePlan.ID(),
			StorageAccountName:      exampleAccount.Name,
			StorageAccountAccessKey: exampleAccount.PrimaryAccessKey,
			OsType:                  pulumi.String("linux"),
			Version:                 pulumi.String("~3"),
		})
		if err != nil {
			return err
		}
		exampleJob, err := streamanalytics.NewJob(ctx, "exampleJob", &streamanalytics.JobArgs{
			ResourceGroupName:   exampleResourceGroup.Name,
			Location:            exampleResourceGroup.Location,
			StreamingUnits:      pulumi.Int(3),
			TransformationQuery: pulumi.String(fmt.Sprintf("%v%v%v", "    SELECT *\n", "    INTO [YourOutputAlias]\n", "    FROM [YourInputAlias]\n")),
		})
		if err != nil {
			return err
		}
		_, err = streamanalytics.NewOutputFunction(ctx, "exampleOutputFunction", &streamanalytics.OutputFunctionArgs{
			ResourceGroupName:      exampleJob.ResourceGroupName,
			StreamAnalyticsJobName: exampleJob.Name,
			FunctionApp:            exampleFunctionApp.Name,
			FunctionName:           pulumi.String("examplefunctionname"),
			ApiKey:                 pulumi.String("exampleapikey"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const examplePlan = new azure.appservice.Plan("examplePlan", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    kind: "FunctionApp",
    reserved: true,
    sku: {
        tier: "Dynamic",
        size: "Y1",
    },
});
const exampleFunctionApp = new azure.appservice.FunctionApp("exampleFunctionApp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    appServicePlanId: examplePlan.id,
    storageAccountName: exampleAccount.name,
    storageAccountAccessKey: exampleAccount.primaryAccessKey,
    osType: "linux",
    version: "~3",
});
const exampleJob = new azure.streamanalytics.Job("exampleJob", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    streamingUnits: 3,
    transformationQuery: `    SELECT *
    INTO [YourOutputAlias]
    FROM [YourInputAlias]
`,
});
const exampleOutputFunction = new azure.streamanalytics.OutputFunction("exampleOutputFunction", {
    resourceGroupName: exampleJob.resourceGroupName,
    streamAnalyticsJobName: exampleJob.name,
    functionApp: exampleFunctionApp.name,
    functionName: "examplefunctionname",
    apiKey: "exampleapikey",
});

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_plan = azure.appservice.Plan("examplePlan",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    kind="FunctionApp",
    reserved=True,
    sku=azure.appservice.PlanSkuArgs(
        tier="Dynamic",
        size="Y1",
    ))
example_function_app = azure.appservice.FunctionApp("exampleFunctionApp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    app_service_plan_id=example_plan.id,
    storage_account_name=example_account.name,
    storage_account_access_key=example_account.primary_access_key,
    os_type="linux",
    version="~3")
example_job = azure.streamanalytics.Job("exampleJob",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    streaming_units=3,
    transformation_query="""    SELECT *
    INTO [YourOutputAlias]
    FROM [YourInputAlias]
""")
example_output_function = azure.streamanalytics.OutputFunction("exampleOutputFunction",
    resource_group_name=example_job.resource_group_name,
    stream_analytics_job_name=example_job.name,
    function_app=example_function_app.name,
    function_name="examplefunctionname",
    api_key="exampleapikey")

Example coming soon!

Create OutputFunction Resource

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

Constructor syntax

new OutputFunction(name: string, args: OutputFunctionArgs, opts?: CustomResourceOptions);

@overload
def OutputFunction(resource_name: str,
                   args: OutputFunctionArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def OutputFunction(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_key: Optional[str] = None,
                   function_app: Optional[str] = None,
                   function_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   stream_analytics_job_name: Optional[str] = None,
                   batch_max_count: Optional[int] = None,
                   batch_max_in_bytes: Optional[int] = None,
                   name: Optional[str] = None)

func NewOutputFunction(ctx *Context, name string, args OutputFunctionArgs, opts ...ResourceOption) (*OutputFunction, error)

public OutputFunction(string name, OutputFunctionArgs args, CustomResourceOptions? opts = null)

public OutputFunction(String name, OutputFunctionArgs args)
public OutputFunction(String name, OutputFunctionArgs args, CustomResourceOptions options)

type: azure:streamanalytics:OutputFunction
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 OutputFunctionArgs: 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 OutputFunctionArgs: 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 OutputFunctionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OutputFunctionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OutputFunctionArgs: 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 outputFunctionResource = new Azure.StreamAnalytics.OutputFunction("outputFunctionResource", new()
{
    ApiKey = "string",
    FunctionApp = "string",
    FunctionName = "string",
    ResourceGroupName = "string",
    StreamAnalyticsJobName = "string",
    BatchMaxCount = 0,
    BatchMaxInBytes = 0,
    Name = "string",
});

example, err := streamanalytics.NewOutputFunction(ctx, "outputFunctionResource", &streamanalytics.OutputFunctionArgs{
	ApiKey:                 pulumi.String("string"),
	FunctionApp:            pulumi.String("string"),
	FunctionName:           pulumi.String("string"),
	ResourceGroupName:      pulumi.String("string"),
	StreamAnalyticsJobName: pulumi.String("string"),
	BatchMaxCount:          pulumi.Int(0),
	BatchMaxInBytes:        pulumi.Int(0),
	Name:                   pulumi.String("string"),
})

var outputFunctionResource = new OutputFunction("outputFunctionResource", OutputFunctionArgs.builder()
    .apiKey("string")
    .functionApp("string")
    .functionName("string")
    .resourceGroupName("string")
    .streamAnalyticsJobName("string")
    .batchMaxCount(0)
    .batchMaxInBytes(0)
    .name("string")
    .build());

output_function_resource = azure.streamanalytics.OutputFunction("outputFunctionResource",
    api_key="string",
    function_app="string",
    function_name="string",
    resource_group_name="string",
    stream_analytics_job_name="string",
    batch_max_count=0,
    batch_max_in_bytes=0,
    name="string")

const outputFunctionResource = new azure.streamanalytics.OutputFunction("outputFunctionResource", {
    apiKey: "string",
    functionApp: "string",
    functionName: "string",
    resourceGroupName: "string",
    streamAnalyticsJobName: "string",
    batchMaxCount: 0,
    batchMaxInBytes: 0,
    name: "string",
});

type: azure:streamanalytics:OutputFunction
properties:
    apiKey: string
    batchMaxCount: 0
    batchMaxInBytes: 0
    functionApp: string
    functionName: string
    name: string
    resourceGroupName: string
    streamAnalyticsJobName: string

OutputFunction 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 OutputFunction resource accepts the following input properties:

ApiKey string: The API key for the Function.
FunctionApp string: The name of the Function App.
FunctionName string: The name of the function in the Function App.
ResourceGroupName string: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
StreamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
BatchMaxCount int: The maximum number of events in each batch that's sent to the function. Defaults to 100.
BatchMaxInBytes int: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
Name string: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.

ApiKey string: The API key for the Function.
FunctionApp string: The name of the Function App.
FunctionName string: The name of the function in the Function App.
ResourceGroupName string: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
StreamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
BatchMaxCount int: The maximum number of events in each batch that's sent to the function. Defaults to 100.
BatchMaxInBytes int: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
Name string: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.

apiKey String: The API key for the Function.
functionApp String: The name of the Function App.
functionName String: The name of the function in the Function App.
resourceGroupName String: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
streamAnalyticsJobName String: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
batchMaxCount Integer: The maximum number of events in each batch that's sent to the function. Defaults to 100.
batchMaxInBytes Integer: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
name String: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.

apiKey string: The API key for the Function.
functionApp string: The name of the Function App.
functionName string: The name of the function in the Function App.
resourceGroupName string: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
streamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
batchMaxCount number: The maximum number of events in each batch that's sent to the function. Defaults to 100.
batchMaxInBytes number: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
name string: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.

api_key str: The API key for the Function.
function_app str: The name of the Function App.
function_name str: The name of the function in the Function App.
resource_group_name str: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
stream_analytics_job_name str: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
batch_max_count int: The maximum number of events in each batch that's sent to the function. Defaults to 100.
batch_max_in_bytes int: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
name str: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.

apiKey String: The API key for the Function.
functionApp String: The name of the Function App.
functionName String: The name of the function in the Function App.
resourceGroupName String: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
streamAnalyticsJobName String: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
batchMaxCount Number: The maximum number of events in each batch that's sent to the function. Defaults to 100.
batchMaxInBytes Number: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
name String: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.

Outputs

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

Get an existing OutputFunction 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?: OutputFunctionState, opts?: CustomResourceOptions): OutputFunction

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        batch_max_count: Optional[int] = None,
        batch_max_in_bytes: Optional[int] = None,
        function_app: Optional[str] = None,
        function_name: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        stream_analytics_job_name: Optional[str] = None) -> OutputFunction

func GetOutputFunction(ctx *Context, name string, id IDInput, state *OutputFunctionState, opts ...ResourceOption) (*OutputFunction, error)

public static OutputFunction Get(string name, Input<string> id, OutputFunctionState? state, CustomResourceOptions? opts = null)

public static OutputFunction get(String name, Output<String> id, OutputFunctionState state, CustomResourceOptions options)

resources:  _:    type: azure:streamanalytics:OutputFunction    get:      id: ${id}

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:

ApiKey string: The API key for the Function.
BatchMaxCount int: The maximum number of events in each batch that's sent to the function. Defaults to 100.
BatchMaxInBytes int: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
FunctionApp string: The name of the Function App.
FunctionName string: The name of the function in the Function App.
Name string: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
StreamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.

ApiKey string: The API key for the Function.
BatchMaxCount int: The maximum number of events in each batch that's sent to the function. Defaults to 100.
BatchMaxInBytes int: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
FunctionApp string: The name of the Function App.
FunctionName string: The name of the function in the Function App.
Name string: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
StreamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.

apiKey String: The API key for the Function.
batchMaxCount Integer: The maximum number of events in each batch that's sent to the function. Defaults to 100.
batchMaxInBytes Integer: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
functionApp String: The name of the Function App.
functionName String: The name of the function in the Function App.
name String: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.
resourceGroupName String: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
streamAnalyticsJobName String: The name of the Stream Analytics Job. Changing this forces a new resource to be created.

apiKey string: The API key for the Function.
batchMaxCount number: The maximum number of events in each batch that's sent to the function. Defaults to 100.
batchMaxInBytes number: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
functionApp string: The name of the Function App.
functionName string: The name of the function in the Function App.
name string: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.
resourceGroupName string: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
streamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.

api_key str: The API key for the Function.
batch_max_count int: The maximum number of events in each batch that's sent to the function. Defaults to 100.
batch_max_in_bytes int: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
function_app str: The name of the Function App.
function_name str: The name of the function in the Function App.
name str: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.
resource_group_name str: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
stream_analytics_job_name str: The name of the Stream Analytics Job. Changing this forces a new resource to be created.

apiKey String: The API key for the Function.
batchMaxCount Number: The maximum number of events in each batch that's sent to the function. Defaults to 100.
batchMaxInBytes Number: The maximum batch size in bytes that's sent to the function. Defaults to 262144 (256 kB).
functionApp String: The name of the Function App.
functionName String: The name of the function in the Function App.
name String: The name which should be used for this Stream Analytics Output. Changing this forces a new resource to be created.
resourceGroupName String: The name of the Resource Group where the Stream Analytics Output should exist. Changing this forces a new resource to be created.
streamAnalyticsJobName String: The name of the Stream Analytics Job. Changing this forces a new resource to be created.

Import

Stream Analytics Output Functions can be imported using the resource id, e.g.

 $ pulumi import azure:streamanalytics/outputFunction:OutputFunction 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.

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

azure.streamanalytics.OutputFunction

On this page

On this page

Example Usage

Create OutputFunction Resource

Constructor syntax

Parameters

Constructor example

OutputFunction Resource Properties

Inputs

Outputs

Look up Existing OutputFunction Resource

Import

Package Details

On this page

On this page