Microsoft.StreamAnalytics streamingjobs/functions 2016-03-01

  • Article

Bicep resource definition

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

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@2016-03-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    type: 'string'
    // For remaining properties, see FunctionProperties objects
  }
}

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'
  }

Property values

streamingjobs/functions

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 3-63

Valid characters:
Alphanumerics, hyphens, and underscores.
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: streamingjobs
properties The properties that are associated with a function. FunctionProperties

FunctionProperties

Name Description Value
type Set the object type Scalar (required)

ScalarFunctionProperties

Name Description Value
type Indicates the type of function. 'Scalar' (required)
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 The output of the function. FunctionOutput

FunctionBinding

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

AzureMachineLearningWebServiceFunctionBinding

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

AzureMachineLearningWebServiceFunctionBindingPropert...

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: https://docs.microsoft.com/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' (required)
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

ARM template resource definition

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

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 JSON to your template.

{
  "type": "Microsoft.StreamAnalytics/streamingjobs/functions",
  "apiVersion": "2016-03-01",
  "name": "string",
  "properties": {
    "type": "string"
    // For remaining properties, see FunctionProperties objects
  }
}

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"
  }

Property values

streamingjobs/functions

Name Description Value
type The resource type 'Microsoft.StreamAnalytics/streamingjobs/functions'
apiVersion The resource api version '2016-03-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)

Character limit: 3-63

Valid characters:
Alphanumerics, hyphens, and underscores.
properties The properties that are associated with a function. FunctionProperties

FunctionProperties

Name Description Value
type Set the object type Scalar (required)

ScalarFunctionProperties

Name Description Value
type Indicates the type of function. 'Scalar' (required)
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 The output of the function. FunctionOutput

FunctionBinding

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

AzureMachineLearningWebServiceFunctionBinding

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

AzureMachineLearningWebServiceFunctionBindingPropert...

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: https://docs.microsoft.com/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' (required)
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

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.StreamAnalytics/streamingjobs/functions@2016-03-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      type = "string"
      // For remaining properties, see FunctionProperties objects
    }
  })
}

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"
  }

Property values

streamingjobs/functions

Name Description Value
type The resource type "Microsoft.StreamAnalytics/streamingjobs/functions@2016-03-01"
name The resource name string (required)

Character limit: 3-63

Valid characters:
Alphanumerics, hyphens, and underscores.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: streamingjobs
properties The properties that are associated with a function. FunctionProperties

FunctionProperties

Name Description Value
type Set the object type Scalar (required)

ScalarFunctionProperties

Name Description Value
type Indicates the type of function. "Scalar" (required)
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 The output of the function. FunctionOutput

FunctionBinding

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

AzureMachineLearningWebServiceFunctionBinding

Name Description Value
type Indicates the function binding type. "Microsoft.MachineLearning/WebService" (required)
properties The binding properties associated with an Azure Machine learning web service. AzureMachineLearningWebServiceFunctionBindingPropert...

AzureMachineLearningWebServiceFunctionBindingPropert...

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: https://docs.microsoft.com/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" (required)
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