Send an activity feed notification in the scope of a team.
For more information about sending notifications and the requirements for doing so, seesending Teams activity notifications.
Send an activity feed notification in the scope of a team.
For more information about sending notifications and the requirements for doing so, seesending Teams activity notifications.
Permissions
Permission type
Permissions (from least to most privileged)
Delegated (work or school account)
TeamsActivity.Send,
Delegated (personal Microsoft account)
Not supported
Application
TeamsActivity.Send.Group, TeamsActivity.Send,
Examples
Example 1: Notify a user about pending finance approval requests
This example will notify the channel members about pending finance approval requests
Example 7: Notify about pending finance approval requests in channel message reply location
Import-Module Microsoft.Graph.Teams
$params = @{
topic = @{
source = "entityUrl"
value = "https://graph.microsoft.com/beta/teams/{teamId}/channels/{channelId}/messages/{messageId}/replies/{replyId}"
}
activityType = "reservationStatusUpdated"
previewText = @{
content = "You have moved up the queue"
}
recipient = @{
"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
userId = "jacob@contoso.com"
}
templateParameters = @(
@{
name = "reservationId"
value = "TREEE433"
}
@{
name = "currentSlot"
value = "23"
}
)
}
Send-MgTeamActivityNotification -TeamId $teamId -BodyParameter $params
This example will notify about pending finance approval requests in channel message reply location
Parameters
-ActivityType
Send an activity feed notification in the scope of a team.
For more information about sending notifications and the requirements for doing so, seesending Teams activity notifications.
Permissions
Permission type
Permissions (from least to most privileged)
Delegated (work or school account)
TeamsActivity.Send,
Delegated (personal Microsoft account)
Not supported
Application
TeamsActivity.Send.Group, TeamsActivity.Send,
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
SendViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
SendExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AdditionalProperties
Additional Parameters
Parameter properties
Type:
System.Collections.Hashtable
Supports wildcards:
False
DontShow:
False
Parameter sets
SendViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
SendExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-BodyParameter
To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Send an activity feed notification in the scope of a team.
For more information about sending notifications and the requirements for doing so, seesending Teams activity notifications.
Permissions
Permission type
Permissions (from least to most privileged)
Delegated (work or school account)
TeamsActivity.Send,
Delegated (personal Microsoft account)
Not supported
Application
TeamsActivity.Send.Group, TeamsActivity.Send,
Parameter properties
Type:
System.Int64
Default value:
0
Supports wildcards:
False
DontShow:
False
Parameter sets
SendViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
SendExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
Supports wildcards:
False
DontShow:
False
Aliases:
cf
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
Send an activity feed notification in the scope of a team.
For more information about sending notifications and the requirements for doing so, seesending Teams activity notifications.
Permissions
Permission type
Permissions (from least to most privileged)
Delegated (work or school account)
TeamsActivity.Send,
Delegated (personal Microsoft account)
Not supported
Application
TeamsActivity.Send.Group, TeamsActivity.Send,
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
SendViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
SendExpanded
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
SendViaIdentityExpanded
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
SendViaIdentity
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-PassThru
Returns true when the command succeeds
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
-PreviewText
itemBody
To construct, see NOTES section for PREVIEWTEXT properties and create a hash table.
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
-Recipient
teamworkNotificationRecipient
Parameter properties
Type:
System.Collections.Hashtable
Supports wildcards:
False
DontShow:
False
Parameter sets
SendViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
SendExpanded
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
-TeamId
The unique identifier of team
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
SendExpanded
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
Send
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TeamsAppId
Send an activity feed notification in the scope of a team.
For more information about sending notifications and the requirements for doing so, seesending Teams activity notifications.
Permissions
Permission type
Permissions (from least to most privileged)
Delegated (work or school account)
TeamsActivity.Send,
Delegated (personal Microsoft account)
Not supported
Application
TeamsActivity.Send.Group, TeamsActivity.Send,
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
SendViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
SendExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TemplateParameters
To construct, see NOTES section for TEMPLATEPARAMETERS properties and create a hash table.
Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
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.
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 <IPaths1Bflym4TeamsTeamIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema>: .
[(Any) <Object>]: This indicates any property can be added to this object.
[ActivityType <String>]:
[ChainId <Int64?>]:
[IconId <String>]:
[PreviewText <IMicrosoftGraphItemBody>]: itemBody
[(Any) <Object>]: This indicates any property can be added to this object.
[Content <String>]: The content of the item.
[ContentType <String>]: bodyType
[Recipient <IMicrosoftGraphTeamworkNotificationRecipient>]: teamworkNotificationRecipient
[(Any) <Object>]: This indicates any property can be added to this object.
[TeamsAppId <String>]:
[TemplateParameters <IMicrosoftGraphKeyValuePair[]>]:
[Name <String>]: Name for this key-value pair
[Value <String>]: Value for this key-value pair
[Topic <IMicrosoftGraphTeamworkActivityTopic>]: teamworkActivityTopic
[(Any) <Object>]: This indicates any property can be added to this object.
[Source <String>]: teamworkActivityTopicSource
[Value <String>]: The topic value.
If the value of the source property is entityUrl, this must be a Microsoft Graph URL.
If the value is text, this must be a plain text value.
[WebUrl <String>]: The link the user clicks when they select the notification.
Optional when source is entityUrl; required when source is text.
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
PREVIEWTEXT <IMicrosoftGraphItemBody>: itemBody
[(Any) <Object>]: This indicates any property can be added to this object.
[Content <String>]: The content of the item.
[ContentType <String>]: bodyType
TEMPLATEPARAMETERS <IMicrosoftGraphKeyValuePair[]>: .
[Name <String>]: Name for this key-value pair
[Value <String>]: Value for this key-value pair
TOPIC <IMicrosoftGraphTeamworkActivityTopic>: teamworkActivityTopic
[(Any) <Object>]: This indicates any property can be added to this object.
[Source <String>]: teamworkActivityTopicSource
[Value <String>]: The topic value.
If the value of the source property is entityUrl, this must be a Microsoft Graph URL.
If the value is text, this must be a plain text value.
[WebUrl <String>]: The link the user clicks when they select the notification.
Optional when source is entityUrl; required when source is text.