Edit

Share via

Update-AzConnectedMachine

Module:
Az.ConnectedMachine Module

The operation to update a hybrid machine.

Syntax

UpdateExpanded (Default) 

Update-AzConnectedMachine
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-EnableSystemAssignedIdentity <Boolean>]
    [-AgentUpgradeCorrelationId <String>]
    [-AgentUpgradeDesiredVersion <String>]
    [-AgentUpgradeEnableAutomatic]
    [-IdentityType <String>]
    [-Kind <String>]
    [-LocationDataCity <String>]
    [-LocationDataCountryOrRegion <String>]
    [-LocationDataDistrict <String>]
    [-LocationDataName <String>]
    [-OSProfile <IOSProfile>]
    [-ParentClusterResourceId <String>]
    [-PrivateLinkScopeResourceId <String>]
    [-Tag <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

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

UpdateViaJsonFilePath 

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

UpdateViaJsonString 

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

UpdateViaIdentity 

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

UpdateViaIdentityExpanded 

Update-AzConnectedMachine
    -InputObject <IConnectedMachineIdentity>
    [-EnableSystemAssignedIdentity <Boolean>]
    [-AgentUpgradeCorrelationId <String>]
    [-AgentUpgradeDesiredVersion <String>]
    [-AgentUpgradeEnableAutomatic]
    [-IdentityType <String>]
    [-Kind <String>]
    [-LocationDataCity <String>]
    [-LocationDataCountryOrRegion <String>]
    [-LocationDataDistrict <String>]
    [-LocationDataName <String>]
    [-OSProfile <IOSProfile>]
    [-ParentClusterResourceId <String>]
    [-PrivateLinkScopeResourceId <String>]
    [-Tag <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The operation to update a hybrid machine.

Examples

Example 1: Update a hybrid machine

Update-AzConnectedMachine -Name $env.MachineName -ResourceGroupName $env.ResourceGroupName -PrivateLinkScopeResourceId $env.PrivateLinkScopeUri

AdFqdn                                      : ********
AgentConfigurationConfigMode                : full
AgentConfigurationExtensionsAllowList       : {}
AgentConfigurationExtensionsBlockList       : {}
AgentConfigurationExtensionsEnabled         : true
AgentConfigurationGuestConfigurationEnabled : true
AgentConfigurationIncomingConnectionsPort   : {}
AgentConfigurationProxyBypass               : {}
AgentConfigurationProxyUrl                  :
AgentUpgradeCorrelationId                   :
AgentUpgradeDesiredVersion                  :
AgentUpgradeEnableAutomaticUpgrade          : False
AgentUpgradeLastAttemptDesiredVersion       :
AgentUpgradeLastAttemptMessage              :
AgentUpgradeLastAttemptStatus               :
AgentUpgradeLastAttemptTimestamp            :
AgentVersion                                : *******
ClientPublicKey                             : ********-****-****-****-**********
CloudMetadataProvider                       : N/A
DetectedProperty                            : {
                                                "cloudprovider": "N/A",
                                                "coreCount": "4",
                                                "logicalCoreCount": "8",
                                                "manufacturer": "LENOVO",
                                                "model": "*******",
                                                "mssqldiscovered": "false",
                                                "processorCount": "1",
                                                "processorNames": "11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz",
                                                "productType": "4",
                                                "serialNumber": "********",
                                                "smbiosAssetTag": "********",
                                                "totalPhysicalMemoryInBytes": "********",
                                                "totalPhysicalMemoryInGigabytes": "32",
                                                "vmuuidEsu2012": "********-****-****-****-**********"
                                              }
DisplayName                                 : ********
DnsFqdn                                     : ********
DomainName                                  : WORKGROUP
ErrorDetail                                 : {}
Extension                                   :
ExtensionServiceStartupType                 : automatic
ExtensionServiceStatus                      : running
Fqdn                                        : ********
GuestConfigurationServiceStartupType        : automatic
GuestConfigurationServiceStatus             : running
Id                                          : /subscriptions/********-****-****-****-**********/resourceGroups/
                                              ********/providers/Microsoft.HybridCompute/machines/********
IdentityPrincipalId                         : ********-****-****-****-**********
IdentityTenantId                            : ********-****-****-****-**********
IdentityType                                : SystemAssigned
Kind                                        :
LastStatusChange                            : 9/20/2024 1:42:35 AM
LicenseProfile                              : {
                                                "esuProfile": {
                                                  "serverType": "Unknown",
                                                  "esuEligibility": "Ineligible",
                                                  "esuKeyState": "Inactive",
                                                  "licenseAssignmentState": "NotAssigned"
                                                },
                                                "licenseStatus": "Licensed",
                                                "licenseChannel": "Retail"
                                              }
Location                                    : centraluseuap
LocationDataCity                            :
LocationDataCountryOrRegion                 :
LocationDataDistrict                        :
LocationDataName                            :
MssqlDiscovered                             : false
Name                                        : testmachine
NetworkProfileNetworkInterface              : {{
                                                "ipAddresses": [
                                                  {
                                                    "subnet": {
                                                      "addressPrefix": "********"
                                                    },
                                                    "address": "********",
                                                    "ipAddressVersion": "IPv4"
                                                  }
                                                ]
                                              }, {
                                                "ipAddresses": [
                                                  {
                                                    "subnet": {
                                                      "addressPrefix": "********"
                                                    },
                                                    "address": "********",
                                                    "ipAddressVersion": "IPv4"
                                                  }
                                                ]
                                              }, {
                                                "ipAddresses": [
                                                  {
                                                    "subnet": {
                                                      "addressPrefix": "********"
                                                    },
                                                    "address": "********",
                                                    "ipAddressVersion": "IPv6"
                                                  }
                                                ]
                                              }}
OSEdition                                   : enterprise
OSName                                      : windows
OSProfile                                   : {
                                                "computerName": "********"
                                              }
OSSku                                       : Windows 10 Enterprise
OSType                                      : windows
OSVersion                                   : ********
ParentClusterResourceId                     :
PrivateLinkScopeResourceId                  :
ProvisioningState                           : Succeeded
Resource                                    :
ResourceGroupName                           : ********
Status                                      : Connected
SystemDataCreatedAt                         :
SystemDataCreatedBy                         :
SystemDataCreatedByType                     :
SystemDataLastModifiedAt                    :
SystemDataLastModifiedBy                    :
SystemDataLastModifiedByType                :
Tags                                        : {
                                              }
Type                                        : Microsoft.HybridCompute/machines
VMId                                        : ********-****-****-****-**********
VMUuid                                      : ********-****-****-****-**********

Update a hybrid machine

Parameters

-AgentUpgradeCorrelationId

The correlation ID passed in from RSM per upgrade.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AgentUpgradeDesiredVersion

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AgentUpgradeEnableAutomatic

Specifies if RSM should try to upgrade this machine

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableSystemAssignedIdentity

Decides if enable a system assigned identity for the resource.

Parameter properties

Type:

Nullable<T>[Boolean]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IdentityType

The identity type.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IConnectedMachineIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-JsonFilePath

Path of Json file supplied to the Update operation

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaJsonFilePath
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JsonString

Json string supplied to the Update operation

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaJsonString
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Kind

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocationDataCity

The city or locality where the resource is located.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocationDataCountryOrRegion

The country or region where the resource is located

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocationDataDistrict

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocationDataName

A canonical name for the geographic or physical location.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the hybrid machine.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MachineName

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaJsonFilePath
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaJsonString
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OSProfile

Specifies the operating system settings for the hybrid machine.

Parameter properties

Type:IOSProfile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Parameter

Describes a hybrid machine Update.

Parameter properties

Type:IMachineUpdate
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentClusterResourceId

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivateLinkScopeResourceId

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaJsonFilePath
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaJsonString
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription.

Parameter properties

Type:String
Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaJsonFilePath
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaJsonString
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Tag

Resource tags

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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.

Inputs

IConnectedMachineIdentity

IMachineUpdate

Outputs

IMachine