job_stream

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

Overview

Name	job_stream
Type	Resource
Id	azure.automation.job_stream

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the id of the resource.
jobStreamId	string	Gets or sets the id of the job stream.
streamText	string	Gets or sets the stream text.
streamType	string	Gets or sets the stream type. Known values are: "Progress", "Output", "Warning", "Error", "Debug", "Verbose", and "Any". (Progress, Output, Warning, Error, Debug, Verbose, Any)
summary	string	Gets or sets the summary.
time	string (date-time)	Gets or sets the creation time of the job.
value	object	Gets or sets the values of the job stream.

list_by_job

Name	Datatype	Description
id	string	Gets or sets the id of the resource.
jobStreamId	string	Gets or sets the id of the job stream.
streamText	string	Gets or sets the stream text.
streamType	string	Gets or sets the stream type. Known values are: "Progress", "Output", "Warning", "Error", "Debug", "Verbose", and "Any". (Progress, Output, Warning, Error, Debug, Verbose, Any)
summary	string	Gets or sets the summary.
time	string (date-time)	Gets or sets the creation time of the job.
value	object	Gets or sets the values of the job stream.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, automation_account_name, job_name, job_stream_id, subscription_id	clientRequestId	Retrieve the job stream identified by job stream id.
list_by_job	select	resource_group_name, automation_account_name, job_name, subscription_id	$filter, clientRequestId	Retrieve a list of jobs streams identified by job name.

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
automation_account_name	string	The name of the automation account. Required.
job_name	string	The job name. Required.
job_stream_id	string	The job stream id. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. Default value is None.
clientRequestId	string	Identifies this specific client request. Default value is None.

SELECT examples

get

Retrieve the job stream identified by job stream id.

SELECT
id,
jobStreamId,
streamText,
streamType,
summary,
time,
value
FROM azure.automation.job_stream
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND job_name = '{{ job_name }}' -- required
AND job_stream_id = '{{ job_stream_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND clientRequestId = '{{ clientRequestId }}'
;

list_by_job

Retrieve a list of jobs streams identified by job name.

SELECT
id,
jobStreamId,
streamText,
streamType,
summary,
time,
value
FROM azure.automation.job_stream
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND job_name = '{{ job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND clientRequestId = '{{ clientRequestId }}'
;