Streaming Jobs - Create Or Replace

Reference

Service:: Stream Analytics

API Version:: 2020-03-01

Creates a streaming job or replaces an already existing streaming job.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}?api-version=2020-03-01

URI Parameters

Name	In	Required	Type	Description
jobName	path	True	string	The name of the streaming job.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Header

Name	Required	Type	Description
If-Match		string	The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
If-None-Match		string	Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

Request Body

Name	Type	Description
identity	Identity	Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
location	string	The geo-location where the resource lives
properties.cluster	ClusterInfo	The cluster which streaming jobs will run on.
properties.compatibilityLevel	CompatibilityLevel	Controls certain runtime behaviors of the streaming job.
properties.contentStoragePolicy	ContentStoragePolicy	Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .
properties.dataLocale	string	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.
properties.eventsLateArrivalMaxDelayInSeconds	integer	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.
properties.eventsOutOfOrderMaxDelayInSeconds	integer	The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.
properties.eventsOutOfOrderPolicy	EventsOutOfOrderPolicy	Indicates the policy to apply to events that arrive out of order in the input event stream.
properties.functions	Function[]	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.
properties.inputs	Input[]	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.
properties.jobStorageAccount	JobStorageAccount	The properties that are associated with an Azure Storage account with MSI
properties.jobType	JobType	Describes the type of the job. Valid modes are `Cloud` and 'Edge'.
properties.outputErrorPolicy	OutputErrorPolicy	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).
properties.outputStartMode	OutputStartMode	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.
properties.outputStartTime	string	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.
properties.outputs	Output[]	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.
properties.sku	Sku	Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.
properties.transformation	Transformation	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.
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	StreamingJob	The streaming job was successfully created or replaced. Headers ETag: string
201 Created	StreamingJob	The streaming job was successfully created or replaced. Headers ETag: string
Other Status Codes	Error	Error.

Name

Type

Description

200 OK

StreamingJob

The streaming job was successfully created or replaced.

Headers

ETag: string

201 Created

StreamingJob

The streaming job was successfully created or replaced.

Headers

ETag: string

Other Status Codes

Error

Error.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

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

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

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

Sample request

PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804?api-version=2020-03-01

{
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "yourAccountName",
                  "accountKey": "yourAccountKey=="
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          }
        },
        "name": "inputtest"
      }
    ],
    "transformation": {
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest"
      },
      "name": "transformationtest"
    },
    "outputs": [
      {
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "user": "<user>",
              "password": "userPassword",
              "table": "tableName"
            }
          }
        },
        "name": "outputtest"
      }
    ],
    "functions": []
  },
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  }
}

