Microsoft.StreamAnalytics streamingjobs 2016-03-01

The streamingjobs resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.StreamAnalytics/streamingjobs resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.StreamAnalytics/streamingjobs@2016-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    compatibilityLevel: '1.0'
    dataLocale: 'string'
    eventsLateArrivalMaxDelayInSeconds: int
    eventsOutOfOrderMaxDelayInSeconds: int
    eventsOutOfOrderPolicy: 'string'
    functions: [
      {
        name: 'string'
        properties: {
          type: 'string'
          // For remaining properties, see FunctionProperties objects
        }
      }
    ]
    inputs: [
      {
        name: 'string'
        properties: {
          serialization: {
            type: 'string'
            // For remaining properties, see Serialization objects
          }
          type: 'string'
          // For remaining properties, see InputProperties objects
        }
      }
    ]
    outputErrorPolicy: 'string'
    outputs: [
      {
        name: 'string'
        properties: {
          datasource: {
            type: 'string'
            // For remaining properties, see OutputDataSource objects
          }
          serialization: {
            type: 'string'
            // For remaining properties, see Serialization objects
          }
        }
      }
    ]
    outputStartMode: 'string'
    outputStartTime: 'string'
    sku: {
      name: 'Standard'
    }
    transformation: {
      name: 'string'
      properties: {
        query: 'string'
        streamingUnits: int
      }
    }
  }
}

FunctionProperties objects

Set the type property to specify the type of object.

For Scalar, use:

  type: 'Scalar'
  properties: {
    binding: {
      type: 'string'
      // For remaining properties, see FunctionBinding objects
    }
    inputs: [
      {
        dataType: 'string'
        isConfigurationParameter: bool
      }
    ]
    output: {
      dataType: 'string'
    }
  }

FunctionBinding objects

Set the type property to specify the type of object.

For Microsoft.MachineLearning/WebService, use:

  type: 'Microsoft.MachineLearning/WebService'
  properties: {
    apiKey: 'string'
    batchSize: int
    endpoint: 'string'
    inputs: {
      columnNames: [
        {
          dataType: 'string'
          mapTo: int
          name: 'string'
        }
      ]
      name: 'string'
    }
    outputs: [
      {
        dataType: 'string'
        name: 'string'
      }
    ]
  }

For Microsoft.StreamAnalytics/JavascriptUdf, use:

  type: 'Microsoft.StreamAnalytics/JavascriptUdf'
  properties: {
    script: 'string'
  }

InputProperties objects

Set the type property to specify the type of object.

For Reference, use:

  type: 'Reference'
  datasource: {
    type: 'string'
    // For remaining properties, see ReferenceInputDataSource objects
  }

For Stream, use:

  type: 'Stream'
  datasource: {
    type: 'string'
    // For remaining properties, see StreamInputDataSource objects
  }

Serialization objects

Set the type property to specify the type of object.

For Avro, use:

  type: 'Avro'
  properties: any()

For Csv, use:

  type: 'Csv'
  properties: {
    encoding: 'UTF8'
    fieldDelimiter: 'string'
  }

For Json, use:

  type: 'Json'
  properties: {
    encoding: 'UTF8'
    format: 'string'
  }

ReferenceInputDataSource objects

Set the type property to specify the type of object.

For Microsoft.Storage/Blob, use:

  type: 'Microsoft.Storage/Blob'
  properties: {
    container: 'string'
    dateFormat: 'string'
    pathPattern: 'string'
    storageAccounts: [
      {
        accountKey: 'string'
        accountName: 'string'
      }
    ]
    timeFormat: 'string'
  }

StreamInputDataSource objects

Set the type property to specify the type of object.

For Microsoft.Devices/IotHubs, use:

  type: 'Microsoft.Devices/IotHubs'
  properties: {
    consumerGroupName: 'string'
    endpoint: 'string'
    iotHubNamespace: 'string'
    sharedAccessPolicyKey: 'string'
    sharedAccessPolicyName: 'string'
  }

