Microsoft.ContainerService (preview:2025-08-02)

2025/10/01 • 10 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ContainerService/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeCustomizations_ListBySubscription (new)
Description :  List the node customizations in a subscription at the latest version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/nodeCustomizations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NodeCustomization items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
version:
{
Description: An auto-generated value that changes when the other fields of the image customization are changed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the node customization. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Provisioning the resource is in progress ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
Accepted: The change request has been accepted ,
}
,
Required: False ,
}
enum ,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeCustomizations_ListByResourceGroup (new)
Description :  List the node customizations in a resource group at the latest version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/nodeCustomizations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NodeCustomization items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
version:
{
Description: An auto-generated value that changes when the other fields of the image customization are changed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the node customization. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Provisioning the resource is in progress ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
Accepted: The change request has been accepted ,
}
,
Required: False ,
}
enum ,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeCustomizations_Get (new)
Description :  Get a node customization at the latest version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/nodeCustomizations/{nodeCustomizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
nodeCustomizationName:
{
Description: The name of the Node Customization resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
version:
{
Description: An auto-generated value that changes when the other fields of the image customization are changed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the node customization. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Provisioning the resource is in progress ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
Accepted: The change request has been accepted ,
}
,
Required: False ,
}
enum ,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeCustomizations_CreateOrUpdate (new)
Description :  Create or update a node customization resource. This will create a new version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/nodeCustomizations/{nodeCustomizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if the targeted resource's etag matches the value provided. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: The request should only proceed if the targeted resource's etag does not match the value provided. ,
Required: False ,
}
string ,
nodeCustomizationName:
{
Description: The name of the Node Customization resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
version:
{
Description: An auto-generated value that changes when the other fields of the image customization are changed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the node customization. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Provisioning the resource is in progress ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
Accepted: The change request has been accepted ,
}
,
Required: False ,
}
enum ,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
version:
{
Description: An auto-generated value that changes when the other fields of the image customization are changed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the node customization. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Provisioning the resource is in progress ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
Accepted: The change request has been accepted ,
}
,
Required: False ,
}
enum ,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Node Customization resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
version:
{
Description: An auto-generated value that changes when the other fields of the image customization are changed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the node customization. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Provisioning the resource is in progress ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
Accepted: The change request has been accepted ,
}
,
Required: False ,
}
enum ,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeCustomizations_Update (new)
Description :  Update a NodeCustomization
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/nodeCustomizations/{nodeCustomizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if the targeted resource's etag matches the value provided. ,
Required: False ,
}
string ,
nodeCustomizationName:
{
Description: The name of the Node Customization resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
version:
{
Description: An auto-generated value that changes when the other fields of the image customization are changed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the node customization. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Provisioning the resource is in progress ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
Accepted: The change request has been accepted ,
}
,
Required: False ,
}
enum ,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeCustomizations_Delete (new)
Description :  Delete a node customization. This operation will be blocked if the resource is in use.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/nodeCustomizations/{nodeCustomizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if the targeted resource's etag matches the value provided. ,
Required: False ,
}
string ,
nodeCustomizationName:
{
Description: The name of the Node Customization resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeCustomizations_ListVersions (new)
Description :  List all versions of a node customization.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/nodeCustomizations/{nodeCustomizationName}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
nodeCustomizationName:
{
Description: The name of the Node Customization resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NodeCustomizationVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
version:
{
Description: An auto-generated value that changes when the other fields of the image customization are changed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the node customization. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Provisioning the resource is in progress ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
Accepted: The change request has been accepted ,
}
,
Required: False ,
}
enum ,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeCustomizations_GetVersion (new)
Description :  Get a node customization at a particular version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/nodeCustomizations/{nodeCustomizationName}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
nodeCustomizationName:
{
Description: The name of the Node Customization resource. ,
Required: True ,
}
string ,
version:
{
Description: The version of the Node Customization. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerImages:
{
Description: The list of container images to cache on nodes. See https://kubernetes.io/docs/concepts/containers/images/#image-names ,
Required: False ,
}
[
string ,
]
,
identityProfile:
{
Description: 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. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
version:
{
Description: An auto-generated value that changes when the other fields of the image customization are changed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the node customization. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Provisioning the resource is in progress ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
Accepted: The change request has been accepted ,
}
,
Required: False ,
}
enum ,
customizationScripts:
{
Description: The scripts to customize the node before or after image capture. ,
Required: False ,
}
[
{
name:
{
Description: The name for the customization script. Must be unique within the node customization resource. Can only contain lowercase alphanumeric,'-' or '.' characters. ,
Required: True ,
}
string ,
executionPoint:
{
Description: The stage at which the script is executed. Specifying `NodeImageBuildTime` will ensure changes are persisted into the node image. ,
Enum:
{
NodeImageBuildTime: Execute during node image build time. ,
NodeProvisionTime: Execute during node provisioning time. ,
}
,
Required: True ,
}
enum ,
scriptType:
{
Description: The runtime environment for the script (e.g. Bash). ,
Enum:
{
Bash: Bash script. ,
PowerShell: PowerShell script. ,
}
,
Required: True ,
}
enum ,
script:
{
Description: The script content to be executed in plain text. Do not include secrets. ,
Required: False ,
}
string ,
rebootAfter:
{
Description: Whether the node should reboot after successful script execution. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeCustomizations_DeleteVersion (new)
Description :  Delete a node customization version. This operation will be blocked if the node customization version is in use.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/nodeCustomizations/{nodeCustomizationName}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if the targeted resource's etag matches the value provided. ,
Required: False ,
}
string ,
nodeCustomizationName:
{
Description: The name of the Node Customization resource. ,
Required: True ,
}
string ,
version:
{
Description: The version of the Node Customization. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}