Update windows10CompliancePolicy

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a windows10CompliancePolicy object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) DeviceManagementConfiguration.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application DeviceManagementConfiguration.ReadWrite.All

HTTP Request

PATCH /deviceManagement/deviceCompliancePolicies/{deviceCompliancePolicyId}

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Accept application/json

Request body

In the request body, supply a JSON representation for the windows10CompliancePolicy object.

The following table shows the properties that are required when you create the windows10CompliancePolicy.

Property Type Description
roleScopeTagIds String collection List of Scope Tags for this Entity instance. Inherited from deviceCompliancePolicy
id String Key of the entity. Inherited from deviceCompliancePolicy
createdDateTime DateTimeOffset DateTime the object was created. Inherited from deviceCompliancePolicy
description String Admin provided description of the Device Configuration. Inherited from deviceCompliancePolicy
lastModifiedDateTime DateTimeOffset DateTime the object was last modified. Inherited from deviceCompliancePolicy
displayName String Admin provided name of the device configuration. Inherited from deviceCompliancePolicy
version Int32 Version of the device configuration. Inherited from deviceCompliancePolicy
passwordRequired Boolean Require a password to unlock Windows device.
passwordBlockSimple Boolean Indicates whether or not to block simple password.
passwordRequiredToUnlockFromIdle Boolean Require a password to unlock an idle device.
passwordMinutesOfInactivityBeforeLock Int32 Minutes of inactivity before a password is required.
passwordExpirationDays Int32 The password expiration in days.
passwordMinimumLength Int32 The minimum password length.
passwordMinimumCharacterSetCount Int32 The number of character sets required in the password.
passwordRequiredType requiredPasswordType The required password type. Possible values are: deviceDefault, alphanumeric, numeric.
passwordPreviousPasswordBlockCount Int32 The number of previous passwords to prevent re-use of.
requireHealthyDeviceReport Boolean Require devices to be reported as healthy by Windows Device Health Attestation.
osMinimumVersion String Minimum Windows 10 version.
osMaximumVersion String Maximum Windows 10 version.
mobileOsMinimumVersion String Minimum Windows Phone version.
mobileOsMaximumVersion String Maximum Windows Phone version.
earlyLaunchAntiMalwareDriverEnabled Boolean Require devices to be reported as healthy by Windows Device Health Attestation - early launch antimalware driver is enabled.
bitLockerEnabled Boolean Require devices to be reported healthy by Windows Device Health Attestation - bit locker is enabled
secureBootEnabled Boolean Require devices to be reported as healthy by Windows Device Health Attestation - secure boot is enabled.
codeIntegrityEnabled Boolean Require devices to be reported as healthy by Windows Device Health Attestation.
memoryIntegrityEnabled Boolean When TRUE, indicates that Memory Integrity as known as Hypervisor-protected Code Integrity (HVCI) or Hypervisor Enforced Code Integrity protection is required to be reported as healthy by Microsoft Azure Attestion. When FALSE, indicates that Memory Integrity Protection is not required to be reported as healthy. Default value is FALSE.
kernelDmaProtectionEnabled Boolean When TRUE, indicates that Kernel Direct Memory Access (DMA) protection is required to be reported as healthy by Microsoft Azure Attestion. When FALSE, indicates that Kernel DMA Protection is not required to be reported as healthy. Default value is FALSE.
virtualizationBasedSecurityEnabled Boolean When TRUE, indicates that Virtualization-based Security is required to be reported as healthy by Microsoft Azure Attestion. When FALSE, indicates that Virtualization-based Security is not required to be reported as healthy. Default value is FALSE.
firmwareProtectionEnabled Boolean When TRUE, indicates that Firmware protection is required to be reported as healthy by Microsoft Azure Attestion. When FALSE, indicates that Firmware protection is not required to be reported as healthy. Devices that support either Dynamic Root of Trust for Measurement (DRTM) or Firmware Attack Surface Reduction (FASR) will report compliant for this setting. Default value is FALSE.
storageRequireEncryption Boolean Require encryption on windows devices.
activeFirewallRequired Boolean Require active firewall on Windows devices.
defenderEnabled Boolean Require Windows Defender Antimalware on Windows devices.
defenderVersion String Require Windows Defender Antimalware minimum version on Windows devices.
signatureOutOfDate Boolean Require Windows Defender Antimalware Signature to be up to date on Windows devices.
rtpEnabled Boolean Require Windows Defender Antimalware Real-Time Protection on Windows devices.
antivirusRequired Boolean Require any Antivirus solution registered with Windows Decurity Center to be on and monitoring (e.g. Symantec, Windows Defender).
antiSpywareRequired Boolean Require any AntiSpyware solution registered with Windows Decurity Center to be on and monitoring (e.g. Symantec, Windows Defender).
validOperatingSystemBuildRanges operatingSystemVersionRange collection The valid operating system build ranges on Windows devices. This collection can contain a maximum of 10000 elements.
deviceThreatProtectionEnabled Boolean Require that devices have enabled device threat protection.
deviceThreatProtectionRequiredSecurityLevel deviceThreatProtectionLevel Require Device Threat Protection minimum risk level to report noncompliance. Possible values are: unavailable, secured, low, medium, high, notSet.
configurationManagerComplianceRequired Boolean Require to consider SCCM Compliance state into consideration for Intune Compliance State.
tpmRequired Boolean Require Trusted Platform Module(TPM) to be present.
deviceCompliancePolicyScript deviceCompliancePolicyScript
wslDistributions wslDistributionConfiguration collection

