Skip to content

Commit 880cb61

Browse files
committed
Add content to New-CsOnlineSchedule and New-CsOnlineTimeRange.
1 parent 9124699 commit 880cb61

File tree

2 files changed

+83
-15
lines changed

2 files changed

+83
-15
lines changed

skype/skype-ps/skype/New-CsOnlineSchedule.md

Lines changed: 52 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-CsOnlineSchedule
99

1010
## SYNOPSIS
11-
Provide the topic introduction here.
11+
Use the New-CsOnlineSchedule cmdlet to create a new schedule.
1212

1313
## SYNTAX
1414

@@ -21,31 +21,49 @@ New-CsOnlineSchedule [-Name <Object>] [-WeeklyRecurrentSchedule] [-BypassDualWri
2121
```
2222

2323
## DESCRIPTION
24-
Provide the detailed description here.
24+
The New-CsOnlineSchedule cmdlet creates a new schedule for the Organizational Auto Attendant (OAA) service. The OAA service uses schedules to conditionally execute call flows when a specific schedule is in effect.
25+
26+
Note:
27+
The type of the schedule cannot be altered after the schedule is created.
28+
For a weekly recurrent schedule, at least one day should have time ranges specified.
29+
You can create a new time range by using New-CsOnlineTimeRange cmdlet.
30+
The return type of this cmdlet composes a member for the underlying type/implementation. For example, in case of the weekly recurrent schedule, you can modify Monday’s time ranges through the Schedule.WeeklyRecurrentSchedule.MondayHours property.
31+
2532

2633
## EXAMPLES
2734

2835
### -------------------------- Example 1 --------------------------
2936
```
30-
31-
Insert example commands for example 1.
37+
$tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00
38+
$tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00
39+
$businessHours = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr1, $tr2) -TuesdayHours @($tr1, $tr2) -WednesdayHours @($tr1, $tr2) -ThursdayHours @($tr1, $tr2) -FridayHours @($tr1, $tr2)
3240
```
3341

34-
Insert descriptive text for example 1.
42+
This example creates a schedule that sets business hours (Monday- Friday, 9am-12pm and 1pm-5pm).
43+
44+
### -------------------------- Example 2 --------------------------
45+
```
46+
$tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00
47+
$tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00
48+
$afterHours = New-CsOnlineSchedule -Name " After Hours" -WeeklyRecurrentSchedule -MondayHours @($tr1, $tr2) -TuesdayHours @($tr1, $tr2) -WednesdayHours @($tr1, $tr2) -ThursdayHours @($tr1, $tr2) -FridayHours @($tr1, $tr2) -Complement
49+
```
3550

51+
This example creates an after-hours schedule that is active at all times except Monday- Friday, 9am-12pm and 1pm-5pm.
3652

3753
## PARAMETERS
3854

3955
### -Name
4056
PARAMVALUE: String
4157

58+
The Name parameter is the friendly name for the schedule.
59+
4260
```yaml
4361
Type: Object
4462
Parameter Sets: (All)
4563
Aliases:
4664
Applicable: Skype for Business Online
4765

