Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

New-MgGroupMemberByRef

Add a member to a security or Microsoft 365 group. When using the API to add multiple members in one request, you can add up to only 20 members. The following table shows the types of members that can be added to either security groups or Microsoft 365 groups.

Note

To view the beta release of this cmdlet, view New-MgBetaGroupMemberByRef

Syntax

CreateExpanded (Default)

New-MgGroupMemberByRef
 -GroupId <string>
 -OdataId <string>
 [-ResponseHeadersVariable <string>]
 [-AdditionalProperties <hashtable>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-PassThru]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Create

New-MgGroupMemberByRef
 -GroupId <string>
 -BodyParameter <IReferenceCreate>
 [-ResponseHeadersVariable <string>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-PassThru]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateViaIdentityExpanded

New-MgGroupMemberByRef
 -InputObject <IGroupsIdentity>
 -OdataId <string>
 [-ResponseHeadersVariable <string>]
 [-AdditionalProperties <hashtable>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-PassThru]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateViaIdentity

New-MgGroupMemberByRef
 -InputObject <IGroupsIdentity>
 -BodyParameter <IReferenceCreate>
 [-ResponseHeadersVariable <string>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-PassThru]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Add a member to a security or Microsoft 365 group. When using the API to add multiple members in one request, you can add up to only 20 members. The following table shows the types of members that can be added to either security groups or Microsoft 365 groups.

Examples

Example 1: Add a member to a group


Import-Module Microsoft.Graph.Groups

$params = @{
	"@odata.id" = "https://graph.microsoft.com/v1.0/directoryObjects/{id}"
}

New-MgGroupMemberByRef -GroupId $groupId -BodyParameter $params

This example will add a member to a group

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

-BodyParameter

To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IReferenceCreate
Supports wildcards:False
DontShow:False

Parameter sets

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-GroupId

The unique identifier of group

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IGroupsIdentity
Supports wildcards:False
DontShow:False

Parameter sets

-OdataId

The entity reference URL of the resource. For example, https://graph.microsoft.com/v1.0/directoryObjects/{id}.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-PassThru

Returns true when the command succeeds

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.PowerShell.Models.IGroupsIdentity

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.IReferenceCreate

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

System.Boolean

{{ Fill in the Description }}

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IReferenceCreate>: . [(Any) <Object>]: This indicates any property can be added to this object. OdataId <String>: The entity reference URL of the resource. For example, https://graph.microsoft.com/v1.0/directoryObjects/{id}.

INPUTOBJECT <IGroupsIdentity>: Identity Parameter [AttachmentId <String>]: The unique identifier of attachment [ConversationId <String>]: The unique identifier of conversation [ConversationThreadId <String>]: The unique identifier of conversationThread [DirectoryObjectId <String>]: The unique identifier of directoryObject [EndDateTime <String>]: Usage: endDateTime='{endDateTime}' [ExtensionId <String>]: The unique identifier of extension [GroupId <String>]: The unique identifier of group [GroupLifecyclePolicyId <String>]: The unique identifier of groupLifecyclePolicy [GroupSettingId <String>]: The unique identifier of groupSetting [GroupSettingTemplateId <String>]: The unique identifier of groupSettingTemplate [Interval <String>]: Usage: interval='{interval}' [ListId <String>]: Usage: listId='{listId}' [Path <String>]: Usage: path='{path}' [PostId <String>]: The unique identifier of post [ProfilePhotoId <String>]: The unique identifier of profilePhoto [ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant [SiteId <String>]: The unique identifier of site [StartDateTime <String>]: Usage: startDateTime='{startDateTime}' [UniqueName <String>]: Alternate key of group

Related Links