Feedback Edit

Update-AzConnectedExtension

  • Reference
Module:
Az.ConnectedMachine

The operation to Upgrade Machine Extensions.

Syntax

Update-AzConnectedExtension
      -MachineName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ExtensionTarget <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzConnectedExtension
      -MachineName <String>
      -ResourceGroupName <String>
      -ExtensionUpgradeParameter <IMachineExtensionUpgrade>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzConnectedExtension
      -InputObject <IConnectedMachineIdentity>
      -ExtensionUpgradeParameter <IMachineExtensionUpgrade>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzConnectedExtension
      -InputObject <IConnectedMachineIdentity>
      [-ExtensionTarget <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The operation to Upgrade Machine Extensions.

Examples

Example 1: Update an extension in a machine to a specific version

$target = @{"Microsoft.Compute.CustomScriptExtension" = @{"targetVersion"="1.10.12"}}
Update-AzConnectedExtension -ResourceGroupName $env.ResourceGroupName -MachineName $machineName -ExtensionTarget $target

<None>

Update an extension in a machine to a specific version

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

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

Describes the Extension Target Properties.

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ExtensionUpgradeParameter

Describes the Machine Extension Upgrade Properties To construct, see NOTES section for EXTENSIONUPGRADEPARAMETER properties and create a hash table.

Type:IMachineExtensionUpgrade
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

The name of the hybrid machine.

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

Run the command asynchronously

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

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
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
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
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IMachineExtensionUpgrade

IConnectedMachineIdentity

Outputs

Boolean

Notes

ALIASES

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.

EXTENSIONUPGRADEPARAMETER <IMachineExtensionUpgrade>: Describes the Machine Extension Upgrade Properties

  • [ExtensionTarget <IExtensionTarget>]: Describes the Extension Target Properties.
    • [(Any) <IExtensionTargetProperties>]: This indicates any property can be added to this object.

INPUTOBJECT <IConnectedMachineIdentity>: Identity Parameter

  • [ExtensionName <String>]: The name of the machine extension.
  • [GroupName <String>]: The name of the private link resource.
  • [Id <String>]: Resource identity path
  • [Location <String>]: The location of the target resource.
  • [MachineName <String>]: The name of the hybrid machine.
  • [PrivateEndpointConnectionName <String>]: The name of the private endpoint connection.
  • [PrivateLinkScopeId <String>]: The id (Guid) of the Azure Arc PrivateLinkScope resource.
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [ScopeName <String>]: The name of the Azure Arc PrivateLinkScope resource.
  • [SubscriptionId <String>]: The ID of the target subscription.