Get-MgBetaUserChatRetainedMessage

Module:

Microsoft.Graph.Beta.Teams Module

Get all retained messages from all chats that a user is a participant in, including one-on-one chats, group chats, and meeting chats. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.

Note

To view the v1.0 release of this cmdlet, view Get-MgUserChatRetainedMessage

Syntax

Get (Default)

Get-MgBetaUserChatRetainedMessage
    -UserId <string>
    [-Count]
    [-ExpandProperty <string[]>]
    [-Filter <string>]
    [-Property <string[]>]
    [-Search <string>]
    [-Skip <int>]
    [-Sort <string[]>]
    [-Top <int>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

GetViaIdentity

Get-MgBetaUserChatRetainedMessage
    -InputObject <ITeamsIdentity>
    [-Count]
    [-ExpandProperty <string[]>]
    [-Filter <string>]
    [-Property <string[]>]
    [-Search <string>]
    [-Skip <int>]
    [-Sort <string[]>]
    [-Top <int>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

Description

Get all retained messages from all chats that a user is a participant in, including one-on-one chats, group chats, and meeting chats. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Not supported
Delegated (personal Microsoft account)	Not supported
Application	Chat.Read.All, Chat.ReadWrite.All,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Teams

Get-MgBetaUserChatRetainedMessage -UserId $userId

This example shows how to use the Get-MgBetaUserChatRetainedMessage Cmdlet.

Parameters

-Break

Wait for .NET debugger to attach

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Count

Include count of items

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ExpandProperty

Expand related entities

Parameter properties

Type:	System.String[]
Supports wildcards:	False
DontShow:	False
Aliases:	Expand

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Filter

Filter items by property values

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Headers

Optional headers that will be added to the request.

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelineAppend

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

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelinePrepend

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

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

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

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Models.ITeamsIdentity
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Property

Select properties to be returned

Parameter properties

Type:	System.String[]
Supports wildcards:	False
DontShow:	False
Aliases:	Select

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Proxy

The URI for the proxy server to use

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-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

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-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

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Search

Search items by search phrases

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Skip

Skip the first n items

Parameter properties

Type:	System.Int32
Default value:	0
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Sort

Order items by property values

Parameter properties

Type:	System.String[]
Supports wildcards:	False
DontShow:	False
Aliases:	OrderBy

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Top

Show only the first n items

Parameter properties

Type:	System.Int32
Default value:	0
Supports wildcards:	False
DontShow:	False
Aliases:	Limit

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UserId

The unique identifier of user

Parameter properties

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

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

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.Beta.PowerShell.Models.ITeamsIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphChatMessage

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

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 [DayNoteId <String>]: The unique identifier of dayNote [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 [PlannerBucketId <String>]: The unique identifier of plannerBucket [PlannerPlanId <String>]: The unique identifier of plannerPlan [PlannerTaskId <String>]: The unique identifier of plannerTask [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 [ShiftsRoleDefinitionId <String>]: The unique identifier of shiftsRoleDefinition [SwapShiftsChangeRequestId <String>]: The unique identifier of swapShiftsChangeRequest [TeamId <String>]: The unique identifier of team [TeamTemplateDefinitionId <String>]: The unique identifier of teamTemplateDefinition [TeamTemplateId <String>]: The unique identifier of teamTemplate [TeamsAppDashboardCardDefinitionId <String>]: The unique identifier of teamsAppDashboardCardDefinition [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 [TeamworkDeviceId <String>]: The unique identifier of teamworkDevice [TeamworkDeviceOperationId <String>]: The unique identifier of teamworkDeviceOperation [TeamworkTagId <String>]: The unique identifier of teamworkTag [TeamworkTagMemberId <String>]: The unique identifier of teamworkTagMember [TimeCardId <String>]: The unique identifier of timeCard [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 [UserPrincipalName <String>]: Alternate key of user [UserScopeTeamsAppInstallationId <String>]: The unique identifier of userScopeTeamsAppInstallation [WorkforceIntegrationId <String>]: The unique identifier of workforceIntegration

Related Links

• Get-MgBetaUserChatRetainedMessage
• Graph API Reference