Class: MicrosoftGraph::Models::Group

Inherits:
DirectoryObject show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/group.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DirectoryObject

#deleted_date_time, #deleted_date_time=

Methods inherited from Entity

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

Constructor Details

#initialize ⇒ Object

Instantiates a new group and sets the default values.



344
345
346
347
 
# File 'lib/models/group.rb', line 344

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

Raises:

  • (StandardError) 


398
399
400
401
 
# File 'lib/models/group.rb', line 398

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

Instance Method Details

#accepted_senders ⇒ Object

Gets the acceptedSenders property value. The list of users or groups that are allowed to create post’s or calendar events in this group. If this list is non-empty then only users or groups listed here are allowed to post.

Returns:

  • a directory_object



209
210
211
 
# File 'lib/models/group.rb', line 209

def accepted_senders
    return @accepted_senders
end

#accepted_senders=(value) ⇒ Object

Sets the acceptedSenders property value. The list of users or groups that are allowed to create post’s or calendar events in this group. If this list is non-empty then only users or groups listed here are allowed to post.

Parameters:

  • value —

    Value to set for the acceptedSenders property.

Returns:

  • a void



217
218
219
 
# File 'lib/models/group.rb', line 217

def accepted_senders=(value)
    @accepted_senders = value
end

#allow_external_senders ⇒ Object

Gets the allowExternalSenders property value. Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Returns:

  • a boolean



224
225
226
 
# File 'lib/models/group.rb', line 224

def allow_external_senders
    return @allow_external_senders
end

#allow_external_senders=(value) ⇒ Object

Sets the allowExternalSenders property value. Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Parameters:

  • value —

    Value to set for the allowExternalSenders property.

Returns:

  • a void



232
233
234
 
# File 'lib/models/group.rb', line 232

def allow_external_senders=(value)
    @allow_external_senders = value
end

#app_role_assignments ⇒ Object

Gets the appRoleAssignments property value. Represents the app roles a group has been granted for an application. Supports $expand.

Returns:

  • a app_role_assignment



239
240
241
 
# File 'lib/models/group.rb', line 239

def app_role_assignments
    return @app_role_assignments
end

#app_role_assignments=(value) ⇒ Object

Sets the appRoleAssignments property value. Represents the app roles a group has been granted for an application. Supports $expand.

Parameters:

  • value —

    Value to set for the appRoleAssignments property.

Returns:

  • a void



247
248
249
 
# File 'lib/models/group.rb', line 247

def app_role_assignments=(value)
    @app_role_assignments = value
end

#assigned_labels ⇒ Object

Gets the assignedLabels property value. The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select.

Returns:

  • a assigned_label



254
255
256
 
# File 'lib/models/group.rb', line 254

def assigned_labels
    return @assigned_labels
end

#assigned_labels=(value) ⇒ Object

Sets the assignedLabels property value. The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select.

Parameters:

  • value —

    Value to set for the assignedLabels property.

Returns:

  • a void



262
263
264
 
# File 'lib/models/group.rb', line 262

def assigned_labels=(value)
    @assigned_labels = value
end

#assigned_licenses ⇒ Object

Gets the assignedLicenses property value. The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only.

Returns:

  • a assigned_license



269
270
271
 
# File 'lib/models/group.rb', line 269

def assigned_licenses
    return @assigned_licenses
end

#assigned_licenses=(value) ⇒ Object

Sets the assignedLicenses property value. The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only.

Parameters:

  • value —

    Value to set for the assignedLicenses property.

Returns:

  • a void



277
278
279
 
# File 'lib/models/group.rb', line 277

def assigned_licenses=(value)
    @assigned_licenses = value
end

#auto_subscribe_new_members ⇒ Object

Gets the autoSubscribeNewMembers property value. Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Returns:

  • a boolean



284
285
286
 
# File 'lib/models/group.rb', line 284

def auto_subscribe_new_members
    return @auto_subscribe_new_members
end

#auto_subscribe_new_members=(value) ⇒ Object

Sets the autoSubscribeNewMembers property value. Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Parameters:

  • value —

    Value to set for the autoSubscribeNewMembers property.

Returns:

  • a void



292
293
294
 
# File 'lib/models/group.rb', line 292

def auto_subscribe_new_members=(value)
    @auto_subscribe_new_members = value
end

#calendar ⇒ Object

Gets the calendar property value. The group’s calendar. Read-only.

Returns:

  • a calendar



299
300
301
 
# File 'lib/models/group.rb', line 299

def calendar
    return @calendar
end

#calendar=(value) ⇒ Object

Sets the calendar property value. The group’s calendar. Read-only.

Parameters:

  • value —

    Value to set for the calendar property.

Returns:

  • a void



307
308
309
 
# File 'lib/models/group.rb', line 307

def calendar=(value)
    @calendar = value
end

#calendar_view ⇒ Object

Gets the calendarView property value. The calendar view for the calendar. Read-only.

Returns:

  • a event



314
315
316
 
# File 'lib/models/group.rb', line 314

def calendar_view
    return @calendar_view
end

#calendar_view=(value) ⇒ Object

Sets the calendarView property value. The calendar view for the calendar. Read-only.

Parameters:

  • value —

    Value to set for the calendarView property.

Returns:

  • a void



322
323
324
 
# File 'lib/models/group.rb', line 322

def calendar_view=(value)
    @calendar_view = value
end

#classification ⇒ Object

Gets the classification property value. Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).

Returns:

  • a string



329
330
331
 
# File 'lib/models/group.rb', line 329

def classification
    return @classification
end

#classification=(value) ⇒ Object

Sets the classification property value. Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).

Parameters:

  • value —

    Value to set for the classification property.

Returns:

  • a void



337
338
339
 
# File 'lib/models/group.rb', line 337

def classification=(value)
    @classification = value
end

#conversations ⇒ Object

Gets the conversations property value. The group’s conversations.

Returns:

  • a conversation



352
353
354
 
# File 'lib/models/group.rb', line 352

def conversations
    return @conversations
end

#conversations=(value) ⇒ Object

Sets the conversations property value. The group’s conversations.

Parameters:

  • value —

    Value to set for the conversations property.

Returns:

  • a void



360
361
362
 
# File 'lib/models/group.rb', line 360