import com.azure.resourcemanager.streamanalytics.fluent.models.InputInner;
import com.azure.resourcemanager.streamanalytics.fluent.models.OutputInner;
import com.azure.resourcemanager.streamanalytics.fluent.models.TransformationInner;
import com.azure.resourcemanager.streamanalytics.models.AzureSqlDatabaseOutputDataSource;
import com.azure.resourcemanager.streamanalytics.models.BlobStreamInputDataSource;
import com.azure.resourcemanager.streamanalytics.models.CompatibilityLevel;
import com.azure.resourcemanager.streamanalytics.models.Encoding;
import com.azure.resourcemanager.streamanalytics.models.EventsOutOfOrderPolicy;
import com.azure.resourcemanager.streamanalytics.models.JsonSerialization;
import com.azure.resourcemanager.streamanalytics.models.OutputErrorPolicy;
import com.azure.resourcemanager.streamanalytics.models.Sku;
import com.azure.resourcemanager.streamanalytics.models.SkuName;
import com.azure.resourcemanager.streamanalytics.models.StorageAccount;
import com.azure.resourcemanager.streamanalytics.models.StreamInputProperties;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for StreamingJobs CreateOrReplace. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_CompleteJob.json
     */
    /**
     * Sample code: Create a complete streaming job (a streaming job with a transformation, at least 1 input and at
     * least 1 output).
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void createACompleteStreamingJobAStreamingJobWithATransformationAtLeast1InputAndAtLeast1Output(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager
            .streamingJobs()
            .define("sj7804")
            .withRegion("West US")
            .withExistingResourceGroup("sjrg3276")
            .withTags(mapOf("key1", "value1", "key3", "value3", "randomKey", "randomValue"))
            .withSku(new Sku().withName(SkuName.STANDARD))
            .withEventsOutOfOrderPolicy(EventsOutOfOrderPolicy.DROP)
            .withOutputErrorPolicy(OutputErrorPolicy.DROP)
            .withEventsOutOfOrderMaxDelayInSeconds(0)
            .withEventsLateArrivalMaxDelayInSeconds(5)
            .withDataLocale("en-US")
            .withCompatibilityLevel(CompatibilityLevel.ONE_ZERO)
            .withInputs(
                Arrays
                    .asList(
                        new InputInner()
                            .withProperties(
                                new StreamInputProperties()
                                    .withSerialization(new JsonSerialization().withEncoding(Encoding.UTF8))
                                    .withDatasource(
                                        new BlobStreamInputDataSource()
                                            .withStorageAccounts(
                                                Arrays
                                                    .asList(
                                                        new StorageAccount()
                                                            .withAccountName("yourAccountName")
                                                            .withAccountKey("yourAccountKey==")))
                                            .withContainer("containerName")
                                            .withPathPattern("")))
                            .withName("inputtest")))
            .withTransformation(
                new TransformationInner()
                    .withName("transformationtest")
                    .withStreamingUnits(1)
                    .withQuery("Select Id, Name from inputtest"))
            .withOutputs(
                Arrays
                    .asList(
                        new OutputInner()
                            .withName("outputtest")
                            .withDatasource(new AzureSqlDatabaseOutputDataSource())))
            .withFunctions(Arrays.asList())
            .create();
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_CompleteJob.json
func ExampleStreamingJobsClient_BeginCreateOrReplace_createACompleteStreamingJobAStreamingJobWithATransformationAtLeast1InputAndAtLeast1Output() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStreamingJobsClient().BeginCreateOrReplace(ctx, "sjrg3276", "sj7804", armstreamanalytics.StreamingJob{
		Location: to.Ptr("West US"),
		Tags: map[string]*string{
			"key1":      to.Ptr("value1"),
			"key3":      to.Ptr("value3"),
			"randomKey": to.Ptr("randomValue"),
		},
		Properties: &armstreamanalytics.StreamingJobProperties{
			CompatibilityLevel:                 to.Ptr(armstreamanalytics.CompatibilityLevelOne0),
			DataLocale:                         to.Ptr("en-US"),
			EventsLateArrivalMaxDelayInSeconds: to.Ptr[int32](5),
			EventsOutOfOrderMaxDelayInSeconds:  to.Ptr[int32](0),
			EventsOutOfOrderPolicy:             to.Ptr(armstreamanalytics.EventsOutOfOrderPolicyDrop),
			Functions:                          []*armstreamanalytics.Function{},
			Inputs: []*armstreamanalytics.Input{
				{
					Name: to.Ptr("inputtest"),
					Properties: &armstreamanalytics.StreamInputProperties{
						Type: to.Ptr("Stream"),
						Serialization: &armstreamanalytics.JSONSerialization{
							Type: to.Ptr(armstreamanalytics.EventSerializationTypeJSON),
							Properties: &armstreamanalytics.JSONSerializationProperties{
								Encoding: to.Ptr(armstreamanalytics.EncodingUTF8),
							},
						},
						Datasource: &armstreamanalytics.BlobStreamInputDataSource{
							Type: to.Ptr("Microsoft.Storage/Blob"),
							Properties: &armstreamanalytics.BlobStreamInputDataSourceProperties{
								Container:   to.Ptr("containerName"),
								PathPattern: to.Ptr(""),
								StorageAccounts: []*armstreamanalytics.StorageAccount{
									{
										AccountKey:  to.Ptr("yourAccountKey=="),
										AccountName: to.Ptr("yourAccountName"),
									}},
							},
						},
					},
				}},
			OutputErrorPolicy: to.Ptr(armstreamanalytics.OutputErrorPolicyDrop),
			Outputs: []*armstreamanalytics.Output{
				{
					Name: to.Ptr("outputtest"),
					Properties: &armstreamanalytics.OutputProperties{
						Datasource: &armstreamanalytics.AzureSQLDatabaseOutputDataSource{
							Type: to.Ptr("Microsoft.Sql/Server/Database"),
							Properties: &armstreamanalytics.AzureSQLDatabaseOutputDataSourceProperties{
								Database: to.Ptr("databaseName"),
								Password: to.Ptr("userPassword"),
								Server:   to.Ptr("serverName"),
								Table:    to.Ptr("tableName"),
								User:     to.Ptr("<user>"),
							},
						},
					},
				}},
			SKU: &armstreamanalytics.SKU{
				Name: to.Ptr(armstreamanalytics.SKUNameStandard),
			},
			Transformation: &armstreamanalytics.Transformation{
				Name: to.Ptr("transformationtest"),
				Properties: &armstreamanalytics.TransformationProperties{
					Query:          to.Ptr("Select Id, Name from inputtest"),
					StreamingUnits: to.Ptr[int32](1),
				},
			},
		},
	}, &armstreamanalytics.StreamingJobsClientBeginCreateOrReplaceOptions{IfMatch: nil,
		IfNoneMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StreamingJob = armstreamanalytics.StreamingJob{
	// 	Name: to.Ptr("sj7804"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs"),
	// 	ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key3": to.Ptr("value3"),
	// 		"randomKey": to.Ptr("randomValue"),
	// 	},
	// 	Properties: &armstreamanalytics.StreamingJobProperties{
	// 		CompatibilityLevel: to.Ptr(armstreamanalytics.CompatibilityLevelOne0),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-11T04:37:11.540Z"); return t}()),
	// 		DataLocale: to.Ptr("en-US"),
	// 		EventsLateArrivalMaxDelayInSeconds: to.Ptr[int32](5),
	// 		EventsOutOfOrderMaxDelayInSeconds: to.Ptr[int32](0),
	// 		EventsOutOfOrderPolicy: to.Ptr(armstreamanalytics.EventsOutOfOrderPolicyDrop),
	// 		Functions: []*armstreamanalytics.Function{
	// 		},
	// 		Inputs: []*armstreamanalytics.Input{
	// 			{
	// 				Name: to.Ptr("inputtest"),
	// 				Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
	// 				ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest"),
	// 				Properties: &armstreamanalytics.StreamInputProperties{
	// 					Type: to.Ptr("Stream"),
	// 					Etag: to.Ptr("ca88f8fa-605b-4c7f-8695-46f5faa60cd0"),
	// 					Serialization: &armstreamanalytics.JSONSerialization{
	// 						Type: to.Ptr(armstreamanalytics.EventSerializationTypeJSON),
	// 						Properties: &armstreamanalytics.JSONSerializationProperties{
	// 							Encoding: to.Ptr(armstreamanalytics.EncodingUTF8),
	// 						},
	// 					},
	// 					Datasource: &armstreamanalytics.BlobStreamInputDataSource{
	// 						Type: to.Ptr("Microsoft.Storage/Blob"),
	// 						Properties: &armstreamanalytics.BlobStreamInputDataSourceProperties{
	// 							Container: to.Ptr("containerName"),
	// 							PathPattern: to.Ptr(""),
	// 							StorageAccounts: []*armstreamanalytics.StorageAccount{
	// 								{
	// 									AccountName: to.Ptr("accountName"),
	// 							}},
	// 						},
	// 					},
	// 				},
	// 		}},
	// 		JobID: to.Ptr("732e4b1d-94a7-43ae-8297-3ad04f1540b9"),
	// 		JobState: to.Ptr("Created"),
	// 		OutputErrorPolicy: to.Ptr(armstreamanalytics.OutputErrorPolicyDrop),
	// 		Outputs: []*armstreamanalytics.Output{
	// 			{
	// 				Name: to.Ptr("outputtest"),
	// 				Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/outputs"),
	// 				ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest"),
	// 				Properties: &armstreamanalytics.OutputProperties{
	// 					Datasource: &armstreamanalytics.AzureSQLDatabaseOutputDataSource{
	// 						Type: to.Ptr("Microsoft.Sql/Server/Database"),
	// 						Properties: &armstreamanalytics.AzureSQLDatabaseOutputDataSourceProperties{
	// 							Database: to.Ptr("databaseName"),
	// 							Server: to.Ptr("serverName"),
	// 							Table: to.Ptr("tableName"),
	// 							User: to.Ptr("userName"),
	// 						},
	// 					},
	// 					Etag: to.Ptr("62097c3c-b503-41ff-a56f-196a9598ab90"),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SKU: &armstreamanalytics.SKU{
	// 			Name: to.Ptr(armstreamanalytics.SKUNameStandard),
	// 		},
	// 		Transformation: &armstreamanalytics.Transformation{
	// 			Name: to.Ptr("transformationtest"),
	// 			Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/transformations"),
	// 			ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest"),
	// 			Properties: &armstreamanalytics.TransformationProperties{
	// 				Etag: to.Ptr("91d8fcbe-60b3-49c3-9f21-9942b95602b8"),
	// 				Query: to.Ptr("Select Id, Name from inputtest"),
	// 				StreamingUnits: to.Ptr[int32](1),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a streaming job or replaces an already existing streaming job.
 *
 * @summary Creates a streaming job or replaces an already existing streaming job.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_CompleteJob.json
 */
