Send-MgBetaTeamworkActivityNotificationToRecipient

  • Reference
Module:
Microsoft.Graph.Beta.Teams

Send activity feed notifications to multiple users in bulk. For more information, see sending Teams activity notifications.

Note

To view the v1.0 release of this cmdlet, view Send-MgTeamworkActivityNotificationToRecipient

Syntax

Send-MgBetaTeamworkActivityNotificationToRecipient
    [-ResponseHeadersVariable <String>]
    [-ActivityType <String>]
    [-AdditionalProperties <Hashtable>]
    [-ChainId <Int64>]
    [-PreviewText <IMicrosoftGraphItemBody>]
    [-Recipients <IMicrosoftGraphTeamworkNotificationRecipient[]>]
    [-TeamsAppId <String>]
    [-TemplateParameters <IMicrosoftGraphKeyValuePair[]>]
    [-Topic <IMicrosoftGraphTeamworkActivityTopic>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Send-MgBetaTeamworkActivityNotificationToRecipient
    -BodyParameter <IPaths1T8Q21HTeamworkMicrosoftGraphSendactivitynotificationtorecipientsPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Send activity feed notifications to multiple users in bulk. For more information, see sending Teams activity notifications.

Examples

Example 1: Notify multiple users about pending finance approval requests

Import-Module Microsoft.Graph.Beta.Teams

$params = @{
	topic = @{
		source = "entityUrl"
		value = "https://graph.microsoft.com/beta/appCatalogs/teamsApps/{teamsAppId}"
	}
	activityType = "pendingFinanceApprovalRequests"
	previewText = @{
		content = "Internal spending team has a pending finance approval requests"
	}
	recipients = @(
		@{
			"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
			userId = "569363e2-4e49-4661-87f2-16f245c5d66a"
		}
		@{
			"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
			userId = "ab88234e-0874-477c-9638-d144296ed04f"
		}
		@{
			"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
			userId = "01c64f53-69aa-42c7-9b7f-9f75195d6bfc"
		}
	)
	templateParameters = @(
		@{
			name = "pendingRequestCount"
			value = "5"
		}
	)
}

Send-MgBetaTeamworkActivityNotificationToRecipient -BodyParameter $params

This example will notify multiple users about pending finance approval requests

Example 2: Notify multiple users about an event using a custom topic

Import-Module Microsoft.Graph.Beta.Teams

$params = @{
	topic = @{
		source = "text"
		value = "Deployment Approvals Channel"
		webUrl = "https://teams.microsoft.com/l/message/19:448cfd2ac2a7490a9084a9ed14cttr78c@thread.skype/1605223780000?tenantId=c8b1bf45-3834-4ecf-971a-b4c755ee677d&groupId=d4c2a937-f097-435a-bc91-5c1683ca7245&parentMessageId=1605223771864&teamName=Approvals&channelName=Azure%20DevOps&createdTime=1605223780000"
	}
	activityType = "deploymentApprovalRequired"
	previewText = @{
		content = "New deployment requires your approval"
	}
	templateParameters = @(
		@{
			name = "deploymentId"
			value = "6788662"
		}
	)
	recipients = @(
		@{
			"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
			userId = "569363e2-4e49-4661-87f2-16f245c5d66a"
		}
		@{
			"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
			userId = "ab88234e-0874-477c-9638-d144296ed04f"
		}
		@{
			"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
			userId = "01c64f53-69aa-42c7-9b7f-9f75195d6bfc"
		}
	)
}

Send-MgBetaTeamworkActivityNotificationToRecipient -BodyParameter $params

This example will notify multiple users about an event using a custom topic

Parameters

-ActivityType

.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AdditionalProperties

Additional Parameters

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:IPaths1T8Q21HTeamworkMicrosoftGraphSendactivitynotificationtorecipientsPostRequestbodyContentApplicationJsonSchema
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ChainId

.

Type:Int64
Position:Named
Default value:0
Required:False
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

-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PreviewText

itemBody To construct, see NOTES section for PREVIEWTEXT properties and create a hash table.

Type:IMicrosoftGraphItemBody
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

-Recipients

.

Type:IMicrosoftGraphTeamworkNotificationRecipient[]
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

-TeamsAppId

.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TemplateParameters

. To construct, see NOTES section for TEMPLATEPARAMETERS properties and create a hash table.

Type:IMicrosoftGraphKeyValuePair[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Topic

teamworkActivityTopic To construct, see NOTES section for TOPIC properties and create a hash table.

Type:IMicrosoftGraphTeamworkActivityTopic
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.Beta.PowerShell.Models.IPaths1T8Q21HTeamworkMicrosoftGraphSendactivitynotificationtorecipientsPostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

System.Boolean

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

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ActivityType <String>]:
  • [ChainId <Int64?>]:
  • [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
  • [Recipients <IMicrosoftGraphTeamworkNotificationRecipient- []>]:
  • [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.

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.