pulumi-azure-native-kotlin/com.pulumi.azurenative.streamanalytics.kotlin/StreamingJobArgs

StreamingJobArgs

data class StreamingJobArgs(val cluster: Output<ClusterInfoArgs>? = null, val compatibilityLevel: Output<Either<String, CompatibilityLevel>>? = null, val contentStoragePolicy: Output<Either<String, ContentStoragePolicy>>? = null, val dataLocale: Output<String>? = null, val eventsLateArrivalMaxDelayInSeconds: Output<Int>? = null, val eventsOutOfOrderMaxDelayInSeconds: Output<Int>? = null, val eventsOutOfOrderPolicy: Output<Either<String, EventsOutOfOrderPolicy>>? = null, val functions: Output<List<FunctionArgs>>? = null, val identity: Output<IdentityArgs>? = null, val inputs: Output<List<InputArgs>>? = null, val jobName: Output<String>? = null, val jobStorageAccount: Output<JobStorageAccountArgs>? = null, val jobType: Output<Either<String, JobType>>? = null, val location: Output<String>? = null, val outputErrorPolicy: Output<Either<String, OutputErrorPolicy>>? = null, val outputStartMode: Output<Either<String, OutputStartMode>>? = null, val outputStartTime: Output<String>? = null, val outputs: Output<List<OutputArgs>>? = null, val resourceGroupName: Output<String>? = null, val sku: Output<SkuArgs>? = null, val tags: Output<Map<String, String>>? = null, val transformation: Output<TransformationArgs>? = null) : ConvertibleToJava<StreamingJobArgs>

A streaming job object, containing all information associated with the named streaming job. Azure REST API version: 2020-03-01. Prior API version in Azure Native 1.x: 2016-03-01. Other available API versions: 2017-04-01-preview, 2021-10-01-preview.

