Remove-MgBetaCommunicationCall
Delete or hang up an active call. For group calls, this will only delete your call leg and the underlying group call will still continue.
Note
To view the v1.0 release of this cmdlet, view Remove-MgCommunicationCall
Syntax
Remove-MgBetaCommunicationCall
-CallId <String>
[-IfMatch <String>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-MgBetaCommunicationCall
-InputObject <ICloudCommunicationsIdentity>
[-IfMatch <String>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Delete or hang up an active call. For group calls, this will only delete your call leg and the underlying group call will still continue.
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.CloudCommunications
Remove-MgBetaCommunicationCall -CallId $callId
This example shows how to use the Remove-MgBetaCommunicationCall Cmdlet.
To learn about permissions for this resource, see the permissions reference.
Parameters
-CallId
The unique identifier of call
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: | ICloudCommunicationsIdentity |
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.ICloudCommunicationsIdentity
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 <ICloudCommunicationsIdentity>
: Identity Parameter
[AttendanceRecordId <String>]
: The unique identifier of attendanceRecord[AudioRoutingGroupId <String>]
: The unique identifier of audioRoutingGroup[CallId <String>]
: The unique identifier of call[CallRecordId <String>]
: The unique identifier of callRecord[CallRecordingId <String>]
: The unique identifier of callRecording[CallTranscriptId <String>]
: The unique identifier of callTranscript[CommsOperationId <String>]
: The unique identifier of commsOperation[ContentSharingSessionId <String>]
: The unique identifier of contentSharingSession[FromDateTime <DateTime?>]
: Usage: fromDateTime={fromDateTime}[JoinWebUrl <String>]
: Alternate key of onlineMeeting[MeetingAttendanceReportId <String>]
: The unique identifier of meetingAttendanceReport[MeetingRegistrantBaseId <String>]
: The unique identifier of meetingRegistrantBase[MeetingRegistrationQuestionId <String>]
: The unique identifier of meetingRegistrationQuestion[OnlineMeetingId <String>]
: The unique identifier of onlineMeeting[ParticipantId <String>]
: The unique identifier of participant[PresenceId <String>]
: The unique identifier of presence[SessionId <String>]
: The unique identifier of session[ToDateTime <DateTime?>]
: Usage: toDateTime={toDateTime}[UserId <String>]
: The unique identifier of user