Get-MgChat

Module:: Microsoft.Graph.Teams Module

Retrieve a single chat (without its messages). This method supports federation. To access a chat, at least one chat member must belong to the tenant the request initiated from.

Note

To view the beta release of this cmdlet, view Get-MgBetaChat

Syntax

List (Default)

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

Get

Get-MgChat
    -ChatId <string>
    [-ExpandProperty <string[]>]
    [-Property <string[]>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

GetViaIdentity

Get-MgChat
    -InputObject <ITeamsIdentity>
    [-ExpandProperty <string[]>]
    [-Property <string[]>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

Description

Retrieve a single chat (without its messages). This method supports federation. To access a chat, at least one chat member must belong to the tenant the request initiated from.

Permissions

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

Examples

Example 1: Get a group chat


Import-Module Microsoft.Graph.Teams

Get-MgChat -ChatId $chatId

This example will get a group chat

Example 2: Get a chat and all its members


Import-Module Microsoft.Graph.Teams

Get-MgChat -ChatId $chatId -ExpandProperty "members"

This example will get a chat and all its members

Example 3: Get the meeting details of a chat associated with a Microsoft Teams meeting


Import-Module Microsoft.Graph.Teams

Get-MgChat -ChatId $chatId

This example will get the meeting details of a chat associated with a microsoft teams meeting

Example 4: Get the chat along with the preview of the last message sent in the chat


Import-Module Microsoft.Graph.Teams

Get-MgChat -ChatId $chatId -ExpandProperty "lastMessagePreview"

This example will get the chat along with the preview of the last message sent in the chat

Parameters

-All

List all pages.

Parameter properties

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

Parameter sets

List

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

-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

-ChatId

The unique identifier of chat

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

-CountVariable

Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.

Parameter properties

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

Parameter sets

List

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

List

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

-PageSize

Sets the page size of results.

Parameter properties

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

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
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

List

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

List

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

List

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

List

Position:	Named
Mandatory:	False
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.PowerShell.Models.ITeamsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphChat

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 [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 [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 [UserScopeTeamsAppInstallationId <String>]: The unique identifier of userScopeTeamsAppInstallation [WorkforceIntegrationId <String>]: The unique identifier of workforceIntegration

Share via

Get-MgChat

Syntax

List (Default)

Get

GetViaIdentity

Description

Examples

Example 1: Get a group chat

Example 2: Get a chat and all its members

Example 3: Get the meeting details of a chat associated with a Microsoft Teams meeting

Example 4: Get the chat along with the preview of the last message sent in the chat

Parameters

-All

Parameter properties

Parameter sets

-Break

Parameter properties

Parameter sets

-ChatId

Parameter properties

Parameter sets

-CountVariable

Parameter properties

Parameter sets

-ExpandProperty

Parameter properties

Parameter sets

-Filter

Parameter properties

Parameter sets

-Headers

Parameter properties

Parameter sets

-HttpPipelineAppend

Parameter properties

Parameter sets

-HttpPipelinePrepend

Parameter properties

Parameter sets

-InputObject

Parameter properties

Parameter sets

-PageSize

Parameter properties

Parameter sets

-Property

Parameter properties

Parameter sets

-Proxy

Parameter properties

Parameter sets

-ProxyCredential

Parameter properties

Parameter sets

-ProxyUseDefaultCredentials

Parameter properties

Parameter sets

-ResponseHeadersVariable

Parameter properties

Parameter sets

-Search

Parameter properties

Parameter sets

-Skip

Parameter properties

Parameter sets

-Sort

Parameter properties

Parameter sets

-Top

Parameter properties

Parameter sets

CommonParameters

Inputs

Microsoft.Graph.PowerShell.Models.ITeamsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphChat

Notes