Get-AzsUpdateRun
Get an instance of update run using the ID.
Syntax
Get-AzsUpdateRun
-UpdateName <String>
[-Location <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzsUpdateRun
-Name <String>
-UpdateName <String>
[-Location <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzsUpdateRun
-INPUTOBJECT \<IUpdateAdminIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Get an instance of update run using the ID.
Examples
Example 1: Get-AzsUpdateRun
PS C:\> Get-AzsUpdateRun
cmdlet Get-AzsUpdateRun at command pipeline position 1
Supply values for the following parameters:
UpdateName: Microsoft1.1907.0.10
Name State ProgressStartTimeUtc ProgressEndTimeUtc
---- ----- -------------------- ------------------
northwest/Microsoft1.1907.0.10/45aaeb... Failed 7/11/2019 3:07:10 PM 7/11/2019 7:38:05 PM
northwest/Microsoft1.1907.0.10/51e878... Succeeded 7/11/2019 3:07:10 PM 7/12/2019 6:47:37 AM
If a UpdateName value is not specified, Get-UpdateRun will always ask for input. Once provided, it will output all instances of UpdateRun that were Failed or Successful
Example 2: Get-AzsUpdateRun By UpdateName
PS C:\> Get-AzsUpdateRun -UpdateName Microsoft1.1907.0.10
or
PS C:\> Get-AzsUpdateRun -UpdateName northwest/Microsoft1.1907.0.10
Name State ProgressStartTimeUtc ProgressEndTimeUtc
---- ----- -------------------- ------------------
northwest/Microsoft1.1907.0.10/45aaeb... Failed 7/11/2019 3:07:10 PM 7/11/2019 7:38:05 PM
northwest/Microsoft1.1907.0.10/51e878... Succeeded 7/11/2019 3:07:10 PM 7/12/2019 6:47:37 AM
Will retrieve all UpdateRuns associated with a specific Update
Example 2: Get-AzsUpdateRun By Name
PS C:\> Get-AzsUpdateRun -UpdateName Microsoft1.1907.0.10 -Name 45aaeb26-805b-495b-9c8c-d5da5542dbf4
or
PS C:\> Get-AzsUpdateRun -UpdateName northwest/Microsoft1.1907.0.10 -Name northwest/Microsoft1.1907.0.10/45aaeb26-805b-495b-9c8c-d5da5542dbf4
Name State ProgressStartTimeUtc ProgressEndTimeUtc
---- ----- -------------------- ------------------
northwest/Microsoft1.1907.0.10/45aaeb... Failed 7/11/2019 3:07:10 PM 7/11/2019 7:38:05 PM
Will retrieve all UpdateRuns associated with a specific Update and a specific Name
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | System.Management.Automation.PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | Microsoft.Azure.PowerShell.Cmdlets.UpdateAdmin.Models.IUpdateAdminIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Location
The name of the update location.
Type: | System.String |
Position: | Named |
Default value: | (Get-AzLocation)[0].Location |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Update run identifier.
Type: | System.String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Resource group name.
Type: | System.String |
Position: | Named |
Default value: | -join("System.",(Get-AzLocation)[0].Location) |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: | System.String[] |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UpdateName
Name of the update.
Type: | System.String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Azure.PowerShell.Cmdlets.UpdateAdmin.Models.IUpdateAdminIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.UpdateAdmin.Models.Api20160501.IUpdateRun
Notes
COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IUpdateAdminIdentity>: Identity Parameter
[Id <String>]
: Resource identity path[ResourceGroupName <String>]
: Resource group name.[RunName <String>]
: Update run identifier.[SubscriptionId <String>]
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.[UpdateLocation <String>]
: The name of the update location.[UpdateName <String>]
: Name of the update.