Class: MicrosoftGraph::Models::WindowsUpdateForBusinessConfiguration

Inherits:
DeviceConfiguration show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/windows_update_for_business_configuration.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DeviceConfiguration

#assignments, #assignments=, #created_date_time, #created_date_time=, #description, #description=, #device_setting_state_summaries, #device_setting_state_summaries=, #device_status_overview, #device_status_overview=, #device_statuses, #device_statuses=, #display_name, #display_name=, #last_modified_date_time, #last_modified_date_time=, #user_status_overview, #user_status_overview=, #user_statuses, #user_statuses=, #version, #version=

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initializeObject

Instantiates a new WindowsUpdateForBusinessConfiguration and sets the default values.



182
183
184
185
# File 'lib/models/windows_update_for_business_configuration.rb', line 182

def initialize()
    super
    @odata_type = "#microsoft.graph.windowsUpdateForBusinessConfiguration"
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node

    The parse node to use to read the discriminator value and create the object

Returns:

  • a windows_update_for_business_configuration

Raises:

  • (StandardError)


191
192
193
194
# File 'lib/models/windows_update_for_business_configuration.rb', line 191

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return WindowsUpdateForBusinessConfiguration.new
end

Instance Method Details

#allow_windows11_upgradeObject

Gets the allowWindows11Upgrade property value. 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.

Returns:

  • a boolean



122
123
124
# File 'lib/models/windows_update_for_business_configuration.rb', line 122

def allow_windows11_upgrade
    return @allow_windows11_upgrade
end

#allow_windows11_upgrade=(value) ⇒ Object

Sets the allowWindows11Upgrade property value. 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.

Parameters:

  • value

    Value to set for the allow_windows11_upgrade property.

Returns:

  • a void



130
131
132
# File 'lib/models/windows_update_for_business_configuration.rb', line 130

def allow_windows11_upgrade=(value)
    @allow_windows11_upgrade = value
end

#auto_restart_notification_dismissalObject

Gets the autoRestartNotificationDismissal property value. Auto restart required notification dismissal method

Returns:

  • a auto_restart_notification_dismissal_method



137
138
139
# File 'lib/models/windows_update_for_business_configuration.rb', line 137

def auto_restart_notification_dismissal
    return @auto_restart_notification_dismissal
end

#auto_restart_notification_dismissal=(value) ⇒ Object

Sets the autoRestartNotificationDismissal property value. Auto restart required notification dismissal method

Parameters:

  • value

    Value to set for the auto_restart_notification_dismissal property.

Returns:

  • a void



145
146
147
# File 'lib/models/windows_update_for_business_configuration.rb', line 145

def auto_restart_notification_dismissal=(value)
    @auto_restart_notification_dismissal = value
end

#automatic_update_modeObject

Gets the automaticUpdateMode property value. Possible values for automatic update mode.

Returns:

  • a automatic_update_mode



152
153
154
# File 'lib/models/windows_update_for_business_configuration.rb', line 152

def automatic_update_mode
    return @automatic_update_mode
end

#automatic_update_mode=(value) ⇒ Object

Sets the automaticUpdateMode property value. Possible values for automatic update mode.

Parameters:

  • value

    Value to set for the automatic_update_mode property.

Returns:

  • a void



160
161
162
# File 'lib/models/windows_update_for_business_configuration.rb', line 160

def automatic_update_mode=(value)
    @automatic_update_mode = value
end

#business_ready_updates_onlyObject

Gets the businessReadyUpdatesOnly property value. Which branch devices will receive their updates from

Returns:

  • a windows_update_type



167
168
169
# File 'lib/models/windows_update_for_business_configuration.rb', line 167

def business_ready_updates_only
    return @business_ready_updates_only
end

#business_ready_updates_only=(value) ⇒ Object

Sets the businessReadyUpdatesOnly property value. Which branch devices will receive their updates from

Parameters:

  • value

    Value to set for the business_ready_updates_only property.

Returns:

  • a void



175
176
177
# File 'lib/models/windows_update_for_business_configuration.rb', line 175

def business_ready_updates_only=(value)
    @business_ready_updates_only = value
end

#deadline_for_feature_updates_in_daysObject

Gets the deadlineForFeatureUpdatesInDays property value. 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.

Returns:

  • a integer



199
200
201
# File 'lib/models/windows_update_for_business_configuration.rb', line 199

def deadline_for_feature_updates_in_days
    return @deadline_for_feature_updates_in_days
end

#deadline_for_feature_updates_in_days=(value) ⇒ Object

Sets the deadlineForFeatureUpdatesInDays property value. 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.

Parameters:

  • value

    Value to set for the deadline_for_feature_updates_in_days property.

Returns:

  • a void



