streaming_jobs

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

Overview

Name	streaming_jobs
Type	Resource
Id	azure.stream_analytics.streaming_jobs

Fields

vw_streaming_jobs

Name	Datatype	Description
cluster	text	field from the properties object
compatibility_level	text	field from the properties object
content_storage_policy	text	field from the properties object
created_date	text	field from the properties object
data_locale	text	field from the properties object
etag	text	field from the properties object
events_late_arrival_max_delay_in_seconds	text	field from the properties object
events_out_of_order_max_delay_in_seconds	text	field from the properties object
events_out_of_order_policy	text	field from the properties object
functions	text	field from the properties object
identity	text	Describes how identity is verified
inputs	text	field from the properties object
jobName	text	field from the properties object
job_id	text	field from the properties object
job_state	text	field from the properties object
job_storage_account	text	field from the properties object
job_type	text	field from the properties object
last_output_event_time	text	field from the properties object
location	text	The geo-location where the resource lives
output_error_policy	text	field from the properties object
output_start_mode	text	field from the properties object
output_start_time	text	field from the properties object
outputs	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
transformation	text	field from the properties object

streaming_jobs

Name	Datatype	Description
identity	object	Describes how identity is verified
location	string	The geo-location where the resource lives
properties	object	The properties that are associated with a streaming job.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	jobName, resourceGroupName, subscriptionId	Gets details about the specified streaming job.
list	SELECT	subscriptionId	Lists all of the streaming jobs in the given subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all of the streaming jobs in the specified resource group.
create_or_replace	INSERT	jobName, resourceGroupName, subscriptionId	Creates a streaming job or replaces an already existing streaming job.
delete	DELETE	jobName, resourceGroupName, subscriptionId	Deletes a streaming job.
update	UPDATE	jobName, resourceGroupName, subscriptionId	Updates an existing streaming job. This can be used to partially update (ie. update one or two properties) a streaming job without affecting the rest the job definition.
scale	EXEC	jobName, resourceGroupName, subscriptionId	Scales a streaming job when the job is running.
start	EXEC	jobName, resourceGroupName, subscriptionId	Starts a streaming job. Once a job is started it will start processing input events and produce output.
stop	EXEC	jobName, resourceGroupName, subscriptionId	Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.

SELECT examples

Lists all of the streaming jobs in the given subscription.

vw_streaming_jobs

SELECT
cluster,
compatibility_level,
content_storage_policy,
created_date,
data_locale,
etag,
events_late_arrival_max_delay_in_seconds,
events_out_of_order_max_delay_in_seconds,
events_out_of_order_policy,
functions,
identity,
inputs,
jobName,
job_id,
job_state,
job_storage_account,
job_type,
last_output_event_time,
location,
output_error_policy,
output_start_mode,
output_start_time,
outputs,
provisioning_state,
resourceGroupName,
sku,
subscriptionId,
tags,
transformation
FROM azure.stream_analytics.vw_streaming_jobs
WHERE subscriptionId = '{{ subscriptionId }}';

streaming_jobs

SELECT
identity,
location,
properties,
tags
FROM azure.stream_analytics.streaming_jobs
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.stream_analytics.streaming_jobs (
jobName,
resourceGroupName,
subscriptionId,
tags,
location,
properties,
identity
)
SELECT 
'{{ jobName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: sku
          value:
            - name: name
              value: string
        - name: jobId
          value: string
        - name: provisioningState
          value: string
        - name: jobState
          value: string
        - name: jobType
          value: string
        - name: outputStartMode
          value: []
        - name: outputStartTime
          value: string
        - name: lastOutputEventTime
          value: string
        - name: eventsOutOfOrderPolicy
          value: []
        - name: outputErrorPolicy
          value: []
        - name: eventsOutOfOrderMaxDelayInSeconds
          value: integer
        - name: eventsLateArrivalMaxDelayInSeconds
          value: integer
        - name: dataLocale
          value: string
        - name: compatibilityLevel
          value: []
        - name: createdDate
          value: string
        - name: inputs
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: properties
                value:
                  - name: type
                    value: string
                  - name: serialization
                    value:
                      - name: type
                        value: []
                  - name: diagnostics
                    value:
                      - name: conditions
                        value:
                          - - name: since
                              value: string
                            - name: code
                              value: string
                            - name: message
                              value: string
                  - name: etag
                    value: string
                  - name: compression
                    value:
                      - name: type
                        value: []
                  - name: partitionKey
                    value: string
        - name: transformation
          value:
            - name: id
              value: string
            - name: name
              value: string
            - name: type
              value: string
            - name: properties
              value:
                - name: streamingUnits
                  value: integer
                - name: validStreamingUnits
                  value:
                    - integer
                - name: query
                  value: string
                - name: etag
                  value: string
        - name: outputs
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: properties
                value:
                  - name: datasource
                    value:
                      - name: type
                        value: string
                  - name: timeWindow
                    value: string
                  - name: sizeWindow
                    value: integer
                  - name: etag
                    value: string
        - name: functions
          value:
            - - 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
        - name: etag
          value: string
        - name: jobStorageAccount
          value:
            - name: accountName
              value: string
            - name: accountKey
              value: string
            - name: authenticationMode
              value: []
        - name: contentStoragePolicy
          value: string
        - name: cluster
          value:
            - name: id
              value: string
    - name: identity
      value:
        - name: tenantId
          value: string
        - name: principalId
          value: string
        - name: type
          value: string

UPDATE example

Updates a streaming_jobs resource.

/*+ update */
UPDATE azure.stream_analytics.streaming_jobs
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
jobName = '{{ jobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified streaming_jobs resource.

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