Class: MicrosoftGraph::Models::DeviceEnrollmentWindowsHelloForBusinessConfiguration

Inherits:
DeviceEnrollmentConfiguration show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/device_enrollment_windows_hello_for_business_configuration.rb

Overview

Windows Hello for Business settings lets users access their devices using a gesture, such as biometric authentication, or a PIN. Configure settings for enrolled Windows 10, Windows 10 Mobile and later.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DeviceEnrollmentConfiguration

#assignments, #assignments=, #created_date_time, #created_date_time=, #description, #description=, #display_name, #display_name=, #last_modified_date_time, #last_modified_date_time=, #priority, #priority=, #version, #version=

Methods inherited from Entity

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

Constructor Details

#initialize ⇒ Object

Instantiates a new deviceEnrollmentWindowsHelloForBusinessConfiguration and sets the default values.



51
52
53
54
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 51

def initialize()
    super
    @odata_type = "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration"
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 device_enrollment_windows_hello_for_business_configuration

Raises:

  • (StandardError) 


60
61
62
63
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 60

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

Instance Method Details

#enhanced_biometrics_state ⇒ Object

Gets the enhancedBiometricsState property value. Possible values of a property

Returns:

  • a enablement



68
69
70
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 68

def enhanced_biometrics_state
    return @enhanced_biometrics_state
end

#enhanced_biometrics_state=(value) ⇒ Object

Sets the enhancedBiometricsState property value. Possible values of a property

Parameters:

  • value —

    Value to set for the enhancedBiometricsState property.

Returns:

  • a void



76
77
78
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 76

def enhanced_biometrics_state=(value)
    @enhanced_biometrics_state = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 83

def get_field_deserializers()
    return super.merge({
        "enhancedBiometricsState" => lambda {|n| @enhanced_biometrics_state = n.get_enum_value(MicrosoftGraph::Models::Enablement) },
        "pinExpirationInDays" => lambda {|n| @pin_expiration_in_days = n.get_number_value() },
        "pinLowercaseCharactersUsage" => lambda {|n| @pin_lowercase_characters_usage = n.get_enum_value(MicrosoftGraph::Models::WindowsHelloForBusinessPinUsage) },
        "pinMaximumLength" => lambda {|n| @pin_maximum_length = n.get_number_value() },
        "pinMinimumLength" => lambda {|n| @pin_minimum_length = n.get_number_value() },
        "pinPreviousBlockCount" => lambda {|n| @pin_previous_block_count = n.get_number_value() },
        "pinSpecialCharactersUsage" => lambda {|n| @pin_special_characters_usage = n.get_enum_value(MicrosoftGraph::Models::WindowsHelloForBusinessPinUsage) },
        "pinUppercaseCharactersUsage" => lambda {|n| @pin_uppercase_characters_usage = n.get_enum_value(MicrosoftGraph::Models::WindowsHelloForBusinessPinUsage) },
        "remotePassportEnabled" => lambda {|n| @remote_passport_enabled = n.get_boolean_value() },
        "securityDeviceRequired" => lambda {|n| @security_device_required = n.get_boolean_value() },
        "state" => lambda {|n| @state = n.get_enum_value(MicrosoftGraph::Models::Enablement) },
        "unlockWithBiometricsEnabled" => lambda {|n| @unlock_with_biometrics_enabled = n.get_boolean_value() },
    })
end

#pin_expiration_in_days ⇒ Object

Gets the pinExpirationInDays property value. Controls the period of time (in days) that a PIN can be used before the system requires the user to change it. This must be set between 0 and 730, inclusive. If set to 0, the user’s PIN will never expire

Returns:

  • a integer



103
104
105
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 103

def pin_expiration_in_days
    return @pin_expiration_in_days
end

#pin_expiration_in_days=(value) ⇒ Object

Sets the pinExpirationInDays property value. Controls the period of time (in days) that a PIN can be used before the system requires the user to change it. This must be set between 0 and 730, inclusive. If set to 0, the user’s PIN will never expire

Parameters:

  • value —

    Value to set for the pinExpirationInDays property.

Returns:

  • a void



111
112
113
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 111

def pin_expiration_in_days=(value)
    @pin_expiration_in_days = value
end

#pin_lowercase_characters_usage ⇒ Object

Gets the pinLowercaseCharactersUsage property value. Windows Hello for Business pin usage options

Returns:

  • a windows_hello_for_business_pin_usage