async function createACompleteStreamingJobAStreamingJobWithATransformationAtLeast1InputAndAtLeast1Output() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg3276";
  const jobName = "sj7804";
  const streamingJob = {
    compatibilityLevel: "1.0",
    dataLocale: "en-US",
    eventsLateArrivalMaxDelayInSeconds: 5,
    eventsOutOfOrderMaxDelayInSeconds: 0,
    eventsOutOfOrderPolicy: "Drop",
    functions: [],
    inputs: [
      {
        name: "inputtest",
        properties: {
          type: "Stream",
          datasource: {
            type: "Microsoft.Storage/Blob",
            container: "containerName",
            pathPattern: "",
            storageAccounts: [{ accountKey: "yourAccountKey==", accountName: "yourAccountName" }],
          },
          serialization: { type: "Json", encoding: "UTF8" },
        },
      },
    ],
    location: "West US",
    outputErrorPolicy: "Drop",
    outputs: [
      {
        name: "outputtest",
        datasource: {
          type: "Microsoft.Sql/Server/Database",
          database: "databaseName",
          password: "userPassword",
          server: "serverName",
          table: "tableName",
          user: "<user>",
        },
      },
    ],
    sku: { name: "Standard" },
    tags: { key1: "value1", key3: "value3", randomKey: "randomValue" },
    transformation: {
      name: "transformationtest",
      query: "Select Id, Name from inputtest",
      streamingUnits: 1,
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.streamingJobs.beginCreateOrReplaceAndWait(
    resourceGroupName,
    jobName,
    streamingJob
  );
  console.log(result);
}

createACompleteStreamingJobAStreamingJobWithATransformationAtLeast1InputAndAtLeast1Output().catch(
  console.error
);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 201

ETag: 87551cc5-1290-4d08-afcd-cdaa92e5ade0

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804",
  "name": "sj7804",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:11.54Z",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
        "name": "inputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "accountName"
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          },
          "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
        }
      }
    ],
    "transformation": {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest",
      "name": "transformationtest",
      "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest",
        "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8"
      }
    },
    "functions": [],
    "outputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest",
        "name": "outputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "table": "tableName",
              "user": "userName"
            }
          },
          "etag": "62097c3c-b503-41ff-a56f-196a9598ab90"
        }
      }
    ]
  }
}

Status code:: 200

ETag: 87551cc5-1290-4d08-afcd-cdaa92e5ade0

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804",
  "name": "sj7804",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:11.54Z",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
        "name": "inputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "accountName"
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          },
          "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
        }
      }
    ],
    "transformation": {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest",
      "name": "transformationtest",
      "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest",
        "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8"
      }
    },
    "functions": [],
    "outputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest",
        "name": "outputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "table": "tableName",
              "user": "userName"
            }
          },
          "etag": "62097c3c-b503-41ff-a56f-196a9598ab90"
        }
      }
    ]
  }
}

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

Sample request

PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59?api-version=2020-03-01

{
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "compatibilityLevel": "1.0",
    "inputs": [],
    "outputs": [],
    "functions": []
  },
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  }
}

