Update-AzConnectedMachineExtension

Module:

Az.ConnectedMachine Module

The operation to update the extension.

Update-AzConnectedMachineExtension
 -MachineName <String>
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String>]
 [-AutoUpgradeMinorVersion]
 [-EnableAutomaticUpgrade]
 [-ForceRerun <String>]
 [-ProtectedSetting <Hashtable>]
 [-Publisher <String>]
 [-Setting <Hashtable>]
 [-Tag <Hashtable>]
 [-Type <String>]
 [-TypeHandlerVersion <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzConnectedMachineExtension
 -MachineName <String>
 -Name <String>
 -ResourceGroupName <String>
 -JsonString <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzConnectedMachineExtension
 -MachineName <String>
 -Name <String>
 -ResourceGroupName <String>
 -JsonFilePath <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzConnectedMachineExtension
 -MachineName <String>
 -Name <String>
 -ResourceGroupName <String>
 -ExtensionParameter <IMachineExtensionUpdate>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzConnectedMachineExtension
 -Name <String>
 -MachineInputObject <IConnectedMachineIdentity>
 [-AutoUpgradeMinorVersion]
 [-EnableAutomaticUpgrade]
 [-ForceRerun <String>]
 [-ProtectedSetting <Hashtable>]
 [-Publisher <String>]
 [-Setting <Hashtable>]
 [-Tag <Hashtable>]
 [-Type <String>]
 [-TypeHandlerVersion <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzConnectedMachineExtension
 -Name <String>
 -MachineInputObject <IConnectedMachineIdentity>
 -ExtensionParameter <IMachineExtensionUpdate>
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzConnectedMachineExtension
 -InputObject <IConnectedMachineIdentity>
 [-AutoUpgradeMinorVersion]
 [-EnableAutomaticUpgrade]
 [-ForceRerun <String>]
 [-ProtectedSetting <Hashtable>]
 [-Publisher <String>]
 [-Setting <Hashtable>]
 [-Tag <Hashtable>]
 [-Type <String>]
 [-TypeHandlerVersion <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzConnectedMachineExtension
 -InputObject <IConnectedMachineIdentity>
 -ExtensionParameter <IMachineExtensionUpdate>
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

The operation to update the extension.

$splat = @{
 ResourceGroupName = "connectedMachines"
 MachineName = "linux-eastus1_1"
 Name = "customScript"
 Settings = @{
 commandToExecute = "ls -l"
 }
}
Update-AzConnectedMachineExtension @splat

Name Location ProvisioningState
---- -------- -----------------
customScript eastus Succeeded

Updates an extension on a specific machine.

$extToUpdate = Get-AzConnectedMachineExtension -ResourceGroupName connectedMachines -MachineName linux-eastus1_1 -Name customScript
$extToUpdate | Update-AzConnectedMachineExtension -Settings @{
 commandToExecute = "ls -l"
}

Name Location ProvisioningState
---- -------- -----------------
customScript eastus Succeeded

Updates a specific extension passed in via the pipeline. Here we are using the extension passed in via the pipeline to help us identify which extension we want to operate on and are specifying what we want to change via the normal parameters (like -Settings)

$extToUpdate = Get-AzConnectedMachineExtension -ResourceGroupName connectedMachines -MachineName linux-eastus1_1 -Name customScript
# Update the settings on the object that will be used via the pipeline
$extToUpdate.Setting.commandToExecute = "ls -l"
$splat = @{
 ResourceGroupName = "connectedMachines"
 MachineName = "linux-eastus1_1"
 Name = "customScript"
}
$extToUpdate | Update-AzConnectedMachineExtension @splat

Name Location ProvisioningState
---- -------- -----------------
customScript eastus Succeeded

Updates a specific extension passed in via the pipeline. Here we are using the extension passed in via the pipeline to provide the changes we want to make on the extension. The location of the extension is not retrieved via the pipeline but rather via the parameters specified normally (by the splat parameter).

$extToUpdate = Get-AzConnectedMachineExtension -ResourceGroupName connectedMachines -MachineName linux-eastus1_1 -Name customScript
# Update the settings on the object that will be used via the pipeline
$extToUpdate.Setting.commandToExecute = "ls -l"
$extToUpdate | Update-AzConnectedMachineExtension -ExtensionParameter $extToUpdate

Name Location ProvisioningState
---- -------- -----------------
customScript eastus Succeeded

Updates a specific extension passed in via the pipeline. Here we are using the extension passed in via the pipeline to help us identify which extension we want to operate on. In addition to that, we are using the parameters of the extension object to specify what to update.

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.