def conversations=(value)
    @conversations = value
end

#created_date_time ⇒ Object

Gets the createdDateTime property value. Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.

Returns:

  • a date_time



367
368
369
 
# File 'lib/models/group.rb', line 367

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.

Parameters:

  • value —

    Value to set for the createdDateTime property.

Returns:

  • a void



375
376
377
 
# File 'lib/models/group.rb', line 375

def created_date_time=(value)
    @created_date_time = value
end

#created_on_behalf_of ⇒ Object

Gets the createdOnBehalfOf property value. The user (or application) that created the group. NOTE: This is not set if the user is an administrator. Read-only.

Returns:

  • a directory_object



382
383
384
 
# File 'lib/models/group.rb', line 382

def created_on_behalf_of
    return @created_on_behalf_of
end

#created_on_behalf_of=(value) ⇒ Object

Sets the createdOnBehalfOf property value. The user (or application) that created the group. NOTE: This is not set if the user is an administrator. Read-only.

Parameters:

  • value —

    Value to set for the createdOnBehalfOf property.

Returns:

  • a void



390
391
392
 
# File 'lib/models/group.rb', line 390

def created_on_behalf_of=(value)
    @created_on_behalf_of = value
end

#description ⇒ Object

Gets the description property value. An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.

Returns:

  • a string



406
407
408
 
# File 'lib/models/group.rb', line 406

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.

Parameters:

  • value —

    Value to set for the description property.

Returns:

  • a void



414
415
416
 
# File 'lib/models/group.rb', line 414

def description=(value)
    @description = value
end

#display_name ⇒ Object

Gets the displayName property value. The display name for the group. This property is required when a group is created and cannot be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.

Returns:

  • a string



421
422
423
 
# File 'lib/models/group.rb', line 421

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. The display name for the group. This property is required when a group is created and cannot be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.

Parameters:

  • value —

    Value to set for the displayName property.

Returns:

  • a void



429
430
431
 
# File 'lib/models/group.rb', line 429

def display_name=(value)
    @display_name = value
end

#drive ⇒ Object

Gets the drive property value. The group’s default drive. Read-only.

Returns:

  • a drive



436
437
438
 
# File 'lib/models/group.rb', line 436

def drive
    return @drive
end

#drive=(value) ⇒ Object

Sets the drive property value. The group’s default drive. Read-only.

Parameters:

  • value —

    Value to set for the drive property.

Returns:

  • a void



444
445
446
 
# File 'lib/models/group.rb', line 444

def drive=(value)
    @drive = value
end

#drives ⇒ Object

Gets the drives property value. The group’s drives. Read-only.

Returns:

  • a drive



451
452
453
 
# File 'lib/models/group.rb', line 451

def drives
    return @drives
end

#drives=(value) ⇒ Object

Sets the drives property value. The group’s drives. Read-only.

Parameters:

  • value —

    Value to set for the drives property.

Returns:

  • a void



459
460
461
 
# File 'lib/models/group.rb', line 459

def drives=(value)
    @drives = value
end

#events ⇒ Object

Gets the events property value. The group’s calendar events.

Returns:

  • a event



466
467
468
 
# File 'lib/models/group.rb', line 466

def events
    return @events
end

#events=(value) ⇒ Object

Sets the events property value. The group’s calendar events.

Parameters:

  • value —

    Value to set for the events property.

Returns:

  • a void



474
475
476
 
# File 'lib/models/group.rb', line 474

def events=(value)
    @events = value
end

#expiration_date_time ⇒ Object

Gets the expirationDateTime property value. Timestamp of when the group is set to expire. Is null for security groups but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.

Returns:

  • a date_time



481
482
483
 
# File 'lib/models/group.rb', line 481

def expiration_date_time
    return @expiration_date_time
end

#expiration_date_time=(value) ⇒ Object

Sets the expirationDateTime property value. Timestamp of when the group is set to expire. Is null for security groups but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.

Parameters:

  • value —

    Value to set for the expirationDateTime property.

Returns:

  • a void



489
490
491
 
# File 'lib/models/group.rb', line 489

def expiration_date_time=(value)
    @expiration_date_time = value
end

#extensions ⇒ Object

Gets the extensions property value. The collection of open extensions defined for the group. Read-only. Nullable.

Returns:

  • a extension



496
497
498
 
# File 'lib/models/group.rb', line 496

def extensions
    return @extensions
end

#extensions=(value) ⇒ Object

Sets the extensions property value. The collection of open extensions defined for the group. Read-only. Nullable.

Parameters:

  • value —

    Value to set for the extensions property.

Returns:

  • a void



504
505
506
 
# File 'lib/models/group.rb', line 504

def extensions=(value)
    @extensions = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/models/group.rb', line 511