207
208
209
# File 'lib/models/windows_update_for_business_configuration.rb', line 207

def deadline_for_feature_updates_in_days=(value)
    @deadline_for_feature_updates_in_days = value
end

#deadline_for_quality_updates_in_daysObject

Gets the deadlineForQualityUpdatesInDays property value. 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.

Returns:

  • a integer



214
215
216
# File 'lib/models/windows_update_for_business_configuration.rb', line 214

def deadline_for_quality_updates_in_days
    return @deadline_for_quality_updates_in_days
end

#deadline_for_quality_updates_in_days=(value) ⇒ Object

Sets the deadlineForQualityUpdatesInDays property value. 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.

Parameters:

  • value

    Value to set for the deadline_for_quality_updates_in_days property.

Returns:

  • a void



222
223
224
# File 'lib/models/windows_update_for_business_configuration.rb', line 222

def deadline_for_quality_updates_in_days=(value)
    @deadline_for_quality_updates_in_days = value
end

#deadline_grace_period_in_daysObject

Gets the deadlineGracePeriodInDays property value. 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.

Returns:

  • a integer



229
230
231
# File 'lib/models/windows_update_for_business_configuration.rb', line 229

def deadline_grace_period_in_days
    return @deadline_grace_period_in_days
end

#deadline_grace_period_in_days=(value) ⇒ Object

Sets the deadlineGracePeriodInDays property value. 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.

Parameters:

  • value

    Value to set for the deadline_grace_period_in_days property.

Returns:

  • a void



237
238
239
# File 'lib/models/windows_update_for_business_configuration.rb', line 237

def deadline_grace_period_in_days=(value)
    @deadline_grace_period_in_days = value
end

#delivery_optimization_modeObject

Gets the deliveryOptimizationMode property value. Delivery optimization mode for peer distribution

Returns:

  • a windows_delivery_optimization_mode



244
245
246
# File 'lib/models/windows_update_for_business_configuration.rb', line 244

def delivery_optimization_mode
    return @delivery_optimization_mode
end

#delivery_optimization_mode=(value) ⇒ Object

Sets the deliveryOptimizationMode property value. Delivery optimization mode for peer distribution

Parameters:

  • value

    Value to set for the delivery_optimization_mode property.

Returns:

  • a void



252
253
254
# File 'lib/models/windows_update_for_business_configuration.rb', line 252

def delivery_optimization_mode=(value)
    @delivery_optimization_mode = value
end

#drivers_excludedObject

Gets the driversExcluded property value. When TRUE, excludes Windows update Drivers. When FALSE, does not exclude Windows update Drivers. Returned by default. Query parameters are not supported.

Returns:

  • a boolean



259
260
261
# File 'lib/models/windows_update_for_business_configuration.rb', line 259

def drivers_excluded
    return @drivers_excluded
end

#drivers_excluded=(value) ⇒ Object

Sets the driversExcluded property value. When TRUE, excludes Windows update Drivers. When FALSE, does not exclude Windows update Drivers. Returned by default. Query parameters are not supported.

Parameters:

  • value

    Value to set for the drivers_excluded property.

Returns:

  • a void



267
268
269
# File 'lib/models/windows_update_for_business_configuration.rb', line 267

def drivers_excluded=(value)
    @drivers_excluded = value
end

#engaged_restart_deadline_in_daysObject

Gets the engagedRestartDeadlineInDays property value. 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.

Returns:

  • a integer



274
275
276
# File 'lib/models/windows_update_for_business_configuration.rb', line 274

def engaged_restart_deadline_in_days
    return @engaged_restart_deadline_in_days
end

#engaged_restart_deadline_in_days=(value) ⇒ Object

Sets the engagedRestartDeadlineInDays property value. 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.

Parameters:

  • value

    Value to set for the engaged_restart_deadline_in_days property.

Returns:

  • a void



282
283
284
# File 'lib/models/windows_update_for_business_configuration.rb', line 282

def engaged_restart_deadline_in_days=(value)
    @engaged_restart_deadline_in_days = value
end

#engaged_restart_snooze_schedule_in_daysObject

Gets the engagedRestartSnoozeScheduleInDays property value. 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.

Returns:

  • a integer



289
290
291
# File 'lib/models/windows_update_for_business_configuration.rb', line 289

def engaged_restart_snooze_schedule_in_days
    return @engaged_restart_snooze_schedule_in_days
end

#engaged_restart_snooze_schedule_in_days=(value) ⇒ Object

Sets the engagedRestartSnoozeScheduleInDays property value. 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.

Parameters:

  • value

    Value to set for the engaged_restart_snooze_schedule_in_days property.

Returns:

  • a void



297
298
299
# File 'lib/models/windows_update_for_business_configuration.rb', line 297

