Share via

Copy-MgTeam

Module:
Microsoft.Graph.Teams Module

Create a copy of a team. This operation also creates a copy of the corresponding group.You can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation. After the POST clone returns, you need to GET the operation returned by the Location: header to see if it's running, succeeded, or failed. You should continue to GET until the status isn't running. The recommended delay between GETs is 5 seconds.

Note

To view the beta release of this cmdlet, view Copy-MgBetaTeam

Syntax

CloneExpanded (Default) 

Copy-MgTeam
    -TeamId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-Classification <String>]
    [-Description <String>]
    [-DisplayName <String>]
    [-MailNickname <String>]
    [-PartsToClone <String>]
    [-Visibility <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Clone 

Copy-MgTeam
    -TeamId <String>
    -BodyParameter <IPaths1Izic0UTeamsTeamIdMicrosoftGraphClonePostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CloneViaIdentityExpanded 

Copy-MgTeam
    -InputObject <ITeamsIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-Classification <String>]
    [-Description <String>]
    [-DisplayName <String>]
    [-MailNickname <String>]
    [-PartsToClone <String>]
    [-Visibility <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CloneViaIdentity 

Copy-MgTeam
    -InputObject <ITeamsIdentity>
    -BodyParameter <IPaths1Izic0UTeamsTeamIdMicrosoftGraphClonePostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a copy of a team. This operation also creates a copy of the corresponding group.You can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation. After the POST clone returns, you need to GET the operation returned by the Location: header to see if it's running, succeeded, or failed. You should continue to GET until the status isn't running. The recommended delay between GETs is 5 seconds.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Teams

$params = @{
	displayName = "Library Assist"
	description = "Self help community for library"
	mailNickname = "libassist"
	partsToClone = "apps,tabs,settings,channels,members"
	visibility = "public"
}

Copy-MgTeam -TeamId $teamId -BodyParameter $params

This example shows how to use the Copy-MgTeam Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CloneExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CloneViaIdentityExpanded
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:IPaths1Izic0UTeamsTeamIdMicrosoftGraphClonePostRequestbodyContentApplicationJsonSchema
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-Classification

Create a copy of a team. This operation also creates a copy of the corresponding group.You can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation. After the POST clone returns, you need to GET the operation returned by the Location: header to see if it's running, succeeded, or failed. You should continue to GET until the status isn't running. The recommended delay between GETs is 5 seconds.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CloneExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CloneViaIdentityExpanded
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:SwitchParameter
Default value:None
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

-Description

Create a copy of a team. This operation also creates a copy of the corresponding group.You can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation. After the POST clone returns, you need to GET the operation returned by the Location: header to see if it's running, succeeded, or failed. You should continue to GET until the status isn't running. The recommended delay between GETs is 5 seconds.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-DisplayName

Create a copy of a team. This operation also creates a copy of the corresponding group.You can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation. After the POST clone returns, you need to GET the operation returned by the Location: header to see if it's running, succeeded, or failed. You should continue to GET until the status isn't running. The recommended delay between GETs is 5 seconds.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CloneExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CloneViaIdentityExpanded
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:IDictionary
Default value:None
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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:ITeamsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-MailNickname

Create a copy of a team. This operation also creates a copy of the corresponding group.You can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation. After the POST clone returns, you need to GET the operation returned by the Location: header to see if it's running, succeeded, or failed. You should continue to GET until the status isn't running. The recommended delay between GETs is 5 seconds.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application Team.Create, Group.ReadWrite.All, Directory.ReadWrite.All,

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-PartsToClone

clonableTeamParts

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-PassThru

Returns true when the command succeeds

Parameter properties

Type: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:String
Default value:None
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:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-Visibility

teamVisibilityType

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
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.PowerShell.Models.IPaths1Izic0UTeamsTeamIdMicrosoftGraphClonePostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.PowerShell.Models.ITeamsIdentity

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

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Classification <String>]:
  • [Description <String>]:
  • [DisplayName <String>]:
  • [MailNickname <String>]:
  • [PartsToClone <String>]: clonableTeamParts
  • [Visibility <String>]: teamVisibilityType

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