subscriptions

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

Overview

Name	subscriptions
Type	Resource
Id	azure.stream_analytics.subscriptions

Fields

The following fields are returned by SELECT queries:

list_quotas

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
currentCount	integer	The current usage of this resource.
maxCount	integer	The max permitted usage of this resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_quotas	select	location, subscription_id		Retrieves the subscription's current quota information in a particular region.
test_query	exec	location, subscription_id, streamingJob		Test the Stream Analytics query on a sample input.
compile_query	exec	location, subscription_id, query, jobType		Compile the Stream Analytics query.
sample_input	exec	location, subscription_id		Sample the Stream Analytics input data.
test_input	exec	location, subscription_id, input		Test the Stream Analytics input.
test_output	exec	location, subscription_id, output		Test the Stream Analytics output.

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
location	string	The region to which the request is sent. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/. Required.
subscription_id	string

SELECT examples

list_quotas

Retrieves the subscription's current quota information in a particular region.

SELECT
id,
name,
currentCount,
maxCount,
type
FROM azure.stream_analytics.subscriptions
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

test_query

Test the Stream Analytics query on a sample input.

EXEC azure.stream_analytics.subscriptions.test_query 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"diagnostics": "{{ diagnostics }}", 
"streamingJob": "{{ streamingJob }}"
}'
;

compile_query

Compile the Stream Analytics query.

EXEC azure.stream_analytics.subscriptions.compile_query 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"query": "{{ query }}", 
"inputs": "{{ inputs }}", 
"functions": "{{ functions }}", 
"jobType": "{{ jobType }}", 
"compatibilityLevel": "{{ compatibilityLevel }}"
}'
;

sample_input

Sample the Stream Analytics input data.

EXEC azure.stream_analytics.subscriptions.sample_input 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"input": "{{ input }}", 
"compatibilityLevel": "{{ compatibilityLevel }}", 
"eventsUri": "{{ eventsUri }}", 
"dataLocale": "{{ dataLocale }}"
}'
;

test_input

Test the Stream Analytics input.

EXEC azure.stream_analytics.subscriptions.test_input 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"input": "{{ input }}"
}'
;

test_output

Test the Stream Analytics output.

EXEC azure.stream_analytics.subscriptions.test_output 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"output": "{{ output }}"
}'
;