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

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified streaming job.

Name	Datatype	Description
identity	object	Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
location	string	The geo-location where the resource lives
properties	object	The properties that are associated with a streaming job. Required on PUT (CreateOrReplace) requests.
tags	object	Resource tags.

list_by_resource_group

Successfully listed the streaming jobs under the specified resource group.

Name	Datatype	Description
identity	object	Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
location	string	The geo-location where the resource lives
properties	object	The properties that are associated with a streaming job. Required on PUT (CreateOrReplace) requests.
tags	object	Resource tags.

list

Successfully listed the streaming jobs under the given subscription.

Name	Datatype	Description
identity	object	Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
location	string	The geo-location where the resource lives
properties	object	The properties that are associated with a streaming job. Required on PUT (CreateOrReplace) requests.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, jobName	$expand	Gets details about the specified streaming job.
list_by_resource_group	select	subscriptionId, resourceGroupName	$expand	Lists all of the streaming jobs in the specified resource group.
list	select	subscriptionId	$expand	Lists all of the streaming jobs in the given subscription.
create_or_replace	insert	subscriptionId, resourceGroupName, jobName	If-Match, If-None-Match	Creates a streaming job or replaces an already existing streaming job.
update	update	subscriptionId, resourceGroupName, jobName	If-Match	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.
delete	delete	subscriptionId, resourceGroupName, jobName		Deletes a streaming job.
start	exec	subscriptionId, resourceGroupName, jobName		Starts a streaming job. Once a job is started it will start processing input events and produce output.
stop	exec	subscriptionId, resourceGroupName, jobName		Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.
scale	exec	subscriptionId, resourceGroupName, jobName		Scales a streaming job when the job is running.

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
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.
$expand	string	The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'.
If-Match	string	The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
If-None-Match	string	Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

SELECT examples

get

Gets details about the specified streaming job.

SELECT
identity,
location,
properties,
tags
FROM azure.stream_analytics.streaming_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Lists all of the streaming jobs in the specified resource group.

SELECT
identity,
location,
properties,
tags
FROM azure.stream_analytics.streaming_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $expand = '{{ $expand }}'
;

list

Lists all of the streaming jobs in the given subscription.

SELECT
identity,
location,
properties,
tags
FROM azure.stream_analytics.streaming_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_replace

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

INSERT INTO azure.stream_analytics.streaming_jobs (
data__tags,
data__location,
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
jobName,
If-Match,
If-None-Match
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ jobName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: streaming_jobs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the streaming_jobs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the streaming_jobs resource.
    - name: jobName
      value: string
      description: Required parameter for the streaming_jobs resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        The properties that are associated with a streaming job.  Required on PUT (CreateOrReplace) requests.
    - name: identity
      value: object
      description: |
        Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
    - name: If-Match
      value: string
      description: The ETag of the streaming job. Omit this value to always overwrite the current record set. 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 streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

UPDATE examples

update

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.

UPDATE azure.stream_analytics.streaming_jobs
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobName = '{{ jobName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Deletes a streaming job.

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

Lifecycle Methods

start

Starts a streaming job. Once a job is started it will start processing input events and produce output.

EXEC azure.stream_analytics.streaming_jobs.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required 
@@json=
'{
"outputStartMode": "{{ outputStartMode }}", 
"outputStartTime": "{{ outputStartTime }}"
}'
;

stop

Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.

EXEC azure.stream_analytics.streaming_jobs.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required
;

scale

Scales a streaming job when the job is running.

EXEC azure.stream_analytics.streaming_jobs.scale 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required 
@@json=
'{
"streamingUnits": {{ streamingUnits }}
}'
;