Invoke-MgBetaArchiveTeam

Module:

Microsoft.Graph.Beta.Teams

Archive the specified team. When a team is archived, users can no longer make most changes to the team. For example, users can no longer: send or like messages on any channel in the team; edit the team's name or description; nor edit other settings. However, membership changes to the team continue to be allowed. Archiving is an async operation. A team is archived once the async operation completes successfully, which can occur subsequent to a response from this API. To archive a team, the team and group must have an owner. To restore a team from its archived state, use the API to unarchive.

Note

To view the v1.0 release of this cmdlet, view Invoke-MgArchiveTeam

Syntax

Invoke-MgBetaArchiveTeam
      -TeamId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ShouldSetSpoSiteReadOnlyForMembers]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaArchiveTeam
      -TeamId <String>
      -BodyParameter <IPathsBezc4TeamsTeamIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaArchiveTeam
      -InputObject <ITeamsIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ShouldSetSpoSiteReadOnlyForMembers]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaArchiveTeam
      -InputObject <ITeamsIdentity>
      -BodyParameter <IPathsBezc4TeamsTeamIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Archive the specified team. When a team is archived, users can no longer make most changes to the team. For example, users can no longer: send or like messages on any channel in the team; edit the team's name or description; nor edit other settings. However, membership changes to the team continue to be allowed. Archiving is an async operation. A team is archived once the async operation completes successfully, which can occur subsequent to a response from this API. To archive a team, the team and group must have an owner. To restore a team from its archived state, use the API to unarchive.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Teams

Invoke-MgBetaArchiveTeam -TeamId $teamId

This example shows how to use the Invoke-MgBetaArchiveTeam Cmdlet.

Parameters

-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:	IPathsBezc4TeamsTeamIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-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

-PassThru

Returns true when the command succeeds

Type:	SwitchParameter
Position:	Named
Default value:	False
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

-ShouldSetSpoSiteReadOnlyForMembers

.

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

-TeamId

The unique identifier of team

Type:	String
Position:	Named
Default value:	None
Required:	True
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.IPathsBezc4TeamsTeamIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.Beta.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 <IPathsBezc4TeamsTeamIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [ShouldSetSpoSiteReadOnlyForMembers <Boolean?>]:

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
• [ShiftsRoleDefinitionId <String>]: The unique identifier of shiftsRoleDefinition
• [SwapShiftsChangeRequestId <String>]: The unique identifier of swapShiftsChangeRequest
• [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
• [TeamworkDeviceId <String>]: The unique identifier of teamworkDevice
• [TeamworkDeviceOperationId <String>]: The unique identifier of teamworkDeviceOperation
• [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

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.teams/invoke-mgbetaarchiveteam
• https://learn.microsoft.com/graph/api/team-archive?view=graph-rest-1.0