def get_field_deserializers()
    return super.merge({
        "acceptedSenders" => lambda {|n| @accepted_senders = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "allowExternalSenders" => lambda {|n| @allow_external_senders = n.get_boolean_value() },
        "appRoleAssignments" => lambda {|n| @app_role_assignments = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AppRoleAssignment.create_from_discriminator_value(pn) }) },
        "assignedLabels" => lambda {|n| @assigned_labels = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AssignedLabel.create_from_discriminator_value(pn) }) },
        "assignedLicenses" => lambda {|n| @assigned_licenses = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AssignedLicense.create_from_discriminator_value(pn) }) },
        "autoSubscribeNewMembers" => lambda {|n| @auto_subscribe_new_members = n.get_boolean_value() },
        "calendar" => lambda {|n| @calendar = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Calendar.create_from_discriminator_value(pn) }) },
        "calendarView" => lambda {|n| @calendar_view = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Event.create_from_discriminator_value(pn) }) },
        "classification" => lambda {|n| @classification = n.get_string_value() },
        "conversations" => lambda {|n| @conversations = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Conversation.create_from_discriminator_value(pn) }) },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "createdOnBehalfOf" => lambda {|n| @created_on_behalf_of = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "description" => lambda {|n| @description = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "drive" => lambda {|n| @drive = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Drive.create_from_discriminator_value(pn) }) },
        "drives" => lambda {|n| @drives = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Drive.create_from_discriminator_value(pn) }) },
        "events" => lambda {|n| @events = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Event.create_from_discriminator_value(pn) }) },
        "expirationDateTime" => lambda {|n| @expiration_date_time = n.get_date_time_value() },
        "extensions" => lambda {|n| @extensions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Extension.create_from_discriminator_value(pn) }) },
        "groupLifecyclePolicies" => lambda {|n| @group_lifecycle_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::GroupLifecyclePolicy.create_from_discriminator_value(pn) }) },
        "groupTypes" => lambda {|n| @group_types = n.get_collection_of_primitive_values(String) },
        "hasMembersWithLicenseErrors" => lambda {|n| @has_members_with_license_errors = n.get_boolean_value() },
        "hideFromAddressLists" => lambda {|n| @hide_from_address_lists = n.get_boolean_value() },
        "hideFromOutlookClients" => lambda {|n| @hide_from_outlook_clients = n.get_boolean_value() },
        "isArchived" => lambda {|n| @is_archived = n.get_boolean_value() },
        "isAssignableToRole" => lambda {|n| @is_assignable_to_role = n.get_boolean_value() },
        "isSubscribedByMail" => lambda {|n| @is_subscribed_by_mail = n.get_boolean_value() },
        "licenseProcessingState" => lambda {|n| @license_processing_state = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::LicenseProcessingState.create_from_discriminator_value(pn) }) },
        "mail" => lambda {|n| @mail = n.get_string_value() },
        "mailEnabled" => lambda {|n| @mail_enabled = n.get_boolean_value() },
        "mailNickname" => lambda {|n| @mail_nickname = n.get_string_value() },
        "memberOf" => lambda {|n| @member_of = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "members" => lambda {|n| @members = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "membersWithLicenseErrors" => lambda {|n| @members_with_license_errors = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "membershipRule" => lambda {|n| @membership_rule = n.get_string_value() },
        "membershipRuleProcessingState" => lambda {|n| @membership_rule_processing_state = n.get_string_value() },
        "onPremisesDomainName" => lambda {|n| @on_premises_domain_name = n.get_string_value() },
        "onPremisesLastSyncDateTime" => lambda {|n| @on_premises_last_sync_date_time = n.get_date_time_value() },
        "onPremisesNetBiosName" => lambda {|n| @on_premises_net_bios_name = n.get_string_value() },
        "onPremisesProvisioningErrors" => lambda {|n| @on_premises_provisioning_errors = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::OnPremisesProvisioningError.create_from_discriminator_value(pn) }) },
        "onPremisesSamAccountName" => lambda {|n|  = n.get_string_value() },
        "onPremisesSecurityIdentifier" => lambda {|n| @on_premises_security_identifier = n.get_string_value() },
        "onPremisesSyncEnabled" => lambda {|n| @on_premises_sync_enabled = n.get_boolean_value() },
        "onenote" => lambda {|n| @onenote = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Onenote.create_from_discriminator_value(pn) }) },
        "owners" => lambda {|n| @owners = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "permissionGrants" => lambda {|n| @permission_grants = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ResourceSpecificPermissionGrant.create_from_discriminator_value(pn) }) },
        "photo" => lambda {|n| @photo = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ProfilePhoto.create_from_discriminator_value(pn) }) },
        "photos" => lambda {|n| @photos = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ProfilePhoto.create_from_discriminator_value(pn) }) },
        "planner" => lambda {|n| @planner = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PlannerGroup.create_from_discriminator_value(pn) }) },
        "preferredDataLocation" => lambda {|n| @preferred_data_location = n.get_string_value() },
        "preferredLanguage" => lambda {|n| @preferred_language = n.get_string_value() },
        "proxyAddresses" => lambda {|n| @proxy_addresses = n.get_collection_of_primitive_values(String) },
        "rejectedSenders" => lambda {|n| @rejected_senders = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "renewedDateTime" => lambda {|n| @renewed_date_time = n.get_date_time_value() },
        "securityEnabled" => lambda {|n| @security_enabled = n.get_boolean_value() },
        "securityIdentifier" => lambda {|n| @security_identifier = n.get_string_value() },
        "settings" => lambda {|n| @settings = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::GroupSetting.create_from_discriminator_value(pn) }) },
        "sites" => lambda {|n| @sites = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Site.create_from_discriminator_value(pn) }) },
        "team" => lambda {|n| @team = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Team.create_from_discriminator_value(pn) }) },
        "theme" => lambda {|n| @theme = n.get_string_value() },
        "threads" => lambda {|n| @threads = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ConversationThread.create_from_discriminator_value(pn) }) },
        "transitiveMemberOf" => lambda {|n| @transitive_member_of = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "transitiveMembers" => lambda {|n| @transitive_members = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "unseenCount" => lambda {|n| @unseen_count = n.get_number_value() },
        "visibility" => lambda {|n| @visibility = n.get_string_value() },
    })
end

#group_lifecycle_policies ⇒ Object

Gets the groupLifecyclePolicies property value. The collection of lifecycle policies for this group. Read-only. Nullable.

Returns:

  • a group_lifecycle_policy



584
585
586
 
# File 'lib/models/group.rb', line 584

def group_lifecycle_policies
    return @group_lifecycle_policies
end

#group_lifecycle_policies=(value) ⇒ Object

Sets the groupLifecyclePolicies property value. The collection of lifecycle policies for this group. Read-only. Nullable.

Parameters:

  • value —

    Value to set for the groupLifecyclePolicies property.

Returns:

  • a void



592
593
594
 
# File 'lib/models/group.rb', line 592

def group_lifecycle_policies=(value)
    @group_lifecycle_policies = value
end

#group_types ⇒ Object

Gets the groupTypes property value. Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it’s either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).

Returns:

  • a string



599
600
601
 
# File 'lib/models/group.rb', line 599

def group_types
    return @group_types
end

#group_types=(value) ⇒ Object

Sets the groupTypes property value. Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it’s either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).

Parameters:

  • value —

    Value to set for the groupTypes property.

Returns:

  • a void



607
608
609
 
# File 'lib/models/group.rb', line 607

def group_types=(value)
    @group_types = value
end

#has_members_with_license_errors ⇒ Object

Gets the hasMembersWithLicenseErrors property value. Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq).

Returns:

  • a boolean



614
615
616
 
# File 'lib/models/group.rb', line 614

