Add-MgTeamMember

Module:

Microsoft.Graph.Teams

Add multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.

Note

To view the beta release of this cmdlet, view Add-MgBetaTeamMember

Syntax

Add-MgTeamMember
   -TeamId <String>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-Values <IMicrosoftGraphConversationMember[]>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-MgTeamMember
   -TeamId <String>
   -BodyParameter <IPaths1E258D4TeamsTeamIdMembersMicrosoftGraphAddPostRequestbodyContentApplicationJsonSchema>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-MgTeamMember
   -InputObject <ITeamsIdentity>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-Values <IMicrosoftGraphConversationMember[]>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-MgTeamMember
   -InputObject <ITeamsIdentity>
   -BodyParameter <IPaths1E258D4TeamsTeamIdMembersMicrosoftGraphAddPostRequestbodyContentApplicationJsonSchema>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Add multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.

Examples

Example 1: Add members in bulk to a team

Import-Module Microsoft.Graph.Teams

$params = @{
	values = @(
		@{
			"@odata.type" = "microsoft.graph.aadUserConversationMember"
			roles = @(
			)
			"user@odata.bind" = "https://graph.microsoft.com/v1.0/users('18a80140-b0fb-4489-b360-2f6efaf225a0')"
		}
		@{
			"@odata.type" = "microsoft.graph.aadUserConversationMember"
			roles = @(
				"owner"
			)
			"user@odata.bind" = "https://graph.microsoft.com/v1.0/users('86503198-b81b-43fe-81ee-ad45b8848ac9')"
		}
	)
}

Add-MgTeamMember -TeamId $teamId -BodyParameter $params

This example will add members in bulk to a team

Example 2: Add members in bulk and encounter partial failure

Import-Module Microsoft.Graph.Teams

$params = @{
	values = @(
		@{
			"@odata.type" = "microsoft.graph.aadUserConversationMember"
			roles = @(
			)
			"user@odata.bind" = "https://graph.microsoft.com/v1.0/users('18a80140-b0fb-4489-b360-2f6efaf225a0')"
		}
		@{
			"@odata.type" = "microsoft.graph.aadUserConversationMember"
			roles = @(
				"owner"
			)
			"user@odata.bind" = "https://graph.microsoft.com/v1.0/users('86503198-b81b-43fe-81ee-ad45b8848ac9')"
		}
	)
}

Add-MgTeamMember -TeamId $teamId -BodyParameter $params

This example will add members in bulk and encounter partial failure

Example 3: Add members in bulk to a team using user principal name

Import-Module Microsoft.Graph.Teams

$params = @{
	values = @(
		@{
			"@odata.type" = "microsoft.graph.aadUserConversationMember"
			roles = @(
			)
			"user@odata.bind" = "https://graph.microsoft.com/v1.0/users('jacob@contoso.com')"
		}
		@{
			"@odata.type" = "microsoft.graph.aadUserConversationMember"
			roles = @(
				"owner"
			)
			"user@odata.bind" = "https://graph.microsoft.com/v1.0/users('alex@contoso.com')"
		}
	)
}

Add-MgTeamMember -TeamId $teamId -BodyParameter $params

This example will add members in bulk to a team using user principal name

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

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

Type:	IPaths1E258D4TeamsTeamIdMembersMicrosoftGraphAddPostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

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

Type:	ITeamsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TeamId

The unique identifier of team

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Values

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

Type:	IMicrosoftGraphConversationMember[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.IPaths1E258D4TeamsTeamIdMembersMicrosoftGraphAddPostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.PowerShell.Models.ITeamsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphActionResultPart

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 <IPaths1E258D4TeamsTeamIdMembersMicrosoftGraphAddPostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Values <IMicrosoftGraphConversationMember- []>]:
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [DisplayName <String>]: The display name of the user.
  • [Roles <String- []>]: The roles for that user. This property contains additional qualifiers only when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains guest as one of the values. A basic member should not have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role.
  • [VisibleHistoryStartDateTime <DateTime?>]: The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.

INPUTOBJECT <ITeamsIdentity>: Identity Parameter

• [AssociatedTeamInfoId <String>]: The unique identifier of associatedTeamInfo
• [ChannelId <String>]: The unique identifier of channel
• [ChatId <String>]: The unique identifier of chat
• [ChatMessageHostedContentId <String>]: The unique identifier of chatMessageHostedContent
• [ChatMessageId <String>]: The unique identifier of chatMessage
• [ChatMessageId1 <String>]: The unique identifier of chatMessage
• [ConversationMemberId <String>]: The unique identifier of conversationMember
• [DeletedChatId <String>]: The unique identifier of deletedChat
• [DeletedTeamId <String>]: The unique identifier of deletedTeam
• [GroupId <String>]: The unique identifier of group
• [OfferShiftRequestId <String>]: The unique identifier of offerShiftRequest
• [OpenShiftChangeRequestId <String>]: The unique identifier of openShiftChangeRequest
• [OpenShiftId <String>]: The unique identifier of openShift
• [PinnedChatMessageInfoId <String>]: The unique identifier of pinnedChatMessageInfo
• [ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant
• [SchedulingGroupId <String>]: The unique identifier of schedulingGroup
• [SharedWithChannelTeamInfoId <String>]: The unique identifier of sharedWithChannelTeamInfo
• [ShiftId <String>]: The unique identifier of shift
• [SwapShiftsChangeRequestId <String>]: The unique identifier of swapShiftsChangeRequest
• [TeamId <String>]: The unique identifier of team
• [TeamsAppDefinitionId <String>]: The unique identifier of teamsAppDefinition
• [TeamsAppId <String>]: The unique identifier of teamsApp
• [TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
• [TeamsAsyncOperationId <String>]: The unique identifier of teamsAsyncOperation
• [TeamsTabId <String>]: The unique identifier of teamsTab
• [TeamworkTagId <String>]: The unique identifier of teamworkTag
• [TeamworkTagMemberId <String>]: The unique identifier of teamworkTagMember
• [TimeOffId <String>]: The unique identifier of timeOff
• [TimeOffReasonId <String>]: The unique identifier of timeOffReason
• [TimeOffRequestId <String>]: The unique identifier of timeOffRequest
• [UserId <String>]: The unique identifier of user
• [UserScopeTeamsAppInstallationId <String>]: The unique identifier of userScopeTeamsAppInstallation
• [WorkforceIntegrationId <String>]: The unique identifier of workforceIntegration

VALUES <IMicrosoftGraphConversationMember- []>: .

• [Id <String>]: The unique identifier for an entity. Read-only.
• [DisplayName <String>]: The display name of the user.
• [Roles <String- []>]: The roles for that user. This property contains additional qualifiers only when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains guest as one of the values. A basic member should not have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role.
• [VisibleHistoryStartDateTime <DateTime?>]: The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.teams/add-mgteammember
• https://learn.microsoft.com/graph/api/conversationmembers-add?view=graph-rest-1.0