Share via


MicrosoftGraphGroup Class

Definition

Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphGroupTypeConverter))]
public class MicrosoftGraphGroup : Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup, Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Runtime.IAssociativeArray<object>, Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphGroupTypeConverter))>]
type MicrosoftGraphGroup = class
    interface IMicrosoftGraphGroup
    interface IJsonSerializable
    interface IMicrosoftGraphDirectoryObject
    interface IMicrosoftGraphEntityAutoGenerated
    interface IAssociativeArray<obj>
    interface IValidates
Public Class MicrosoftGraphGroup
Implements IAssociativeArray(Of Object), IMicrosoftGraphGroup, IValidates
Inheritance
MicrosoftGraphGroup
Attributes
Implements

Constructors

MicrosoftGraphGroup()

Creates an new MicrosoftGraphGroup instance.

Fields

__additionalProperties

Properties

AppRoleAssignment

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

Classification

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).

CreatedDateTime

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. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.

CreatedOnBehalfOf

Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types.

DeletedDateTime
Description

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

DisplayName

The name displayed in directory

ExpirationDateTime

Timestamp of when the group is set to expire. 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. Supports $filter (eq, ne, NOT, ge, le, in). Read-only.

GroupLifecyclePolicy

The collection of lifecycle policies for this group. Read-only. Nullable.

GroupType

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).

HasMembersWithLicenseError

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). Supports $filter (eq).

Id

Read-only.

IsArchived
IsAssignableToRole

Indicates whether this group can be assigned to an Azure Active Directory role.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 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 Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT).

Item[String]
Mail

The SMTP address for the group, for example, 'serviceadmins@contoso.onmicrosoft.com'. Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).

MailEnabled

Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT).

MailNickname
Member

Users, contacts, and groups that are members of this group. HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. Nullable. Supports $expand.

MemberOf

Groups and administrative units that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.

MembershipRule

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).

MembershipRuleProcessingState

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).

MembersWithLicenseError

A list of group members with license errors from this group-based license assignment. Read-only.

OdataId

The full id of object in directory

OdataType

The type of object in directory

Owner

The owners of the group. The owners are a set of non-admin users who are allowed to modify this object. HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. Nullable. Supports $expand.

PermissionGrant

The permissions that have been granted for a group to a specific application. Supports $expand.

PreferredDataLocation

The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default.

PreferredLanguage

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).

ProxyAddress

Email addresses for the group that direct to the same group mailbox. For example: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. The any operator is required for filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith).

RenewedDateTime

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.

ResourceGroupName

Gets the resource group name

SecurityEnabled

Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in).

SecurityIdentifier

Security identifier of the group, used in Windows scenarios. Returned by default.

Theme

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

Visibility

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. See group visibility options to learn more. Returned by default.

Methods

Add(String, Object)
Clear()
ContainsKey(String)
CopyFrom(IDictionary)
CopyFrom(PSObject)
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of MicrosoftGraphGroup.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of MicrosoftGraphGroup.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup.

FromJsonString(String)

Creates a new instance of MicrosoftGraphGroup, deserializing the content from a json string.

Remove(String)
ToJson(JsonObject, SerializationMode)

Serializes this instance of MicrosoftGraphGroup into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
TryGetValue(String, Object)
Validate(IEventListener)

Validates that this object meets the validation criteria.

Operators

Implicit(MicrosoftGraphGroup to Dictionary<String,Object>)

Explicit Interface Implementations

IAssociativeArray<Object>.AdditionalProperties

Applies to