Update-AzConnectedMachine

Reference

Module:: Az.ConnectedMachine

The operation to update a hybrid machine.

Syntax

Update-AzConnectedMachine
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-AgentUpgradeCorrelationId <String>]
      [-AgentUpgradeDesiredVersion <String>]
      [-AgentUpgradeEnableAutomatic]
      [-IdentityType <String>]
      [-Kind <String>]
      [-LinuxConfigurationPatchSettingsAssessmentMode <String>]
      [-LinuxConfigurationPatchSettingsPatchMode <String>]
      [-LocationDataCity <String>]
      [-LocationDataCountryOrRegion <String>]
      [-LocationDataDistrict <String>]
      [-LocationDataName <String>]
      [-ParentClusterResourceId <String>]
      [-PrivateLinkScopeResourceId <String>]
      [-Tag <Hashtable>]
      [-WindowsConfigurationPatchSettingsAssessmentMode <String>]
      [-WindowsConfigurationPatchSettingsPatchMode <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzConnectedMachine
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonString <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzConnectedMachine
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonFilePath <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzConnectedMachine
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Parameter <IMachineUpdate>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzConnectedMachine
      -InputObject <IConnectedMachineIdentity>
      [-AgentUpgradeCorrelationId <String>]
      [-AgentUpgradeDesiredVersion <String>]
      [-AgentUpgradeEnableAutomatic]
      [-IdentityType <String>]
      [-Kind <String>]
      [-LinuxConfigurationPatchSettingsAssessmentMode <String>]
      [-LinuxConfigurationPatchSettingsPatchMode <String>]
      [-LocationDataCity <String>]
      [-LocationDataCountryOrRegion <String>]
      [-LocationDataDistrict <String>]
      [-LocationDataName <String>]
      [-ParentClusterResourceId <String>]
      [-PrivateLinkScopeResourceId <String>]
      [-Tag <Hashtable>]
      [-WindowsConfigurationPatchSettingsAssessmentMode <String>]
      [-WindowsConfigurationPatchSettingsPatchMode <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzConnectedMachine
      -InputObject <IConnectedMachineIdentity>
      -Parameter <IMachineUpdate>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The operation to update a hybrid machine.

Examples

Example 1: Update a machine using parameters

Update-AzConnectedMachine -Name surface -ResourceGroupName rg -PrivateLinkScopeResourceId privateLinkScopeId -WindowsConfigurationPatchSettingsAssessmentMode AutomaticByOS -Tag @{"key"="value"}

ResourceGroupName Name    Location    OSType  Status    ProvisioningState
----------------- ----    --------    ------  ------    -----------------
rg               surface    eastus2euap windows Connected Updating

Update a machine

Example 2: Update a machine - cleaning a field

Update-AzConnectedMachine -Name surface -ResourceGroupName rg -PrivateLinkScopeResourceId $null

ResourceGroupName Name    Location    OSType  Status    ProvisioningState
----------------- ----    --------    ------  ------    -----------------
rg               surface eastus2euap windows Connected Updating

Update a machine to clean a field

Parameters

-AgentUpgradeCorrelationId

The correlation ID passed in from RSM per upgrade.

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

-AgentUpgradeDesiredVersion

Specifies the version info w.r.t AgentUpgrade for the machine.

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

-AgentUpgradeEnableAutomatic

Specifies if RSM should try to upgrade this machine

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

-IdentityType

The identity type.

Type:	String
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

-JsonFilePath

Path of Json file supplied to the Update operation

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

-JsonString

Json string supplied to the Update operation

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

-Kind

Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc.

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

-LinuxConfigurationPatchSettingsAssessmentMode

Specifies the assessment mode.

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

-LinuxConfigurationPatchSettingsPatchMode

Specifies the patch mode.

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

-LocationDataCity

The city or locality where the resource is located.

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

-LocationDataCountryOrRegion

The country or region where the resource is located

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

-LocationDataDistrict

The district, state, or province where the resource is located.

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

-LocationDataName

A canonical name for the geographic or physical location.

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

-Name

The name of the hybrid machine.

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

-Parameter

Describes a hybrid machine Update.

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

-ParentClusterResourceId

The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any.

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

-PrivateLinkScopeResourceId

The resource id of the private link scope this machine is assigned to, if any.

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-Tag

Resource tags

Type:	Hashtable
Position:	Named
Default value:	None
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

-WindowsConfigurationPatchSettingsAssessmentMode