Update-AzConnectedMachine
The operation to update a hybrid machine.
Syntax
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-AzConnectedMachine
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-Parameter <IMachineUpdate>
[-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>]
-JsonString <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzConnectedMachine
-InputObject <IConnectedMachineIdentity>
-Parameter <IMachineUpdate>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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.
| 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 |
-EnableSystemAssignedIdentity
Decides if enable a system assigned identity for the resource.
| Type: | Nullable<T>[Boolean] |
| 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 |
-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 |
-OSProfile
Specifies the operating system settings for the hybrid machine.
| Type: | IOSProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
