Remove-CsTeamsShiftsScheduleRecord

Reference

Module:: MicrosoftTeamsPowerShell

This cmdlet enqueues the clear schedule message.

Syntax

Remove-CsTeamsShiftsScheduleRecord
      [-ClearSchedulingGroup]
      -EntityType <String[]>
      -TeamId <String>
      [-DateRangeEndDate <DateTime>]
      [-DateRangeStartDate <DateTime>]
      [-DesignatedActorId <String>]
      [-TimeZone <String>]
      [-Break]
      [-HttpPipelineAppend <SendAsyncStep[]>]
      [-HttpPipelinePrepend <SendAsyncStep[]>]
      [-PassThru]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CsTeamsShiftsScheduleRecord
      -Body <IClearScheduleRequest>
      [-Break]
      [-HttpPipelineAppend <SendAsyncStep[]>]
      [-HttpPipelinePrepend <SendAsyncStep[]>]
      [-PassThru]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

This cmdlet sends a request of removing Shifts schedule with specified time range.

Examples

Example 1

PS C:\> Remove-CsTeamsShiftsScheduleRecord -TeamId "eddc3b94-21d5-4ef0-a76a-2e4d632e50be" -DateRangeStartDate "2021-09-30T00:00:00" -DateRangeEndDate "2021-10-01T00:00:00" -ClearSchedulingGroup:$false -EntityType "swapRequest", "openShiftRequest" -DesignatedActorId "683af6f2-4f72-4770-b8e1-4ec31836156ad"

Removes the Shifts schedule record of swapRequest and openShiftRequest scenarios in the team with ID eddc3b94-21d5-4ef0-a76a-2e4d632e50be from 09/30/2021 to 10/01/2021.

Parameters

-Body

The request body.

Type:	IClearScheduleRequest
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Break

Wait for .NET debugger to attach.

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

-ClearSchedulingGroup

A value indicating whether to clear schedule group.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-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

-DateRangeEndDate

The end date of removing schedule record.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-DateRangeStartDate

The start date of removing schedule record.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-DesignatedActorId

The user ID of designated actor.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-EntityType

The entity types.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Type:	SendAsyncStep[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Type:	SendAsyncStep[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Used to return an object that represents the item being modified.

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

-Proxy

The URI for the proxy server to use

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

-ProxyCredential

Credentials for a proxy server to use for the remote call.

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

-ProxyUseDefaultCredentials

Use the default credentials for the proxy.

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

-TeamId

The Teams team ID where you want to remove schedule record.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-TimeZone

The Timezone parameter ensures that the shifts are displayed in the correct time zone based on your team’s location.

Type:	String
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

Notes

The parameters of start time, end time and designated actor ID are optional only when removing the schedule record of a linked team.

Share via