def engaged_restart_snooze_schedule_in_days=(value)
    @engaged_restart_snooze_schedule_in_days = value
end

#engaged_restart_transition_schedule_in_daysObject

Gets the engagedRestartTransitionScheduleInDays property value. 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.

Returns:

  • a integer



304
305
306
# File 'lib/models/windows_update_for_business_configuration.rb', line 304

def engaged_restart_transition_schedule_in_days
    return @engaged_restart_transition_schedule_in_days
end

#engaged_restart_transition_schedule_in_days=(value) ⇒ Object

Sets the engagedRestartTransitionScheduleInDays property value. 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.

Parameters:

  • value

    Value to set for the engaged_restart_transition_schedule_in_days property.

Returns:

  • a void



312
313
314
# File 'lib/models/windows_update_for_business_configuration.rb', line 312

def engaged_restart_transition_schedule_in_days=(value)
    @engaged_restart_transition_schedule_in_days = value
end

#feature_updates_deferral_period_in_daysObject

Gets the featureUpdatesDeferralPeriodInDays property value. Defer Feature Updates by these many days with valid range from 0 to 30 days. Returned by default. Query parameters are not supported.

Returns:

  • a integer



319
320
321
# File 'lib/models/windows_update_for_business_configuration.rb', line 319

def feature_updates_deferral_period_in_days
    return @feature_updates_deferral_period_in_days
end

#feature_updates_deferral_period_in_days=(value) ⇒ Object

Sets the featureUpdatesDeferralPeriodInDays property value. Defer Feature Updates by these many days with valid range from 0 to 30 days. Returned by default. Query parameters are not supported.

Parameters:

  • value

    Value to set for the feature_updates_deferral_period_in_days property.

Returns:

  • a void



327
328
329
# File 'lib/models/windows_update_for_business_configuration.rb', line 327

def feature_updates_deferral_period_in_days=(value)
    @feature_updates_deferral_period_in_days = value
end

#feature_updates_pause_expiry_date_timeObject

Gets the featureUpdatesPauseExpiryDateTime property value. 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.

Returns:

  • a date_time



334
335
336
# File 'lib/models/windows_update_for_business_configuration.rb', line 334

def feature_updates_pause_expiry_date_time
    return @feature_updates_pause_expiry_date_time
end

#feature_updates_pause_expiry_date_time=(value) ⇒ Object

Sets the featureUpdatesPauseExpiryDateTime property value. 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.

Parameters:

  • value

    Value to set for the feature_updates_pause_expiry_date_time property.

Returns:

  • a void



342
343
344
# File 'lib/models/windows_update_for_business_configuration.rb', line 342

def feature_updates_pause_expiry_date_time=(value)
    @feature_updates_pause_expiry_date_time = value
end

#feature_updates_pause_start_dateObject

Gets the featureUpdatesPauseStartDate property value. 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.

Returns:

  • a date



349
350
351
# File 'lib/models/windows_update_for_business_configuration.rb', line 349

def feature_updates_pause_start_date
    return @feature_updates_pause_start_date
end

#feature_updates_pause_start_date=(value) ⇒ Object

Sets the featureUpdatesPauseStartDate property value. 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.

Parameters:

  • value

    Value to set for the feature_updates_pause_start_date property.

Returns:

  • a void



357
358
359
# File 'lib/models/windows_update_for_business_configuration.rb', line 357

def feature_updates_pause_start_date=(value)
    @feature_updates_pause_start_date = value
end

#feature_updates_pausedObject

Gets the featureUpdatesPaused property value. 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

Returns:

  • a boolean



364
365
366
# File 'lib/models/windows_update_for_business_configuration.rb', line 364

def feature_updates_paused
    return @feature_updates_paused
end

#feature_updates_paused=(value) ⇒ Object

Sets the featureUpdatesPaused property value. 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

Parameters:

  • value

    Value to set for the feature_updates_paused property.

Returns:

  • a void



372
373
374
# File 'lib/models/windows_update_for_business_configuration.rb', line 372

def feature_updates_paused=(value)
    @feature_updates_paused = value
end

#feature_updates_rollback_start_date_timeObject

Gets the featureUpdatesRollbackStartDateTime property value. 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.

Returns:

  • a date_time



379
380
381
# File 'lib/models/windows_update_for_business_configuration.rb', line 379

def feature_updates_rollback_start_date_time
    return @feature_updates_rollback_start_date_time
end

#feature_updates_rollback_start_date_time=(value) ⇒ Object

Sets the featureUpdatesRollbackStartDateTime property value. 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.

Parameters:

  • value

    Value to set for the feature_updates_rollback_start_date_time property.

Returns:

  • a void



387
388
389
# File 'lib/models/windows_update_for_business_configuration.rb', line 387

