Get-AzAutomationSoftwareUpdateRun

Module:

Az.Automation Module

Gets a list of azure automation software update runs.

Syntax

ByAll (Default)

Get-AzAutomationSoftwareUpdateRun
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-OperatingSystem <OperatingSystemType>]
    [-Status <SoftwareUpdateRunStatus>]
    [-StartTime <DateTimeOffset>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ById

Get-AzAutomationSoftwareUpdateRun
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    -Id <Guid>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

BySucName

Get-AzAutomationSoftwareUpdateRun
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-SoftwareUpdateConfigurationName <String>]
    [-OperatingSystem <OperatingSystemType>]
    [-Status <SoftwareUpdateRunStatus>]
    [-StartTime <DateTimeOffset>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

BySuc

Get-AzAutomationSoftwareUpdateRun
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-SoftwareUpdateConfiguration <SoftwareUpdateConfiguration>]
    [-OperatingSystem <OperatingSystemType>]
    [-Status <SoftwareUpdateRunStatus>]
    [-StartTime <DateTimeOffset>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzAutomationSoftwareUpdateRun cmdlet returns a list of software update runs. Since a software update configuration has an associated schedule, it can be triggered multiple times. Each time a schedule is triggered will result in an update run created. Update run is an aggregate of the result of all machine runs. You can get runs for specific software update configuration by passing the SoftwareUpdateConfigurationName parameter. To get a specific runs, you need to pass the name parameter. You can also list runs with specific status, runs targeting specific operating system, or runs started after specific time by passing the appropriate parameter.

Examples

Example 1

This example list all update runs triggered by a specific software update configuration.

Get-AzAutomationSoftwareUpdateRun -ResourceGroupName "mygroup" `
                                               -AutomationAccountName "myaccount" `
                                               -SoftwareUpdateConfigurationName "MyUpdateConfiguration"

RunId                           : ec9ce57f-da18-44be-b33b-651a0f93cb52
SoftwareUpdateConfigurationName : MyUpdateConfiguration
ConfiguredDuration              : 02:00:00
OperatingSystem                 : Windows
StartTime                       : 5/22/2018 11:37:42 PM +00:00
EndTime                         : 5/22/2018 11:38:31 PM +00:00
ComputerCount                   : 2
FailedCount                     : 0
ResourceGroupName               : mygroup
AutomationAccountName           : myaccount
Name                            : ec9ce57f-da18-44be-b33b-651a0f93cb52
CreationTime                    : 5/22/2018 11:37:42 PM +00:00
LastModifiedTime                : 5/22/2018 11:38:54 PM +00:00
Description                     :

RunId                           : ac9396c7-a837-43d4-be97-fbfe46c80baa
SoftwareUpdateConfigurationName : MyUpdateConfiguration
ConfiguredDuration              : 02:00:00
OperatingSystem                 : Windows
StartTime                       : 5/22/2018 10:00:47 PM +00:00
EndTime                         : 5/22/2018 10:02:20 PM +00:00
ComputerCount                   : 2
FailedCount                     : 0
ResourceGroupName               : mygroup
AutomationAccountName           : myaccount
Name                            : ac9396c7-a837-43d4-be97-fbfe46c80baa
CreationTime                    : 5/22/2018 10:00:47 PM +00:00
LastModifiedTime                : 5/22/2018 10:02:58 PM +00:00

Parameters

-AutomationAccountName

The automation account name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Id

Id of the software update configuration run.

Parameter properties

Type:	Guid
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ById

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-OperatingSystem

The operating system of the run.

Parameter properties

Type:	Nullable<T>[OperatingSystemType]
Default value:	None
Accepted values:	Windows, Linux
Supports wildcards:	False
DontShow:	False

Parameter sets

ByAll

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

BySucName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

BySuc

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ResourceGroupName

The resource group name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-SoftwareUpdateConfiguration

The software update configuration triggered the run.

Parameter properties

Type:	SoftwareUpdateConfiguration
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

BySuc

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-SoftwareUpdateConfigurationName

Name of the software update configuration triggered the run.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

BySucName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-StartTime

Minimum start time of the run.

Parameter properties

Type:	DateTimeOffset
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByAll

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

BySucName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

BySuc

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Status

Status of the run.

Parameter properties

Type:	Nullable<T>[SoftwareUpdateRunStatus]
Default value:	None
Accepted values:	NotStarted, InProgress, Succeeded, Failed, MaintenanceWindowExceeded
Supports wildcards:	False
DontShow:	False

Parameter sets

ByAll

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

BySucName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

BySuc

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Guid

String

SoftwareUpdateConfiguration

Nullable<T>

Nullable<T>

DateTimeOffset

Outputs

SoftwareUpdateRun