118
119
120
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 118

def pin_lowercase_characters_usage
    return @pin_lowercase_characters_usage
end

#pin_lowercase_characters_usage=(value) ⇒ Object

Sets the pinLowercaseCharactersUsage property value. Windows Hello for Business pin usage options

Parameters:

  • value —

    Value to set for the pinLowercaseCharactersUsage property.

Returns:

  • a void



126
127
128
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 126

def pin_lowercase_characters_usage=(value)
    @pin_lowercase_characters_usage = value
end

#pin_maximum_length ⇒ Object

Gets the pinMaximumLength property value. Controls the maximum number of characters allowed for the Windows Hello for Business PIN. This value must be between 4 and 127, inclusive. This value must be greater than or equal to the value set for the minimum PIN.

Returns:

  • a integer



133
134
135
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 133

def pin_maximum_length
    return @pin_maximum_length
end

#pin_maximum_length=(value) ⇒ Object

Sets the pinMaximumLength property value. Controls the maximum number of characters allowed for the Windows Hello for Business PIN. This value must be between 4 and 127, inclusive. This value must be greater than or equal to the value set for the minimum PIN.

Parameters:

  • value —

    Value to set for the pinMaximumLength property.

Returns:

  • a void



141
142
143
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 141

def pin_maximum_length=(value)
    @pin_maximum_length = value
end

#pin_minimum_length ⇒ Object

Gets the pinMinimumLength property value. Controls the minimum number of characters required for the Windows Hello for Business PIN. This value must be between 4 and 127, inclusive, and less than or equal to the value set for the maximum PIN.

Returns:

  • a integer



148
149
150
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 148

def pin_minimum_length
    return @pin_minimum_length
end

#pin_minimum_length=(value) ⇒ Object

Sets the pinMinimumLength property value. Controls the minimum number of characters required for the Windows Hello for Business PIN. This value must be between 4 and 127, inclusive, and less than or equal to the value set for the maximum PIN.

Parameters:

  • value —

    Value to set for the pinMinimumLength property.

Returns:

  • a void



156
157
158
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 156

def pin_minimum_length=(value)
    @pin_minimum_length = value
end

#pin_previous_block_count ⇒ Object

Gets the pinPreviousBlockCount property value. Controls the ability to prevent users from using past PINs. This must be set between 0 and 50, inclusive, and the current PIN of the user is included in that count. If set to 0, previous PINs are not stored. PIN history is not preserved through a PIN reset.

Returns:

  • a integer



163
164
165
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 163

def pin_previous_block_count
    return @pin_previous_block_count
end

#pin_previous_block_count=(value) ⇒ Object

Sets the pinPreviousBlockCount property value. Controls the ability to prevent users from using past PINs. This must be set between 0 and 50, inclusive, and the current PIN of the user is included in that count. If set to 0, previous PINs are not stored. PIN history is not preserved through a PIN reset.

Parameters:

  • value —

    Value to set for the pinPreviousBlockCount property.

Returns:

  • a void



171
172
173
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 171

def pin_previous_block_count=(value)
    @pin_previous_block_count = value
end

#pin_special_characters_usage ⇒ Object

Gets the pinSpecialCharactersUsage property value. Windows Hello for Business pin usage options

Returns:

  • a windows_hello_for_business_pin_usage



178
179
180
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 178

def pin_special_characters_usage
    return @pin_special_characters_usage
end

#pin_special_characters_usage=(value) ⇒ Object

Sets the pinSpecialCharactersUsage property value. Windows Hello for Business pin usage options

Parameters:

  • value —

    Value to set for the pinSpecialCharactersUsage property.

Returns:

  • a void



186
187
188
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 186

def pin_special_characters_usage=(value)
    @pin_special_characters_usage = value
end

#pin_uppercase_characters_usage ⇒ Object

Gets the pinUppercaseCharactersUsage property value. Windows Hello for Business pin usage options

Returns:

  • a windows_hello_for_business_pin_usage



193
194
195
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 193

def pin_uppercase_characters_usage
    return @pin_uppercase_characters_usage
end

#pin_uppercase_characters_usage=(value) ⇒ Object

Sets the pinUppercaseCharactersUsage property value. Windows Hello for Business pin usage options

Parameters:

  • value —

    Value to set for the pinUppercaseCharactersUsage property.

Returns:

  • a void



201
202
203
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 201

def pin_uppercase_characters_usage=(value)
    @pin_uppercase_characters_usage = value