def feature_updates_rollback_start_date_time=(value)
    @feature_updates_rollback_start_date_time = value
end

#feature_updates_rollback_window_in_daysObject

Gets the featureUpdatesRollbackWindowInDays property value. 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.

Returns:

  • a integer



394
395
396
# File 'lib/models/windows_update_for_business_configuration.rb', line 394

def feature_updates_rollback_window_in_days
    return @feature_updates_rollback_window_in_days
end

#feature_updates_rollback_window_in_days=(value) ⇒ Object

Sets the featureUpdatesRollbackWindowInDays property value. 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.

Parameters:

  • value

    Value to set for the feature_updates_rollback_window_in_days property.

Returns:

  • a void



402
403
404
# File 'lib/models/windows_update_for_business_configuration.rb', line 402

def feature_updates_rollback_window_in_days=(value)
    @feature_updates_rollback_window_in_days = value
end

#feature_updates_will_be_rolled_backObject

Gets the featureUpdatesWillBeRolledBack property value. 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.

Returns:

  • a boolean



409
410
411
# File 'lib/models/windows_update_for_business_configuration.rb', line 409

def feature_updates_will_be_rolled_back
    return @feature_updates_will_be_rolled_back
end

#feature_updates_will_be_rolled_back=(value) ⇒ Object

Sets the featureUpdatesWillBeRolledBack property value. 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.

Parameters:

  • value

    Value to set for the feature_updates_will_be_rolled_back property.

Returns:

  • a void



417
418
419
# File 'lib/models/windows_update_for_business_configuration.rb', line 417

def feature_updates_will_be_rolled_back=(value)
    @feature_updates_will_be_rolled_back = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
# File 'lib/models/windows_update_for_business_configuration.rb', line 424

def get_field_deserializers()
    return super.merge({
        "allowWindows11Upgrade" => lambda {|n| @allow_windows11_upgrade = n.get_boolean_value() },
        "autoRestartNotificationDismissal" => lambda {|n| @auto_restart_notification_dismissal = n.get_enum_value(MicrosoftGraph::Models::AutoRestartNotificationDismissalMethod) },
        "automaticUpdateMode" => lambda {|n| @automatic_update_mode = n.get_enum_value(MicrosoftGraph::Models::AutomaticUpdateMode) },
        "businessReadyUpdatesOnly" => lambda {|n| @business_ready_updates_only = n.get_enum_value(MicrosoftGraph::Models::WindowsUpdateType) },
        "deadlineForFeatureUpdatesInDays" => lambda {|n| @deadline_for_feature_updates_in_days = n.get_number_value() },
        "deadlineForQualityUpdatesInDays" => lambda {|n| @deadline_for_quality_updates_in_days = n.get_number_value() },
        "deadlineGracePeriodInDays" => lambda {|n| @deadline_grace_period_in_days = n.get_number_value() },
        "deliveryOptimizationMode" => lambda {|n| @delivery_optimization_mode = n.get_enum_value(MicrosoftGraph::Models::WindowsDeliveryOptimizationMode) },
        "driversExcluded" => lambda {|n| @drivers_excluded = n.get_boolean_value() },
        "engagedRestartDeadlineInDays" => lambda {|n| @engaged_restart_deadline_in_days = n.get_number_value() },
        "engagedRestartSnoozeScheduleInDays" => lambda {|n| @engaged_restart_snooze_schedule_in_days = n.get_number_value() },
        "engagedRestartTransitionScheduleInDays" => lambda {|n| @engaged_restart_transition_schedule_in_days = n.get_number_value() },
        "featureUpdatesDeferralPeriodInDays" => lambda {|n| @feature_updates_deferral_period_in_days = n.get_number_value() },
        "featureUpdatesPauseExpiryDateTime" => lambda {|n| @feature_updates_pause_expiry_date_time = n.get_date_time_value() },
        "featureUpdatesPauseStartDate" => lambda {|n| @feature_updates_pause_start_date = n.get_date_value() },
        "featureUpdatesPaused" => lambda {|n| @feature_updates_paused = n.get_boolean_value() },
        "featureUpdatesRollbackStartDateTime" => lambda {|n| @feature_updates_rollback_start_date_time = n.get_date_time_value() },
        "featureUpdatesRollbackWindowInDays" => lambda {|n| @feature_updates_rollback_window_in_days = n.get_number_value() },
        "featureUpdatesWillBeRolledBack" => lambda {|n| @feature_updates_will_be_rolled_back = n.get_boolean_value() },
        "installationSchedule" => lambda {|n| @installation_schedule = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WindowsUpdateInstallScheduleType.create_from_discriminator_value(pn) }) },
        "microsoftUpdateServiceAllowed" => lambda {|n| @microsoft_update_service_allowed = n.get_boolean_value() },
        "postponeRebootUntilAfterDeadline" => lambda {|n| @postpone_reboot_until_after_deadline = n.get_boolean_value() },
        "prereleaseFeatures" => lambda {|n| @prerelease_features = n.get_enum_value(MicrosoftGraph::Models::PrereleaseFeatures) },
        "qualityUpdatesDeferralPeriodInDays" => lambda {|n| @quality_updates_deferral_period_in_days = n.get_number_value() },
        "qualityUpdatesPauseExpiryDateTime" => lambda {|n| @quality_updates_pause_expiry_date_time = n.get_date_time_value() },
        "qualityUpdatesPauseStartDate" => lambda {|n| @quality_updates_pause_start_date = n.get_date_value() },
        "qualityUpdatesPaused" => lambda {|n| @quality_updates_paused = n.get_boolean_value() },
        "qualityUpdatesRollbackStartDateTime" => lambda {|n| @quality_updates_rollback_start_date_time = n.get_date_time_value() },
        "qualityUpdatesWillBeRolledBack" => lambda {|n| @quality_updates_will_be_rolled_back = n.get_boolean_value() },
        "scheduleImminentRestartWarningInMinutes" => lambda {|n| @schedule_imminent_restart_warning_in_minutes = n.get_number_value() },
        "scheduleRestartWarningInHours" => lambda {|n| @schedule_restart_warning_in_hours = n.get_number_value() },
        "skipChecksBeforeRestart" => lambda {|n| @skip_checks_before_restart = n.get_boolean_value() },
        "updateNotificationLevel" => lambda {|n| @update_notification_level = n.get_enum_value(MicrosoftGraph::Models::WindowsUpdateNotificationDisplayOption) },
        "updateWeeks" => lambda {|n| @update_weeks = n.get_enum_value(MicrosoftGraph::Models::WindowsUpdateForBusinessUpdateWeeks) },
        "userPauseAccess" => lambda {|n| @user_pause_access = n.get_enum_value(MicrosoftGraph::Models::Enablement) },
        "userWindowsUpdateScanAccess" => lambda {|n| @user_windows_update_scan_access = n.get_enum_value(MicrosoftGraph::Models::Enablement) },
    })
