outputs

Creates, updates, deletes, gets or lists an outputs resource.

Overview

Name	outputs
Type	Resource
Id	azure.stream_analytics.outputs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
datasource	object	Describes the data source that output will be written to. Required on PUT (CreateOrReplace) requests.
diagnostics	object	Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
etag	string	The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
lastOutputEventTimestamps	array	A list of the last output event times for each output partition. The index of the array corresponds to the partition number.
serialization	object	Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.
sizeWindow	integer	The size window to constrain a Stream Analytics output to.
timeWindow	string	The time frame for filtering Stream Analytics job outputs.
type	string	Resource type.
watermarkSettings	object	Settings which determine whether to send watermarks to downstream.

list_by_streaming_job

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
datasource	object	Describes the data source that output will be written to. Required on PUT (CreateOrReplace) requests.
diagnostics	object	Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
etag	string	The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
lastOutputEventTimestamps	array	A list of the last output event times for each output partition. The index of the array corresponds to the partition number.
serialization	object	Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.
sizeWindow	integer	The size window to constrain a Stream Analytics output to.
timeWindow	string	The time frame for filtering Stream Analytics job outputs.
type	string	Resource type.
watermarkSettings	object	Settings which determine whether to send watermarks to downstream.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, job_name, output_name, subscription_id		Gets details about the specified output.
list_by_streaming_job	select	resource_group_name, job_name, subscription_id	$select	Lists all of the outputs under the specified streaming job.
create_or_replace	insert	resource_group_name, job_name, output_name, subscription_id	If-Match, If-None-Match	Creates an output or replaces an already existing output under an existing streaming job.
update	update	resource_group_name, job_name, output_name, subscription_id	If-Match	Updates an existing output under an existing streaming job. This can be used to partially update (ie. update one or two properties) an output without affecting the rest the job or output definition.
create_or_replace	replace	resource_group_name, job_name, output_name, subscription_id	If-Match, If-None-Match	Creates an output or replaces an already existing output under an existing streaming job.
delete	delete	resource_group_name, job_name, output_name, subscription_id		Deletes an output from the streaming job.
test	exec	resource_group_name, job_name, output_name, subscription_id		Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.

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
job_name	string	The name of the streaming job. Required.
output_name	string	The name of the output. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$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. Default value is None.
If-Match	string	The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. Default value is None.
If-None-Match	string	Set to '*' to allow a new output to be created, but to prevent updating an existing output. Other values will result in a 412 Pre-condition Failed response. Default value is None.

SELECT examples

get

Gets details about the specified output.

SELECT
id,
name,
datasource,
diagnostics,
etag,
lastOutputEventTimestamps,
serialization,
sizeWindow,
timeWindow,
type,
watermarkSettings
FROM azure.stream_analytics.outputs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND job_name = '{{ job_name }}' -- required
AND output_name = '{{ output_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_streaming_job

Lists all of the outputs under the specified streaming job.

SELECT
id,
name,
datasource,
diagnostics,
etag,
lastOutputEventTimestamps,
serialization,
sizeWindow,
timeWindow,
type,
watermarkSettings
FROM azure.stream_analytics.outputs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND job_name = '{{ job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $select = '{{ $select }}'
;

INSERT examples

create_or_replace

Creates an output or replaces an already existing output under an existing streaming job.

INSERT INTO azure.stream_analytics.outputs (
name,
properties,
resource_group_name,
job_name,
output_name,
subscription_id,
If-Match,
If-None-Match
)
SELECT 
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ job_name }}',
'{{ output_name }}',
'{{ subscription_id }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: outputs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the outputs resource.
  - name: job_name
    value: "{{ job_name }}"
    description: Required parameter for the outputs resource.
  - name: output_name
    value: "{{ output_name }}"
    description: Required parameter for the outputs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the outputs resource.
  - name: name
    value: "{{ name }}"
    description: |
      Resource name.
  - name: properties
    value:
      datasource:
        type: "{{ type }}"
      timeWindow: "{{ timeWindow }}"
      sizeWindow: {{ sizeWindow }}
      serialization:
        type: "{{ type }}"
      watermarkSettings:
        watermarkMode: "{{ watermarkMode }}"
        maxWatermarkDifferenceAcrossPartitions: "{{ maxWatermarkDifferenceAcrossPartitions }}"
  - name: If-Match
    value: "{{ If-Match }}"
    description: The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. Default value is None.
    description: The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. Default value is None.
  - name: If-None-Match
    value: "{{ If-None-Match }}"
    description: Set to '*' to allow a new output to be created, but to prevent updating an existing output. Other values will result in a 412 Pre-condition Failed response. Default value is None.
    description: Set to '*' to allow a new output to be created, but to prevent updating an existing output. Other values will result in a 412 Pre-condition Failed response. Default value is None.

UPDATE examples

update

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

UPDATE azure.stream_analytics.outputs
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND job_name = '{{ job_name }}' --required
AND output_name = '{{ output_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
properties,
type;

REPLACE examples

create_or_replace

Creates an output or replaces an already existing output under an existing streaming job.

REPLACE azure.stream_analytics.outputs
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND job_name = '{{ job_name }}' --required
AND output_name = '{{ output_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
AND If-None-Match = '{{ If-None-Match}}'
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes an output from the streaming job.

DELETE FROM azure.stream_analytics.outputs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND job_name = '{{ job_name }}' --required
AND output_name = '{{ output_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

test

Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.

EXEC azure.stream_analytics.outputs.test 
@resource_group_name='{{ resource_group_name }}' --required, 
@job_name='{{ job_name }}' --required, 
@output_name='{{ output_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"properties": "{{ properties }}"
}'
;