import com.azure.resourcemanager.streamanalytics.models.CompatibilityLevel;
import com.azure.resourcemanager.streamanalytics.models.EventsOutOfOrderPolicy;
import com.azure.resourcemanager.streamanalytics.models.OutputErrorPolicy;
import com.azure.resourcemanager.streamanalytics.models.Sku;
import com.azure.resourcemanager.streamanalytics.models.SkuName;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for StreamingJobs CreateOrReplace. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_JobShell.json
     */
    /**
     * Sample code: Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or
     * functions).
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void createAStreamingJobShellAStreamingJobWithNoInputsOutputsTransformationOrFunctions(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager
            .streamingJobs()
            .define("sj59")
            .withRegion("West US")
            .withExistingResourceGroup("sjrg6936")
            .withTags(mapOf("key1", "value1", "key3", "value3", "randomKey", "randomValue"))
            .withSku(new Sku().withName(SkuName.STANDARD))
            .withEventsOutOfOrderPolicy(EventsOutOfOrderPolicy.DROP)
            .withOutputErrorPolicy(OutputErrorPolicy.DROP)
            .withEventsOutOfOrderMaxDelayInSeconds(5)
            .withEventsLateArrivalMaxDelayInSeconds(16)
            .withDataLocale("en-US")
            .withCompatibilityLevel(CompatibilityLevel.ONE_ZERO)
            .withInputs(Arrays.asList())
            .withOutputs(Arrays.asList())
            .withFunctions(Arrays.asList())
            .create();
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_JobShell.json
func ExampleStreamingJobsClient_BeginCreateOrReplace_createAStreamingJobShellAStreamingJobWithNoInputsOutputsTransformationOrFunctions() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStreamingJobsClient().BeginCreateOrReplace(ctx, "sjrg6936", "sj59", armstreamanalytics.StreamingJob{
		Location: to.Ptr("West US"),
		Tags: map[string]*string{
			"key1":      to.Ptr("value1"),
			"key3":      to.Ptr("value3"),
			"randomKey": to.Ptr("randomValue"),
		},
		Properties: &armstreamanalytics.StreamingJobProperties{
			CompatibilityLevel:                 to.Ptr(armstreamanalytics.CompatibilityLevelOne0),
			DataLocale:                         to.Ptr("en-US"),
			EventsLateArrivalMaxDelayInSeconds: to.Ptr[int32](16),
			EventsOutOfOrderMaxDelayInSeconds:  to.Ptr[int32](5),
			EventsOutOfOrderPolicy:             to.Ptr(armstreamanalytics.EventsOutOfOrderPolicyDrop),
			Functions:                          []*armstreamanalytics.Function{},
			Inputs:                             []*armstreamanalytics.Input{},
			OutputErrorPolicy:                  to.Ptr(armstreamanalytics.OutputErrorPolicyDrop),
			Outputs:                            []*armstreamanalytics.Output{},
			SKU: &armstreamanalytics.SKU{
				Name: to.Ptr(armstreamanalytics.SKUNameStandard),
			},
		},
	}, &armstreamanalytics.StreamingJobsClientBeginCreateOrReplaceOptions{IfMatch: nil,
		IfNoneMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StreamingJob = armstreamanalytics.StreamingJob{
	// 	Name: to.Ptr("sj59"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs"),
	// 	ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key3": to.Ptr("value3"),
	// 		"randomKey": to.Ptr("randomValue"),
	// 	},
	// 	Properties: &armstreamanalytics.StreamingJobProperties{
	// 		CompatibilityLevel: to.Ptr(armstreamanalytics.CompatibilityLevelOne0),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-11T04:37:04.697Z"); return t}()),
	// 		DataLocale: to.Ptr("en-US"),
	// 		EventsLateArrivalMaxDelayInSeconds: to.Ptr[int32](16),
	// 		EventsOutOfOrderMaxDelayInSeconds: to.Ptr[int32](5),
	// 		EventsOutOfOrderPolicy: to.Ptr(armstreamanalytics.EventsOutOfOrderPolicyDrop),
	// 		Functions: []*armstreamanalytics.Function{
	// 		},
	// 		Inputs: []*armstreamanalytics.Input{
	// 		},
	// 		JobID: to.Ptr("d53ecc3c-fcb0-485d-9caf-25e20fcb2061"),
	// 		JobState: to.Ptr("Created"),
	// 		OutputErrorPolicy: to.Ptr(armstreamanalytics.OutputErrorPolicyDrop),
	// 		Outputs: []*armstreamanalytics.Output{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SKU: &armstreamanalytics.SKU{
	// 			Name: to.Ptr(armstreamanalytics.SKUNameStandard),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a streaming job or replaces an already existing streaming job.
 *
 * @summary Creates a streaming job or replaces an already existing streaming job.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_JobShell.json
 */
async function createAStreamingJobShellAStreamingJobWithNoInputsOutputsTransformationOrFunctions() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg6936";
  const jobName = "sj59";
  const streamingJob = {
    compatibilityLevel: "1.0",
    dataLocale: "en-US",
    eventsLateArrivalMaxDelayInSeconds: 16,
    eventsOutOfOrderMaxDelayInSeconds: 5,
    eventsOutOfOrderPolicy: "Drop",
    functions: [],
    inputs: [],
    location: "West US",
    outputErrorPolicy: "Drop",
    outputs: [],
    sku: { name: "Standard" },
    tags: { key1: "value1", key3: "value3", randomKey: "randomValue" },
  };
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.streamingJobs.beginCreateOrReplaceAndWait(
    resourceGroupName,
    jobName,
    streamingJob
  );
  console.log(result);
}

createAStreamingJobShellAStreamingJobWithNoInputsOutputsTransformationOrFunctions().catch(
  console.error
);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 201

ETag: 3e6872bc-c9d0-45b6-91b6-da66f1773056

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59",
  "name": "sj59",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:04.697Z",
    "compatibilityLevel": "1.0",
    "inputs": [],
    "functions": [],
    "outputs": []
  }
}

Status code:: 200

ETag: 3e6872bc-c9d0-45b6-91b6-da66f1773056

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59",
  "name": "sj59",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:04.697Z",
    "compatibilityLevel": "1.0",
    "inputs": [],
    "functions": [],
    "outputs": []
  }
}

Definitions

