Microsoft.StreamAnalytics streamingjobs/functions

Article
12/09/2024

Bicep resource definition

The streamingjobs/functions resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.StreamAnalytics/streamingjobs/functions@2021-10-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    properties: {
      binding: {
        type: 'string'
        // For remaining properties, see FunctionBinding objects
      }
      inputs: [
        {
          dataType: 'string'
          isConfigurationParameter: bool
        }
      ]
      output: {
        dataType: 'string'
      }
    }
    type: 'string'
    // For remaining properties, see FunctionProperties objects
  }
}

FunctionBinding objects

Set the type property to specify the type of object.

For Microsoft.MachineLearning/WebService, use:

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

For Microsoft.MachineLearningServices, use:

{
  properties: {
    apiKey: 'string'
    batchSize: int
    endpoint: 'string'
    inputRequestName: 'string'
    inputs: [
      {
        dataType: 'string'
        mapTo: int
        name: 'string'
      }
    ]
    numberOfParallelRequests: int
    outputResponseName: 'string'
    outputs: [
      {
        dataType: 'string'
        mapTo: int
        name: 'string'
      }
    ]
  }
  type: 'Microsoft.MachineLearningServices'
}

For Microsoft.StreamAnalytics/CLRUdf, use:

{
  properties: {
    class: 'string'
    dllPath: 'string'
    method: 'string'
    updateMode: 'string'
  }
  type: 'Microsoft.StreamAnalytics/CLRUdf'
}

For Microsoft.StreamAnalytics/JavascriptUdf, use:

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

FunctionProperties objects

Set the type property to specify the type of object.

For Aggregate, use:

{
  type: 'Aggregate'
}

For Scalar, use:

{
  type: 'Scalar'
}

Property Values

AggregateFunctionProperties

Name	Description	Value
type	Indicates the type of function.	'Aggregate' (required)

AzureMachineLearningServiceFunctionBinding

Name	Description	Value
properties	The binding properties associated with an Azure Machine learning web service.	AzureMachineLearningServiceFunctionBindingProperties
type	Indicates the function binding type.	'Microsoft.MachineLearningServices' (required)

AzureMachineLearningServiceFunctionBindingProperties

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.	string
inputRequestName	Label for the input request object.	string
inputs	The inputs for the Azure Machine Learning web service endpoint.	AzureMachineLearningServiceInputColumn[]
numberOfParallelRequests	The number of parallel requests that will be sent per partition of your job to the machine learning service. Default is 1.	int
outputResponseName	Label for the output request object.	string
outputs	A list of outputs from the Azure Machine Learning web service endpoint execution.	AzureMachineLearningServiceOutputColumn[]

AzureMachineLearningServiceInputColumn

Name	Description	Value
dataType	The (Azure Machine Learning supported) data type of the input column.	string
mapTo	The zero based index of the function parameter this input maps to.	int
name	The name of the input column.	string

AzureMachineLearningServiceOutputColumn

Name	Description	Value
dataType	The (Azure Machine Learning supported) data type of the output column.	string
mapTo	The zero based index of the function parameter this input maps to.	int
name	The name of the output column.	string

AzureMachineLearningStudioFunctionBinding

Name	Description	Value
properties	The binding properties associated with an Azure Machine learning Studio.	AzureMachineLearningStudioFunctionBindingProperties
type	Indicates the function binding type.	'Microsoft.MachineLearning/WebService' (required)

AzureMachineLearningStudioFunctionBindingProperties

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 Studio. 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 Studio endpoint.	AzureMachineLearningStudioInputs
outputs	A list of outputs from the Azure Machine Learning Studio endpoint execution.	AzureMachineLearningStudioOutputColumn[]

AzureMachineLearningStudioInputColumn

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/en-us/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

AzureMachineLearningStudioInputs

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

AzureMachineLearningStudioOutputColumn

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/en-us/library/azure/dn905923.aspx .	string
name	The name of the output column.	string

CSharpFunctionBinding

Name	Description	Value
properties	The binding properties associated with a CSharp function.	CSharpFunctionBindingProperties
type	Indicates the function binding type.	'Microsoft.StreamAnalytics/CLRUdf' (required)

CSharpFunctionBindingProperties

Name	Description	Value
class	The Csharp code containing a single function definition.	string
dllPath	The Csharp code containing a single function definition.	string
method	The Csharp code containing a single function definition.	string
updateMode	Refresh modes for Stream Analytics functions.	'Refreshable' 'Static'

FunctionBinding

Name	Description	Value
type	Set to 'Microsoft.MachineLearning/WebService' for type AzureMachineLearningStudioFunctionBinding. Set to 'Microsoft.MachineLearningServices' for type AzureMachineLearningServiceFunctionBinding. Set to 'Microsoft.StreamAnalytics/CLRUdf' for type CSharpFunctionBinding. Set to 'Microsoft.StreamAnalytics/JavascriptUdf' for type JavaScriptFunctionBinding.	'Microsoft.MachineLearning/WebService' 'Microsoft.MachineLearningServices' 'Microsoft.StreamAnalytics/CLRUdf' 'Microsoft.StreamAnalytics/JavascriptUdf' (required)

FunctionConfiguration

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		FunctionInput[]
output	Describes the output of a function.	FunctionOutput

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/en-us/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/en-us/library/azure/dn835065.aspx	string

FunctionProperties

Name	Description	Value
properties		FunctionConfiguration
type	Set to 'Aggregate' for type AggregateFunctionProperties. Set to 'Scalar' for type ScalarFunctionProperties.	'Aggregate' 'Scalar' (required)

JavaScriptFunctionBinding

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

JavaScriptFunctionBindingProperties

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