Invoke-MgArchiveTeamChannel
Archive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. A channel without an owner or that belongs to a group that has no owner, can't be archived. To restore a channel from its archived state, use the channel: unarchive method. A channel can't be archived or unarchived if its team is archived.
Note
To view the beta release of this cmdlet, view Invoke-MgBetaArchiveTeamChannel
Syntax
Invoke-MgArchiveTeamChannel
-ChannelId <String>
-TeamId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ShouldSetSpoSiteReadOnlyForMembers]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-MgArchiveTeamChannel
-ChannelId <String>
-TeamId <String>
-BodyParameter <IPaths1R5Aj03TeamsTeamIdChannelsChannelIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-MgArchiveTeamChannel
-InputObject <ITeamsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ShouldSetSpoSiteReadOnlyForMembers]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-MgArchiveTeamChannel
-InputObject <ITeamsIdentity>
-BodyParameter <IPaths1R5Aj03TeamsTeamIdChannelsChannelIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Archive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. A channel without an owner or that belongs to a group that has no owner, can't be archived. To restore a channel from its archived state, use the channel: unarchive method. A channel can't be archived or unarchived if its team is archived.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | ChannelSettings.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | ChannelSettings.ReadWrite.All | Not available. |
Examples
Example 1: Archive a channel
Import-Module Microsoft.Graph.Teams
Invoke-MgArchiveTeamChannel -TeamId $teamId -ChannelId $channelId
This example will archive a channel
Example 2: Archive a channel when the team is archived
Import-Module Microsoft.Graph.Teams
Invoke-MgArchiveTeamChannel -TeamId $teamId -ChannelId $channelId
This example will archive a channel when the team is archived
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: | IPaths1R5Aj03TeamsTeamIdChannelsChannelIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ChannelId
The unique identifier of channel
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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 |
-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.PowerShell.Models.IPaths1R5Aj03TeamsTeamIdChannelsChannelIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema
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 <IPaths1R5Aj03TeamsTeamIdChannelsChannelIdMicrosoftGraphArchivePostRequestbodyContentApplicationJsonSchema>
: .
[(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[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[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