def has_members_with_license_errors
    return @has_members_with_license_errors
end

#has_members_with_license_errors=(value) ⇒ Object

Sets the hasMembersWithLicenseErrors property value. Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the hasMembersWithLicenseErrors property.

Returns:

  • a void



622
623
624
 
# File 'lib/models/group.rb', line 622

def has_members_with_license_errors=(value)
    @has_members_with_license_errors = value
end

#hide_from_address_lists ⇒ Object

Gets the hideFromAddressLists property value. True if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Returns:

  • a boolean



629
630
631
 
# File 'lib/models/group.rb', line 629

def hide_from_address_lists
    return @hide_from_address_lists
end

#hide_from_address_lists=(value) ⇒ Object

Sets the hideFromAddressLists property value. True if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Parameters:

  • value —

    Value to set for the hideFromAddressLists property.

Returns:

  • a void



637
638
639
 
# File 'lib/models/group.rb', line 637

def hide_from_address_lists=(value)
    @hide_from_address_lists = value
end

#hide_from_outlook_clients ⇒ Object

Gets the hideFromOutlookClients property value. True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Returns:

  • a boolean



644
645
646
 
# File 'lib/models/group.rb', line 644

def hide_from_outlook_clients
    return @hide_from_outlook_clients
end

#hide_from_outlook_clients=(value) ⇒ Object

Sets the hideFromOutlookClients property value. True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Parameters:

  • value —

    Value to set for the hideFromOutlookClients property.

Returns:

  • a void



652
653
654
 
# File 'lib/models/group.rb', line 652

def hide_from_outlook_clients=(value)
    @hide_from_outlook_clients = value
end

#is_archived ⇒ Object

Gets the isArchived property value. When a group is associated with a team this property determines whether the team is in read-only mode.To read this property, use the /group/groupId/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.

Returns:

  • a boolean



659
660
661
 
# File 'lib/models/group.rb', line 659

def is_archived
    return @is_archived
end

#is_archived=(value) ⇒ Object

Sets the isArchived property value. When a group is associated with a team this property determines whether the team is in read-only mode.To read this property, use the /group/groupId/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.

Parameters:

  • value —

    Value to set for the isArchived property.

Returns:

  • a void



667
668
669
 
# File 'lib/models/group.rb', line 667

def is_archived=(value)
    @is_archived = value
end

#is_assignable_to_role ⇒ Object

Gets the isAssignableToRole property value. Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Azure AD role assignmentsUsing this feature requires a Azure AD Premium P1 license. Returned by default. Supports $filter (eq, ne, not).

Returns:

  • a boolean



674
675
676
 
# File 'lib/models/group.rb', line 674

def is_assignable_to_role
    return @is_assignable_to_role
end

#is_assignable_to_role=(value) ⇒ Object

Sets the isAssignableToRole property value. Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Azure AD role assignmentsUsing this feature requires a Azure AD Premium P1 license. Returned by default. Supports $filter (eq, ne, not).

Parameters:

  • value —

    Value to set for the isAssignableToRole property.

Returns:

  • a void



682
683
684
 
# File 'lib/models/group.rb', line 682

def is_assignable_to_role=(value)
    @is_assignable_to_role = value
end

#is_subscribed_by_mail ⇒ Object

Gets the isSubscribedByMail property value. Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Returns:

  • a boolean



689
690
691
 
# File 'lib/models/group.rb', line 689

def is_subscribed_by_mail
    return @is_subscribed_by_mail
end

#is_subscribed_by_mail=(value) ⇒ Object

Sets the isSubscribedByMail property value. Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Parameters:

  • value —

    Value to set for the isSubscribedByMail property.

Returns:

  • a void



697
698
699
 
# File 'lib/models/group.rb', line 697

def is_subscribed_by_mail=(value)
    @is_subscribed_by_mail = value
end

#license_processing_state ⇒ Object

Gets the licenseProcessingState property value. Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only.

Returns:

  • a license_processing_state



704
705
706
 
# File 'lib/models/group.rb', line 704

def license_processing_state
    return @license_processing_state
end

#license_processing_state=(value) ⇒ Object

Sets the licenseProcessingState property value. Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only.

Parameters:

  • value —

    Value to set for the licenseProcessingState property.

Returns:

  • a void



712
713
714
 
# File 'lib/models/group.rb', line 712

def license_processing_state=(value)
    @license_processing_state = value
end

#mail ⇒ Object

Gets the mail property value. The SMTP address for the group, for example, ‘[email protected]’. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



719
720
721
 
# File 'lib/models/group.rb', line 719

def mail
    return @mail
end

#mail=(value) ⇒ Object

Sets the mail property value. The SMTP address for the group, for example, ‘[email protected]’. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value —

    Value to set for the mail property.

Returns:

  • a void



727
728
729
 
# File 'lib/models/group.rb', line 727

def mail=(value)
    @mail = value
end

#mail_enabled ⇒ Object

Gets the mailEnabled property value. Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not).

Returns:

  • a boolean



734
735
736
 
# File 'lib/models/group.rb', line 734

def mail_enabled
    return @mail_enabled
end

#mail_enabled=(value) ⇒ Object

Sets the mailEnabled property value. Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not).

Parameters:

  • value —

    Value to set for the mailEnabled property.

Returns:

  • a void



742
743
744
 
# File 'lib/models/group.rb', line 742

def mail_enabled=(value)
    @mail_enabled = value
end

#mail_nickname ⇒ Object

Gets the mailNickname property value. The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () / [] ‘ ; : <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



749
750
751
 
# File 'lib/models/group.rb', line 749

def mail_nickname
    return @mail_nickname
end

#mail_nickname=(value) ⇒ Object

Sets the mailNickname property value. The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () / [] ‘ ; : <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value —

    Value to set for the mailNickname property.

Returns:

  • a void



757
758
759
 
# File 'lib/models/group.rb', line 757

def mail_nickname=(value)
    @mail_nickname = value
end

#member_of ⇒ Object

Gets the memberOf property value. Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.

Returns:

  • a directory_object



764
765
766
 
# File 'lib/models/group.rb', line 764

def member_of
    return @member_of
end

#member_of=(value) ⇒ Object

Sets the memberOf property value. Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.

Parameters:

  • value —

    Value to set for the memberOf property.

