Install-AzConnectedMachinePatch

Reference

Module:: Az.ConnectedMachine

The operation to install patches on a hybrid machine identity in Azure.

Syntax

Install-AzConnectedMachinePatch
       -Name <String>
       -ResourceGroupName <String>
       [-SubscriptionId <String>]
       -MaximumDuration <String>
       -RebootSetting <String>
       [-LinuxParameterClassificationsToInclude <String[]>]
       [-LinuxParameterPackageNameMasksToExclude <String[]>]
       [-LinuxParameterPackageNameMasksToInclude <String[]>]
       [-WindowParameterClassificationsToInclude <String[]>]
       [-WindowParameterExcludeKbsRequiringReboot]
       [-WindowParameterKbNumbersToExclude <String[]>]
       [-WindowParameterKbNumbersToInclude <String[]>]
       [-WindowParameterMaxPatchPublishDate <DateTime>]
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-AzConnectedMachinePatch
       -Name <String>
       -ResourceGroupName <String>
       [-SubscriptionId <String>]
       -JsonString <String>
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-AzConnectedMachinePatch
       -Name <String>
       -ResourceGroupName <String>
       [-SubscriptionId <String>]
       -JsonFilePath <String>
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-AzConnectedMachinePatch
       -Name <String>
       -ResourceGroupName <String>
       [-SubscriptionId <String>]
       -InstallPatchesInput <IMachineInstallPatchesParameters>
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-AzConnectedMachinePatch
       -InputObject <IConnectedMachineIdentity>
       -MaximumDuration <String>
       -RebootSetting <String>
       [-LinuxParameterClassificationsToInclude <String[]>]
       [-LinuxParameterPackageNameMasksToExclude <String[]>]
       [-LinuxParameterPackageNameMasksToInclude <String[]>]
       [-WindowParameterClassificationsToInclude <String[]>]
       [-WindowParameterExcludeKbsRequiringReboot]
       [-WindowParameterKbNumbersToExclude <String[]>]
       [-WindowParameterKbNumbersToInclude <String[]>]
       [-WindowParameterMaxPatchPublishDate <DateTime>]
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-AzConnectedMachinePatch
       -InputObject <IConnectedMachineIdentity>
       -InstallPatchesInput <IMachineInstallPatchesParameters>
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The operation to install patches on a hybrid machine identity in Azure.

Examples

Example 1: Install assess patches

Install-AzConnectedMachinePatch -ResourceGroupName az-sdk-test -Name testMachine -MaximumDuration 'PT4H' -RebootSetting 'IfRequired' -WindowParameterClassificationsToInclude 'Critical'

ExcludedPatchCount FailedPatchCount InstallationActivityId               InstalledPatchCount LastModifiedDateTime Maint
                                                                                                                  enanc
                                                                                                                  eWind
                                                                                                                  owExc
                                                                                                                  eeded
------------------ ---------------- ----------------------               ------------------- -------------------- -----
0                  0                ********-****-****-****-********** 0                   7/28/2023 7:55:08 AM  False

Install machine patches.

Parameters

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter

Type:	IConnectedMachineIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InstallPatchesInput

Input for InstallPatches as directly received by the API

Type:	IMachineInstallPatchesParameters
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-JsonFilePath

Path of Json file supplied to the Install operation

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-JsonString

Json string supplied to the Install operation

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-LinuxParameterClassificationsToInclude

The update classifications to select when installing patches for Linux.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LinuxParameterPackageNameMasksToExclude

packages to exclude in the patch operation. Format: packageName_packageVersion

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LinuxParameterPackageNameMasksToInclude

packages to include in the patch operation. Format: packageName_packageVersion

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaximumDuration

Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the hybrid machine.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RebootSetting

Defines when it is acceptable to reboot a VM during a software update operation.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WindowParameterClassificationsToInclude

The update classifications to select when installing patches for Windows.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WindowParameterExcludeKbsRequiringReboot

Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WindowParameterKbNumbersToExclude

Kbs to exclude in the patch operation

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WindowParameterKbNumbersToInclude

Kbs to include in the patch operation

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WindowParameterMaxPatchPublishDate

This is used to install patches that were published on or before this given max published date.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IConnectedMachineIdentity

IMachineInstallPatchesParameters

Outputs

IMachineInstallPatchesResult

Share via