Name	Description
AggregateFunctionProperties	The properties that are associated with an aggregate function.
AuthenticationMode	Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'.
AvroSerialization	Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.
AzureDataLakeStoreOutputDataSource	Describes an Azure Data Lake Store output data source.
AzureFunctionOutputDataSource	Defines the metadata of AzureFunctionOutputDataSource
AzureMachineLearningWebServiceFunctionBinding	The binding to an Azure Machine Learning web service.
AzureMachineLearningWebServiceInputColumn	Describes an input column for the Azure Machine Learning web service endpoint.
AzureMachineLearningWebServiceInputs	The inputs for the Azure Machine Learning web service endpoint.
AzureMachineLearningWebServiceOutputColumn	Describes an output column for the Azure Machine Learning web service endpoint.
AzureSqlDatabaseOutputDataSource	Describes an Azure SQL database output data source.
AzureSqlReferenceInputDataSource	Describes an Azure SQL database reference input data source.
AzureSynapseOutputDataSource	Describes an Azure Synapse output data source.
AzureTableOutputDataSource	Describes an Azure Table output data source.
BlobOutputDataSource	Describes a blob output data source.
BlobReferenceInputDataSource	Describes a blob input data source that contains reference data.
BlobStreamInputDataSource	Describes a blob input data source that contains stream data.
ClusterInfo	The properties associated with a Stream Analytics cluster.
CompatibilityLevel	Controls certain runtime behaviors of the streaming job.
Compression	Describes how input data is compressed
CompressionType	Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests.
ContentStoragePolicy	Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .
CsvSerialization	Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.
DiagnosticCondition	Condition applicable to the resource, or to the job overall, that warrant customer attention.
Diagnostics	Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
DocumentDbOutputDataSource	Describes a DocumentDB output data source.
Encoding	Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output.
Error	Common error representation.
EventHubOutputDataSource	Describes an Event Hub output data source.
EventHubStreamInputDataSource	Describes an Event Hub input data source that contains stream data.
EventHubV2OutputDataSource	Describes an Event Hub output data source.
EventHubV2StreamInputDataSource	Describes an Event Hub input data source that contains stream data.
EventSerializationType	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.
EventsOutOfOrderPolicy	Indicates the policy to apply to events that arrive out of order in the input event stream.
FileReferenceInputDataSource	Describes a file input data source that contains reference data.
Function	A function object, containing all information associated with the named function. All functions are contained under a streaming job.
FunctionInput	Describes one input parameter of a function.
FunctionOutput	Describes the output of a function.
GatewayMessageBusOutputDataSource	Describes a Gateway Message Bus output data source.
GatewayMessageBusStreamInputDataSource	Describes a blob input data source that contains stream data.
Identity	Describes how identity is verified
Input	An input object, containing all information associated with the named input. All inputs are contained under a streaming job.
IoTHubStreamInputDataSource	Describes an IoT Hub input data source that contains stream data.
JavaScriptFunctionBinding	The binding to a JavaScript function.
JobStorageAccount	The properties that are associated with an Azure Storage account with MSI
JobType	Describes the type of the job. Valid modes are `Cloud` and 'Edge'.
JsonOutputSerializationFormat	Specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects.
JsonSerialization	Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.
Output	An output object, containing all information associated with the named output. All outputs are contained under a streaming job.
OutputErrorPolicy	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).
OutputStartMode	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.
ParquetSerialization	Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.
PowerBIOutputDataSource	Describes a Power BI output data source.
ReferenceInputProperties	The properties that are associated with an input containing reference data.
RefreshType	Indicates the type of data refresh option.
ScalarFunctionProperties	The properties that are associated with a scalar function.
ServiceBusQueueOutputDataSource	Describes a Service Bus Queue output data source.
ServiceBusTopicOutputDataSource	Describes a Service Bus Topic output data source.
Sku	The properties that are associated with a SKU.
SkuName	The name of the SKU. Required on PUT (CreateOrReplace) requests.
StorageAccount	The properties that are associated with an Azure Storage account
StreamingJob	A streaming job object, containing all information associated with the named streaming job.
StreamInputProperties	The properties that are associated with an input containing stream data.
Transformation	A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.

AggregateFunctionProperties

The properties that are associated with an aggregate function.

Name	Type	Description
etag	string	The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
properties.binding	FunctionBinding: AzureMachineLearningWebServiceFunctionBinding JavaScriptFunctionBinding	The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
properties.inputs	FunctionInput[]	Describes one input parameter of a function.
properties.output	FunctionOutput	Describes the output of a function.
type	string: Aggregate	Indicates the type of function.

AuthenticationMode

Authentication Mode. Valid modes are ConnectionString, Msi and 'UserToken'.

Name	Type	Description
ConnectionString	string
Msi	string
UserToken	string

AvroSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.

Name	Type	Description
type	string: Avro	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

AzureDataLakeStoreOutputDataSource

Describes an Azure Data Lake Store output data source.

Name	Type	Default value	Description
properties.accountName	string		The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests.
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.dateFormat	string		The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead.
properties.filePathPrefix	string		The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests.
properties.refreshToken	string		A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.
properties.tenantId	string		The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests.
properties.timeFormat	string		The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead.
properties.tokenUserDisplayName	string		The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.
properties.tokenUserPrincipalName	string		The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.
type	string: Microsoft.DataLake/Accounts		Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

AzureFunctionOutputDataSource

Defines the metadata of AzureFunctionOutputDataSource

Name	Type	Description
properties.apiKey	string	If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function.
properties.functionAppName	string	The name of your Azure Functions app.
properties.functionName	string	The name of the function in your Azure Functions app.
properties.maxBatchCount	number	A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100.
properties.maxBatchSize	number	A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB).
type	string: Microsoft.AzureFunction	Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

AzureMachineLearningWebServiceFunctionBinding

The binding to an Azure Machine Learning web service.

Name	Type	Description
properties.apiKey	string	The API key used to authenticate with Request-Response endpoint.
properties.batchSize	integer	Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.
properties.endpoint	string	The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
properties.inputs	AzureMachineLearningWebServiceInputs	The inputs for the Azure Machine Learning web service endpoint.
properties.outputs	AzureMachineLearningWebServiceOutputColumn[]	A list of outputs from the Azure Machine Learning web service endpoint execution.
type	string: Microsoft.MachineLearning/WebService	Indicates the function binding type.

AzureMachineLearningWebServiceInputColumn

Describes an input column for the Azure Machine Learning web service endpoint.

Name	Type	Description
dataType	string	The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
mapTo	integer	The zero based index of the function parameter this input maps to.
name	string	The name of the input column.

AzureMachineLearningWebServiceInputs

The inputs for the Azure Machine Learning web service endpoint.

Name	Type	Description
columnNames	AzureMachineLearningWebServiceInputColumn[]	A list of input columns for the Azure Machine Learning web service endpoint.
name	string	The name of the input. This is the name provided while authoring the endpoint.

AzureMachineLearningWebServiceOutputColumn

Describes an output column for the Azure Machine Learning web service endpoint.

Name	Type	Description
dataType	string	The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
name	string	The name of the output column.

AzureSqlDatabaseOutputDataSource

Describes an Azure SQL database output data source.

Name	Type	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.database	string		The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests.
properties.maxBatchCount	number		Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests.
properties.maxWriterCount	number		Max Writer count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests.
properties.password	string		The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.
properties.server	string		The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests.
properties.table	string		The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests.
properties.user	string		The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.Sql/Server/Database		Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

AzureSqlReferenceInputDataSource

Describes an Azure SQL database reference input data source.