Response

If successful, this method returns a 200 OK response code and an updated windows10CompliancePolicy object in the response body.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceManagement/deviceCompliancePolicies/{deviceCompliancePolicyId}
Content-type: application/json
Content-length: 2337

{
  "@odata.type": "#microsoft.graph.windows10CompliancePolicy",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "description": "Description value",
  "displayName": "Display Name value",
  "version": 7,
  "passwordRequired": true,
  "passwordBlockSimple": true,
  "passwordRequiredToUnlockFromIdle": true,
  "passwordMinutesOfInactivityBeforeLock": 5,
  "passwordExpirationDays": 6,
  "passwordMinimumLength": 5,
  "passwordMinimumCharacterSetCount": 0,
  "passwordRequiredType": "alphanumeric",
  "passwordPreviousPasswordBlockCount": 2,
  "requireHealthyDeviceReport": true,
  "osMinimumVersion": "Os Minimum Version value",
  "osMaximumVersion": "Os Maximum Version value",
  "mobileOsMinimumVersion": "Mobile Os Minimum Version value",
  "mobileOsMaximumVersion": "Mobile Os Maximum Version value",
  "earlyLaunchAntiMalwareDriverEnabled": true,
  "bitLockerEnabled": true,
  "secureBootEnabled": true,
  "codeIntegrityEnabled": true,
  "memoryIntegrityEnabled": true,
  "kernelDmaProtectionEnabled": true,
  "virtualizationBasedSecurityEnabled": true,
  "firmwareProtectionEnabled": true,
  "storageRequireEncryption": true,
  "activeFirewallRequired": true,
  "defenderEnabled": true,
  "defenderVersion": "Defender Version value",
  "signatureOutOfDate": true,
  "rtpEnabled": true,
  "antivirusRequired": true,
  "antiSpywareRequired": true,
  "validOperatingSystemBuildRanges": [
    {
      "@odata.type": "microsoft.graph.operatingSystemVersionRange",
      "description": "Description value",
      "lowestVersion": "Lowest Version value",
      "highestVersion": "Highest Version value"
    }
  ],
  "deviceThreatProtectionEnabled": true,
  "deviceThreatProtectionRequiredSecurityLevel": "secured",
  "configurationManagerComplianceRequired": true,
  "tpmRequired": true,
  "deviceCompliancePolicyScript": {
    "@odata.type": "microsoft.graph.deviceCompliancePolicyScript",
    "deviceComplianceScriptId": "Device Compliance Script Id value",
    "rulesContent": "cnVsZXNDb250ZW50"
  },
  "wslDistributions": [
    {
      "@odata.type": "microsoft.graph.wslDistributionConfiguration",
      "distribution": "Distribution value",
      "minimumOSVersion": "Minimum OSVersion value",
      "maximumOSVersion": "Maximum OSVersion value"
    }
  ]
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2509

{
  "@odata.type": "#microsoft.graph.windows10CompliancePolicy",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "id": "2919ae62-ae62-2919-62ae-192962ae1929",
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "description": "Description value",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "displayName": "Display Name value",
  "version": 7,
  "passwordRequired": true,
  "passwordBlockSimple": true,
  "passwordRequiredToUnlockFromIdle": true,
  "passwordMinutesOfInactivityBeforeLock": 5,
  "passwordExpirationDays": 6,
  "passwordMinimumLength": 5,
  "passwordMinimumCharacterSetCount": 0,
  "passwordRequiredType": "alphanumeric",
  "passwordPreviousPasswordBlockCount": 2,
  "requireHealthyDeviceReport": true,
  "osMinimumVersion": "Os Minimum Version value",
  "osMaximumVersion": "Os Maximum Version value",
  "mobileOsMinimumVersion": "Mobile Os Minimum Version value",
  "mobileOsMaximumVersion": "Mobile Os Maximum Version value",
  "earlyLaunchAntiMalwareDriverEnabled": true,
  "bitLockerEnabled": true,
  "secureBootEnabled": true,
  "codeIntegrityEnabled": true,
  "memoryIntegrityEnabled": true,
  "kernelDmaProtectionEnabled": true,
  "virtualizationBasedSecurityEnabled": true,
  "firmwareProtectionEnabled": true,
  "storageRequireEncryption": true,
  "activeFirewallRequired": true,
  "defenderEnabled": true,
  "defenderVersion": "Defender Version value",
  "signatureOutOfDate": true,
  "rtpEnabled": true,
  "antivirusRequired": true,
  "antiSpywareRequired": true,
  "validOperatingSystemBuildRanges": [
    {
      "@odata.type": "microsoft.graph.operatingSystemVersionRange",
      "description": "Description value",
      "lowestVersion": "Lowest Version value",
      "highestVersion": "Highest Version value"
    }
  ],
  "deviceThreatProtectionEnabled": true,
  "deviceThreatProtectionRequiredSecurityLevel": "secured",
  "configurationManagerComplianceRequired": true,
  "tpmRequired": true,
  "deviceCompliancePolicyScript": {
    "@odata.type": "microsoft.graph.deviceCompliancePolicyScript",
    "deviceComplianceScriptId": "Device Compliance Script Id value",
    "rulesContent": "cnVsZXNDb250ZW50"
  },
  "wslDistributions": [
    {
      "@odata.type": "microsoft.graph.wslDistributionConfiguration",
      "distribution": "Distribution value",
      "minimumOSVersion": "Minimum OSVersion value",
      "maximumOSVersion": "Maximum OSVersion value"
    }
  ]
}