For Microsoft.ServiceBus/EventHub, use:

  type: 'Microsoft.ServiceBus/EventHub'
  properties: {
    consumerGroupName: 'string'
    eventHubName: 'string'
    serviceBusNamespace: 'string'
    sharedAccessPolicyKey: 'string'
    sharedAccessPolicyName: 'string'
  }

For Microsoft.Storage/Blob, use:

  type: 'Microsoft.Storage/Blob'
  properties: {
    container: 'string'
    dateFormat: 'string'
    pathPattern: 'string'
    sourcePartitionCount: int
    storageAccounts: [
      {
        accountKey: 'string'
        accountName: 'string'
      }
    ]
    timeFormat: 'string'
  }

OutputDataSource objects

Set the type property to specify the type of object.

For Microsoft.DataLake/Accounts, use:

  type: 'Microsoft.DataLake/Accounts'
  properties: {
    accountName: 'string'
    dateFormat: 'string'
    filePathPrefix: 'string'
    refreshToken: 'string'
    tenantId: 'string'
    timeFormat: 'string'
    tokenUserDisplayName: 'string'
    tokenUserPrincipalName: 'string'
  }

For Microsoft.ServiceBus/EventHub, use:

  type: 'Microsoft.ServiceBus/EventHub'
  properties: {
    eventHubName: 'string'
    partitionKey: 'string'
    serviceBusNamespace: 'string'
    sharedAccessPolicyKey: 'string'
    sharedAccessPolicyName: 'string'
  }

For Microsoft.ServiceBus/Queue, use:

  type: 'Microsoft.ServiceBus/Queue'
  properties: {
    propertyColumns: [ 'string' ]
    queueName: 'string'
    serviceBusNamespace: 'string'
    sharedAccessPolicyKey: 'string'
    sharedAccessPolicyName: 'string'
  }

For Microsoft.ServiceBus/Topic, use:

  type: 'Microsoft.ServiceBus/Topic'
  properties: {
    propertyColumns: [ 'string' ]
    serviceBusNamespace: 'string'
    sharedAccessPolicyKey: 'string'
    sharedAccessPolicyName: 'string'
    topicName: 'string'
  }

For Microsoft.Sql/Server/Database, use:

  type: 'Microsoft.Sql/Server/Database'
  properties: {
    database: 'string'
    password: 'string'
    server: 'string'
    table: 'string'
    user: 'string'
  }

For Microsoft.Storage/Blob, use:

  type: 'Microsoft.Storage/Blob'
  properties: {
    container: 'string'
    dateFormat: 'string'
    pathPattern: 'string'
    storageAccounts: [
      {
        accountKey: 'string'
        accountName: 'string'
      }
    ]
    timeFormat: 'string'
  }

For Microsoft.Storage/DocumentDB, use:

  type: 'Microsoft.Storage/DocumentDB'
  properties: {
    accountId: 'string'
    accountKey: 'string'
    collectionNamePattern: 'string'
    database: 'string'
    documentId: 'string'
    partitionKey: 'string'
  }

For Microsoft.Storage/Table, use:

  type: 'Microsoft.Storage/Table'
  properties: {
    accountKey: 'string'
    accountName: 'string'
    batchSize: int
    columnsToRemove: [ 'string' ]
    partitionKey: 'string'
    rowKey: 'string'
    table: 'string'
  }

For PowerBI, use:

  type: 'PowerBI'
  properties: {
    dataset: 'string'
    groupId: 'string'
    groupName: 'string'
    refreshToken: 'string'
    table: 'string'
    tokenUserDisplayName: 'string'
    tokenUserPrincipalName: 'string'
  }

Property values

streamingjobs

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.StreamAnalytics/streamingjobs'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2016-03-01'
name The resource name string (required)
location The geo-location where the resource lives string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties The properties that are associated with a streaming job. StreamingJobProperties

StreamingJobProperties