end

#installation_scheduleObject

Gets the installationSchedule property value. The Installation Schedule. Possible values are: ActiveHoursStart, ActiveHoursEnd, ScheduledInstallDay, ScheduledInstallTime. Returned by default. Query parameters are not supported.

Returns:

  • a windows_update_install_schedule_type



468
469
470
# File 'lib/models/windows_update_for_business_configuration.rb', line 468

def installation_schedule
    return @installation_schedule
end

#installation_schedule=(value) ⇒ Object

Sets the installationSchedule property value. The Installation Schedule. Possible values are: ActiveHoursStart, ActiveHoursEnd, ScheduledInstallDay, ScheduledInstallTime. Returned by default. Query parameters are not supported.

Parameters:

  • value

    Value to set for the installation_schedule property.

Returns:

  • a void



476
477
478
# File 'lib/models/windows_update_for_business_configuration.rb', line 476

def installation_schedule=(value)
    @installation_schedule = value
end

#microsoft_update_service_allowedObject

Gets the microsoftUpdateServiceAllowed property value. When TRUE, allows Microsoft Update Service. When FALSE, does not allow Microsoft Update Service. Returned by default. Query parameters are not supported.

Returns:

  • a boolean



483
484
485
# File 'lib/models/windows_update_for_business_configuration.rb', line 483

def microsoft_update_service_allowed
    return @microsoft_update_service_allowed
end

#microsoft_update_service_allowed=(value) ⇒ Object

Sets the microsoftUpdateServiceAllowed property value. When TRUE, allows Microsoft Update Service. When FALSE, does not allow Microsoft Update Service. Returned by default. Query parameters are not supported.

Parameters:

  • value

    Value to set for the microsoft_update_service_allowed property.

Returns:

  • a void



491
492
493
# File 'lib/models/windows_update_for_business_configuration.rb', line 491

def microsoft_update_service_allowed=(value)
    @microsoft_update_service_allowed = value
end

#postpone_reboot_until_after_deadlineObject

Gets the postponeRebootUntilAfterDeadline property value. 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.

Returns:

  • a boolean



498
499
500
# File 'lib/models/windows_update_for_business_configuration.rb', line 498

def postpone_reboot_until_after_deadline
    return @postpone_reboot_until_after_deadline
end

#postpone_reboot_until_after_deadline=(value) ⇒ Object

Sets the postponeRebootUntilAfterDeadline property value. 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.

Parameters:

  • value

    Value to set for the postpone_reboot_until_after_deadline property.

Returns:

  • a void



