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

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.streamanalytics.Job

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Manages a Stream Analytics Job.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleJob = new azure.streamanalytics.Job("example", {
        name: "example-job",
        resourceGroupName: example.name,
        location: example.location,
        compatibilityLevel: "1.2",
        dataLocale: "en-GB",
        eventsLateArrivalMaxDelayInSeconds: 60,
        eventsOutOfOrderMaxDelayInSeconds: 50,
        eventsOutOfOrderPolicy: "Adjust",
        outputErrorPolicy: "Drop",
        streamingUnits: 3,
        tags: {
            environment: "Example",
        },
        transformationQuery: `    SELECT *
        INTO [YourOutputAlias]
        FROM [YourInputAlias]
    `,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_job = azure.streamanalytics.Job("example",
        name="example-job",
        resource_group_name=example.name,
        location=example.location,
        compatibility_level="1.2",
        data_locale="en-GB",
        events_late_arrival_max_delay_in_seconds=60,
        events_out_of_order_max_delay_in_seconds=50,
        events_out_of_order_policy="Adjust",
        output_error_policy="Drop",
        streaming_units=3,
        tags={
            "environment": "Example",
        },
        transformation_query="""    SELECT *
        INTO [YourOutputAlias]
        FROM [YourInputAlias]
    """)
    
    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.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = streamanalytics.NewJob(ctx, "example", &streamanalytics.JobArgs{
    			Name:                               pulumi.String("example-job"),
    			ResourceGroupName:                  example.Name,
    			Location:                           example.Location,
    			CompatibilityLevel:                 pulumi.String("1.2"),
    			DataLocale:                         pulumi.String("en-GB"),
    			EventsLateArrivalMaxDelayInSeconds: pulumi.Int(60),
    			EventsOutOfOrderMaxDelayInSeconds:  pulumi.Int(50),
    			EventsOutOfOrderPolicy:             pulumi.String("Adjust"),
    			OutputErrorPolicy:                  pulumi.String("Drop"),
    			StreamingUnits:                     pulumi.Int(3),
    			Tags: pulumi.StringMap{
    				"environment": pulumi.String("Example"),
    			},
    			TransformationQuery: pulumi.String("    SELECT *\n    INTO [YourOutputAlias]\n    FROM [YourInputAlias]\n"),
    		})
    		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 = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleJob = new Azure.StreamAnalytics.Job("example", new()
        {
            Name = "example-job",
            ResourceGroupName = example.Name,
            Location = example.Location,
            CompatibilityLevel = "1.2",
            DataLocale = "en-GB",
            EventsLateArrivalMaxDelayInSeconds = 60,
            EventsOutOfOrderMaxDelayInSeconds = 50,
            EventsOutOfOrderPolicy = "Adjust",
            OutputErrorPolicy = "Drop",
            StreamingUnits = 3,
            Tags = 
            {
                { "environment", "Example" },
            },
            TransformationQuery = @"    SELECT *
        INTO [YourOutputAlias]
        FROM [YourInputAlias]
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.streamanalytics.Job;
    import com.pulumi.azure.streamanalytics.JobArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleJob = new Job("exampleJob", JobArgs.builder()        
                .name("example-job")
                .resourceGroupName(example.name())
                .location(example.location())
                .compatibilityLevel("1.2")
                .dataLocale("en-GB")
                .eventsLateArrivalMaxDelayInSeconds(60)
                .eventsOutOfOrderMaxDelayInSeconds(50)
                .eventsOutOfOrderPolicy("Adjust")
                .outputErrorPolicy("Drop")
                .streamingUnits(3)
                .tags(Map.of("environment", "Example"))
                .transformationQuery("""
        SELECT *
        INTO [YourOutputAlias]
        FROM [YourInputAlias]
                """)
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleJob:
        type: azure:streamanalytics:Job
        name: example
        properties:
          name: example-job
          resourceGroupName: ${example.name}
          location: ${example.location}
          compatibilityLevel: '1.2'
          dataLocale: en-GB
          eventsLateArrivalMaxDelayInSeconds: 60
          eventsOutOfOrderMaxDelayInSeconds: 50
          eventsOutOfOrderPolicy: Adjust
          outputErrorPolicy: Drop
          streamingUnits: 3
          tags:
            environment: Example
          transformationQuery: |2
                SELECT *
                INTO [YourOutputAlias]
                FROM [YourInputAlias]
    

    Create Job Resource

    new Job(name: string, args: JobArgs, opts?: CustomResourceOptions);
    @overload
    def Job(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            compatibility_level: Optional[str] = None,
            content_storage_policy: Optional[str] = None,
            data_locale: Optional[str] = None,
            events_late_arrival_max_delay_in_seconds: Optional[int] = None,
            events_out_of_order_max_delay_in_seconds: Optional[int] = None,
            events_out_of_order_policy: Optional[str] = None,
            identity: Optional[JobIdentityArgs] = None,
            job_storage_accounts: Optional[Sequence[JobJobStorageAccountArgs]] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            output_error_policy: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            sku_name: Optional[str] = None,
            stream_analytics_cluster_id: Optional[str] = None,
            streaming_units: Optional[int] = None,
            tags: Optional[Mapping[str, str]] = None,
            transformation_query: Optional[str] = None,
            type: Optional[str] = None)
    @overload
    def Job(resource_name: str,
            args: JobArgs,
            opts: Optional[ResourceOptions] = None)
    func NewJob(ctx *Context, name string, args JobArgs, opts ...ResourceOption) (*Job, error)
    public Job(string name, JobArgs args, CustomResourceOptions? opts = null)
    public Job(String name, JobArgs args)
    public Job(String name, JobArgs args, CustomResourceOptions options)
    
    type: azure:streamanalytics:Job
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args JobArgs
    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 JobArgs
    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 JobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ResourceGroupName string
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    TransformationQuery string
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    CompatibilityLevel string

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    ContentStoragePolicy string
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    DataLocale string
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    EventsLateArrivalMaxDelayInSeconds int
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    EventsOutOfOrderMaxDelayInSeconds int
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    EventsOutOfOrderPolicy string
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    Identity JobIdentity
    An identity block as defined below.
    JobStorageAccounts List<JobJobStorageAccount>
    The details of the job storage account. A job_storage_account block as defined below.
    Location string
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    Name string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    OutputErrorPolicy string
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    SkuName string
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    StreamAnalyticsClusterId string
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    StreamingUnits int

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    Tags Dictionary<string, string>
    A mapping of tags assigned to the resource.
    Type string

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    ResourceGroupName string
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    TransformationQuery string
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    CompatibilityLevel string

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    ContentStoragePolicy string
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    DataLocale string
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    EventsLateArrivalMaxDelayInSeconds int
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    EventsOutOfOrderMaxDelayInSeconds int
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    EventsOutOfOrderPolicy string
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    Identity JobIdentityArgs
    An identity block as defined below.
    JobStorageAccounts []JobJobStorageAccountArgs
    The details of the job storage account. A job_storage_account block as defined below.
    Location string
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    Name string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    OutputErrorPolicy string
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    SkuName string
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    StreamAnalyticsClusterId string
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    StreamingUnits int

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    Tags map[string]string
    A mapping of tags assigned to the resource.
    Type string

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    resourceGroupName String
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    transformationQuery String
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    compatibilityLevel String

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    contentStoragePolicy String
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    dataLocale String
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    eventsLateArrivalMaxDelayInSeconds Integer
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    eventsOutOfOrderMaxDelayInSeconds Integer
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    eventsOutOfOrderPolicy String
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    identity JobIdentity
    An identity block as defined below.
    jobStorageAccounts List<JobJobStorageAccount>
    The details of the job storage account. A job_storage_account block as defined below.
    location String
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    name String
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    outputErrorPolicy String
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    skuName String
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    streamAnalyticsClusterId String
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    streamingUnits Integer

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    tags Map<String,String>
    A mapping of tags assigned to the resource.
    type String

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    resourceGroupName string
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    transformationQuery string
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    compatibilityLevel string

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    contentStoragePolicy string
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    dataLocale string
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    eventsLateArrivalMaxDelayInSeconds number
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    eventsOutOfOrderMaxDelayInSeconds number
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    eventsOutOfOrderPolicy string
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    identity JobIdentity
    An identity block as defined below.
    jobStorageAccounts JobJobStorageAccount[]
    The details of the job storage account. A job_storage_account block as defined below.
    location string
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    name string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    outputErrorPolicy string
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    skuName string
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    streamAnalyticsClusterId string
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    streamingUnits number

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    tags {[key: string]: string}
    A mapping of tags assigned to the resource.
    type string

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    resource_group_name str
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    transformation_query str
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    compatibility_level str

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    content_storage_policy str
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    data_locale str
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    events_late_arrival_max_delay_in_seconds int
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    events_out_of_order_max_delay_in_seconds int
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    events_out_of_order_policy str
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    identity JobIdentityArgs
    An identity block as defined below.
    job_storage_accounts Sequence[JobJobStorageAccountArgs]
    The details of the job storage account. A job_storage_account block as defined below.
    location str
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    name str
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    output_error_policy str
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    sku_name str
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    stream_analytics_cluster_id str
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    streaming_units int

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    tags Mapping[str, str]
    A mapping of tags assigned to the resource.
    type str

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    resourceGroupName String
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    transformationQuery String
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    compatibilityLevel String

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    contentStoragePolicy String
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    dataLocale String
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    eventsLateArrivalMaxDelayInSeconds Number
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    eventsOutOfOrderMaxDelayInSeconds Number
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    eventsOutOfOrderPolicy String
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    identity Property Map
    An identity block as defined below.
    jobStorageAccounts List<Property Map>
    The details of the job storage account. A job_storage_account block as defined below.
    location String
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    name String
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    outputErrorPolicy String
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    skuName String
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    streamAnalyticsClusterId String
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    streamingUnits Number

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    tags Map<String>
    A mapping of tags assigned to the resource.
    type String

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Job resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    JobId string
    The Job ID assigned by the Stream Analytics Job.
    Id string
    The provider-assigned unique ID for this managed resource.
    JobId string
    The Job ID assigned by the Stream Analytics Job.
    id String
    The provider-assigned unique ID for this managed resource.
    jobId String
    The Job ID assigned by the Stream Analytics Job.
    id string
    The provider-assigned unique ID for this managed resource.
    jobId string
    The Job ID assigned by the Stream Analytics Job.
    id str
    The provider-assigned unique ID for this managed resource.
    job_id str
    The Job ID assigned by the Stream Analytics Job.
    id String
    The provider-assigned unique ID for this managed resource.
    jobId String
    The Job ID assigned by the Stream Analytics Job.

    Look up Existing Job Resource

    Get an existing Job 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?: JobState, opts?: CustomResourceOptions): Job
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compatibility_level: Optional[str] = None,
            content_storage_policy: Optional[str] = None,
            data_locale: Optional[str] = None,
            events_late_arrival_max_delay_in_seconds: Optional[int] = None,
            events_out_of_order_max_delay_in_seconds: Optional[int] = None,
            events_out_of_order_policy: Optional[str] = None,
            identity: Optional[JobIdentityArgs] = None,
            job_id: Optional[str] = None,
            job_storage_accounts: Optional[Sequence[JobJobStorageAccountArgs]] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            output_error_policy: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            sku_name: Optional[str] = None,
            stream_analytics_cluster_id: Optional[str] = None,
            streaming_units: Optional[int] = None,
            tags: Optional[Mapping[str, str]] = None,
            transformation_query: Optional[str] = None,
            type: Optional[str] = None) -> Job
    func GetJob(ctx *Context, name string, id IDInput, state *JobState, opts ...ResourceOption) (*Job, error)
    public static Job Get(string name, Input<string> id, JobState? state, CustomResourceOptions? opts = null)
    public static Job get(String name, Output<String> id, JobState 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:
    CompatibilityLevel string

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    ContentStoragePolicy string
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    DataLocale string
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    EventsLateArrivalMaxDelayInSeconds int
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    EventsOutOfOrderMaxDelayInSeconds int
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    EventsOutOfOrderPolicy string
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    Identity JobIdentity
    An identity block as defined below.
    JobId string
    The Job ID assigned by the Stream Analytics Job.
    JobStorageAccounts List<JobJobStorageAccount>
    The details of the job storage account. A job_storage_account block as defined below.
    Location string
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    Name string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    OutputErrorPolicy string
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    ResourceGroupName string
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    SkuName string
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    StreamAnalyticsClusterId string
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    StreamingUnits int

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    Tags Dictionary<string, string>
    A mapping of tags assigned to the resource.
    TransformationQuery string
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    Type string

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    CompatibilityLevel string

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    ContentStoragePolicy string
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    DataLocale string
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    EventsLateArrivalMaxDelayInSeconds int
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    EventsOutOfOrderMaxDelayInSeconds int
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    EventsOutOfOrderPolicy string
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    Identity JobIdentityArgs
    An identity block as defined below.
    JobId string
    The Job ID assigned by the Stream Analytics Job.
    JobStorageAccounts []JobJobStorageAccountArgs
    The details of the job storage account. A job_storage_account block as defined below.
    Location string
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    Name string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    OutputErrorPolicy string
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    ResourceGroupName string
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    SkuName string
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    StreamAnalyticsClusterId string
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    StreamingUnits int

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    Tags map[string]string
    A mapping of tags assigned to the resource.
    TransformationQuery string
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    Type string

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    compatibilityLevel String

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    contentStoragePolicy String
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    dataLocale String
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    eventsLateArrivalMaxDelayInSeconds Integer
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    eventsOutOfOrderMaxDelayInSeconds Integer
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    eventsOutOfOrderPolicy String
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    identity JobIdentity
    An identity block as defined below.
    jobId String
    The Job ID assigned by the Stream Analytics Job.
    jobStorageAccounts List<JobJobStorageAccount>
    The details of the job storage account. A job_storage_account block as defined below.
    location String
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    name String
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    outputErrorPolicy String
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    resourceGroupName String
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    skuName String
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    streamAnalyticsClusterId String
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    streamingUnits Integer

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    tags Map<String,String>
    A mapping of tags assigned to the resource.
    transformationQuery String
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    type String

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    compatibilityLevel string

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    contentStoragePolicy string
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    dataLocale string
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    eventsLateArrivalMaxDelayInSeconds number
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    eventsOutOfOrderMaxDelayInSeconds number
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    eventsOutOfOrderPolicy string
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    identity JobIdentity
    An identity block as defined below.
    jobId string
    The Job ID assigned by the Stream Analytics Job.
    jobStorageAccounts JobJobStorageAccount[]
    The details of the job storage account. A job_storage_account block as defined below.
    location string
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    name string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    outputErrorPolicy string
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    resourceGroupName string
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    skuName string
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    streamAnalyticsClusterId string
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    streamingUnits number

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    tags {[key: string]: string}
    A mapping of tags assigned to the resource.
    transformationQuery string
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    type string

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    compatibility_level str

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    content_storage_policy str
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    data_locale str
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    events_late_arrival_max_delay_in_seconds int
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    events_out_of_order_max_delay_in_seconds int
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    events_out_of_order_policy str
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    identity JobIdentityArgs
    An identity block as defined below.
    job_id str
    The Job ID assigned by the Stream Analytics Job.
    job_storage_accounts Sequence[JobJobStorageAccountArgs]
    The details of the job storage account. A job_storage_account block as defined below.
    location str
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    name str
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    output_error_policy str
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    resource_group_name str
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    sku_name str
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    stream_analytics_cluster_id str
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    streaming_units int

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    tags Mapping[str, str]
    A mapping of tags assigned to the resource.
    transformation_query str
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    type str

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    compatibilityLevel String

    Specifies the compatibility level for this job - which controls certain runtime behaviours of the streaming job. Possible values are 1.0, 1.1 and 1.2.

    NOTE: Support for Compatibility Level 1.2 is dependent on a new version of the Stream Analytics API, which being tracked in this issue.

    contentStoragePolicy String
    The policy for storing stream analytics content. Possible values are JobStorageAccount, SystemAccount. Defaults to SystemAccount.
    dataLocale String
    Specifies the Data Locale of the Job, which should be a supported .NET Culture.
    eventsLateArrivalMaxDelayInSeconds Number
    Specifies the maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 (indefinite) to 1814399 (20d 23h 59m 59s). Default is 5.
    eventsOutOfOrderMaxDelayInSeconds Number
    Specifies the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. Supported range is 0 to 599 (9m 59s). Default is 0.
    eventsOutOfOrderPolicy String
    Specifies the policy which should be applied to events which arrive out of order in the input event stream. Possible values are Adjust and Drop. Default is Adjust.
    identity Property Map
    An identity block as defined below.
    jobId String
    The Job ID assigned by the Stream Analytics Job.
    jobStorageAccounts List<Property Map>
    The details of the job storage account. A job_storage_account block as defined below.
    location String
    The Azure Region in which the Resource Group exists. Changing this forces a new resource to be created.
    name String
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    outputErrorPolicy String
    Specifies the policy which should be applied to events which arrive at the output and cannot be written to the external storage due to being malformed (such as missing column values, column values of wrong type or size). Possible values are Drop and Stop. Default is Drop.
    resourceGroupName String
    The name of the Resource Group where the Stream Analytics Job should exist. Changing this forces a new resource to be created.
    skuName String
    The SKU Name to use for the Stream Analytics Job. Possible values are Standard, StandardV2. Defaults to Standard.
    streamAnalyticsClusterId String
    The ID of an existing Stream Analytics Cluster where the Stream Analytics Job should run.
    streamingUnits Number

    Specifies the number of streaming units that the streaming job uses. Supported values are 1, 3, 6 and multiples of 6 up to 120.

    NOTE: streaming_units must be set when type is Cloud.

    tags Map<String>
    A mapping of tags assigned to the resource.
    transformationQuery String
    Specifies the query that will be run in the streaming job, written in Stream Analytics Query Language (SAQL).
    type String

    The type of the Stream Analytics Job. Possible values are Cloud and Edge. Defaults to Cloud. Changing this forces a new resource to be created.

    NOTE: Edge doesn't support stream_analytics_cluster_id and streaming_units.

    Supporting Types

    JobIdentity, JobIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Stream Analytics Job. Possible values are SystemAssigned and UserAssigned.
    IdentityIds List<string>
    The identity id of the user assigned identity to use when type is UserAssigned
    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Stream Analytics Job. Possible values are SystemAssigned and UserAssigned.
    IdentityIds []string
    The identity id of the user assigned identity to use when type is UserAssigned
    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Stream Analytics Job. Possible values are SystemAssigned and UserAssigned.
    identityIds List<String>
    The identity id of the user assigned identity to use when type is UserAssigned
    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    Specifies the type of Managed Service Identity that should be configured on this Stream Analytics Job. Possible values are SystemAssigned and UserAssigned.
    identityIds string[]
    The identity id of the user assigned identity to use when type is UserAssigned
    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Stream Analytics Job. Possible values are SystemAssigned and UserAssigned.
    identity_ids Sequence[str]
    The identity id of the user assigned identity to use when type is UserAssigned
    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Stream Analytics Job. Possible values are SystemAssigned and UserAssigned.
    identityIds List<String>
    The identity id of the user assigned identity to use when type is UserAssigned
    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    JobJobStorageAccount, JobJobStorageAccountArgs

    AccountKey string
    The account key for the Azure storage account.
    AccountName string
    The name of the Azure storage account.
    AuthenticationMode string
    The authentication mode of the storage account. The only supported value is ConnectionString. Defaults to ConnectionString.
    AccountKey string
    The account key for the Azure storage account.
    AccountName string
    The name of the Azure storage account.
    AuthenticationMode string
    The authentication mode of the storage account. The only supported value is ConnectionString. Defaults to ConnectionString.
    accountKey String
    The account key for the Azure storage account.
    accountName String
    The name of the Azure storage account.
    authenticationMode String
    The authentication mode of the storage account. The only supported value is ConnectionString. Defaults to ConnectionString.
    accountKey string
    The account key for the Azure storage account.
    accountName string
    The name of the Azure storage account.
    authenticationMode string
    The authentication mode of the storage account. The only supported value is ConnectionString. Defaults to ConnectionString.
    account_key str
    The account key for the Azure storage account.
    account_name str
    The name of the Azure storage account.
    authentication_mode str
    The authentication mode of the storage account. The only supported value is ConnectionString. Defaults to ConnectionString.
    accountKey String
    The account key for the Azure storage account.
    accountName String
    The name of the Azure storage account.
    authenticationMode String
    The authentication mode of the storage account. The only supported value is ConnectionString. Defaults to ConnectionString.

    Import

    Stream Analytics Job’s can be imported using the resource id, e.g.

    $ pulumi import azure:streamanalytics/job:Job example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.StreamAnalytics/streamingJobs/job1
    

    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.70.0 published on Wednesday, Mar 27, 2024 by Pulumi