Example Usage

Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var streamingJob = new AzureNative.StreamAnalytics.StreamingJob("streamingJob", new()
    {
        CompatibilityLevel = "1.0",
        DataLocale = "en-US",
        EventsLateArrivalMaxDelayInSeconds = 5,
        EventsOutOfOrderMaxDelayInSeconds = 0,
        EventsOutOfOrderPolicy = "Drop",
        Functions = new[] {},
        Inputs = new[]
        {
            new AzureNative.StreamAnalytics.Inputs.InputArgs
            {
                Name = "inputtest",
                Properties = new AzureNative.StreamAnalytics.Inputs.StreamInputPropertiesArgs
                {
                    Datasource = new AzureNative.StreamAnalytics.Inputs.BlobStreamInputDataSourceArgs
                    {
                        Container = "containerName",
                        PathPattern = "",
                        StorageAccounts = new[]
                        {
                            new AzureNative.StreamAnalytics.Inputs.StorageAccountArgs
                            {
                                AccountKey = "yourAccountKey==",
                                AccountName = "yourAccountName",
                            },
                        },
                        Type = "Microsoft.Storage/Blob",
                    },
                    Serialization = new AzureNative.StreamAnalytics.Inputs.JsonSerializationArgs
                    {
                        Encoding = "UTF8",
                        Type = "Json",
                    },
                    Type = "Stream",
                },
            },
        },
        JobName = "sj7804",
        Location = "West US",
        OutputErrorPolicy = "Drop",
        Outputs = new[]
        {
            new AzureNative.StreamAnalytics.Inputs.OutputArgs
            {
                Datasource = new AzureNative.StreamAnalytics.Inputs.AzureSqlDatabaseOutputDataSourceArgs
                {
                    Database = "databaseName",
                    Password = "userPassword",
                    Server = "serverName",
                    Table = "tableName",
                    Type = "Microsoft.Sql/Server/Database",
                    User = "<user>",
                },
                Name = "outputtest",
            },
        },
        ResourceGroupName = "sjrg3276",
        Sku = new AzureNative.StreamAnalytics.Inputs.SkuArgs
        {
            Name = "Standard",
        },
        Tags =
        {
            { "key1", "value1" },
            { "key3", "value3" },
            { "randomKey", "randomValue" },
        },
        Transformation = new AzureNative.StreamAnalytics.Inputs.TransformationArgs
        {
            Name = "transformationtest",
            Query = "Select Id, Name from inputtest",
            StreamingUnits = 1,
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/streamanalytics/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := streamanalytics.NewStreamingJob(ctx, "streamingJob", &streamanalytics.StreamingJobArgs{
			CompatibilityLevel:                 pulumi.String("1.0"),
			DataLocale:                         pulumi.String("en-US"),
			EventsLateArrivalMaxDelayInSeconds: pulumi.Int(5),
			EventsOutOfOrderMaxDelayInSeconds:  pulumi.Int(0),
			EventsOutOfOrderPolicy:             pulumi.String("Drop"),
			Functions:                          streamanalytics.FunctionTypeArray{},
			Inputs: []streamanalytics.InputTypeArgs{
				{
					Name: pulumi.String("inputtest"),
					Properties: {
						Datasource: {
							Container:   "containerName",
							PathPattern: "",
							StorageAccounts: []streamanalytics.StorageAccount{
								{
									AccountKey:  "yourAccountKey==",
									AccountName: "yourAccountName",
								},
							},
							Type: "Microsoft.Storage/Blob",
						},
						Serialization: {
							Encoding: "UTF8",
							Type:     "Json",
						},
						Type: "Stream",
					},
				},
			},
			JobName:           pulumi.String("sj7804"),
			Location:          pulumi.String("West US"),
			OutputErrorPolicy: pulumi.String("Drop"),
			Outputs: []streamanalytics.OutputTypeArgs{
				{
					Datasource: {
						Database: "databaseName",
						Password: "userPassword",
						Server:   "serverName",
						Table:    "tableName",
						Type:     "Microsoft.Sql/Server/Database",
						User:     "<user>",
					},
					Name: pulumi.String("outputtest"),
				},
			},
			ResourceGroupName: pulumi.String("sjrg3276"),
			Sku: &streamanalytics.SkuArgs{
				Name: pulumi.String("Standard"),
			},
			Tags: pulumi.StringMap{
				"key1":      pulumi.String("value1"),
				"key3":      pulumi.String("value3"),
				"randomKey": pulumi.String("randomValue"),
			},
			Transformation: &streamanalytics.TransformationArgs{
				Name:           pulumi.String("transformationtest"),
				Query:          pulumi.String("Select Id, Name from inputtest"),
				StreamingUnits: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.streamanalytics.StreamingJob;
import com.pulumi.azurenative.streamanalytics.StreamingJobArgs;
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 streamingJob = new StreamingJob("streamingJob", StreamingJobArgs.builder()
            .compatibilityLevel("1.0")
            .dataLocale("en-US")
            .eventsLateArrivalMaxDelayInSeconds(5)
            .eventsOutOfOrderMaxDelayInSeconds(0)
            .eventsOutOfOrderPolicy("Drop")
            .functions()
            .inputs(Map.ofEntries(
                Map.entry("name", "inputtest"),
                Map.entry("properties", Map.ofEntries(
                    Map.entry("datasource", Map.ofEntries(
                        Map.entry("container", "containerName"),
                        Map.entry("pathPattern", ""),
                        Map.entry("storageAccounts", Map.ofEntries(
                            Map.entry("accountKey", "yourAccountKey=="),
                            Map.entry("accountName", "yourAccountName")
                        )),
                        Map.entry("type", "Microsoft.Storage/Blob")
                    )),
                    Map.entry("serialization", Map.ofEntries(
                        Map.entry("encoding", "UTF8"),
                        Map.entry("type", "Json")
                    )),
                    Map.entry("type", "Stream")
                ))
            ))
            .jobName("sj7804")
            .location("West US")
            .outputErrorPolicy("Drop")
            .outputs(Map.ofEntries(
                Map.entry("datasource", Map.ofEntries(
                    Map.entry("database", "databaseName"),
                    Map.entry("password", "userPassword"),
                    Map.entry("server", "serverName"),
                    Map.entry("table", "tableName"),
                    Map.entry("type", "Microsoft.Sql/Server/Database"),
                    Map.entry("user", "<user>")
                )),
                Map.entry("name", "outputtest")
            ))
            .resourceGroupName("sjrg3276")
            .sku(Map.of("name", "Standard"))
            .tags(Map.ofEntries(
                Map.entry("key1", "value1"),
                Map.entry("key3", "value3"),
                Map.entry("randomKey", "randomValue")
            ))
            .transformation(Map.ofEntries(
                Map.entry("name", "transformationtest"),
                Map.entry("query", "Select Id, Name from inputtest"),
                Map.entry("streamingUnits", 1)
            ))
            .build());
    }
}
Content copied to clipboard

Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var streamingJob = new AzureNative.StreamAnalytics.StreamingJob("streamingJob", new()
    {
        CompatibilityLevel = "1.0",
        DataLocale = "en-US",
        EventsLateArrivalMaxDelayInSeconds = 16,
        EventsOutOfOrderMaxDelayInSeconds = 5,
        EventsOutOfOrderPolicy = "Drop",
        Functions = new[] {},
        Inputs = new[] {},
        JobName = "sj59",
        Location = "West US",
        OutputErrorPolicy = "Drop",
        Outputs = new[] {},
        ResourceGroupName = "sjrg6936",
        Sku = new AzureNative.StreamAnalytics.Inputs.SkuArgs
        {
            Name = "Standard",
        },
        Tags =
        {
            { "key1", "value1" },
            { "key3", "value3" },
            { "randomKey", "randomValue" },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/streamanalytics/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := streamanalytics.NewStreamingJob(ctx, "streamingJob", &streamanalytics.StreamingJobArgs{
			CompatibilityLevel:                 pulumi.String("1.0"),
			DataLocale:                         pulumi.String("en-US"),
			EventsLateArrivalMaxDelayInSeconds: pulumi.Int(16),
			EventsOutOfOrderMaxDelayInSeconds:  pulumi.Int(5),
			EventsOutOfOrderPolicy:             pulumi.String("Drop"),
			Functions:                          streamanalytics.FunctionTypeArray{},
			Inputs:                             streamanalytics.InputTypeArray{},
			JobName:                            pulumi.String("sj59"),
			Location:                           pulumi.String("West US"),
			OutputErrorPolicy:                  pulumi.String("Drop"),
			Outputs:                            streamanalytics.OutputTypeArray{},
			ResourceGroupName:                  pulumi.String("sjrg6936"),
			Sku: &streamanalytics.SkuArgs{
				Name: pulumi.String("Standard"),
			},
			Tags: pulumi.StringMap{
				"key1":      pulumi.String("value1"),
				"key3":      pulumi.String("value3"),
				"randomKey": pulumi.String("randomValue"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.streamanalytics.StreamingJob;
import com.pulumi.azurenative.streamanalytics.StreamingJobArgs;
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 streamingJob = new StreamingJob("streamingJob", StreamingJobArgs.builder()
            .compatibilityLevel("1.0")
            .dataLocale("en-US")
            .eventsLateArrivalMaxDelayInSeconds(16)
            .eventsOutOfOrderMaxDelayInSeconds(5)
            .eventsOutOfOrderPolicy("Drop")
            .functions()
            .inputs()
            .jobName("sj59")
            .location("West US")
            .outputErrorPolicy("Drop")
            .outputs()
            .resourceGroupName("sjrg6936")
            .sku(Map.of("name", "Standard"))
            .tags(Map.ofEntries(
                Map.entry("key1", "value1"),
                Map.entry("key3", "value3"),
                Map.entry("randomKey", "randomValue")
            ))
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:streamanalytics:StreamingJob sj59 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}
Content copied to clipboard

Constructors

Link copied to clipboard
fun StreamingJobArgs(cluster: Output<ClusterInfoArgs>? = null, compatibilityLevel: Output<Either<String, CompatibilityLevel>>? = null, contentStoragePolicy: Output<Either<String, ContentStoragePolicy>>? = null, dataLocale: Output<String>? = null, eventsLateArrivalMaxDelayInSeconds: Output<Int>? = null, eventsOutOfOrderMaxDelayInSeconds: Output<Int>? = null, eventsOutOfOrderPolicy: Output<Either<String, EventsOutOfOrderPolicy>>? = null, functions: Output<List<FunctionArgs>>? = null, identity: Output<IdentityArgs>? = null, inputs: Output<List<InputArgs>>? = null, jobName: Output<String>? = null, jobStorageAccount: Output<JobStorageAccountArgs>? = null, jobType: Output<Either<String, JobType>>? = null, location: Output<String>? = null, outputErrorPolicy: Output<Either<String, OutputErrorPolicy>>? = null, outputStartMode: Output<Either<String, OutputStartMode>>? = null, outputStartTime: Output<String>? = null, outputs: Output<List<OutputArgs>>? = null, resourceGroupName: Output<String>? = null, sku: Output<SkuArgs>? = null, tags: Output<Map<String, String>>? = null, transformation: Output<TransformationArgs>? = null)

Functions

Link copied to clipboard
open override fun toJava(): StreamingJobArgs

Properties

Link copied to clipboard
val cluster: Output<ClusterInfoArgs>? = null

The cluster which streaming jobs will run on.

Link copied to clipboard
val compatibilityLevel: Output<Either<String, CompatibilityLevel>>? = null

Controls certain runtime behaviors of the streaming job.

Link copied to clipboard
val contentStoragePolicy: Output<Either<String, ContentStoragePolicy>>? = null

Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .

Link copied to clipboard
val dataLocale: Output<String>? = null

The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified.

Link copied to clipboard
val eventsLateArrivalMaxDelayInSeconds: Output<Int>? = null

The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1.

Link copied to clipboard
val eventsOutOfOrderMaxDelayInSeconds: Output<Int>? = null

The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.

Link copied to clipboard
val eventsOutOfOrderPolicy: Output<Either<String, EventsOutOfOrderPolicy>>? = null

Indicates the policy to apply to events that arrive out of order in the input event stream.

Link copied to clipboard
val functions: Output<List<FunctionArgs>>? = null

A list of one or more functions for the streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.

Link copied to clipboard
val identity: Output<IdentityArgs>? = null

Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.

Link copied to clipboard
val inputs: Output<List<InputArgs>>? = null

A list of one or more inputs to the streaming job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input.

Link copied to clipboard
val jobName: Output<String>? = null

The name of the streaming job.

Link copied to clipboard
val jobStorageAccount: Output<JobStorageAccountArgs>? = null

The properties that are associated with an Azure Storage account with MSI

Link copied to clipboard
val jobType: Output<Either<String, JobType>>? = null

Describes the type of the job. Valid modes are Cloud and 'Edge'.

Link copied to clipboard
val location: Output<String>? = null

The geo-location where the resource lives

Link copied to clipboard
val outputErrorPolicy: Output<Either<String, OutputErrorPolicy>>? = null

Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size).

Link copied to clipboard
val outputs: Output<List<OutputArgs>>? = null

A list of one or more outputs for the streaming job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output.

Link copied to clipboard
val outputStartMode: Output<Either<String, OutputStartMode>>? = null

This property should only be utilized when it is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.

Link copied to clipboard
val outputStartTime: Output<String>? = null

Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val sku: Output<SkuArgs>? = null

Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Resource tags.

Link copied to clipboard
val transformation: Output<TransformationArgs>? = null

Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.