inputs

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

Overview

Name	inputs
Type	Resource
Id	azure.stream_analytics.inputs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
compression	object	Describes how input data is compressed.
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 input. 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.
partitionKey	string	partitionKey Describes a key in the input data which is used for partitioning the input data.
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.
type	string	Resource type.
watermarkSettings	object	Settings which determine whether to read watermark events.

list_by_streaming_job

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
compression	object	Describes how input data is compressed.
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 input. 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.
partitionKey	string	partitionKey Describes a key in the input data which is used for partitioning the input data.
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.
type	string	Resource type.
watermarkSettings	object	Settings which determine whether to read watermark events.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, job_name, input_name, subscription_id		Gets details about the specified input.
list_by_streaming_job	select	resource_group_name, job_name, subscription_id	$select	Lists all of the inputs under the specified streaming job.
create_or_replace	insert	resource_group_name, job_name, input_name, subscription_id	If-Match, If-None-Match	Creates an input or replaces an already existing input under an existing streaming job.
update	update	resource_group_name, job_name, input_name, subscription_id	If-Match	Updates an existing input under an existing streaming job. This can be used to partially update (ie. update one or two properties) an input without affecting the rest the job or input definition.
create_or_replace	replace	resource_group_name, job_name, input_name, subscription_id	If-Match, If-None-Match	Creates an input or replaces an already existing input under an existing streaming job.
delete	delete	resource_group_name, job_name, input_name, subscription_id		Deletes an input from the streaming job.
test	exec	resource_group_name, job_name, input_name, subscription_id		Tests whether an input’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
input_name	string	The name of the input. Required.
job_name	string	The name of the streaming job. 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 input. Omit this value to always overwrite the current input. 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 input to be created, but to prevent updating an existing input. Other values will result in a 412 Pre-condition Failed response. Default value is None.

SELECT examples

get

Gets details about the specified input.

SELECT
id,
name,
compression,
diagnostics,
etag,
partitionKey,
serialization,
type,
watermarkSettings
FROM azure.stream_analytics.inputs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND job_name = '{{ job_name }}' -- required
AND input_name = '{{ input_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_streaming_job

Lists all of the inputs under the specified streaming job.

SELECT
id,
name,
compression,
diagnostics,
etag,
partitionKey,
serialization,
type,
watermarkSettings
FROM azure.stream_analytics.inputs
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 input or replaces an already existing input under an existing streaming job.

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

Manifest

# Description fields are for documentation purposes
- name: inputs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the inputs resource.
  - name: job_name
    value: "{{ job_name }}"
    description: Required parameter for the inputs resource.
  - name: input_name
    value: "{{ input_name }}"
    description: Required parameter for the inputs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the inputs resource.
  - name: name
    value: "{{ name }}"
    description: |
      Resource name.
  - name: properties
    description: |
      The properties that are associated with an input. Required on PUT (CreateOrReplace) requests.
    value:
      type: "{{ type }}"
      serialization:
        type: "{{ type }}"
      diagnostics:
        conditions:
          - since: "{{ since }}"
            code: "{{ code }}"
            message: "{{ message }}"
      etag: "{{ etag }}"
      compression:
        type: "{{ type }}"
      partitionKey: "{{ partitionKey }}"
      watermarkSettings:
        watermarkMode: "{{ watermarkMode }}"
  - name: If-Match
    value: "{{ If-Match }}"
    description: The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. Default value is None.
    description: The ETag of the input. Omit this value to always overwrite the current input. 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 input to be created, but to prevent updating an existing input. Other values will result in a 412 Pre-condition Failed response. Default value is None.
    description: Set to '*' to allow a new input to be created, but to prevent updating an existing input. Other values will result in a 412 Pre-condition Failed response. Default value is None.

UPDATE examples

update

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

UPDATE azure.stream_analytics.inputs
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND job_name = '{{ job_name }}' --required
AND input_name = '{{ input_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 input or replaces an already existing input under an existing streaming job.

REPLACE azure.stream_analytics.inputs
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND job_name = '{{ job_name }}' --required
AND input_name = '{{ input_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 input from the streaming job.

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

Lifecycle Methods

test

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

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