New-MgChatPinnedMessage
Pin a chat message in the specified chat. This API cannot create a new chat; you must use the list chats method to retrieve the ID of an existing chat before you can pin a chat message.
Note
To view the beta release of this cmdlet, view New-MgBetaChatPinnedMessage
Syntax
New-MgChatPinnedMessage
-ChatId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Id <String>]
[-Message <IMicrosoftGraphChatMessage>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgChatPinnedMessage
-ChatId <String>
-BodyParameter <IMicrosoftGraphPinnedChatMessageInfo>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgChatPinnedMessage
-InputObject <ITeamsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Id <String>]
[-Message <IMicrosoftGraphChatMessage>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgChatPinnedMessage
-InputObject <ITeamsIdentity>
-BodyParameter <IMicrosoftGraphPinnedChatMessageInfo>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Pin a chat message in the specified chat. This API cannot create a new chat; you must use the list chats method to retrieve the ID of an existing chat before you can pin a chat message.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | ChatMessage.Send | Chat.ReadWrite |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Chat.ReadWrite.All | ChatMessage.ReadWriteSelected.Chat |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Teams
$params = @{
"message@odata.bind" = "https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832"
}
New-MgChatPinnedMessage -ChatId $chatId -BodyParameter $paramsThis example shows how to use the New-MgChatPinnedMessage Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
pinnedChatMessageInfo To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphPinnedChatMessageInfo |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ChatId
The unique identifier of chat
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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 |
-Id
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 |
-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 |
-Message
chatMessage To construct, see NOTES section for MESSAGE properties and create a hash table.
| Type: | IMicrosoftGraphChatMessage |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-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.IMicrosoftGraphPinnedChatMessageInfo
Microsoft.Graph.PowerShell.Models.ITeamsIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPinnedChatMessageInfo
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 <IMicrosoftGraphPinnedChatMessageInfo>: pinnedChatMessageInfo
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[Message <IMicrosoftGraphChatMessage>]: chatMessage[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphChatMessageAttachment-[]>]: References to attached objects like files, tabs, meetings etc.[Content <String>]: The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive.[ContentType <String>]: The media type of the content attachment. It can have the following values: reference: Attachment is a link to another file. Populate the contentURL with the link to the object.Any contentType that is supported by the Bot Framework's Attachment objectapplication/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.[ContentUrl <String>]: The URL for the content of the attachment.[Id <String>]: Read-only. The unique id of the attachment.[Name <String>]: The name of the attachment.[TeamsAppId <String>]: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.[ThumbnailUrl <String>]: The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.
[Body <IMicrosoftGraphItemBody>]: itemBody[(Any) <Object>]: This indicates any property can be added to this object.[Content <String>]: The content of the item.[ContentType <String>]: bodyType
[ChannelIdentity <IMicrosoftGraphChannelIdentity>]: channelIdentity[(Any) <Object>]: This indicates any property can be added to this object.[ChannelId <String>]: The identity of the channel in which the message was posted.[TeamId <String>]: The identity of the team in which the message was posted.
[ChatId <String>]: If the message was sent in a chat, represents the identity of the chat.[CreatedDateTime <DateTime?>]: Timestamp of when the chat message was created.[DeletedDateTime <DateTime?>]: Read only. Timestamp at which the chat message was deleted, or null if not deleted.[Etag <String>]: Read-only. Version number of the chat message.[EventDetail <IMicrosoftGraphEventMessageDetail>]: eventMessageDetail[(Any) <Object>]: This indicates any property can be added to this object.
[From <IMicrosoftGraphChatMessageFromIdentitySet>]: chatMessageFromIdentitySet[(Any) <Object>]: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]: identity[(Any) <Object>]: This indicates any property can be added to this object.[DisplayName <String>]: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]: identity[User <IMicrosoftGraphIdentity>]: identity
[HostedContents <IMicrosoftGraphChatMessageHostedContent-[]>]: Content in a message hosted by Microsoft Teams - for example, images or code snippets.[ContentBytes <Byte-[]>]: Write only. Bytes for the hosted content (such as images).[ContentType <String>]: Write only. Content type. such as image/png, image/jpg.[Id <String>]: The unique identifier for an entity. Read-only.
[Importance <String>]: chatMessageImportance[LastEditedDateTime <DateTime?>]: Read only. Timestamp when edits to the chat message were made. Triggers an 'Edited' flag in the Teams UI. If no edits are made the value is null.[LastModifiedDateTime <DateTime?>]: Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.[Locale <String>]: Locale of the chat message set by the client. Always set to en-us.[Mentions <IMicrosoftGraphChatMessageMention-[]>]: List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.[Id <Int32?>]: Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding<at id='{index}'>tag in the message body.[MentionText <String>]: String used to represent the mention. For example, a user's display name, a team name.[Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]: chatMessageMentionedIdentitySet[(Any) <Object>]: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]: identity[Device <IMicrosoftGraphIdentity>]: identity[User <IMicrosoftGraphIdentity>]: identity[Conversation <IMicrosoftGraphTeamworkConversationIdentity>]: teamworkConversationIdentity[(Any) <Object>]: This indicates any property can be added to this object.[DisplayName <String>]: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[ConversationIdentityType <String>]: teamworkConversationIdentityType
[MessageHistory <IMicrosoftGraphChatMessageHistoryItem-[]>]: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.[Actions <String>]: chatMessageActions[ModifiedDateTime <DateTime?>]: The date and time when the message was modified.[Reaction <IMicrosoftGraphChatMessageReaction>]: chatMessageReaction[(Any) <Object>]: This indicates any property can be added to this object.[CreatedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[ReactionType <String>]: Supported values are like, angry, sad, laugh, heart, surprised.[User <IMicrosoftGraphChatMessageReactionIdentitySet>]: chatMessageReactionIdentitySet[(Any) <Object>]: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]: identity[Device <IMicrosoftGraphIdentity>]: identity[User <IMicrosoftGraphIdentity>]: identity
[MessageType <String>]: chatMessageType[PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]: chatMessagePolicyViolation[(Any) <Object>]: This indicates any property can be added to this object.[DlpAction <String>]: chatMessagePolicyViolationDlpActionTypes[JustificationText <String>]: Justification text provided by the sender of the message when overriding a policy violation.[PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]: chatMessagePolicyViolationPolicyTip[(Any) <Object>]: This indicates any property can be added to this object.[ComplianceUrl <String>]: The URL a user can visit to read about the data loss prevention policies for the organization. (ie, policies about what users shouldn't say in chats)[GeneralText <String>]: Explanatory text shown to the sender of the message.[MatchedConditionDescriptions <String-[]>]: The list of improper data in the message that was detected by the data loss prevention app. Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
[UserAction <String>]: chatMessagePolicyViolationUserActionTypes[VerdictDetails <String>]: chatMessagePolicyViolationVerdictDetailsTypes
[Reactions <IMicrosoftGraphChatMessageReaction-[]>]: Reactions for this chat message (for example, Like).[Replies <IMicrosoftGraphChatMessage-[]>]: Replies for a specified message. Supports $expand for channel messages.[ReplyToId <String>]: Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)[Subject <String>]: The subject of the chat message, in plaintext.[Summary <String>]: Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.[WebUrl <String>]: Read-only. Link to the message in Microsoft Teams.
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
MESSAGE <IMicrosoftGraphChatMessage>: chatMessage
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphChatMessageAttachment-[]>]: References to attached objects like files, tabs, meetings etc.[Content <String>]: The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive.[ContentType <String>]: The media type of the content attachment. It can have the following values: reference: Attachment is a link to another file. Populate the contentURL with the link to the object.Any contentType that is supported by the Bot Framework's Attachment objectapplication/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.[ContentUrl <String>]: The URL for the content of the attachment.[Id <String>]: Read-only. The unique id of the attachment.[Name <String>]: The name of the attachment.[TeamsAppId <String>]: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.[ThumbnailUrl <String>]: The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.
[Body <IMicrosoftGraphItemBody>]: itemBody[(Any) <Object>]: This indicates any property can be added to this object.[Content <String>]: The content of the item.[ContentType <String>]: bodyType
[ChannelIdentity <IMicrosoftGraphChannelIdentity>]: channelIdentity[(Any) <Object>]: This indicates any property can be added to this object.[ChannelId <String>]: The identity of the channel in which the message was posted.[TeamId <String>]: The identity of the team in which the message was posted.
[ChatId <String>]: If the message was sent in a chat, represents the identity of the chat.[CreatedDateTime <DateTime?>]: Timestamp of when the chat message was created.[DeletedDateTime <DateTime?>]: Read only. Timestamp at which the chat message was deleted, or null if not deleted.[Etag <String>]: Read-only. Version number of the chat message.[EventDetail <IMicrosoftGraphEventMessageDetail>]: eventMessageDetail[(Any) <Object>]: This indicates any property can be added to this object.
[From <IMicrosoftGraphChatMessageFromIdentitySet>]: chatMessageFromIdentitySet[(Any) <Object>]: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]: identity[(Any) <Object>]: This indicates any property can be added to this object.[DisplayName <String>]: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]: identity[User <IMicrosoftGraphIdentity>]: identity
[HostedContents <IMicrosoftGraphChatMessageHostedContent-[]>]: Content in a message hosted by Microsoft Teams - for example, images or code snippets.[ContentBytes <Byte-[]>]: Write only. Bytes for the hosted content (such as images).[ContentType <String>]: Write only. Content type. such as image/png, image/jpg.[Id <String>]: The unique identifier for an entity. Read-only.
[Importance <String>]: chatMessageImportance[LastEditedDateTime <DateTime?>]: Read only. Timestamp when edits to the chat message were made. Triggers an 'Edited' flag in the Teams UI. If no edits are made the value is null.[LastModifiedDateTime <DateTime?>]: Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.[Locale <String>]: Locale of the chat message set by the client. Always set to en-us.[Mentions <IMicrosoftGraphChatMessageMention-[]>]: List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.[Id <Int32?>]: Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding<at id='{index}'>tag in the message body.[MentionText <String>]: String used to represent the mention. For example, a user's display name, a team name.[Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]: chatMessageMentionedIdentitySet[(Any) <Object>]: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]: identity[Device <IMicrosoftGraphIdentity>]: identity[User <IMicrosoftGraphIdentity>]: identity[Conversation <IMicrosoftGraphTeamworkConversationIdentity>]: teamworkConversationIdentity[(Any) <Object>]: This indicates any property can be added to this object.[DisplayName <String>]: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[ConversationIdentityType <String>]: teamworkConversationIdentityType
[MessageHistory <IMicrosoftGraphChatMessageHistoryItem-[]>]: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.[Actions <String>]: chatMessageActions[ModifiedDateTime <DateTime?>]: The date and time when the message was modified.[Reaction <IMicrosoftGraphChatMessageReaction>]: chatMessageReaction[(Any) <Object>]: This indicates any property can be added to this object.[CreatedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[ReactionType <String>]: Supported values are like, angry, sad, laugh, heart, surprised.[User <IMicrosoftGraphChatMessageReactionIdentitySet>]: chatMessageReactionIdentitySet[(Any) <Object>]: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]: identity[Device <IMicrosoftGraphIdentity>]: identity[User <IMicrosoftGraphIdentity>]: identity
[MessageType <String>]: chatMessageType[PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]: chatMessagePolicyViolation[(Any) <Object>]: This indicates any property can be added to this object.[DlpAction <String>]: chatMessagePolicyViolationDlpActionTypes[JustificationText <String>]: Justification text provided by the sender of the message when overriding a policy violation.[PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]: chatMessagePolicyViolationPolicyTip[(Any) <Object>]: This indicates any property can be added to this object.[ComplianceUrl <String>]: The URL a user can visit to read about the data loss prevention policies for the organization. (ie, policies about what users shouldn't say in chats)[GeneralText <String>]: Explanatory text shown to the sender of the message.[MatchedConditionDescriptions <String-[]>]: The list of improper data in the message that was detected by the data loss prevention app. Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
[UserAction <String>]: chatMessagePolicyViolationUserActionTypes[VerdictDetails <String>]: chatMessagePolicyViolationVerdictDetailsTypes
[Reactions <IMicrosoftGraphChatMessageReaction-[]>]: Reactions for this chat message (for example, Like).[Replies <IMicrosoftGraphChatMessage-[]>]: Replies for a specified message. Supports $expand for channel messages.[ReplyToId <String>]: Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)[Subject <String>]: The subject of the chat message, in plaintext.[Summary <String>]: Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.[WebUrl <String>]: Read-only. Link to the message in Microsoft Teams.
RELATED LINKS
https://learn.microsoft.com/powershell/module/microsoft.graph.teams/new-mgchatpinnedmessage
https://learn.microsoft.com/graph/api/chat-post-pinnedmessages?view=graph-rest-1.0