Name	Type	Description
properties.database	string	This element is associated with the datasource element. This is the name of the database that output will be written to.
properties.deltaSnapshotQuery	string	This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database.
properties.fullSnapshotQuery	string	This element is associated with the datasource element. This query is used to fetch data from the sql database.
properties.password	string	This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance.
properties.refreshRate	string	This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format.
properties.refreshType	RefreshType	Indicates the type of data refresh option.
properties.server	string	This element is associated with the datasource element. This is the name of the server that contains the database that will be written to.
properties.table	string	This element is associated with the datasource element. The name of the table in the Azure SQL database..
properties.user	string	This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance.
type	string: Microsoft.Sql/Server/Database	Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests.

AzureSynapseOutputDataSource

Describes an Azure Synapse output data source.

Name	Type	Description
properties.database	string	The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests.
properties.password	string	The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.
properties.server	string	The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests.
properties.table	string	The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests.
properties.user	string	The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.Sql/Server/DataWarehouse	Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

AzureTableOutputDataSource

Describes an Azure Table output data source.

Name	Type	Description
properties.accountKey	string	The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.
properties.accountName	string	The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.
properties.batchSize	integer	The number of rows to write to the Azure Table at a time.
properties.columnsToRemove	string[]	If specified, each item in the array is the name of a column to remove (if present) from output event entities.
properties.partitionKey	string	This element indicates the name of a column from the SELECT statement in the query that will be used as the partition key for the Azure Table. Required on PUT (CreateOrReplace) requests.
properties.rowKey	string	This element indicates the name of a column from the SELECT statement in the query that will be used as the row key for the Azure Table. Required on PUT (CreateOrReplace) requests.
properties.table	string	The name of the Azure Table. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.Storage/Table	Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

BlobOutputDataSource

Describes a blob output data source.

Name	Type	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.blobPathPrefix	string		Blob path prefix.
properties.container	string		The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.
properties.dateFormat	string		The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.
properties.pathPattern	string		The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.
properties.storageAccounts	StorageAccount[]		A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.
properties.timeFormat	string		The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.
type	string: Microsoft.Storage/Blob		Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

BlobReferenceInputDataSource

Describes a blob input data source that contains reference data.

Name	Type	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.container	string		The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.
properties.dateFormat	string		The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.
properties.pathPattern	string		The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.
properties.storageAccounts	StorageAccount[]		A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.
properties.timeFormat	string		The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.
type	string: Microsoft.Storage/Blob		Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests.

BlobStreamInputDataSource

Describes a blob input data source that contains stream data.

Name	Type	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.container	string		The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.
properties.dateFormat	string		The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.
properties.pathPattern	string		The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.
properties.sourcePartitionCount	integer		The partition count of the blob input data source. Range 1 - 1024.
properties.storageAccounts	StorageAccount[]		A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.
properties.timeFormat	string		The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.
type	string: Microsoft.Storage/Blob		Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

ClusterInfo

The properties associated with a Stream Analytics cluster.

Name	Type	Description
id	string	The resource id of cluster.

CompatibilityLevel

Controls certain runtime behaviors of the streaming job.

Name	Type	Description
1.0	string
1.2	string

Compression

Describes how input data is compressed

Name	Type	Default value	Description
type	CompressionType	None	Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests.

CompressionType

Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests.

Name	Type	Description
Deflate	string
GZip	string
None	string

ContentStoragePolicy

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

Name	Type	Description
JobStorageAccount	string
SystemAccount	string

CsvSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.

Name	Type	Description
properties.encoding	Encoding	Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests.
properties.fieldDelimiter	string	Specifies the delimiter that will be used to separate comma-separated value (CSV) records. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a list of supported values. Required on PUT (CreateOrReplace) requests.
type	string: Csv	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

DiagnosticCondition

Condition applicable to the resource, or to the job overall, that warrant customer attention.

Name	Type	Description
code	string	The opaque diagnostic code.
message	string	The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request.
since	string	The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time.

Diagnostics

Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.

Name	Type	Description
conditions	DiagnosticCondition[]	A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention.

DocumentDbOutputDataSource

Describes a DocumentDB output data source.

Name	Type	Description
properties.accountId	string	The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests.
properties.accountKey	string	The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests.
properties.collectionNamePattern	string	The collection name pattern for the collections to be used. The collection name format can be constructed using the optional {partition} token, where partitions start from 0. See the DocumentDB section of https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests.
properties.database	string	The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests.
properties.documentId	string	The name of the field in output events used to specify the primary key which insert or update operations are based on.
properties.partitionKey	string	The name of the field in output events used to specify the key for partitioning output across collections. If 'collectionNamePattern' contains the {partition} token, this property is required to be specified.
type	string: Microsoft.Storage/DocumentDB	Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

Encoding

Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output.

Name	Type	Description
UTF8	string

Error

Common error representation.

Name	Type	Description
error	Error	Error definition properties.

EventHubOutputDataSource

Describes an Event Hub output data source.

Name	Type	Default value	Description
authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.eventHubName	string		The name of the Event Hub. Required on PUT (CreateOrReplace) requests.
properties.partitionKey	string		The key/column that is used to determine to which partition to send event data.
properties.propertyColumns	string[]		The properties associated with this Event Hub output.
serviceBusNamespace	string		The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyKey	string		The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyName	string		The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.ServiceBus/EventHub		Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

EventHubStreamInputDataSource

Describes an Event Hub input data source that contains stream data.

Name	Type	Default value	Description
authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.consumerGroupName	string		The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group.
properties.eventHubName	string		The name of the Event Hub. Required on PUT (CreateOrReplace) requests.
serviceBusNamespace	string		The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyKey	string		The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyName	string		The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.ServiceBus/EventHub		Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

EventHubV2OutputDataSource

Describes an Event Hub output data source.

Name	Type	Default value	Description
authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.eventHubName	string		The name of the Event Hub. Required on PUT (CreateOrReplace) requests.
properties.partitionKey	string		The key/column that is used to determine to which partition to send event data.
properties.propertyColumns	string[]		The properties associated with this Event Hub output.
serviceBusNamespace	string		The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyKey	string		The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyName	string		The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.EventHub/EventHub		Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