506
507
508
# File 'lib/models/windows_update_for_business_configuration.rb', line 506

def postpone_reboot_until_after_deadline=(value)
    @postpone_reboot_until_after_deadline = value
end

#prerelease_featuresObject

Gets the prereleaseFeatures property value. Possible values for pre-release features.

Returns:

  • a prerelease_features



513
514
515
# File 'lib/models/windows_update_for_business_configuration.rb', line 513

def prerelease_features
    return @prerelease_features
end

#prerelease_features=(value) ⇒ Object

Sets the prereleaseFeatures property value. Possible values for pre-release features.

Parameters:

  • value

    Value to set for the prerelease_features property.

Returns:

  • a void



521
522
523
# File 'lib/models/windows_update_for_business_configuration.rb', line 521

def prerelease_features=(value)
    @prerelease_features = value
end

#quality_updates_deferral_period_in_daysObject

Gets the qualityUpdatesDeferralPeriodInDays property value. Defer Quality Updates by these many days with valid range from 0 to 30 days. Returned by default. Query parameters are not supported.

Returns:

  • a integer



528
529
530
# File 'lib/models/windows_update_for_business_configuration.rb', line 528

def quality_updates_deferral_period_in_days
    return @quality_updates_deferral_period_in_days
end

#quality_updates_deferral_period_in_days=(value) ⇒ Object

Sets the qualityUpdatesDeferralPeriodInDays property value. Defer Quality Updates by these many days with valid range from 0 to 30 days. Returned by default. Query parameters are not supported.

Parameters:

  • value

    Value to set for the quality_updates_deferral_period_in_days property.

Returns:

  • a void



536
537
538
# File 'lib/models/windows_update_for_business_configuration.rb', line 536

def quality_updates_deferral_period_in_days=(value)
    @quality_updates_deferral_period_in_days = value
end

#quality_updates_pause_expiry_date_timeObject

Gets the qualityUpdatesPauseExpiryDateTime property value. 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.

Returns:

  • a date_time



543
544
545
# File 'lib/models/windows_update_for_business_configuration.rb', line 543

def quality_updates_pause_expiry_date_time
    return @quality_updates_pause_expiry_date_time
end

#quality_updates_pause_expiry_date_time=(value) ⇒ Object

Sets the qualityUpdatesPauseExpiryDateTime property value. 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.

Parameters:

  • value

    Value to set for the quality_updates_pause_expiry_date_time property.

Returns:

  • a void



551
552
553
# File 'lib/models/windows_update_for_business_configuration.rb', line 551

def quality_updates_pause_expiry_date_time=(value)
    @quality_updates_pause_expiry_date_time = value
end

#quality_updates_pause_start_dateObject

Gets the qualityUpdatesPauseStartDate property value. 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.

Returns:

  • a date



558
559
560
# File 'lib/models/windows_update_for_business_configuration.rb', line 558

def quality_updates_pause_start_date
    return @quality_updates_pause_start_date
end

#quality_updates_pause_start_date=(value) ⇒ Object

Sets the qualityUpdatesPauseStartDate property value. 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.

Parameters:

  • value

    Value to set for the quality_updates_pause_start_date property.

Returns:

  • a void



566
567
568
# File 'lib/models/windows_update_for_business_configuration.rb', line 566

def quality_updates_pause_start_date=(value)
    @quality_updates_pause_start_date = value
end

#quality_updates_pausedObject

Gets the qualityUpdatesPaused property value. 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.

Returns:

  • a boolean



573
574
575
# File 'lib/models/windows_update_for_business_configuration.rb', line 573

def quality_updates_paused
    return @quality_updates_paused
end

#quality_updates_paused=(value) ⇒ Object

Sets the qualityUpdatesPaused property value. 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.

Parameters:

  • value

    Value to set for the quality_updates_paused property.

Returns:

  • a void



581
582
583
# File 'lib/models/windows_update_for_business_configuration.rb', line 581

def quality_updates_paused=(value)
    @quality_updates_paused = value
end

#quality_updates_rollback_start_date_timeObject

Gets the qualityUpdatesRollbackStartDateTime property value. 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.

Returns:

  • a date_time



588
589
590
# File 'lib/models/windows_update_for_business_configuration.rb', line 588

def quality_updates_rollback_start_date_time
    return @quality_updates_rollback_start_date_time
end

#quality_updates_rollback_start_date_time=(value) ⇒ Object

Sets the qualityUpdatesRollbackStartDateTime property value. 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.

Parameters:

  • value

    Value to set for the quality_updates_rollback_start_date_time property.

Returns:

  • a void



596
597
598
# File 'lib/models/windows_update_for_business_configuration.rb', line 596

def quality_updates_rollback_start_date_time=(value)
    @quality_updates_rollback_start_date_time = value
