functions

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

Overview

Name	functions
Type	Resource
Id	azure.stream_analytics.functions

Fields

vw_functions

Name	Datatype	Description
id	text	Resource Id
name	text	Resource name
etag	text	field from the properties object
functionName	text	field from the properties object
jobName	text	field from the properties object
properties	text	The properties that are associated with a function.
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	Resource type

functions

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

Name	Accessible by	Required Params	Description
get	SELECT	functionName, jobName, resourceGroupName, subscriptionId	Gets details about the specified function.
list_by_streaming_job	SELECT	jobName, resourceGroupName, subscriptionId	Lists all of the functions under the specified streaming job.
create_or_replace	INSERT	functionName, jobName, resourceGroupName, subscriptionId	Creates a function or replaces an already existing function under an existing streaming job.
delete	DELETE	functionName, jobName, resourceGroupName, subscriptionId	Deletes a function from the streaming job.
update	UPDATE	functionName, jobName, resourceGroupName, subscriptionId	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.
retrieve_default_definition	EXEC	functionName, jobName, resourceGroupName, subscriptionId, data__bindingType	Retrieves the default definition of a function based on the parameters specified.
test	EXEC	functionName, jobName, resourceGroupName, subscriptionId	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.

SELECT examples

Lists all of the functions under the specified streaming job.

vw_functions

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

functions

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

INSERT example

Use the following StackQL query and manifest file to create a new functions resource.

All Properties

/*+ create */
INSERT INTO azure.stream_analytics.functions (
functionName,
jobName,
resourceGroupName,
subscriptionId,
name,
properties
)
SELECT 
'{{ functionName }}',
'{{ jobName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ name }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: type
          value: string
        - name: etag
          value: string
        - name: properties
          value:
            - name: inputs
              value:
                - - name: dataType
                    value: string
                  - name: isConfigurationParameter
                    value: boolean
            - name: output
              value:
                - name: dataType
                  value: string
            - name: binding
              value:
                - name: type
                  value: string

UPDATE example

Updates a functions resource.

/*+ update */
UPDATE azure.stream_analytics.functions
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
functionName = '{{ functionName }}'
AND jobName = '{{ jobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified functions resource.

/*+ delete */
DELETE FROM azure.stream_analytics.functions
WHERE functionName = '{{ functionName }}'
AND jobName = '{{ jobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';