Returns:

  • a void



772
773
774
 
# File 'lib/models/group.rb', line 772

def member_of=(value)
    @member_of = value
end

#members ⇒ Object

Gets the members property value. The members of this group, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,‘Role’)&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).

Returns:

  • a directory_object



779
780
781
 
# File 'lib/models/group.rb', line 779

def members
    return @members
end

#members=(value) ⇒ Object

Sets the members property value. The members of this group, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,‘Role’)&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).

Parameters:

  • value —

    Value to set for the members property.

Returns:

  • a void



787
788
789
 
# File 'lib/models/group.rb', line 787

def members=(value)
    @members = value
end

#members_with_license_errors ⇒ Object

Gets the membersWithLicenseErrors property value. A list of group members with license errors from this group-based license assignment. Read-only.

Returns:

  • a directory_object



794
795
796
 
# File 'lib/models/group.rb', line 794

def members_with_license_errors
    return @members_with_license_errors
end

#members_with_license_errors=(value) ⇒ Object

Sets the membersWithLicenseErrors property value. A list of group members with license errors from this group-based license assignment. Read-only.

Parameters:

  • value —

    Value to set for the membersWithLicenseErrors property.

Returns:

  • a void



802
803
804
 
# File 'lib/models/group.rb', line 802

def members_with_license_errors=(value)
    @members_with_license_errors = value
end

#membership_rule ⇒ Object

Gets the membershipRule property value. The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).

Returns:

  • a string



809
810
811
 
# File 'lib/models/group.rb', line 809

def membership_rule
    return @membership_rule
end

#membership_rule=(value) ⇒ Object

Sets the membershipRule property value. The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).

Parameters:

  • value —

    Value to set for the membershipRule property.

Returns:

  • a void



817
818
819
 
# File 'lib/models/group.rb', line 817

def membership_rule=(value)
    @membership_rule = value
end

#membership_rule_processing_state ⇒ Object

Gets the membershipRuleProcessingState property value. Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in).

Returns:

  • a string



824
825
826
 
# File 'lib/models/group.rb', line 824

def membership_rule_processing_state
    return @membership_rule_processing_state
end

#membership_rule_processing_state=(value) ⇒ Object

Sets the membershipRuleProcessingState property value. Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in).

Parameters:

  • value —

    Value to set for the membershipRuleProcessingState property.

Returns:

  • a void



832
833
834
 
# File 'lib/models/group.rb', line 832

def membership_rule_processing_state=(value)
    @membership_rule_processing_state = value
end

#on_premises_domain_name ⇒ Object

Gets the onPremisesDomainName property value. The onPremisesDomainName property

Returns:

  • a string



839
840
841
 
# File 'lib/models/group.rb', line 839

def on_premises_domain_name
    return @on_premises_domain_name
end

#on_premises_domain_name=(value) ⇒ Object

Sets the onPremisesDomainName property value. The onPremisesDomainName property

Parameters:

  • value —

    Value to set for the onPremisesDomainName property.

Returns:

  • a void



847
848
849
 
# File 'lib/models/group.rb', line 847

def on_premises_domain_name=(value)
    @on_premises_domain_name = value
end

#on_premises_last_sync_date_time ⇒ Object

Gets the onPremisesLastSyncDateTime property value. Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).

Returns:

  • a date_time



854
855
856
 
# File 'lib/models/group.rb', line 854

def on_premises_last_sync_date_time
    return @on_premises_last_sync_date_time
end

#on_premises_last_sync_date_time=(value) ⇒ Object

Sets the onPremisesLastSyncDateTime property value. Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).

Parameters:

  • value —

    Value to set for the onPremisesLastSyncDateTime property.

Returns:

  • a void



862
863
864
 
# File 'lib/models/group.rb', line 862

def on_premises_last_sync_date_time=(value)
    @on_premises_last_sync_date_time = value
end

#on_premises_net_bios_name ⇒ Object

Gets the onPremisesNetBiosName property value. The onPremisesNetBiosName property

Returns:

  • a string



869
870
871
 
# File 'lib/models/group.rb', line 869

def on_premises_net_bios_name
    return @on_premises_net_bios_name
end

#on_premises_net_bios_name=(value) ⇒ Object

Sets the onPremisesNetBiosName property value. The onPremisesNetBiosName property

Parameters:

  • value —

    Value to set for the onPremisesNetBiosName property.

Returns:

  • a void



877
878
879
 
# File 'lib/models/group.rb', line 877

def on_premises_net_bios_name=(value)
    @on_premises_net_bios_name = value
end

#on_premises_provisioning_errors ⇒ Object

Gets the onPremisesProvisioningErrors property value. Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).

Returns:

  • a on_premises_provisioning_error



884
885
886
 
# File 'lib/models/group.rb', line 884

def on_premises_provisioning_errors
    return @on_premises_provisioning_errors
end

#on_premises_provisioning_errors=(value) ⇒ Object

Sets the onPremisesProvisioningErrors property value. Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).

Parameters:

  • value —

    Value to set for the onPremisesProvisioningErrors property.

Returns:

  • a void



892
893
894
 
# File 'lib/models/group.rb', line 892

def on_premises_provisioning_errors=(value)
    @on_premises_provisioning_errors = value
end

#on_premises_sam_account_name ⇒ Object

Gets the onPremisesSamAccountName property value. Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.

Returns:

  • a string



899
900
901
 
# File 'lib/models/group.rb', line 899

def 
    return 
end

#on_premises_sam_account_name=(value) ⇒ Object

Sets the onPremisesSamAccountName property value. Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.

Parameters:

  • value —

    Value to set for the onPremisesSamAccountName property.

Returns:

  • a void



907
908
909
 
# File 'lib/models/group.rb', line 907

def (value)
     = value
end

#on_premises_security_identifier ⇒ Object

Gets the onPremisesSecurityIdentifier property value. Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter (eq including on null values). Read-only.

Returns:

  • a string



914
915
916
 
# File 'lib/models/group.rb', line 914

def on_premises_security_identifier
    return @on_premises_security_identifier
end

#on_premises_security_identifier=(value) ⇒ Object

Sets the onPremisesSecurityIdentifier property value. Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter (eq including on null values). Read-only.

