Machine Extensions - Update

Service:: Hybrid Compute

API Version:: 2026-09-01

The operation to create or update the extension.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}?api-version=2026-09-01

URI Parameters

Name	In	Required	Type	Description
extensionName	path	True	string	The name of the machine extension.
machineName	path	True	string minLength: 1 maxLength: 54 pattern: ^[a-zA-Z0-9-_\.]{1,54}$	The name of the hybrid machine.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties.autoUpgradeMinorVersion	boolean	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
properties.enableAutomaticUpgrade	boolean	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
properties.forceUpdateTag	string	How the extension handler should be forced to update even if the extension configuration has not changed.
properties.protectedSettings	management.azure.com.hybridcompute.machineextensions.update	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
properties.publisher	string	The name of the extension handler publisher.
properties.settings	management.azure.com.hybridcompute.machineextensions.update	Json formatted public settings for the extension.
properties.type	string	Specifies the type of the extension; an example is "CustomScriptExtension".
properties.typeHandlerVersion	string	Specifies the version of the script handler.
tags	object	Resource tags

Responses

Name	Type	Description
200 OK	MachineExtension	Azure operation completed successfully.
202 Accepted		Resource update request accepted. Headers Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

MachineExtension

Azure operation completed successfully.

202 Accepted

Resource update request accepted.

Headers

Azure-AsyncOperation: string
Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create or Update a Machine Extension

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/extensions/CustomScriptExtension?api-version=2026-09-01

{
  "properties": {
    "type": "CustomScriptExtension",
    "enableAutomaticUpgrade": true,
    "publisher": "Microsoft.Compute",
    "settings": {
      "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\""
    },
    "typeHandlerVersion": "1.10"
  }
}

Sample response

Status code:: 200

{
  "name": "CustomScriptExtension",
  "type": "Microsoft.HybridCompute/machines/extensions",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension",
  "location": "eastus2euap",
  "properties": {
    "type": "string",
    "autoUpgradeMinorVersion": false,
    "enableAutomaticUpgrade": true,
    "instanceView": {
      "name": "CustomScriptExtension",
      "type": "CustomScriptExtension",
      "status": {
        "code": "success",
        "level": "Information",
        "message": "Finished executing command, StdOut: , StdErr:",
        "time": "2020-01-08T20:42:10.999Z"
      },
      "typeHandlerVersion": "1.10.3"
    },
    "protectedSettings": {},
    "provisioningState": "Succeeded",
    "publisher": "Microsoft.Compute",
    "settings": {
      "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\""
    },
    "typeHandlerVersion": "1.10.3"
  }
}

Status code:: 202

Azure-AsyncOperation: {callbackUri}
Location: {callbackUrl}
Retry-After: 200

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
MachineExtension	Describes a Machine Extension.
MachineExtensionInstanceView	Describes the Machine Extension Instance View.
MachineExtensionInstanceViewStatus	Instance view status.
MachineExtensionProperties	Describes the properties of a Machine Extension.
MachineExtensionUpdate	Describes a Machine Extension Update.
StatusLevelTypes	The level code.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.