windowsUpdateForBusinessConfiguration resource type
Namespace: microsoft.graph
Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.
Windows Update for business configuration, allows you to specify how and when Windows as a Service updates your Windows 10/11 devices with feature and quality updates. Supports ODATA clauses that DeviceConfiguration entity supports: $filter by types of DeviceConfiguration, $top, $select only DeviceConfiguration base properties, $orderby only DeviceConfiguration base properties, and $skip. The query parameter '$search' is not supported.
Inherits from deviceConfiguration
Methods
| Method | Return Type | Description |
|---|---|---|
| List windowsUpdateForBusinessConfigurations | windowsUpdateForBusinessConfiguration collection | List properties and relationships of the windowsUpdateForBusinessConfiguration objects. |
| Get windowsUpdateForBusinessConfiguration | windowsUpdateForBusinessConfiguration | Read properties and relationships of the windowsUpdateForBusinessConfiguration object. |
| Create windowsUpdateForBusinessConfiguration | windowsUpdateForBusinessConfiguration | Create a new windowsUpdateForBusinessConfiguration object. |
| Delete windowsUpdateForBusinessConfiguration | None | Deletes a windowsUpdateForBusinessConfiguration. |
| Update windowsUpdateForBusinessConfiguration | windowsUpdateForBusinessConfiguration | Update the properties of a windowsUpdateForBusinessConfiguration object. |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | Key of the entity. Inherited from deviceConfiguration |
| lastModifiedDateTime | DateTimeOffset | DateTime the object was last modified. Inherited from deviceConfiguration |
| createdDateTime | DateTimeOffset | DateTime the object was created. Inherited from deviceConfiguration |
| description | String | Admin provided description of the Device Configuration. Inherited from deviceConfiguration |
| displayName | String | Admin provided name of the device configuration. Inherited from deviceConfiguration |
| version | Int32 | Version of the device configuration. Inherited from deviceConfiguration |
| deliveryOptimizationMode | windowsDeliveryOptimizationMode | The Delivery Optimization Mode. Possible values are: UserDefined, HttpOnly, HttpWithPeeringNat, HttpWithPeeringPrivateGroup, HttpWithInternetPeering, SimpleDownload, BypassMode. UserDefined allows the user to set. Returned by default. Query parameters are not supported. Possible values are: userDefined, httpOnly, httpWithPeeringNat, httpWithPeeringPrivateGroup, httpWithInternetPeering, simpleDownload, bypassMode. |
| prereleaseFeatures | prereleaseFeatures | The Pre-Release Features. Possible values are: UserDefined, SettingsOnly, SettingsAndExperimentations, NotAllowed. UserDefined is the default value, no intent. Returned by default. Query parameters are not supported. Possible values are: userDefined, settingsOnly, settingsAndExperimentations, notAllowed. |
| automaticUpdateMode | automaticUpdateMode | The Automatic Update Mode. Possible values are: UserDefined, NotifyDownload, AutoInstallAtMaintenanceTime, AutoInstallAndRebootAtMaintenanceTime, AutoInstallAndRebootAtScheduledTime, AutoInstallAndRebootWithoutEndUserControl, WindowsDefault. UserDefined is the default value, no intent. Returned by default. Query parameters are not supported. Possible values are: userDefined, notifyDownload, autoInstallAtMaintenanceTime, autoInstallAndRebootAtMaintenanceTime, autoInstallAndRebootAtScheduledTime, autoInstallAndRebootWithoutEndUserControl. |
| microsoftUpdateServiceAllowed | Boolean | When TRUE, allows Microsoft Update Service. When FALSE, does not allow Microsoft Update Service. Returned by default. Query parameters are not supported. |
| driversExcluded | Boolean | When TRUE, excludes Windows update Drivers. When FALSE, does not exclude Windows update Drivers. Returned by default. Query parameters are not supported. |
| installationSchedule | windowsUpdateInstallScheduleType | The Installation Schedule. Possible values are: ActiveHoursStart, ActiveHoursEnd, ScheduledInstallDay, ScheduledInstallTime. Returned by default. Query parameters are not supported. |
| qualityUpdatesDeferralPeriodInDays | Int32 | Defer Quality Updates by these many days with valid range from 0 to 30 days. Returned by default. Query parameters are not supported. |
| featureUpdatesDeferralPeriodInDays | Int32 | Defer Feature Updates by these many days with valid range from 0 to 30 days. Returned by default. Query parameters are not supported. |
| qualityUpdatesPaused | Boolean | When TRUE, assigned devices are paused from receiving quality updates for up to 35 days from the time you pause the ring. When FALSE, does not pause Quality Updates. Returned by default. Query parameters are not supported. |
| featureUpdatesPaused | Boolean | When TRUE, assigned devices are paused from receiving feature updates for up to 35 days from the time you pause the ring. When FALSE, does not pause Feature Updates. Returned by default. Query parameters are not supported.s |
| qualityUpdatesPauseExpiryDateTime | DateTimeOffset | The Quality Updates Pause Expiry datetime. This value is 35 days from the time admin paused or extended the pause for the ring. Returned by default. Query parameters are not supported. |
| featureUpdatesPauseExpiryDateTime | DateTimeOffset | The Feature Updates Pause Expiry datetime. This value is 35 days from the time admin paused or extended the pause for the ring. Returned by default. Query parameters are not supported. |
| businessReadyUpdatesOnly | windowsUpdateType | Determines which branch devices will receive their updates from. Possible values are: UserDefined, All, BusinessReadyOnly, WindowsInsiderBuildFast, WindowsInsiderBuildSlow, WindowsInsiderBuildRelease. Returned by default. Query parameters are not supported. Possible values are: userDefined, all, businessReadyOnly, windowsInsiderBuildFast, windowsInsiderBuildSlow, windowsInsiderBuildRelease. |
| skipChecksBeforeRestart | Boolean | When TRUE, skips all checks before restart: Battery level = 40%, User presence, Display Needed, Presentation mode, Full screen mode, phone call state, game mode etc. When FALSE, does not skip all checks before restart. Returned by default. Query parameters are not supported. |
| updateWeeks | windowsUpdateForBusinessUpdateWeeks | Schedule the update installation on the weeks of the month. Possible values are: UserDefined, FirstWeek, SecondWeek, ThirdWeek, FourthWeek, EveryWeek. Returned by default. Query parameters are not supported. Possible values are: userDefined, firstWeek, secondWeek, thirdWeek, fourthWeek, everyWeek, unknownFutureValue. |
| qualityUpdatesPauseStartDate | Date | The Quality Updates Pause start date. This value is the time when the admin paused or extended the pause for the ring. Returned by default. Query parameters are not supported. This property is read-only. |
| featureUpdatesPauseStartDate | Date | The Feature Updates Pause start date. This value is the time when the admin paused or extended the pause for the ring. Returned by default. Query parameters are not supported. This property is read-only. |
| featureUpdatesRollbackWindowInDays | Int32 | The number of days after a Feature Update for which a rollback is valid with valid range from 2 to 60 days. Returned by default. Query parameters are not supported. |
| qualityUpdatesWillBeRolledBack | Boolean | When TRUE, rollback Quality Updates on the next device check in. When FALSE, do not rollback Quality Updates on the next device check in. Returned by default. Query parameters are not supported. |
| featureUpdatesWillBeRolledBack | Boolean | When TRUE, rollback Feature Updates on the next device check in. When FALSE, do not rollback Feature Updates on the next device check in. Returned by default.Query parameters are not supported. |
| qualityUpdatesRollbackStartDateTime | DateTimeOffset | The Quality Updates Rollback Start datetime. This value is the time when the admin rolled back the Quality update for the ring. Returned by default. Query parameters are not supported. |
| featureUpdatesRollbackStartDateTime | DateTimeOffset | The Feature Updates Rollback Start datetime.This value is the time when the admin rolled back the Feature update for the ring.Returned by default.Query parameters are not supported. |
| engagedRestartDeadlineInDays | Int32 | Deadline in days before automatically scheduling and executing a pending restart outside of active hours, with valid range from 2 to 30 days. Returned by default. Query parameters are not supported. |
| engagedRestartSnoozeScheduleInDays | Int32 | Number of days a user can snooze Engaged Restart reminder notifications with valid range from 1 to 3 days. Returned by default. Query parameters are not supported. |
| engagedRestartTransitionScheduleInDays | Int32 | Number of days before transitioning from Auto Restarts scheduled outside of active hours to Engaged Restart, which requires the user to schedule, with valid range from 0 to 30 days. Returned by default. Query parameters are not supported. |
| deadlineForFeatureUpdatesInDays | Int32 | Number of days before feature updates are installed automatically with valid range from 0 to 30 days. Returned by default. Query parameters are not supported. |
| deadlineForQualityUpdatesInDays | Int32 | Number of days before quality updates are installed automatically with valid range from 0 to 30 days. Returned by default. Query parameters are not supported. |
| deadlineGracePeriodInDays | Int32 | Number of days after deadline until restarts occur automatically with valid range from 0 to 7 days. Returned by default. Query parameters are not supported. |
| postponeRebootUntilAfterDeadline | Boolean | When TRUE the device should wait until deadline for rebooting outside of active hours. When FALSE the device should not wait until deadline for rebooting outside of active hours. Returned by default. Query parameters are not supported. |
| autoRestartNotificationDismissal | autoRestartNotificationDismissalMethod | Specify the method by which the auto-restart required notification is dismissed. Possible values are: NotConfigured, Automatic, User. Returned by default. Query parameters are not supported. Possible values are: notConfigured, automatic, user, unknownFutureValue. |
| scheduleRestartWarningInHours | Int32 | Specify the period for auto-restart warning reminder notifications. Supported values: 2, 4, 8, 12 or 24 (hours). Returned by default. Query parameters are not supported. |
| scheduleImminentRestartWarningInMinutes | Int32 | Specify the period for auto-restart imminent warning notifications. Supported values: 15, 30 or 60 (minutes). Returned by default. Query parameters are not supported. |
| userPauseAccess | enablement | Specifies whether to enable end user’s access to pause software updates. Possible values are: NotConfigured, Enabled, Disabled. Returned by default. Query parameters are not supported. Possible values are: notConfigured, enabled, disabled. |
| userWindowsUpdateScanAccess | enablement | Specifies whether to disable user’s access to scan Windows Update. Possible values are: NotConfigured, Enabled, Disabled. Returned by default. Query parameters are not supported. Possible values are: notConfigured, enabled, disabled. |
| updateNotificationLevel | windowsUpdateNotificationDisplayOption | Specifies what Windows Update notifications users see. Possible values are: NotConfigured, DefaultNotifications, RestartWarningsOnly, DisableAllNotifications. Returned by default. Query parameters are not supported. Possible values are: notConfigured, defaultNotifications, restartWarningsOnly, disableAllNotifications, unknownFutureValue. |
| allowWindows11Upgrade | Boolean | When TRUE, allows eligible Windows 10 devices to upgrade to Windows 11. When FALSE, implies the device stays on the existing operating system. Returned by default. Query parameters are not supported. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| assignments | deviceConfigurationAssignment collection | The list of assignments for the device configuration profile. Inherited from deviceConfiguration |
| deviceStatuses | deviceConfigurationDeviceStatus collection | Device configuration installation status by device. Inherited from deviceConfiguration |
| userStatuses | deviceConfigurationUserStatus collection | Device configuration installation status by user. Inherited from deviceConfiguration |
| deviceStatusOverview | deviceConfigurationDeviceOverview | Device Configuration devices status overview Inherited from deviceConfiguration |
| userStatusOverview | deviceConfigurationUserOverview | Device Configuration users status overview Inherited from deviceConfiguration |
| deviceSettingStateSummaries | settingStateDeviceSummary collection | Device Configuration Setting State Device Summary Inherited from deviceConfiguration |
JSON Representation
Here is a JSON representation of the resource.
{
"@odata.type": "#microsoft.graph.windowsUpdateForBusinessConfiguration",
"id": "String (identifier)",
"lastModifiedDateTime": "String (timestamp)",
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"version": 1024,
"deliveryOptimizationMode": "String",
"prereleaseFeatures": "String",
"automaticUpdateMode": "String",
"microsoftUpdateServiceAllowed": true,
"driversExcluded": true,
"installationSchedule": {
"@odata.type": "microsoft.graph.windowsUpdateScheduledInstall",
"scheduledInstallDay": "String",
"scheduledInstallTime": "String (time of day)"
},
"qualityUpdatesDeferralPeriodInDays": 1024,
"featureUpdatesDeferralPeriodInDays": 1024,
"qualityUpdatesPaused": true,
"featureUpdatesPaused": true,
"qualityUpdatesPauseExpiryDateTime": "String (timestamp)",
"featureUpdatesPauseExpiryDateTime": "String (timestamp)",
"businessReadyUpdatesOnly": "String",
"skipChecksBeforeRestart": true,
"updateWeeks": "String",
"qualityUpdatesPauseStartDate": "String (Date)",
"featureUpdatesPauseStartDate": "String (Date)",
"featureUpdatesRollbackWindowInDays": 1024,
"qualityUpdatesWillBeRolledBack": true,
"featureUpdatesWillBeRolledBack": true,
"qualityUpdatesRollbackStartDateTime": "String (timestamp)",
"featureUpdatesRollbackStartDateTime": "String (timestamp)",
"engagedRestartDeadlineInDays": 1024,
"engagedRestartSnoozeScheduleInDays": 1024,
"engagedRestartTransitionScheduleInDays": 1024,
"deadlineForFeatureUpdatesInDays": 1024,
"deadlineForQualityUpdatesInDays": 1024,
"deadlineGracePeriodInDays": 1024,
"postponeRebootUntilAfterDeadline": true,
"autoRestartNotificationDismissal": "String",
"scheduleRestartWarningInHours": 1024,
"scheduleImminentRestartWarningInMinutes": 1024,
"userPauseAccess": "String",
"userWindowsUpdateScanAccess": "String",
"updateNotificationLevel": "String",
"allowWindows11Upgrade": true
}