windowsUpdateForBusinessConfiguration resource type

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.

Windows Update for business configuration.

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.
extendFeatureUpdatesPause action None Extend Feature Updates Pause for a Windows Update for Business ring.
extendQualityUpdatesPause action None Extend Quality Updates Pause for a Windows Update for Business ring.

Properties

Property Type Description
id String Key of the entity. Inherited from deviceConfiguration
lastModifiedDateTime DateTimeOffset DateTime the object was last modified. Inherited from deviceConfiguration
roleScopeTagIds String collection List of Scope Tags for this Entity instance. Inherited from deviceConfiguration
supportsScopeTags Boolean Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleOsEdition deviceManagementApplicabilityRuleOsEdition The OS edition applicability for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleOsVersion deviceManagementApplicabilityRuleOsVersion The OS version applicability rule for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleDeviceMode deviceManagementApplicabilityRuleDeviceMode The device mode applicability rule for this Policy. 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 Delivery Optimization Mode. Possible values are: userDefined, httpOnly, httpWithPeeringNat, httpWithPeeringPrivateGroup, httpWithInternetPeering, simpleDownload, bypassMode.
prereleaseFeatures prereleaseFeatures The pre-release features. Possible values are: userDefined, settingsOnly, settingsAndExperimentations, notAllowed.
automaticUpdateMode automaticUpdateMode Automatic update mode. Possible values are: userDefined, notifyDownload, autoInstallAtMaintenanceTime, autoInstallAndRebootAtMaintenanceTime, autoInstallAndRebootAtScheduledTime, autoInstallAndRebootWithoutEndUserControl, windowsDefault.
microsoftUpdateServiceAllowed Boolean Allow Microsoft Update Service
driversExcluded Boolean Exclude Windows update Drivers
installationSchedule windowsUpdateInstallScheduleType Installation schedule
qualityUpdatesDeferralPeriodInDays Int32 Defer Quality Updates by these many days
featureUpdatesDeferralPeriodInDays Int32 Defer Feature Updates by these many days
qualityUpdatesPaused Boolean Pause Quality Updates
featureUpdatesPaused Boolean Pause Feature Updates
qualityUpdatesPauseExpiryDateTime DateTimeOffset Quality Updates Pause Expiry datetime
featureUpdatesPauseExpiryDateTime DateTimeOffset Feature Updates Pause Expiry datetime
businessReadyUpdatesOnly windowsUpdateType Determines which branch devices will receive their updates from. Possible values are: userDefined, all, businessReadyOnly, windowsInsiderBuildFast, windowsInsiderBuildSlow, windowsInsiderBuildRelease.
skipChecksBeforeRestart Boolean Set to skip all check before restart: Battery level = 40%, User presence, Display Needed, Presentation mode, Full screen mode, phone call state, game mode etc.
updateWeeks windowsUpdateForBusinessUpdateWeeks Scheduled the update installation on the weeks of the month. Possible values are: userDefined, firstWeek, secondWeek, thirdWeek, fourthWeek, everyWeek.
qualityUpdatesPauseStartDate Date Quality Updates Pause start date. This property is read-only.
featureUpdatesPauseStartDate Date Feature Updates Pause start date. This property is read-only.
featureUpdatesRollbackWindowInDays Int32 The number of days after a Feature Update for which a rollback is valid
qualityUpdatesWillBeRolledBack Boolean Specifies whether to rollback Quality Updates on the next device check in
featureUpdatesWillBeRolledBack Boolean Specifies whether to rollback Feature Updates on the next device check in
qualityUpdatesRollbackStartDateTime DateTimeOffset Quality Updates Rollback Start datetime
featureUpdatesRollbackStartDateTime DateTimeOffset Feature Updates Rollback Start datetime
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
engagedRestartSnoozeScheduleInDays Int32 Number of days a user can snooze Engaged Restart reminder notifications with valid range from 1 to 3 days
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
deadlineForFeatureUpdatesInDays Int32 Number of days before feature updates are installed automatically with valid range from 2 to 30 days
deadlineForQualityUpdatesInDays Int32 Number of days before quality updates are installed automatically with valid range from 2 to 30 days
deadlineGracePeriodInDays Int32 Number of days after deadline until restarts occur automatically with valid range from 0 to 7 days
postponeRebootUntilAfterDeadline Boolean Specifies if the device should wait until deadline for rebooting outside of active hours
autoRestartNotificationDismissal autoRestartNotificationDismissalMethod Specify the method by which the auto-restart required notification is dismissed. Possible values are: notConfigured, automatic, user.
scheduleRestartWarningInHours Int32 Specify the period for auto-restart warning reminder notifications. Supported values: 2, 4, 8, 12 or 24 (hours).
scheduleImminentRestartWarningInMinutes Int32 Specify the period for auto-restart imminent warning notifications. Supported values: 15, 30 or 60 (minutes).
userPauseAccess enablement Specifies whether to enable end user’s access to pause software updates. 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.
updateNotificationLevel windowsUpdateNotificationDisplayOption Specifies what Windows Update notifications users see. Possible values are: notConfigured, defaultNotifications, restartWarningsOnly, disableAllNotifications.

Relationships

Relationship Type Description
groupAssignments deviceConfigurationGroupAssignment collection The list of group assignments for the device configuration profile. Inherited from deviceConfiguration
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
deviceUpdateStates windowsUpdateState collection Windows update for business configuration device states.

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.windowsUpdateForBusinessConfiguration",
  "id": "String (identifier)",
  "lastModifiedDateTime": "String (timestamp)",
  "roleScopeTagIds": [
    "String"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "String"
    ],
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "String",
    "maxOSVersion": "String",
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "String",
    "name": "String",
    "ruleType": "String"
  },
  "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": "<Unknown Primitive Type Edm.Date>",
  "featureUpdatesPauseStartDate": "<Unknown Primitive Type Edm.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"
}