New-MgChatMember
Add a conversationMember to a chat.
Note
To view the beta release of this cmdlet, view New-MgBetaChatMember
New-MgChatMember
-ChatId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-DisplayName <String>]
[-Id <String>]
[-Roles <String[]>]
[-VisibleHistoryStartDateTime <DateTime>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgChatMember
-ChatId <String>
-BodyParameter <IMicrosoftGraphConversationMember>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgChatMember
-InputObject <ITeamsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-DisplayName <String>]
[-Id <String>]
[-Roles <String[]>]
[-VisibleHistoryStartDateTime <DateTime>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgChatMember
-InputObject <ITeamsIdentity>
-BodyParameter <IMicrosoftGraphConversationMember>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add a conversationMember to a chat.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | ChatMember.ReadWrite | Chat.ReadWrite |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Chat.Manage.Chat | Chat.ReadWrite.All, ChatMember.ReadWrite.All |
Import-Module Microsoft.Graph.Teams
$params = @{
"@odata.type" = "#microsoft.graph.aadUserConversationMember"
"user@odata.bind" = "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5"
visibleHistoryStartDateTime = [System.DateTime]::Parse("2019-04-18T23:51:43.255Z")
roles = @(
"owner"
)
}
New-MgChatMember -ChatId $chatId -BodyParameter $params
This example will add a single member to a chat and specify the timespan for the conversation history
Import-Module Microsoft.Graph.Teams
$params = @{
"@odata.type" = "#microsoft.graph.aadUserConversationMember"
"user@odata.bind" = "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5"
roles = @(
"owner"
)
}
New-MgChatMember -ChatId $chatId -BodyParameter $params
This example will add a single member to a microsoft teams chat, sharing no chat history
Import-Module Microsoft.Graph.Teams
$params = @{
"@odata.type" = "#microsoft.graph.aadUserConversationMember"
"user@odata.bind" = "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5"
visibleHistoryStartDateTime = [System.DateTime]::Parse("0001-01-01T00:00:00Z")
roles = @(
"owner"
)
}
New-MgChatMember -ChatId $chatId -BodyParameter $params
This example will add a single member to a microsoft teams chat, sharing the whole history of the chat
Import-Module Microsoft.Graph.Teams
$params = @{
"@odata.type" = "#microsoft.graph.aadUserConversationMember"
"user@odata.bind" = "https://graph.microsoft.com/v1.0/users/jacob@contoso.com"
visibleHistoryStartDateTime = [System.DateTime]::Parse("2019-04-18T23:51:43.255Z")
roles = @(
"owner"
)
}
New-MgChatMember -ChatId $chatId -BodyParameter $params
This example will add a single member to a chat using user principal name
Import-Module Microsoft.Graph.Teams
$params = @{
"@odata.type" = "#microsoft.graph.aadUserConversationMember"
"user@odata.bind" = "https://graph.microsoft.com/v1.0/users/8ba98gf6-7fc2-4eb2-c7f2-aef9f21fd98g"
roles = @(
"guest"
)
}
New-MgChatMember -ChatId $chatId -BodyParameter $params
This example will add an in-tenant guest to a chat, sharing no chat history
Import-Module Microsoft.Graph.Teams
$params = @{
"@odata.type" = "#microsoft.graph.aadUserConversationMember"
"user@odata.bind" = "https://graph.microsoft.com/v1.0/users/82af01c5-f7cc-4a2e-a728-3a5df21afd9d"
roles = @(
"owner"
)
tenantId = "4dc1fe35-8ac6-4f0d-904a-7ebcd364bea1"
}
New-MgChatMember -ChatId $chatId -BodyParameter $params
This example will add an out-of-tenant external user to a chat, sharing no chat history
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
conversationMember To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphConversationMember |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The unique identifier of chat
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
The display name of the user.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
The unique identifier for an entity. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
{{ Fill ProgressAction Description }}
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Optional Response Headers Variable.
Type: | String |
Aliases: | RHV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphConversationMember
Microsoft.Graph.PowerShell.Models.ITeamsIdentity
System.Collections.IDictionary
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphConversationMember
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 <IMicrosoftGraphConversationMember>
: conversationMember
[(Any) <Object>]
: This indicates any property can be added to this object.[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