Remove-MgBetaChat
Soft-delete a chat. When invoked with delegated permissions, this operation only works for tenant admins and Teams service admins.
Note
To view the v1.0 release of this cmdlet, view Remove-MgChat
Syntax
Remove-MgBetaChat
-ChatId <String>
[-IfMatch <String>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-MgBetaChat
-InputObject <ITeamsIdentity>
[-IfMatch <String>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Soft-delete a chat. When invoked with delegated permissions, this operation only works for tenant admins and Teams service admins.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Chat.ManageDeletion.All | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Chat.ManageDeletion.Chat | Chat.ManageDeletion.All |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Teams
Remove-MgBetaChat -ChatId $chatIdThis example shows how to use the Remove-MgBetaChat Cmdlet.
Parameters
-ChatId
The unique identifier of chat
| 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 |
-IfMatch
ETag
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-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.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.
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