EventHubV2StreamInputDataSource

Describes an Event Hub input data source that contains stream data.

Name	Type	Default value	Description
authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.consumerGroupName	string		The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group.
properties.eventHubName	string		The name of the Event Hub. Required on PUT (CreateOrReplace) requests.
serviceBusNamespace	string		The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyKey	string		The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyName	string		The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.EventHub/EventHub		Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

EventSerializationType

Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

Name	Type	Description
Avro	string
Csv	string
Json	string
Parquet	string

EventsOutOfOrderPolicy

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

Name	Type	Description
Adjust	string
Drop	string

FileReferenceInputDataSource

Describes a file input data source that contains reference data.

Name	Type	Description
properties.path	string	The path of the file.
type	string: File	Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests.

Function

A function object, containing all information associated with the named function. All functions are contained under a streaming job.

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties	FunctionProperties: AggregateFunctionProperties ScalarFunctionProperties	The properties that are associated with a function.
type	string	Resource type

FunctionInput

Describes one input parameter of a function.

Name	Type	Description
dataType	string	The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
isConfigurationParameter	boolean	A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false.

FunctionOutput

Describes the output of a function.

Name	Type	Description
dataType	string	The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

GatewayMessageBusOutputDataSource

Describes a Gateway Message Bus output data source.

Name	Type	Description
properties.topic	string	The name of the Service Bus topic.
type	string: GatewayMessageBus	Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

GatewayMessageBusStreamInputDataSource

Describes a blob input data source that contains stream data.

Name	Type	Description
properties.topic	string	The name of the Service Bus topic.
type	string: GatewayMessageBus	Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

Identity

Describes how identity is verified

Name	Type	Description
principalId	string	The identity principal ID
tenantId	string	The identity tenantId
type	string	The identity type

Input

An input object, containing all information associated with the named input. All inputs are contained under a streaming job.

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties	InputProperties: ReferenceInputProperties StreamInputProperties	The properties that are associated with an input. Required on PUT (CreateOrReplace) requests.
type	string	Resource type

IoTHubStreamInputDataSource

Describes an IoT Hub input data source that contains stream data.

Name	Type	Description
properties.consumerGroupName	string	The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group.
properties.endpoint	string	The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
properties.iotHubNamespace	string	The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests.
properties.sharedAccessPolicyKey	string	The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
properties.sharedAccessPolicyName	string	The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.Devices/IotHubs	Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

JavaScriptFunctionBinding

The binding to a JavaScript function.

Name	Type	Description
properties.script	string	The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'
type	string: Microsoft.StreamAnalytics/JavascriptUdf	Indicates the function binding type.

JobStorageAccount

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

Name	Type	Default value	Description
accountKey	string		The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.
accountName	string		The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.
authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.

JobType

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

Name	Type	Description
Cloud	string
Edge	string

JsonOutputSerializationFormat

Specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects.

Name	Type	Description
Array	string
LineSeparated	string

JsonSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.

Name	Type	Description
properties.encoding	Encoding	Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests.
properties.format	JsonOutputSerializationFormat	This property only applies to JSON serialization of outputs only. It is not applicable to inputs. This property specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects. Default value is 'lineSeparated' if left null.
type	string: Json	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

Output

An output object, containing all information associated with the named output. All outputs are contained under a streaming job.

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.datasource	OutputDataSource: AzureDataLakeStoreOutputDataSource AzureFunctionOutputDataSource AzureSqlDatabaseOutputDataSource AzureSynapseOutputDataSource AzureTableOutputDataSource BlobOutputDataSource DocumentDbOutputDataSource EventHubOutputDataSource EventHubV2OutputDataSource GatewayMessageBusOutputDataSource PowerBIOutputDataSource ServiceBusQueueOutputDataSource ServiceBusTopicOutputDataSource	Describes the data source that output will be written to. Required on PUT (CreateOrReplace) requests.
properties.diagnostics	Diagnostics	Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
properties.etag	string	The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
properties.serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.
properties.sizeWindow	integer	The size window to constrain a Stream Analytics output to.
properties.timeWindow	string	The time frame for filtering Stream Analytics job outputs.
type	string	Resource type

OutputErrorPolicy

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).

Name	Type	Description
Drop	string
Stop	string

OutputStartMode

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.

Name	Type	Description
CustomTime	string
JobStartTime	string
LastOutputEventTime	string

ParquetSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.

Name	Type	Description
type	string: Parquet	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

PowerBIOutputDataSource

Describes a Power BI output data source.

Name	Type	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.dataset	string		The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests.
properties.groupId	string		The ID of the Power BI group.
properties.groupName	string		The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.
properties.refreshToken	string		A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.
properties.table	string		The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests.
properties.tokenUserDisplayName	string		The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.
properties.tokenUserPrincipalName	string		The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.
type	string: PowerBI		Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

ReferenceInputProperties

The properties that are associated with an input containing reference data.

Name	Type	Description
compression	Compression	Describes how input data is compressed
datasource	ReferenceInputDataSource: AzureSqlReferenceInputDataSource BlobReferenceInputDataSource FileReferenceInputDataSource	Describes an input data source that contains reference data. Required on PUT (CreateOrReplace) requests.
diagnostics	Diagnostics	Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
etag	string	The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
partitionKey	string	partitionKey Describes a key in the input data which is used for partitioning the input data
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.
type	string: Reference	Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests.

RefreshType

Indicates the type of data refresh option.

Name	Type	Description
RefreshPeriodicallyWithDelta	string
RefreshPeriodicallyWithFull	string
Static	string

ScalarFunctionProperties

The properties that are associated with a scalar function.

Name	Type	Description
etag	string	The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
properties.binding	FunctionBinding: AzureMachineLearningWebServiceFunctionBinding JavaScriptFunctionBinding	The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
properties.inputs	FunctionInput[]	Describes one input parameter of a function.
properties.output	FunctionOutput	Describes the output of a function.
type	string: Scalar	Indicates the type of function.

ServiceBusQueueOutputDataSource

