New-AzConnectedMachineExtension

Module:

Az.ConnectedMachine Module

The operation to create the extension.

New-AzConnectedMachineExtension
 -MachineName <String>
 -Name <String>
 -ResourceGroupName <String>
 -Location <String>
 [-SubscriptionId <String>]
 [-AutoUpgradeMinorVersion]
 [-EnableAutomaticUpgrade]
 [-ExtensionType <String>]
 [-ForceRerun <String>]
 [-InstanceViewName <String>]
 [-InstanceViewType <String>]
 [-InstanceViewTypeHandlerVersion <String>]
 [-ProtectedSetting <Hashtable>]
 [-Publisher <String>]
 [-Setting <Hashtable>]
 [-StatusCode <String>]
 [-StatusDisplayStatus <String>]
 [-StatusLevel <String>]
 [-StatusMessage <String>]
 [-StatusTime <DateTime>]
 [-Tag <Hashtable>]
 [-TypeHandlerVersion <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

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

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

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

New-AzConnectedMachineExtension
 -Name <String>
 -MachineInputObject <IConnectedMachineIdentity>
 -Location <String>
 [-AutoUpgradeMinorVersion]
 [-EnableAutomaticUpgrade]
 [-ExtensionType <String>]
 [-ForceRerun <String>]
 [-InstanceViewName <String>]
 [-InstanceViewType <String>]
 [-InstanceViewTypeHandlerVersion <String>]
 [-ProtectedSetting <Hashtable>]
 [-Publisher <String>]
 [-Setting <Hashtable>]
 [-StatusCode <String>]
 [-StatusDisplayStatus <String>]
 [-StatusLevel <String>]
 [-StatusMessage <String>]
 [-StatusTime <DateTime>]
 [-Tag <Hashtable>]
 [-TypeHandlerVersion <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

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

New-AzConnectedMachineExtension
 -InputObject <IConnectedMachineIdentity>
 -Location <String>
 [-AutoUpgradeMinorVersion]
 [-EnableAutomaticUpgrade]
 [-ExtensionType <String>]
 [-ForceRerun <String>]
 [-InstanceViewName <String>]
 [-InstanceViewType <String>]
 [-InstanceViewTypeHandlerVersion <String>]
 [-ProtectedSetting <Hashtable>]
 [-Publisher <String>]
 [-Setting <Hashtable>]
 [-StatusCode <String>]
 [-StatusDisplayStatus <String>]
 [-StatusLevel <String>]
 [-StatusMessage <String>]
 [-StatusTime <DateTime>]
 [-Tag <Hashtable>]
 [-TypeHandlerVersion <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

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

The operation to create the extension.

$Settings = @{ "commandToExecute" = "powershell.exe -c Get-Process" }
New-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName win-eastus1 -Location eastus -Publisher "Microsoft.Compute" -TypeHandlerVersion 1.10 -Settings $Settings -ExtensionType CustomScriptExtension

Name Location ProvisioningState
---- -------- -----------------
custom eastus Succeeded

Sets an extension on a machine.

$otherExtension = Get-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName other
$otherExtension | New-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName important

Name Location ProvisioningState
---- -------- -----------------
custom eastus Succeeded

This creates a new extension with the extension parameters provided by the object passed in via the pipeline. This is great if you want to grab the parameters of one machine and apply it to another machine.

$identity = [Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.ConnectedMachineIdentity]@{
 Id = "/subscriptions/$($SubscriptionId)/resourceGroups/$($ResourceGroupName)/providers/Microsoft.HybridCompute/machines/$MachineName/extensions/$ExtensionName"
}
$Settings = @{ "commandToExecute" = "powershell.exe -c Get-Process" }
$identity | New-AzConnectedMachineExtension -Location eastus -Publisher "Microsoft.Compute" -TypeHandlerVersion 1.10 -Settings $Settings -ExtensionType CustomScriptExtension

Name Location ProvisioningState
---- -------- -----------------
custom eastus Succeeded

This creates a new machine extension using the identity provided via the pipeline. You likely won't do this, but it's possible.

$ext = Get-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName other
$ext | New-AzConnectedMachineExtension -ExtensionParameter $ext

This creates a new machine extension using the identity provided via the pipeline and the extension details provided by the passed in extension object. You likely won't do this, but it's possible.

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.