Name Description Value
compatibilityLevel Controls certain runtime behaviors of the streaming job. '1.0'
dataLocale 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/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified. string
eventsLateArrivalMaxDelayInSeconds 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. int
eventsOutOfOrderMaxDelayInSeconds The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. int
eventsOutOfOrderPolicy Indicates the policy to apply to events that arrive out of order in the input event stream. 'Adjust'
'Drop'
functions 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. Function[]
inputs 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. Input[]
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). 'Drop'
'Stop'
outputs 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. Output[]
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. 'CustomTime'
'JobStartTime'
'LastOutputEventTime'
outputStartTime 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. string
sku The properties that are associated with a SKU. Sku
transformation A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. Transformation

Function

Name Description Value
name Resource name string
properties The properties that are associated with a function. FunctionProperties

FunctionProperties

Name Description Value
type Set the object type Scalar

ScalarFunctionProperties

Name Description Value
type Indicates the type of function. 'Scalar'
properties Describes the configuration of the scalar function. ScalarFunctionConfiguration

ScalarFunctionConfiguration

Name Description Value
binding The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. FunctionBinding
inputs A list of inputs describing the parameters of the function. FunctionInput[]
output Describes the output of a function. FunctionOutput

FunctionBinding

Name Description Value
type Set the object type Microsoft.MachineLearning/WebService
Microsoft.StreamAnalytics/JavascriptUdf

AzureMachineLearningWebServiceFunctionBinding

Name Description Value
type Indicates the function binding type. 'Microsoft.MachineLearning/WebService'
properties The binding properties associated with an Azure Machine learning web service. AzureMachineLearningWebServiceFunctionBindingProperties

AzureMachineLearningWebServiceFunctionBindingProperties

Name Description Value
apiKey The API key used to authenticate with Request-Response endpoint. string
batchSize Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000. int
endpoint The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: /azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs string
inputs The inputs for the Azure Machine Learning web service endpoint. AzureMachineLearningWebServiceInputs
outputs A list of outputs from the Azure Machine Learning web service endpoint execution. AzureMachineLearningWebServiceOutputColumn[]

AzureMachineLearningWebServiceInputs

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

AzureMachineLearningWebServiceInputColumn

Name Description Value
dataType 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/library/azure/dn905923.aspx . string
mapTo The zero based index of the function parameter this input maps to. int
name The name of the input column. string

AzureMachineLearningWebServiceOutputColumn

Name Description Value
dataType 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/library/azure/dn905923.aspx . string
name The name of the output column. string

JavaScriptFunctionBinding

Name Description Value
type Indicates the function binding type. 'Microsoft.StreamAnalytics/JavascriptUdf'
properties The binding properties associated with a JavaScript function. JavaScriptFunctionBindingProperties

JavaScriptFunctionBindingProperties

Name Description Value
script The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' string

FunctionInput

Name Description Value
dataType 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/library/azure/dn835065.aspx string
isConfigurationParameter A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. bool

FunctionOutput

Name Description Value
dataType 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/library/azure/dn835065.aspx string

Input

Name Description Value
name Resource name string
properties The properties that are associated with an input. InputProperties

InputProperties

Name Description Value
serialization Describes how data from an input is serialized or how data is serialized when written to an output. Serialization
type Set the object type Reference
Stream

Serialization

Name Description Value
type Set the object type Avro
Csv
Json

AvroSerialization

Name Description Value
type Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. 'Avro'
properties Any object For Bicep, you can use the any() function.

CsvSerialization

Name Description Value
type Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. 'Csv'
properties The properties that are associated with the CSV serialization type. CsvSerializationProperties

CsvSerializationProperties

Name Description Value
encoding Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. 'UTF8'
fieldDelimiter Specifies the delimiter that will be used to separate comma-separated value (CSV) records. See /rest/api/streamanalytics/stream-analytics-input or /rest/api/streamanalytics/stream-analytics-output for a list of supported values. Required on PUT (CreateOrReplace) requests. string

JsonSerialization

Name Description Value
type Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. 'Json'
properties The properties that are associated with the JSON serialization type. JsonSerializationProperties

JsonSerializationProperties

Name Description Value
encoding Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. 'UTF8'
format 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. 'Array'
'LineSeparated'

