POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches/?api-version=2023-09-01

Installs patches on the VM.

Servers

Path parameters

Name Type Required Description
vmName String Yes

The name of the virtual machine.

subscriptionId String Yes

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName String Yes

The name of the resource group.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
linuxParameters Object No

Input for InstallPatches on a Linux VM, as directly received by the API

linuxParameters.classificationsToInclude[] Array No

The update classifications to select when installing patches for Linux.

linuxParameters.packageNameMasksToInclude[] Array No

packages to include in the patch operation. Format: packageName_packageVersion

linuxParameters.packageNameMasksToExclude[] Array No

packages to exclude in the patch operation. Format: packageName_packageVersion

linuxParameters.maintenanceRunId String No

This is used as a maintenance run identifier for Auto VM Guest Patching in Linux.

maximumDuration String No

Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)

windowsParameters Object No

Input for InstallPatches on a Windows VM, as directly received by the API

windowsParameters.classificationsToInclude[] Array No

The update classifications to select when installing patches for Windows.

windowsParameters.kbNumbersToInclude[] Array No

Kbs to include in the patch operation

windowsParameters.kbNumbersToExclude[] Array No

Kbs to exclude in the patch operation

windowsParameters.excludeKbsRequiringReboot Boolean No

Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true.

windowsParameters.maxPatchPublishDate String No

This is used to install patches that were published on or before this given max published date.

rebootSetting String Yes

Defines when it is acceptable to reboot a VM during a software update operation.

Possible values:

  • "Always"
  • "IfRequired"
  • "Never"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.