Parameters:

  • value —

    Value to set for the onPremisesSecurityIdentifier property.

Returns:

  • a void



922
923
924
 
# File 'lib/models/group.rb', line 922

def on_premises_security_identifier=(value)
    @on_premises_security_identifier = value
end

#on_premises_sync_enabled ⇒ Object

Gets the onPremisesSyncEnabled property value. true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).

Returns:

  • a boolean



929
930
931
 
# File 'lib/models/group.rb', line 929

def on_premises_sync_enabled
    return @on_premises_sync_enabled
end

#on_premises_sync_enabled=(value) ⇒ Object

Sets the onPremisesSyncEnabled property value. true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).

Parameters:

  • value —

    Value to set for the onPremisesSyncEnabled property.

Returns:

  • a void



937
938
939
 
# File 'lib/models/group.rb', line 937

def on_premises_sync_enabled=(value)
    @on_premises_sync_enabled = value
end

#onenote ⇒ Object

Gets the onenote property value. The onenote property

Returns:

  • a onenote



944
945
946
 
# File 'lib/models/group.rb', line 944

def onenote
    return @onenote
end

#onenote=(value) ⇒ Object

Sets the onenote property value. The onenote property

Parameters:

  • value —

    Value to set for the onenote property.

Returns:

  • a void



952
953
954
 
# File 'lib/models/group.rb', line 952

def onenote=(value)
    @onenote = value
end

#owners ⇒ Object

Gets the owners property value. The owners of the group. Limited to 100 owners. Nullable. If this property is not specified when creating a Microsoft 365 group, the calling user is automatically assigned as the group owner. Supports $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,‘Role’)&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).

Returns:

  • a directory_object



959
960
961
 
# File 'lib/models/group.rb', line 959

def owners
    return @owners
end

#owners=(value) ⇒ Object

Sets the owners property value. The owners of the group. Limited to 100 owners. Nullable. If this property is not specified when creating a Microsoft 365 group, the calling user is automatically assigned as the group owner. Supports $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,‘Role’)&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).

Parameters:

  • value —

    Value to set for the owners property.

Returns:

  • a void



967
968
969
 
# File 'lib/models/group.rb', line 967

def owners=(value)
    @owners = value
end

#permission_grants ⇒ Object

Gets the permissionGrants property value. The permission that has been granted for a group to a specific application. Supports $expand.

Returns:

  • a resource_specific_permission_grant



974
975
976
 
# File 'lib/models/group.rb', line 974

def permission_grants
    return @permission_grants
end

#permission_grants=(value) ⇒ Object

Sets the permissionGrants property value. The permission that has been granted for a group to a specific application. Supports $expand.

Parameters:

  • value —

    Value to set for the permissionGrants property.

Returns:

  • a void



982
983
984
 
# File 'lib/models/group.rb', line 982

def permission_grants=(value)
    @permission_grants = value
end

#photo ⇒ Object

Gets the photo property value. The group’s profile photo

Returns:

  • a profile_photo



989
990
991
 
# File 'lib/models/group.rb', line 989

def photo
    return @photo
end

#photo=(value) ⇒ Object

Sets the photo property value. The group’s profile photo

Parameters:

  • value —

    Value to set for the photo property.

Returns:

  • a void



997
998
999
 
# File 'lib/models/group.rb', line 997

def photo=(value)
    @photo = value
end

#photos ⇒ Object

Gets the photos property value. The profile photos owned by the group. Read-only. Nullable.

Returns:

  • a profile_photo



1004
1005
1006
 
# File 'lib/models/group.rb', line 1004

def photos
    return @photos
end

#photos=(value) ⇒ Object

Sets the photos property value. The profile photos owned by the group. Read-only. Nullable.

Parameters:

  • value —

    Value to set for the photos property.

Returns:

  • a void



1012
1013
1014
 
# File 'lib/models/group.rb', line 1012

def photos=(value)
    @photos = value
end

#planner ⇒ Object

Gets the planner property value. Entry-point to Planner resource that might exist for a Unified Group.

Returns:

  • a planner_group



1019
1020
1021
 
# File 'lib/models/group.rb', line 1019

def planner
    return @planner
end

#planner=(value) ⇒ Object

Sets the planner property value. Entry-point to Planner resource that might exist for a Unified Group.

Parameters:

  • value —

    Value to set for the planner property.

Returns:

  • a void



1027
1028
1029
 
# File 'lib/models/group.rb', line 1027

def planner=(value)
    @planner = value
end

#preferred_data_location ⇒ Object

Gets the preferredDataLocation property value. The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator’s preferred data location. To set this property, the calling user must be assigned one of the following Azure AD roles: Global Administrator User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default.

Returns:

  • a string



1034
1035
1036
 
# File 'lib/models/group.rb', line 1034

def preferred_data_location
    return @preferred_data_location
end

#preferred_data_location=(value) ⇒ Object

Sets the preferredDataLocation property value. The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator’s preferred data location. To set this property, the calling user must be assigned one of the following Azure AD roles: Global Administrator User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default.

Parameters:

  • value —

    Value to set for the preferredDataLocation property.

Returns:

  • a void



1042
1043
1044
 
# File 'lib/models/group.rb', line 1042

def preferred_data_location=(value)
    @preferred_data_location = value
end

#preferred_language ⇒ Object

Gets the preferredLanguage property value. The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



1049
1050
1051
 
# File 'lib/models/group.rb', line 1049

def preferred_language
    return @preferred_language
end

#preferred_language=(value) ⇒ Object

Sets the preferredLanguage property value. The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value —

    Value to set for the preferredLanguage property.

Returns:

  • a void



1057
1058
1059
 
# File 'lib/models/group.rb', line 1057

def preferred_language=(value)
    @preferred_language = value
end

#proxy_addresses ⇒ Object

Gets the proxyAddresses property value. Email addresses for the group that direct to the same group mailbox. For example: [‘SMTP: [email protected]’, ‘smtp: [email protected]’]. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).

Returns:

  • a string



1064
1065
1066
 
# File 'lib/models/group.rb', line 1064

def proxy_addresses
    return @proxy_addresses
end

#proxy_addresses=(value) ⇒ Object

Sets the proxyAddresses property value. Email addresses for the group that direct to the same group mailbox. For example: [‘SMTP: [email protected]’, ‘smtp: [email protected]’]. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).

