|
| 1 | +--- |
| 2 | +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml |
| 3 | +Module Name: MicrosoftTeams |
| 4 | +online version: https://docs.microsoft.com/powershell/module/teams/new-teamsshiftspolicy |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# New-CsTeamsShiftsPolicy |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | + |
| 12 | +This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. |
| 13 | + |
| 14 | +## SYNTAX |
| 15 | + |
| 16 | +``` |
| 17 | +New-CsTeamsShiftsPolicy [-Identity] <XdsIdentity> [-EnableShiftPresence <Boolean>] |
| 18 | + [-ShiftNoticeFrequency <String>] [-ShiftNoticeMessageType <String>] [-ShiftNoticeMessageCustom <String>] |
| 19 | + [-AccessType <String>] [-AccessGracePeriodMinutes <Int64>] [<CommonParameters>] |
| 20 | +``` |
| 21 | + |
| 22 | +## DESCRIPTION |
| 23 | +This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). |
| 24 | + |
| 25 | + |
| 26 | +## EXAMPLES |
| 27 | + |
| 28 | +### Example 1 |
| 29 | +```powershell |
| 30 | +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always |
| 31 | +``` |
| 32 | + |
| 33 | +Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the default values to its settings. |
| 34 | + |
| 35 | +### Example 2 |
| 36 | +```powershell |
| 37 | +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -EnableShiftPresence $true -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 |
| 38 | +``` |
| 39 | + |
| 40 | +Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. |
| 41 | + |
| 42 | +## PARAMETERS |
| 43 | + |
| 44 | +### -Identity |
| 45 | +Policy instance name. |
| 46 | + |
| 47 | +```yaml |
| 48 | +Type: XdsIdentity |
| 49 | +Parameter Sets: (All) |
| 50 | +Aliases: |
| 51 | +Applicable: Microsoft Teams |
| 52 | +Required: True |
| 53 | +Position: 1 |
| 54 | +Default value: None |
| 55 | +Accept pipeline input: False |
| 56 | +Accept wildcard characters: False |
| 57 | +``` |
| 58 | +
|
| 59 | +### -AccessType |
| 60 | +Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. |
| 61 | +Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. |
| 62 | +For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. |
| 63 | +
|
| 64 | +
|
| 65 | +```yaml |
| 66 | +Type: String |
| 67 | +Parameter Sets: (All) |
| 68 | +Aliases: |
| 69 | +Applicable: Microsoft Teams |
| 70 | +Required: False |
| 71 | +Position: Named |
| 72 | +Default value: UnrestrictedAccess_TeamsApp |
| 73 | +Accept pipeline input: False |
| 74 | +Accept wildcard characters: False |
| 75 | +``` |
| 76 | +
|
| 77 | +### -EnableShiftPresence |
| 78 | +Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. |
| 79 | +
|
| 80 | +```yaml |
| 81 | +Type: Boolean |
| 82 | +Parameter Sets: (All) |
| 83 | +Aliases: |
| 84 | +Applicable: Microsoft Teams |
| 85 | +Required: False |
| 86 | +Position: Named |
| 87 | +Default value: False |
| 88 | +Accept pipeline input: False |
| 89 | +Accept wildcard characters: False |
| 90 | +``` |
| 91 | +
|
| 92 | +### -ShiftNoticeFrequency |
| 93 | +Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. |
| 94 | +
|
| 95 | +```yaml |
| 96 | +Type: String |
| 97 | +Parameter Sets: (All) |
| 98 | +Aliases: |
| 99 | +Applicable: Microsoft Teams |
| 100 | +Required: False |
| 101 | +Position: Named |
| 102 | +Default value: None |
| 103 | +Accept pipeline input: False |
| 104 | +Accept wildcard characters: False |
| 105 | +``` |
| 106 | +
|
| 107 | +### -ShiftNoticeMessageType |
| 108 | +The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. |
| 109 | +'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. |
| 110 | +'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. |
| 111 | +'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. |
| 112 | +'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. |
| 113 | +'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. |
| 114 | +'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer’s timekeeping system. |
| 115 | +'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. |
| 116 | +'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. |
| 117 | +'CustomMessage' |
| 118 | +
|
| 119 | +
|
| 120 | +```yaml |
| 121 | +Type: String |
| 122 | +Parameter Sets: (All) |
| 123 | +Aliases: |
| 124 | +Applicable: Microsoft Teams |
| 125 | +Required: False |
| 126 | +Position: Named |
| 127 | +Default value: DefaultMessage |
| 128 | +Accept pipeline input: False |
| 129 | +Accept wildcard characters: False |
| 130 | +``` |
| 131 | +
|
| 132 | +### -ShiftNoticeMessageCustom |
| 133 | +Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. |
| 134 | +
|
| 135 | +```yaml |
| 136 | +Type: String |
| 137 | +Parameter Sets: (All) |
| 138 | +Aliases: |
| 139 | +Applicable: Microsoft Teams |
| 140 | +Required: False |
| 141 | +Position: Named |
| 142 | +Default value: None |
| 143 | +Accept pipeline input: False |
| 144 | +Accept wildcard characters: False |
| 145 | +``` |
| 146 | +
|
| 147 | +### -AccessGracePeriodMinutes |
| 148 | +Indicates the grace period time in minutes between when the first shift starts or last shift ends and when access is blocked. |
| 149 | +
|
| 150 | +```yaml |
| 151 | +Type: Int64 |
| 152 | +Parameter Sets: (All) |
| 153 | +Aliases: |
| 154 | +Applicable: Microsoft Teams |
| 155 | +Required: False |
| 156 | +Position: Named |
| 157 | +Default value: None |
| 158 | +Accept pipeline input: False |
| 159 | +Accept wildcard characters: False |
| 160 | +``` |
| 161 | +
|
| 162 | +### CommonParameters |
| 163 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). |
| 164 | +
|
| 165 | +
|
| 166 | +## INPUTS |
| 167 | +
|
| 168 | +### None |
| 169 | +
|
| 170 | +## OUTPUTS |
| 171 | +
|
| 172 | +### System.Object |
| 173 | +## NOTES |
| 174 | +
|
| 175 | +## RELATED LINKS |
| 176 | +
|
| 177 | +[Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) |
| 178 | +
|
| 179 | +[Set-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) |
| 180 | +
|
| 181 | +[Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) |
| 182 | +
|
| 183 | +[Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) |
0 commit comments