Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The nodeCustomizations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerService/nodeCustomizations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ContainerService/nodeCustomizations@2025-09-02-preview' = {
location: 'string'
name: 'string'
properties: {
containerImages: [
'string'
]
customizationScripts: [
{
executionPoint: 'string'
name: 'string'
rebootAfter: bool
script: 'string'
scriptType: 'string'
}
]
identityProfile: {}
version: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.ContainerService/nodeCustomizations
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required) |
| properties | The resource-specific properties for this resource. | NodeCustomizationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
NodeCustomizationProperties
| Name | Description | Value |
|---|---|---|
| containerImages | The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names | string[] |
| customizationScripts | The scripts to customize the node before or after image capture. | NodeCustomizationScript[] |
| identityProfile | The identity used to execute node customization tasks during image build time and provisioning time. If not specified the default agentpool identity will be used. This does not affect provisioned nodes. |
UserAssignedIdentity |
| version | The client-provided version of the node customization. | string Constraints: Pattern = ^(?![.-])[A-Za-z0-9_.-]{1,63}$ |
NodeCustomizationScript
| Name | Description | Value |
|---|---|---|
| executionPoint | The stage at which the script is executed. Specifying NodeImageBuildTime will ensure changes are persisted into the node image. |
'NodeImageBuildTime' 'NodeProvisionTime' (required) |
| name | The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. |
string Constraints: Max length = 263 Pattern = ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$ (required) |
| rebootAfter | Whether the node should reboot after successful script execution. | bool |
| script | The script content to be executed in plain text. Do not include secrets. | string |
| scriptType | The runtime environment for the script (e.g. Bash). | 'Bash' 'PowerShell' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The nodeCustomizations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerService/nodeCustomizations resource, add the following JSON to your template.
{
"type": "Microsoft.ContainerService/nodeCustomizations",
"apiVersion": "2025-09-02-preview",
"name": "string",
"location": "string",
"properties": {
"containerImages": [ "string" ],
"customizationScripts": [
{
"executionPoint": "string",
"name": "string",
"rebootAfter": "bool",
"script": "string",
"scriptType": "string"
}
],
"identityProfile": {
},
"version": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.ContainerService/nodeCustomizations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-09-02-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required) |
| properties | The resource-specific properties for this resource. | NodeCustomizationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.ContainerService/nodeCustomizations' |
NodeCustomizationProperties
| Name | Description | Value |
|---|---|---|
| containerImages | The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names | string[] |
| customizationScripts | The scripts to customize the node before or after image capture. | NodeCustomizationScript[] |
| identityProfile | The identity used to execute node customization tasks during image build time and provisioning time. If not specified the default agentpool identity will be used. This does not affect provisioned nodes. |
UserAssignedIdentity |
| version | The client-provided version of the node customization. | string Constraints: Pattern = ^(?![.-])[A-Za-z0-9_.-]{1,63}$ |
NodeCustomizationScript
| Name | Description | Value |
|---|---|---|
| executionPoint | The stage at which the script is executed. Specifying NodeImageBuildTime will ensure changes are persisted into the node image. |
'NodeImageBuildTime' 'NodeProvisionTime' (required) |
| name | The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. |
string Constraints: Max length = 263 Pattern = ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$ (required) |
| rebootAfter | Whether the node should reboot after successful script execution. | bool |
| script | The script content to be executed in plain text. Do not include secrets. | string |
| scriptType | The runtime environment for the script (e.g. Bash). | 'Bash' 'PowerShell' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The nodeCustomizations resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerService/nodeCustomizations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerService/nodeCustomizations@2025-09-02-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
containerImages = [
"string"
]
customizationScripts = [
{
executionPoint = "string"
name = "string"
rebootAfter = bool
script = "string"
scriptType = "string"
}
]
identityProfile = {
}
version = "string"
}
}
}
Property Values
Microsoft.ContainerService/nodeCustomizations
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required) |
| properties | The resource-specific properties for this resource. | NodeCustomizationProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.ContainerService/nodeCustomizations@2025-09-02-preview" |
NodeCustomizationProperties
| Name | Description | Value |
|---|---|---|
| containerImages | The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names | string[] |
| customizationScripts | The scripts to customize the node before or after image capture. | NodeCustomizationScript[] |
| identityProfile | The identity used to execute node customization tasks during image build time and provisioning time. If not specified the default agentpool identity will be used. This does not affect provisioned nodes. |
UserAssignedIdentity |
| version | The client-provided version of the node customization. | string Constraints: Pattern = ^(?![.-])[A-Za-z0-9_.-]{1,63}$ |
NodeCustomizationScript
| Name | Description | Value |
|---|---|---|
| executionPoint | The stage at which the script is executed. Specifying NodeImageBuildTime will ensure changes are persisted into the node image. |
'NodeImageBuildTime' 'NodeProvisionTime' (required) |
| name | The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. |
string Constraints: Max length = 263 Pattern = ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$ (required) |
| rebootAfter | Whether the node should reboot after successful script execution. | bool |
| script | The script content to be executed in plain text. Do not include secrets. | string |
| scriptType | The runtime environment for the script (e.g. Bash). | 'Bash' 'PowerShell' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|