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

Successfully retrieved the specified output.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
properties	object	The properties that are associated with an output. Required on PUT (CreateOrReplace) requests.
type	string	Resource type

list_by_streaming_job

Successfully listed the outputs under the specified streaming job.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
properties	object	The properties that are associated with an output. Required on PUT (CreateOrReplace) requests.
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, outputName		Gets details about the specified output.
list_by_streaming_job	select	subscriptionId, resourceGroupName, jobName	$select	Lists all of the outputs under the specified streaming job.
create_or_replace	insert	subscriptionId, resourceGroupName, jobName, outputName	If-Match, If-None-Match	Creates an output or replaces an already existing output under an existing streaming job.
update	update	subscriptionId, resourceGroupName, jobName, outputName	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.
delete	delete	subscriptionId, resourceGroupName, jobName, outputName		Deletes an output from the streaming job.
test	exec	subscriptionId, resourceGroupName, jobName, outputName		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
jobName	string	The name of the streaming job.
outputName	string	The name of the output.
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 output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
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.

SELECT examples

get

Gets details about the specified output.

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

list_by_streaming_job

Lists all of the outputs under the specified streaming job.

SELECT
id,
name,
properties,
type
FROM azure.stream_analytics.outputs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND jobName = '{{ jobName }}' -- 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 (
data__name,
data__properties,
subscriptionId,
resourceGroupName,
jobName,
outputName,
If-Match,
If-None-Match
)
SELECT 
'{{ name }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ jobName }}',
'{{ outputName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: outputs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the outputs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the outputs resource.
    - name: jobName
      value: string
      description: Required parameter for the outputs resource.
    - name: outputName
      value: string
      description: Required parameter for the outputs resource.
    - name: name
      value: string
      description: |
        Resource name
    - name: properties
      value: object
      description: |
        The properties that are associated with an output. Required on PUT (CreateOrReplace) requests.
    - name: If-Match
      value: string
      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.
    - name: If-None-Match
      value: string
      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.

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 
data__name = '{{ name }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobName = '{{ jobName }}' --required
AND outputName = '{{ outputName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes an output from the streaming job.

DELETE FROM azure.stream_analytics.outputs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobName = '{{ jobName }}' --required
AND outputName = '{{ outputName }}' --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 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required, 
@outputName='{{ outputName }}' --required 
@@json=
'{
"name": "{{ name }}", 
"properties": "{{ properties }}"
}'
;