end

#remote_passport_enabled ⇒ Object

Gets the remotePassportEnabled property value. Controls the use of Remote Windows Hello for Business. Remote Windows Hello for Business provides the ability for a portable, registered device to be usable as a companion for desktop authentication. The desktop must be Azure AD joined and the companion device must have a Windows Hello for Business PIN.

Returns:

  • a boolean



208
209
210
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 208

def remote_passport_enabled
    return @remote_passport_enabled
end

#remote_passport_enabled=(value) ⇒ Object

Sets the remotePassportEnabled property value. Controls the use of Remote Windows Hello for Business. Remote Windows Hello for Business provides the ability for a portable, registered device to be usable as a companion for desktop authentication. The desktop must be Azure AD joined and the companion device must have a Windows Hello for Business PIN.

Parameters:

  • value —

    Value to set for the remotePassportEnabled property.

Returns:

  • a void



216
217
218
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 216

def remote_passport_enabled=(value)
    @remote_passport_enabled = value
end

#security_device_required ⇒ Object

Gets the securityDeviceRequired property value. Controls whether to require a Trusted Platform Module (TPM) for provisioning Windows Hello for Business. A TPM provides an additional security benefit in that data stored on it cannot be used on other devices. If set to False, all devices can provision Windows Hello for Business even if there is not a usable TPM.

Returns:

  • a boolean



223
224
225
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 223

def security_device_required
    return @security_device_required
end

#security_device_required=(value) ⇒ Object

Sets the securityDeviceRequired property value. Controls whether to require a Trusted Platform Module (TPM) for provisioning Windows Hello for Business. A TPM provides an additional security benefit in that data stored on it cannot be used on other devices. If set to False, all devices can provision Windows Hello for Business even if there is not a usable TPM.

Parameters:

  • value —

    Value to set for the securityDeviceRequired property.

Returns:

  • a void



231
232
233
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 231

def security_device_required=(value)
    @security_device_required = 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) 


239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/models/device_enrollment_windows_hello_for_business_configuration.rb', line 239

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_enum_value("enhancedBiometricsState", @enhanced_biometrics_state)
    writer.write_number_value("pinExpirationInDays", @pin_expiration_in_days)
    writer.write_enum_value("pinLowercaseCharactersUsage", @pin_lowercase_characters_usage)
    writer.write_number_value("pinMaximumLength", @pin_maximum_length)
    writer.write_number_value("pinMinimumLength", @pin_minimum_length)
    writer.write_number_value("pinPreviousBlockCount", @pin_previous_block_count)
    writer.write_enum_value("pinSpecialCharactersUsage", @pin_special_characters_usage)
    writer.write_enum_value("pinUppercaseCharactersUsage", @pin_uppercase_characters_usage)
    writer.write_boolean_value("remotePassportEnabled", @remote_passport_enabled)
    writer.write_boolean_value("securityDeviceRequired", @security_device_required)
    writer.write_enum_value("state", @state)
    writer.write_boolean_value("unlockWithBiometricsEnabled", @unlock_with_biometrics_enabled)
end

#state ⇒ Object

Gets the state property value. Possible values of a property

Returns:

  • a enablement



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

def state
    return @state
end

#state=(value) ⇒ Object

Sets the state property value. Possible values of a property

Parameters:

  • value —

    Value to set for the state property.

Returns:

  • a void



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

def state=(value)
    @state = value
end

#unlock_with_biometrics_enabled ⇒ Object

Gets the unlockWithBiometricsEnabled property value. Controls the use of biometric gestures, such as face and fingerprint, as an alternative to the Windows Hello for Business PIN. If set to False, biometric gestures are not allowed. Users must still configure a PIN as a backup in case of failures.

Returns:

  • a boolean



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

def unlock_with_biometrics_enabled
    return @unlock_with_biometrics_enabled
end

#unlock_with_biometrics_enabled=(value) ⇒ Object

Sets the unlockWithBiometricsEnabled property value. Controls the use of biometric gestures, such as face and fingerprint, as an alternative to the Windows Hello for Business PIN. If set to False, biometric gestures are not allowed. Users must still configure a PIN as a backup in case of failures.

Parameters:

  • value —

    Value to set for the unlockWithBiometricsEnabled property.

Returns:

  • a void



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

def unlock_with_biometrics_enabled=(value)
    @unlock_with_biometrics_enabled = value
end