ReferenceInputProperties

Name Description Value
type Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. 'Reference'
datasource Describes an input data source that contains reference data. ReferenceInputDataSource

ReferenceInputDataSource

Name Description Value
type Set the object type Microsoft.Storage/Blob

BlobReferenceInputDataSource

Name Description Value
type Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. 'Microsoft.Storage/Blob'
properties The properties that are associated with a blob input containing reference data. BlobReferenceInputDataSourceProperties

BlobReferenceInputDataSourceProperties

Name Description Value
container 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. string
dateFormat The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. string
pathPattern 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 /rest/api/streamanalytics/stream-analytics-input or /rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example. string
storageAccounts A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. StorageAccount[]
timeFormat The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. string

StorageAccount

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

StreamInputProperties

Name Description Value
type Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. 'Stream'
datasource Describes an input data source that contains stream data. StreamInputDataSource

StreamInputDataSource

Name Description Value
type Set the object type Microsoft.Devices/IotHubs
Microsoft.ServiceBus/EventHub
Microsoft.Storage/Blob

IoTHubStreamInputDataSource

Name Description Value
type Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. 'Microsoft.Devices/IotHubs'
properties The properties that are associated with a IoT Hub input containing stream data. IoTHubStreamInputDataSourceProperties

IoTHubStreamInputDataSourceProperties

Name Description Value
consumerGroupName 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. string
endpoint The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.). string
iotHubNamespace The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyKey The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyName The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests. string

EventHubStreamInputDataSource

Name Description Value
type Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. 'Microsoft.ServiceBus/EventHub'
properties The properties that are associated with a Event Hub input containing stream data. EventHubStreamInputDataSourceProperties

EventHubStreamInputDataSourceProperties

Name Description Value
consumerGroupName 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. string
eventHubName The name of the Event Hub. Required on PUT (CreateOrReplace) requests. string
serviceBusNamespace The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyKey The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyName The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. string

BlobStreamInputDataSource

Name Description Value
type Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. 'Microsoft.Storage/Blob'
properties The properties that are associated with a blob input containing stream data. BlobStreamInputDataSourceProperties

BlobStreamInputDataSourceProperties

Name Description Value
container 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. string
dateFormat The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. string
pathPattern 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 /rest/api/streamanalytics/stream-analytics-input or /rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example. string
sourcePartitionCount The partition count of the blob input data source. Range 1 - 256. int
storageAccounts A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. StorageAccount[]
timeFormat The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. string

Output

Name Description Value
name Resource name string
properties The properties that are associated with an output. OutputProperties

OutputProperties

Name Description Value
datasource Describes the data source that output will be written to. OutputDataSource
serialization Describes how data from an input is serialized or how data is serialized when written to an output. Serialization

OutputDataSource

Name Description Value
type Set the object type Microsoft.DataLake/Accounts
Microsoft.ServiceBus/EventHub
Microsoft.ServiceBus/Queue
Microsoft.ServiceBus/Topic
Microsoft.Sql/Server/Database
Microsoft.Storage/Blob
Microsoft.Storage/DocumentDB
Microsoft.Storage/Table
PowerBI

AzureDataLakeStoreOutputDataSource

Name Description Value
type Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. 'Microsoft.DataLake/Accounts'
properties The properties that are associated with an Azure Data Lake Store. AzureDataLakeStoreOutputDataSourceProperties

AzureDataLakeStoreOutputDataSourceProperties

Name Description Value
accountName The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. string
dateFormat The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. string
filePathPrefix The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. string
refreshToken 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. string
tenantId The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. string
timeFormat The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. string
tokenUserDisplayName 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. string
tokenUserPrincipalName 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. string

EventHubOutputDataSource

Name Description Value
type Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. 'Microsoft.ServiceBus/EventHub'
properties The properties that are associated with an Event Hub output. EventHubOutputDataSourceProperties

EventHubOutputDataSourceProperties