Parameters:

  • value —

    Value to set for the proxyAddresses property.

Returns:

  • a void



1072
1073
1074
 
# File 'lib/models/group.rb', line 1072

def proxy_addresses=(value)
    @proxy_addresses = value
end

#rejected_senders ⇒ Object

Gets the rejectedSenders property value. The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable

Returns:

  • a directory_object



1079
1080
1081
 
# File 'lib/models/group.rb', line 1079

def rejected_senders
    return @rejected_senders
end

#rejected_senders=(value) ⇒ Object

Sets the rejectedSenders property value. The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable

Parameters:

  • value —

    Value to set for the rejectedSenders property.

Returns:

  • a void



1087
1088
1089
 
# File 'lib/models/group.rb', line 1087

def rejected_senders=(value)
    @rejected_senders = value
end

#renewed_date_time ⇒ Object

Gets the renewedDateTime property value. Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.

Returns:

  • a date_time



1094
1095
1096
 
# File 'lib/models/group.rb', line 1094

def renewed_date_time
    return @renewed_date_time
end

#renewed_date_time=(value) ⇒ Object

Sets the renewedDateTime property value. Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.

Parameters:

  • value —

    Value to set for the renewedDateTime property.

Returns:

  • a void



1102
1103
1104
 
# File 'lib/models/group.rb', line 1102

def renewed_date_time=(value)
    @renewed_date_time = value
end

#security_enabled ⇒ Object

Gets the securityEnabled property value. Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in).

Returns:

  • a boolean



1109
1110
1111
 
# File 'lib/models/group.rb', line 1109

def security_enabled
    return @security_enabled
end

#security_enabled=(value) ⇒ Object

Sets the securityEnabled property value. Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in).

Parameters:

  • value —

    Value to set for the securityEnabled property.

Returns:

  • a void



1117
1118
1119
 
# File 'lib/models/group.rb', line 1117

def security_enabled=(value)
    @security_enabled = value
end

#security_identifier ⇒ Object

Gets the securityIdentifier property value. Security identifier of the group, used in Windows scenarios. Returned by default.

Returns:

  • a string



1124
1125
1126
 
# File 'lib/models/group.rb', line 1124

def security_identifier
    return @security_identifier
end

#security_identifier=(value) ⇒ Object

Sets the securityIdentifier property value. Security identifier of the group, used in Windows scenarios. Returned by default.

Parameters:

  • value —

    Value to set for the securityIdentifier property.

Returns:

  • a void



1132
1133
1134
 
# File 'lib/models/group.rb', line 1132

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


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/models/group.rb', line 1140

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("acceptedSenders", @accepted_senders)
    writer.write_boolean_value("allowExternalSenders", @allow_external_senders)
    writer.write_collection_of_object_values("appRoleAssignments", @app_role_assignments)
    writer.write_collection_of_object_values("assignedLabels", @assigned_labels)
    writer.write_collection_of_object_values("assignedLicenses", @assigned_licenses)
    writer.write_boolean_value("autoSubscribeNewMembers", @auto_subscribe_new_members)
    writer.write_object_value("calendar", @calendar)
    writer.write_collection_of_object_values("calendarView", @calendar_view)
    writer.write_string_value("classification", @classification)
    writer.write_collection_of_object_values("conversations", @conversations)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_object_value("createdOnBehalfOf", @created_on_behalf_of)
    writer.write_string_value("description", @description)
    writer.write_string_value("displayName", @display_name)
    writer.write_object_value("drive", @drive)
    writer.write_collection_of_object_values("drives", @drives)
    writer.write_collection_of_object_values("events", @events)
    writer.write_date_time_value("expirationDateTime", @expiration_date_time)
    writer.write_collection_of_object_values("extensions", @extensions)
    writer.write_collection_of_object_values("groupLifecyclePolicies", @group_lifecycle_policies)
    writer.write_collection_of_primitive_values("groupTypes", @group_types)
    writer.write_boolean_value("hasMembersWithLicenseErrors", @has_members_with_license_errors)
    writer.write_boolean_value("hideFromAddressLists", @hide_from_address_lists)
    writer.write_boolean_value("hideFromOutlookClients", @hide_from_outlook_clients)
    writer.write_boolean_value("isArchived", @is_archived)
    writer.write_boolean_value("isAssignableToRole", @is_assignable_to_role)
    writer.write_boolean_value("isSubscribedByMail", @is_subscribed_by_mail)
    writer.write_object_value("licenseProcessingState", @license_processing_state)
    writer.write_string_value("mail", @mail)
    writer.write_boolean_value("mailEnabled", @mail_enabled)
    writer.write_string_value("mailNickname", @mail_nickname)
    writer.write_collection_of_object_values("memberOf", @member_of)
    writer.write_collection_of_object_values("members", @members)
    writer.write_collection_of_object_values("membersWithLicenseErrors", @members_with_license_errors)
    writer.write_string_value("membershipRule", @membership_rule)
    writer.write_string_value("membershipRuleProcessingState", @membership_rule_processing_state)
    writer.write_string_value("onPremisesDomainName", @on_premises_domain_name)
    writer.write_date_time_value("onPremisesLastSyncDateTime", @on_premises_last_sync_date_time)
    writer.write_string_value("onPremisesNetBiosName", @on_premises_net_bios_name)
    writer.write_collection_of_object_values("onPremisesProvisioningErrors", @on_premises_provisioning_errors)
    writer.write_string_value("onPremisesSamAccountName", )
    writer.write_string_value("onPremisesSecurityIdentifier", @on_premises_security_identifier)
    writer.write_boolean_value("onPremisesSyncEnabled", @on_premises_sync_enabled)
    writer.write_object_value("onenote", @onenote)
    writer.write_collection_of_object_values("owners", @owners)
    writer.write_collection_of_object_values("permissionGrants", @permission_grants)
    writer.write_object_value("photo", @photo)
    writer.write_collection_of_object_values("photos", @photos)
    writer.write_object_value("planner", @planner)
    writer.write_string_value("preferredDataLocation", @preferred_data_location)
    writer.write_string_value("preferredLanguage", @preferred_language)
    writer.write_collection_of_primitive_values("proxyAddresses", @proxy_addresses)
    writer.write_collection_of_object_values("rejectedSenders", @rejected_senders)
    writer.write_date_time_value("renewedDateTime", @renewed_date_time)
    writer.write_boolean_value("securityEnabled", @security_enabled)
    writer.write_string_value("securityIdentifier", @security_identifier)
    writer.write_collection_of_object_values("settings", @settings)
    writer.write_collection_of_object_values("sites", @sites)
    writer.write_object_value("team", @team)
    writer.write_string_value("theme", @theme)
    writer.write_collection_of_object_values("threads", @threads)
    writer.write_collection_of_object_values("transitiveMemberOf", @transitive_member_of)
    writer.write_collection_of_object_values("transitiveMembers", @transitive_members)
    writer.write_number_value("unseenCount", @unseen_count)
    writer.write_string_value("visibility", @visibility)