Describes a Service Bus Queue output data source.

Name	Type	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.propertyColumns	string[]		A string array of the names of output columns to be attached to Service Bus messages as custom properties.
properties.queueName	string		The name of the Service Bus Queue. Required on PUT (CreateOrReplace) requests.
properties.serviceBusNamespace	string		The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
properties.sharedAccessPolicyKey	string		The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
properties.sharedAccessPolicyName	string		The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
properties.systemPropertyColumns	object		The system properties associated with the Service Bus Queue. The following system properties are supported: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.
type	string: Microsoft.ServiceBus/Queue		Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

ServiceBusTopicOutputDataSource

Describes a Service Bus Topic output data source.

Name	Type	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.propertyColumns	string[]		A string array of the names of output columns to be attached to Service Bus messages as custom properties.
properties.serviceBusNamespace	string		The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
properties.sharedAccessPolicyKey	string		The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
properties.sharedAccessPolicyName	string		The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
properties.systemPropertyColumns	object		The system properties associated with the Service Bus Topic Output. The following system properties are supported: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.
properties.topicName	string		The name of the Service Bus Topic. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.ServiceBus/Topic		Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

Sku

The properties that are associated with a SKU.

Name	Type	Description
name	SkuName	The name of the SKU. Required on PUT (CreateOrReplace) requests.

SkuName

The name of the SKU. Required on PUT (CreateOrReplace) requests.

Name	Type	Description
Standard	string

StorageAccount

The properties that are associated with an Azure Storage account

Name	Type	Description
accountKey	string	The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.
accountName	string	The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.

StreamingJob

A streaming job object, containing all information associated with the named streaming job.

Name	Type	Description
id	string	Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.cluster	ClusterInfo	The cluster which streaming jobs will run on.
properties.compatibilityLevel	CompatibilityLevel	Controls certain runtime behaviors of the streaming job.
properties.contentStoragePolicy	ContentStoragePolicy	Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .
properties.createdDate	string	Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created.
properties.dataLocale	string	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.
properties.etag	string	The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
properties.eventsLateArrivalMaxDelayInSeconds	integer	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.
properties.eventsOutOfOrderMaxDelayInSeconds	integer	The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.
properties.eventsOutOfOrderPolicy	EventsOutOfOrderPolicy	Indicates the policy to apply to events that arrive out of order in the input event stream.
properties.functions	Function[]	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.
properties.inputs	Input[]	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.
properties.jobId	string	A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job.
properties.jobState	string	Describes the state of the streaming job.
properties.jobStorageAccount	JobStorageAccount	The properties that are associated with an Azure Storage account with MSI
properties.jobType	JobType	Describes the type of the job. Valid modes are `Cloud` and 'Edge'.
properties.lastOutputEventTime	string	Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set.
properties.outputErrorPolicy	OutputErrorPolicy	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).
properties.outputStartMode	OutputStartMode	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.
properties.outputStartTime	string	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.
properties.outputs	Output[]	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.
properties.provisioningState	string	Describes the provisioning status of the streaming job.
properties.sku	Sku	Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.
properties.transformation	Transformation	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.
tags	object	Resource tags.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

StreamInputProperties

The properties that are associated with an input containing stream data.

Name	Type	Description
compression	Compression	Describes how input data is compressed
datasource	StreamInputDataSource: BlobStreamInputDataSource EventHubStreamInputDataSource EventHubV2StreamInputDataSource GatewayMessageBusStreamInputDataSource IoTHubStreamInputDataSource	Describes an input data source that contains stream data. Required on PUT (CreateOrReplace) requests.
diagnostics	Diagnostics	Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
etag	string	The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
partitionKey	string	partitionKey Describes a key in the input data which is used for partitioning the input data
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.
type	string: Stream	Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests.

Transformation

A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.

Name	Type	Default value	Description
id	string		Resource Id
name	string		Resource name
properties.etag	string		The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
properties.query	string		Specifies the query that will be run in the streaming job. You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . Required on PUT (CreateOrReplace) requests.
properties.streamingUnits	integer	3	Specifies the number of streaming units that the streaming job uses.
properties.validStreamingUnits	integer[]		Specifies the valid streaming units a streaming job can scale to.
type	string		Resource type

Share via

Streaming Jobs - Create Or Replace

URI Parameters

Request Header

Request Body

Responses

Security

azure_auth

Scopes

Examples

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

Sample request

Sample response

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

Sample request

Sample response

Definitions

AggregateFunctionProperties

AuthenticationMode

AvroSerialization

AzureDataLakeStoreOutputDataSource

AzureFunctionOutputDataSource

AzureMachineLearningWebServiceFunctionBinding

AzureMachineLearningWebServiceInputColumn

AzureMachineLearningWebServiceInputs

AzureMachineLearningWebServiceOutputColumn

AzureSqlDatabaseOutputDataSource

AzureSqlReferenceInputDataSource

AzureSynapseOutputDataSource

AzureTableOutputDataSource

BlobOutputDataSource

BlobReferenceInputDataSource

BlobStreamInputDataSource

ClusterInfo

CompatibilityLevel

Compression

CompressionType

ContentStoragePolicy

CsvSerialization

DiagnosticCondition

Diagnostics

DocumentDbOutputDataSource

Encoding

Error

EventHubOutputDataSource

EventHubStreamInputDataSource

EventHubV2OutputDataSource

EventHubV2StreamInputDataSource

EventSerializationType

EventsOutOfOrderPolicy

FileReferenceInputDataSource

Function

FunctionInput

FunctionOutput

GatewayMessageBusOutputDataSource

GatewayMessageBusStreamInputDataSource

Identity

Input

IoTHubStreamInputDataSource

JavaScriptFunctionBinding

JobStorageAccount

JobType

JsonOutputSerializationFormat

JsonSerialization

Output

OutputErrorPolicy

OutputStartMode

ParquetSerialization

PowerBIOutputDataSource

ReferenceInputProperties

RefreshType

ScalarFunctionProperties

ServiceBusQueueOutputDataSource

ServiceBusTopicOutputDataSource

Sku

SkuName

StorageAccount

StreamingJob

StreamInputProperties

Transformation