48-
Required: False
66+
Required: True
4967
Position: Named
5068
Default value: None
5169
Accept pipeline input: False
@@ -55,13 +73,15 @@ Accept wildcard characters: False
5573
### -WeeklyRecurrentSchedule
5674
PARAMVALUE: SwitchParameter
5775
76+
The WeeklyRecurrentSchedule parameter indicates that a weekly recurrent schedule is to be created.
77+
5878
```yaml
5979
Type: SwitchParameter
6080
Parameter Sets: (All)
6181
Aliases:
6282
Applicable: Skype for Business Online
6383

64-
Required: False
84+
Required: True
6585
Position: Named
6686
Default value: None
6787
Accept pipeline input: False
@@ -87,6 +107,10 @@ Accept wildcard characters: False
87107
### -Complement
88108
PARAMVALUE: SwitchParameter
89109
110+
The Complement parameter indicates how the schedule is used.
111+
When Complement is enabled, the schedule is used as the inverse of the provided configuration.
112+
For example, if Complement is enabled and the schedule only contains time ranges of Monday to Friday from 9am to 5pm, then the schedule is active at all times other than the specified time ranges.
113+
90114
```yaml
91115
Type: SwitchParameter
92116
Parameter Sets: (All)
@@ -135,6 +159,8 @@ Accept wildcard characters: False
135159
### -FridayHours
136160
PARAMVALUE: List
137161
162+
List of time ranges for that day.
163+
138164
```yaml
139165
Type: Object
140166
Parameter Sets: (All)
@@ -151,6 +177,8 @@ Accept wildcard characters: False
151177
### -MondayHours
152178
PARAMVALUE: List
153179
180+
List of time ranges for that day.
181+
154182
```yaml
155183
Type: Object
156184
Parameter Sets: (All)
@@ -167,6 +195,8 @@ Accept wildcard characters: False
167195
### -SaturdayHours
168196
PARAMVALUE: List
169197
198+
List of time ranges for that day.
199+
170200
```yaml
171201
Type: Object
172202
Parameter Sets: (All)
@@ -183,6 +213,8 @@ Accept wildcard characters: False
183213
### -SundayHours
184214
PARAMVALUE: List
185215
216+
List of time ranges for that day.
217+
186218
```yaml
187219
Type: Object
188220
Parameter Sets: (All)
@@ -215,6 +247,8 @@ Accept wildcard characters: False
215247
### -ThursdayHours
216248
PARAMVALUE: List
217249
250+
List of time ranges for that day.
251+
218252
```yaml
219253
Type: Object
220254
Parameter Sets: (All)
@@ -231,6 +265,8 @@ Accept wildcard characters: False
231265
### -TuesdayHours
232266
PARAMVALUE: List
233267
268+
List of time ranges for that day.
269+
234270
```yaml
235271
Type: Object
236272
Parameter Sets: (All)
@@ -247,6 +283,8 @@ Accept wildcard characters: False
247283
### -WednesdayHours
248284
PARAMVALUE: List
249285
286+
List of time ranges for that day.
287+
250288
```yaml
251289
Type: Object
252290
Parameter Sets: (All)
@@ -301,7 +339,7 @@ Parameter Sets: (All)
301339
Aliases:
302340
Applicable: Skype for Business Online
303341

304-
Required: False
342+
Required: True
305343
Position: Named
306344
Default value: None
307345
Accept pipeline input: False
@@ -313,8 +351,14 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl
313351

314352
## INPUTS
315353

354+
### None
355+
356+
316357
## OUTPUTS
317358

359+
### Microsoft.Rtc.Management.Hosted.Online.Models.Schedule
360+
361+
318362
## NOTES
319363

320364
## RELATED LINKS

skype/skype-ps/skype/New-CsOnlineTimeRange.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-CsOnlineTimeRange
99

1010
## SYNOPSIS
11-
Provide the topic introduction here.
11+
The New-CsOnlineTimeRange cmdlet creates a new time range.
1212

1313
## SYNTAX
1414

@@ -18,31 +18,47 @@ New-CsOnlineTimeRange [-End <Object>] [-Start <Object>] [-BypassDualWrite <Objec
1818
```
1919

2020
## DESCRIPTION
21-
Provide the detailed description here.
21+
The New-CsOnlineTimeRange cmdlet creates a new time range to be used with the Organizational Auto Attendant (OAA) service. Time ranges are used to form schedules.
22+
23+
Note: The start and end bounds of the time range must obey the relation start < end.
24+
A time range can only be formed of minute/hour increments.
25+
A time range can span from one minute to 24 hours.
26+
27+
2228

2329
## EXAMPLES
2430

25-
### -------------------------- Example 1 -------------------------- (Skype for Business Online)
31+
### -------------------------- Example 1 --------------------------
32+
```
33+
34+
$workdayTimeRange = New-CsOnlineTimeRange -Start 09:00 -End 17:00
35+
2636
```
2737

28-
Insert example commands for example 1.
38+
This example creates a time range for a 9am to 5pm work day.
39+
40+
### -------------------------- Example 2 --------------------------
41+
```
42+
$allDayTimeRange = New-CsOnlineTimeRange -Start 00:00 -End 1.00:00
2943
```
3044

31-
Insert descriptive text for example 1.
45+
This example creates a 24-hour time range.
3246

3347

3448
## PARAMETERS
3549

3650
### -End
3751
PARAMVALUE: TimeSpan
3852

53+
The End parameter represents the end bound of the time range.
54+
3955
```yaml
4056
Type: Object
4157
Parameter Sets: (All)
4258
Aliases:
4359
Applicable: Skype for Business Online
4460

45-
Required: False
61+
Required: True
4662
Position: Named
4763
Default value: None
4864
Accept pipeline input: False
@@ -52,13 +68,15 @@ Accept wildcard characters: False
5268
### -Start
5369
PARAMVALUE: TimeSpan
5470
71+
The Start parameter represents the start bound of the time range.
72+
5573
```yaml
5674
Type: Object
5775
Parameter Sets: (All)
5876
Aliases:
5977
Applicable: Skype for Business Online
6078

61-
Required: False
79+
Required: True
6280
Position: Named
6381
Default value: None
6482
Accept pipeline input: False
@@ -150,8 +168,14 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl
150168

151169
## INPUTS
152170

171+
### None
172+
173+
153174
## OUTPUTS
154175

176+
### Microsoft.Rtc.Management.Hosted.Online.Models.TimeRange
177+
178+
155179
## NOTES
156180

157181
## RELATED LINKS

0 commit comments

Comments
 (0)