functions

Creates, updates, deletes, gets or lists a functions resource.

Overview

Name	functions
Type	Resource
Id	azure.stream_analytics.functions

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified function.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
properties	object	The properties that are associated with a function.
type	string	Resource type

list_by_streaming_job

Successfully listed the functions under the specified streaming job.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
properties	object	The properties that are associated with a function.
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, jobName, functionName		Gets details about the specified function.
list_by_streaming_job	select	subscriptionId, resourceGroupName, jobName	$select	Lists all of the functions under the specified streaming job.
create_or_replace	insert	subscriptionId, resourceGroupName, jobName, functionName	If-Match, If-None-Match	Creates a function or replaces an already existing function under an existing streaming job.
update	update	subscriptionId, resourceGroupName, jobName, functionName	If-Match	Updates an existing function under an existing streaming job. This can be used to partially update (ie. update one or two properties) a function without affecting the rest the job or function definition.
delete	delete	subscriptionId, resourceGroupName, jobName, functionName		Deletes a function from the streaming job.
test	exec	subscriptionId, resourceGroupName, jobName, functionName		Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct.
retrieve_default_definition	exec	subscriptionId, resourceGroupName, jobName, functionName, bindingType		Retrieves the default definition of a function based on the parameters specified.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
functionName	string	The name of the function.
jobName	string	The name of the streaming job.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$select	string	The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or "" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '' as a valid value.
If-Match	string	The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
If-None-Match	string	Set to '*' to allow a new function to be created, but to prevent updating an existing function. Other values will result in a 412 Pre-condition Failed response.

SELECT examples

get

Gets details about the specified function.

SELECT
id,
name,
properties,
type
FROM azure.stream_analytics.functions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND functionName = '{{ functionName }}' -- required
;

list_by_streaming_job

Lists all of the functions under the specified streaming job.

SELECT
id,
name,
properties,
type
FROM azure.stream_analytics.functions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND $select = '{{ $select }}'
;

INSERT examples

create_or_replace

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

INSERT INTO azure.stream_analytics.functions (
data__name,
data__properties,
subscriptionId,
resourceGroupName,
jobName,
functionName,
If-Match,
If-None-Match
)
SELECT 
'{{ name }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ jobName }}',
'{{ functionName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: functions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the functions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the functions resource.
    - name: jobName
      value: string
      description: Required parameter for the functions resource.
    - name: functionName
      value: string
      description: Required parameter for the functions resource.
    - name: name
      value: string
      description: |
        Resource name
    - name: properties
      value: object
      description: |
        The properties that are associated with a function.
    - name: If-Match
      value: string
      description: The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new function to be created, but to prevent updating an existing function. Other values will result in a 412 Pre-condition Failed response.

UPDATE examples

update

Updates an existing function under an existing streaming job. This can be used to partially update (ie. update one or two properties) a function without affecting the rest the job or function definition.

UPDATE azure.stream_analytics.functions
SET 
data__name = '{{ name }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobName = '{{ jobName }}' --required
AND functionName = '{{ functionName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes a function from the streaming job.

DELETE FROM azure.stream_analytics.functions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobName = '{{ jobName }}' --required
AND functionName = '{{ functionName }}' --required
;

Lifecycle Methods

test

Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct.

EXEC azure.stream_analytics.functions.test 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required, 
@functionName='{{ functionName }}' --required 
@@json=
'{
"name": "{{ name }}", 
"properties": "{{ properties }}"
}'
;

retrieve_default_definition

Retrieves the default definition of a function based on the parameters specified.

EXEC azure.stream_analytics.functions.retrieve_default_definition 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required, 
@functionName='{{ functionName }}' --required 
@@json=
'{
"bindingType": "{{ bindingType }}"
}'
;