software_update_configuration_runs

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

Overview

Name	software_update_configuration_runs
Type	Resource
Id	azure.automation.software_update_configuration_runs

Fields

The following fields are returned by SELECT queries:

get_by_id

Name	Datatype	Description
id	string	Resource Id of the software update configuration run.
name	string	Name of the software update configuration run.
computerCount	integer	Number of computers in the software update configuration run.
configuredDuration	string	Configured duration for the software update configuration run.
createdBy	string	CreatedBy property, which only appears in the response.
creationTime	string (date-time)	Creation time of the resource, which only appears in the response.
endTime	string (date-time)	End time of the software update configuration run.
failedCount	integer	Number of computers with failed status.
lastModifiedBy	string	LastModifiedBy property, which only appears in the response.
lastModifiedTime	string (date-time)	Last time resource was modified, which only appears in the response.
osType	string	Operating system target of the software update configuration triggered this run.
softwareUpdateConfiguration	object	software update configuration triggered this run.
startTime	string (date-time)	Start time of the software update configuration run.
status	string	Status of the software update configuration run.
tasks	object	Software update configuration tasks triggered in this run.

list

Name	Datatype	Description
id	string	Resource Id of the software update configuration run.
name	string	Name of the software update configuration run.
computerCount	integer	Number of computers in the software update configuration run.
configuredDuration	string	Configured duration for the software update configuration run.
createdBy	string	CreatedBy property, which only appears in the response.
creationTime	string (date-time)	Creation time of the resource, which only appears in the response.
endTime	string (date-time)	End time of the software update configuration run.
failedCount	integer	Number of computers with failed status.
lastModifiedBy	string	LastModifiedBy property, which only appears in the response.
lastModifiedTime	string (date-time)	Last time resource was modified, which only appears in the response.
osType	string	Operating system target of the software update configuration triggered this run.
softwareUpdateConfiguration	object	software update configuration triggered this run.
startTime	string (date-time)	Start time of the software update configuration run.
status	string	Status of the software update configuration run.
tasks	object	Software update configuration tasks triggered in this run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_id	select	resource_group_name, automation_account_name, software_update_configuration_run_id, subscription_id	clientRequestId	Get a single software update configuration Run by Id.
list	select	resource_group_name, automation_account_name, subscription_id	clientRequestId, $filter, $skip, $top	Return list of software update configuration runs.

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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
software_update_configuration_run_id	string	The Id of the software update configuration run. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name'. Default value is None.
$skip	string	Number of entries you skip before returning results. Default value is None.
$top	string	Maximum number of entries returned in the results collection. Default value is None.
clientRequestId	string	Identifies this specific client request. Default value is None.

SELECT examples

get_by_id

Get a single software update configuration Run by Id.

SELECT
id,
name,
computerCount,
configuredDuration,
createdBy,
creationTime,
endTime,
failedCount,
lastModifiedBy,
lastModifiedTime,
osType,
softwareUpdateConfiguration,
startTime,
status,
tasks
FROM azure.automation.software_update_configuration_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND software_update_configuration_run_id = '{{ software_update_configuration_run_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND clientRequestId = '{{ clientRequestId }}'
;

list

Return list of software update configuration runs.

SELECT
id,
name,
computerCount,
configuredDuration,
createdBy,
creationTime,
endTime,
failedCount,
lastModifiedBy,
lastModifiedTime,
osType,
softwareUpdateConfiguration,
startTime,
status,
tasks
FROM azure.automation.software_update_configuration_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND clientRequestId = '{{ clientRequestId }}'
AND $filter = '{{ $filter }}'
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
;