Name Description Value
eventHubName The name of the Event Hub. Required on PUT (CreateOrReplace) requests. string
partitionKey The key/column that is used to determine to which partition to send event data. string
serviceBusNamespace The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyKey The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyName The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. string

ServiceBusQueueOutputDataSource

Name Description Value
type Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. 'Microsoft.ServiceBus/Queue'
properties The properties that are associated with a Service Bus Queue output. ServiceBusQueueOutputDataSourceProperties

ServiceBusQueueOutputDataSourceProperties

Name Description Value
propertyColumns A string array of the names of output columns to be attached to Service Bus messages as custom properties. string[]
queueName The name of the Service Bus Queue. Required on PUT (CreateOrReplace) requests. string
serviceBusNamespace The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyKey The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyName The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. string

ServiceBusTopicOutputDataSource

Name Description Value
type Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. 'Microsoft.ServiceBus/Topic'
properties The properties that are associated with a Service Bus Topic output. ServiceBusTopicOutputDataSourceProperties

ServiceBusTopicOutputDataSourceProperties

Name Description Value
propertyColumns A string array of the names of output columns to be attached to Service Bus messages as custom properties. string[]
serviceBusNamespace The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyKey The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. string
sharedAccessPolicyName The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. string
topicName The name of the Service Bus Topic. Required on PUT (CreateOrReplace) requests. string

AzureSqlDatabaseOutputDataSource

Name Description Value
type Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. 'Microsoft.Sql/Server/Database'
properties The properties that are associated with an Azure SQL database output. AzureSqlDatabaseOutputDataSourceProperties

AzureSqlDatabaseOutputDataSourceProperties

Name Description Value
database The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. string
password The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. string
server The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. string
table The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. string
user The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. string

BlobOutputDataSource

Name Description Value
type Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. 'Microsoft.Storage/Blob'
properties The properties that are associated with a blob output. BlobOutputDataSourceProperties

BlobOutputDataSourceProperties

Name Description Value
container 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. string
dateFormat The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. string
pathPattern 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 /rest/api/streamanalytics/stream-analytics-input or /rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example. string
storageAccounts A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. StorageAccount[]
timeFormat The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. string

DocumentDbOutputDataSource

Name Description Value
type Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. 'Microsoft.Storage/DocumentDB'
properties The properties that are associated with a DocumentDB output. DocumentDbOutputDataSourceProperties

DocumentDbOutputDataSourceProperties

Name Description Value
accountId The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. string
accountKey The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. string
collectionNamePattern 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 /rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests. string
database The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. string
documentId The name of the field in output events used to specify the primary key which insert or update operations are based on. string
partitionKey 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. string

AzureTableOutputDataSource

Name Description Value
type Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. 'Microsoft.Storage/Table'
properties The properties that are associated with an Azure Table output. AzureTableOutputDataSourceProperties

AzureTableOutputDataSourceProperties

Name Description Value
accountKey The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. string
accountName The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. string
batchSize The number of rows to write to the Azure Table at a time. int
columnsToRemove If specified, each item in the array is the name of a column to remove (if present) from output event entities. string[]
partitionKey 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. string
rowKey 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. string
table The name of the Azure Table. Required on PUT (CreateOrReplace) requests. string

PowerBIOutputDataSource

Name Description Value
type Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. 'PowerBI'
properties The properties that are associated with a Power BI output. PowerBIOutputDataSourceProperties

PowerBIOutputDataSourceProperties

Name Description Value
dataset The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. string
groupId The ID of the Power BI group. string
groupName The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. string
refreshToken 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. string
table The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. string
tokenUserDisplayName 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. string
tokenUserPrincipalName 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. string

Sku

Name Description Value
name The name of the SKU. Required on PUT (CreateOrReplace) requests. 'Standard'

Transformation

Name Description Value
name Resource name string
properties The properties that are associated with a transformation. TransformationProperties

TransformationProperties

Name Description Value
query 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. string
streamingUnits Specifies the number of streaming units that the streaming job uses. int

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Standard Stream Analytics Job

Deploy to Azure
This template creates a Standard Stream Analytics Job without input and output