end

#settings ⇒ Object

Gets the settings property value. Settings that can govern this group’s behavior, like whether members can invite guest users to the group. Nullable.

Returns:

  • a group_setting



1213
1214
1215
 
# File 'lib/models/group.rb', line 1213

def settings
    return @settings
end

#settings=(value) ⇒ Object

Sets the settings property value. Settings that can govern this group’s behavior, like whether members can invite guest users to the group. Nullable.

Parameters:

  • value —

    Value to set for the settings property.

Returns:

  • a void



1221
1222
1223
 
# File 'lib/models/group.rb', line 1221

def settings=(value)
    @settings = value
end

#sites ⇒ Object

Gets the sites property value. The list of SharePoint sites in this group. Access the default site with /sites/root.

Returns:

  • a site



1228
1229
1230
 
# File 'lib/models/group.rb', line 1228

def sites
    return @sites
end

#sites=(value) ⇒ Object

Sets the sites property value. The list of SharePoint sites in this group. Access the default site with /sites/root.

Parameters:

  • value —

    Value to set for the sites property.

Returns:

  • a void



1236
1237
1238
 
# File 'lib/models/group.rb', line 1236

def sites=(value)
    @sites = value
end

#team ⇒ Object

Gets the team property value. The team associated with this group.

Returns:

  • a team



1243
1244
1245
 
# File 'lib/models/group.rb', line 1243

def team
    return @team
end

#team=(value) ⇒ Object

Sets the team property value. The team associated with this group.

Parameters:

  • value —

    Value to set for the team property.

Returns:

  • a void



1251
1252
1253
 
# File 'lib/models/group.rb', line 1251

def team=(value)
    @team = value
end

#theme ⇒ Object

Gets the theme property value. Specifies a Microsoft 365 group’s color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.

Returns:

  • a string



1258
1259
1260
 
# File 'lib/models/group.rb', line 1258

def theme
    return @theme
end

#theme=(value) ⇒ Object

Sets the theme property value. Specifies a Microsoft 365 group’s color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.

Parameters:

  • value —

    Value to set for the theme property.

Returns:

  • a void



1266
1267
1268
 
# File 'lib/models/group.rb', line 1266

def theme=(value)
    @theme = value
end

#threads ⇒ Object

Gets the threads property value. The group’s conversation threads. Nullable.

Returns:

  • a conversation_thread



1273
1274
1275
 
# File 'lib/models/group.rb', line 1273

def threads
    return @threads
end

#threads=(value) ⇒ Object

Sets the threads property value. The group’s conversation threads. Nullable.

Parameters:

  • value —

    Value to set for the threads property.

Returns:

  • a void



1281
1282
1283
 
# File 'lib/models/group.rb', line 1281

def threads=(value)
    @threads = value
end

#transitive_member_of ⇒ Object

Gets the transitiveMemberOf property value. The groups that a group is a member of, either directly and through nested membership. Nullable.

Returns:

  • a directory_object



1288
1289
1290
 
# File 'lib/models/group.rb', line 1288

def transitive_member_of
    return @transitive_member_of
end

#transitive_member_of=(value) ⇒ Object

Sets the transitiveMemberOf property value. The groups that a group is a member of, either directly and through nested membership. Nullable.

Parameters:

  • value —

    Value to set for the transitiveMemberOf property.

Returns:

  • a void



1296
1297
1298
 
# File 'lib/models/group.rb', line 1296

def transitive_member_of=(value)
    @transitive_member_of = value
end

#transitive_members ⇒ Object

Gets the transitiveMembers property value. The direct and transitive members of a group. Nullable.

Returns:

  • a directory_object



1303
1304
1305
 
# File 'lib/models/group.rb', line 1303

def transitive_members
    return @transitive_members
end

#transitive_members=(value) ⇒ Object

Sets the transitiveMembers property value. The direct and transitive members of a group. Nullable.

Parameters:

  • value —

    Value to set for the transitiveMembers property.

Returns:

  • a void



1311
1312
1313
 
# File 'lib/models/group.rb', line 1311

def transitive_members=(value)
    @transitive_members = value
end

#unseen_count ⇒ Object

Gets the unseenCount property value. Count of conversations that have received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Returns:

  • a integer



1318
1319
1320
 
# File 'lib/models/group.rb', line 1318

def unseen_count
    return @unseen_count
end

#unseen_count=(value) ⇒ Object

Sets the unseenCount property value. Count of conversations that have received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/ID).

Parameters:

  • value —

    Value to set for the unseenCount property.

Returns:

  • a void



1326
1327
1328
 
# File 'lib/models/group.rb', line 1326

def unseen_count=(value)
    @unseen_count = value
end

#visibility ⇒ Object

Gets the visibility property value. Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups, when the groups are created. It can’t be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. Groups assignable to roles are always Private. See group visibility options to learn more. Returned by default. Nullable.

Returns:

  • a string



1333
1334
1335
 
# File 'lib/models/group.rb', line 1333

def visibility
    return @visibility
end

#visibility=(value) ⇒ Object

Sets the visibility property value. Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups, when the groups are created. It can’t be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. Groups assignable to roles are always Private. See group visibility options to learn more. Returned by default. Nullable.

Parameters:

  • value —

    Value to set for the visibility property.

Returns:

  • a void



1341
1342
1343
 
# File 'lib/models/group.rb', line 1341

def visibility=(value)
    @visibility = value
end