Start-MgBetaChatMigration

Module:

Microsoft.Graph.Beta.Teams Module

Start the migration of external messages by enabling migration mode in an existing chat. Import operations were limited to newly created standard channels that were in an empty state. For more information, see Import third-party platform messages to Teams using Microsoft Graph. You can define a minimum timestamp for content migration that enables the import of messages from the past. The specified timestamp must be earlier than the current createdDateTime of the chat. Imported content is always limited by the createdDateTime of the target thread. An optional createdDateTime property in the payload allows you to update this value, but with strict rules: This API supportes the following channel types.

Note

To view the v1.0 release of this cmdlet, view Start-MgChatMigration

Syntax

StartExpanded (Default)

Start-MgBetaChatMigration
    -ChatId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ConversationCreationDateTime <datetime>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Start

Start-MgBetaChatMigration
    -ChatId <string>
    -BodyParameter <IPathsKxnvx4ChatsChatIdMicrosoftGraphStartmigrationPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

StartViaIdentityExpanded

Start-MgBetaChatMigration
    -InputObject <ITeamsIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ConversationCreationDateTime <datetime>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

StartViaIdentity

Start-MgBetaChatMigration
    -InputObject <ITeamsIdentity>
    -BodyParameter <IPathsKxnvx4ChatsChatIdMicrosoftGraphStartmigrationPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Start the migration of external messages by enabling migration mode in an existing chat. Import operations were limited to newly created standard channels that were in an empty state. For more information, see Import third-party platform messages to Teams using Microsoft Graph. You can define a minimum timestamp for content migration that enables the import of messages from the past. The specified timestamp must be earlier than the current createdDateTime of the chat. Imported content is always limited by the createdDateTime of the target thread. An optional createdDateTime property in the payload allows you to update this value, but with strict rules: This API supportes the following channel types.

Examples

Example 1: Start the migration in a chat

Import-Module Microsoft.Graph.Beta.Teams

Start-MgBetaChatMigration -ChatId $chatId

This example will start the migration in a chat

Example 2: Start the migration when a chat is already in migration mode

Import-Module Microsoft.Graph.Beta.Teams

Start-MgBetaChatMigration -ChatId $chatId

This example will start the migration when a chat is already in migration mode

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

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

Parameter sets

StartViaIdentityExpanded

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

StartExpanded

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.

Parameter properties

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

Parameter sets

StartViaIdentity

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

Start

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

StartExpanded

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

Start

Position:	Named
Mandatory:	True
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

-ConversationCreationDateTime

Start the migration of external messages by enabling migration mode in an existing chat. Import operations were limited to newly created standard channels that were in an empty state. For more information, see Import third-party platform messages to Teams using Microsoft Graph. You can define a minimum timestamp for content migration that enables the import of messages from the past. The specified timestamp must be earlier than the current createdDateTime of the chat. Imported content is always limited by the createdDateTime of the target thread. An optional createdDateTime property in the payload allows you to update this value, but with strict rules: This API supportes the following channel types.

Parameter properties

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

Parameter sets

StartViaIdentityExpanded

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

StartExpanded

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

StartViaIdentityExpanded

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

StartViaIdentity

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

-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

-WhatIf

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.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IPathsKxnvx4ChatsChatIdMicrosoftGraphStartmigrationPostRequestbodyContentApplicationJsonSchema

{{ Fill in the Description }}

Microsoft.Graph.Beta.PowerShell.Models.ITeamsIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

System.Boolean

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

BODYPARAMETER <IPathsKxnvx4ChatsChatIdMicrosoftGraphStartmigrationPostRequestbodyContentApplicationJsonSchema>: . [(Any) <Object>]: This indicates any property can be added to this object. [ConversationCreationDateTime <DateTime?>]:

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 [PlannerGoalId <String>]: The unique identifier of plannerGoal [PlannerHistoryItemId <String>]: The unique identifier of plannerHistoryItem [PlannerPlanId <String>]: The unique identifier of plannerPlan [PlannerTaskChatMessageId <String>]: The unique identifier of plannerTaskChatMessage [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 [TargetedChatMessageId <String>]: The unique identifier of targetedChatMessage [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 [TeamworkCustomEmojiDisplayName <String>]: The unique identifier of teamworkCustomEmoji [TeamworkDeviceId <String>]: The unique identifier of teamworkDevice [TeamworkDeviceOperationId <String>]: The unique identifier of teamworkDeviceOperation [TeamworkSectionId <String>]: The unique identifier of teamworkSection [TeamworkSectionItemId <String>]: The unique identifier of teamworkSectionItem [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

• Start-MgBetaChatMigration
• Graph API Reference