end

#quality_updates_will_be_rolled_backObject

Gets the qualityUpdatesWillBeRolledBack property value. 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.

Returns:

  • a boolean



603
604
605
# File 'lib/models/windows_update_for_business_configuration.rb', line 603

def quality_updates_will_be_rolled_back
    return @quality_updates_will_be_rolled_back
end

#quality_updates_will_be_rolled_back=(value) ⇒ Object

Sets the qualityUpdatesWillBeRolledBack property value. 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.

Parameters:

  • value

    Value to set for the quality_updates_will_be_rolled_back property.

Returns:

  • a void



611
612
613
# File 'lib/models/windows_update_for_business_configuration.rb', line 611

def quality_updates_will_be_rolled_back=(value)
    @quality_updates_will_be_rolled_back = value
end

#schedule_imminent_restart_warning_in_minutesObject

Gets the scheduleImminentRestartWarningInMinutes property value. Specify the period for auto-restart imminent warning notifications. Supported values: 15, 30 or 60 (minutes). Returned by default. Query parameters are not supported.

Returns:

  • a integer



618
619
620
# File 'lib/models/windows_update_for_business_configuration.rb', line 618

def schedule_imminent_restart_warning_in_minutes
    return @schedule_imminent_restart_warning_in_minutes
end

#schedule_imminent_restart_warning_in_minutes=(value) ⇒ Object

Sets the scheduleImminentRestartWarningInMinutes property value. Specify the period for auto-restart imminent warning notifications. Supported values: 15, 30 or 60 (minutes). Returned by default. Query parameters are not supported.

Parameters:

  • value

    Value to set for the schedule_imminent_restart_warning_in_minutes property.

Returns:

  • a void



626
627
628
# File 'lib/models/windows_update_for_business_configuration.rb', line 626

def schedule_imminent_restart_warning_in_minutes=(value)
    @schedule_imminent_restart_warning_in_minutes = value
end

#schedule_restart_warning_in_hoursObject

Gets the scheduleRestartWarningInHours property value. 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.

Returns:

  • a integer



633
634
635
# File 'lib/models/windows_update_for_business_configuration.rb', line 633

def schedule_restart_warning_in_hours
    return @schedule_restart_warning_in_hours
end

#schedule_restart_warning_in_hours=(value) ⇒ Object

Sets the scheduleRestartWarningInHours property value. 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.

Parameters:

  • value

    Value to set for the schedule_restart_warning_in_hours property.

Returns:

  • a void



641
642
643
# File 'lib/models/windows_update_for_business_configuration.rb', line 641

def schedule_restart_warning_in_hours=(value)
    @schedule_restart_warning_in_hours = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError)


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
# File 'lib/models/windows_update_for_business_configuration.rb', line 649

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_boolean_value("allowWindows11Upgrade", @allow_windows11_upgrade)
    writer.write_enum_value("autoRestartNotificationDismissal", @auto_restart_notification_dismissal)
    writer.write_enum_value("automaticUpdateMode", @automatic_update_mode)
    writer.write_enum_value("businessReadyUpdatesOnly", @business_ready_updates_only)
    writer.write_number_value("deadlineForFeatureUpdatesInDays", @deadline_for_feature_updates_in_days)
    writer.write_number_value("deadlineForQualityUpdatesInDays", @deadline_for_quality_updates_in_days)
    writer.write_number_value("deadlineGracePeriodInDays", @deadline_grace_period_in_days)
    writer.write_enum_value("deliveryOptimizationMode", @delivery_optimization_mode)
    writer.write_boolean_value("driversExcluded", @drivers_excluded)
    writer.write_number_value("engagedRestartDeadlineInDays", @engaged_restart_deadline_in_days)
    writer.write_number_value("engagedRestartSnoozeScheduleInDays", @engaged_restart_snooze_schedule_in_days)
    writer.write_number_value("engagedRestartTransitionScheduleInDays", @engaged_restart_transition_schedule_in_days)
    writer.write_number_value("featureUpdatesDeferralPeriodInDays", @feature_updates_deferral_period_in_days)
    writer.write_date_time_value("featureUpdatesPauseExpiryDateTime", @feature_updates_pause_expiry_date_time)
    writer.write_boolean_value("featureUpdatesPaused", @feature_updates_paused)
    writer.write_date_time_value("featureUpdatesRollbackStartDateTime", @feature_updates_rollback_start_date_time)
    writer.write_number_value("featureUpdatesRollbackWindowInDays", @feature_updates_rollback_window_in_days)
    writer.write_boolean_value("featureUpdatesWillBeRolledBack", @feature_updates_will_be_rolled_back)
    writer.write_object_value("installationSchedule", @installation_schedule)
    writer.write_boolean_value("microsoftUpdateServiceAllowed", @microsoft_update_service_allowed)
    writer.write_boolean_value("postponeRebootUntilAfterDeadline", @postpone_reboot_until_after_deadline)
    writer.write_enum_value("prereleaseFeatures", @prerelease_features)
    writer.write_number_value("qualityUpdatesDeferralPeriodInDays", @quality_updates_deferral_period_in_days)
    writer.write_date_time_value("qualityUpdatesPauseExpiryDateTime", @quality_updates_pause_expiry_date_time)
    writer.write_boolean_value("qualityUpdatesPaused", @quality_updates_paused)
    writer.write_date_time_value("qualityUpdatesRollbackStartDateTime", @quality_updates_rollback_start_date_time)
    writer.write_boolean_value("qualityUpdatesWillBeRolledBack", @quality_updates_will_be_rolled_back)
    writer.write_number_value("scheduleImminentRestartWarningInMinutes", @schedule_imminent_restart_warning_in_minutes)
    writer.write_number_value("scheduleRestartWarningInHours", @schedule_restart_warning_in_hours)
    writer.write_boolean_value("skipChecksBeforeRestart", @skip_checks_before_restart)
    writer.write_enum_value("updateNotificationLevel", @update_notification_level)
    writer.write_enum_value("updateWeeks", @update_weeks)
    writer.write_enum_value("userPauseAccess", @user_pause_access)
    writer.write_enum_value("userWindowsUpdateScanAccess", @user_windows_update_scan_access)
end

#skip_checks_before_restartObject

Gets the skipChecksBeforeRestart property value. 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.

Returns:

  • a boolean



691
692
693
# File 'lib/models/windows_update_for_business_configuration.rb', line 691

def skip_checks_before_restart
    return @skip_checks_before_restart
end

#skip_checks_before_restart=(value) ⇒ Object

Sets the skipChecksBeforeRestart property value. 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.

Parameters:

  • value

    Value to set for the skip_checks_before_restart property.

Returns:

  • a void



699
700
701
# File 'lib/models/windows_update_for_business_configuration.rb', line 699

def skip_checks_before_restart=(value)
    @skip_checks_before_restart = value
end

#update_notification_levelObject

Gets the updateNotificationLevel property value. Windows Update Notification Display Options

Returns:

  • a windows_update_notification_display_option



706
707
708
# File 'lib/models/windows_update_for_business_configuration.rb', line 706

def update_notification_level
    return @update_notification_level
end

#update_notification_level=(value) ⇒ Object

Sets the updateNotificationLevel property value. Windows Update Notification Display Options

Parameters:

  • value

    Value to set for the update_notification_level property.

Returns:

  • a void



714
715
716
# File 'lib/models/windows_update_for_business_configuration.rb', line 714

def update_notification_level=(value)
    @update_notification_level = value
end

#update_weeksObject

Gets the updateWeeks property value. 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.

Returns:

  • a windows_update_for_business_update_weeks



721
722
723
# File 'lib/models/windows_update_for_business_configuration.rb', line 721

def update_weeks
    return @update_weeks
end

#update_weeks=(value) ⇒ Object

Sets the updateWeeks property value. 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.

Parameters:

  • value

    Value to set for the update_weeks property.

Returns:

  • a void



729
730
731
# File 'lib/models/windows_update_for_business_configuration.rb', line 729

def update_weeks=(value)
    @update_weeks = value
end

#user_pause_accessObject

Gets the userPauseAccess property value. Possible values of a property

Returns:

  • a enablement



736
737
738
# File 'lib/models/windows_update_for_business_configuration.rb', line 736

def user_pause_access
    return @user_pause_access
end

#user_pause_access=(value) ⇒ Object

Sets the userPauseAccess property value. Possible values of a property

Parameters:

  • value

    Value to set for the user_pause_access property.

Returns:

  • a void



744
745
746
# File 'lib/models/windows_update_for_business_configuration.rb', line 744

def user_pause_access=(value)
    @user_pause_access = value
end

#user_windows_update_scan_accessObject

Gets the userWindowsUpdateScanAccess property value. Possible values of a property

Returns:

  • a enablement



751
752
753
# File 'lib/models/windows_update_for_business_configuration.rb', line 751

def user_windows_update_scan_access
    return @user_windows_update_scan_access
end

#user_windows_update_scan_access=(value) ⇒ Object

Sets the userWindowsUpdateScanAccess property value. Possible values of a property

Parameters:

  • value

    Value to set for the user_windows_update_scan_access property.

Returns:

  • a void



759
760
761
# File 'lib/models/windows_update_for_business_configuration.rb', line 759

def user_windows_update_scan_access=(value)
    @user_windows_update_scan_access = value
end