Skip to content

Commit e09f1e8

Browse files
kenwithkenwith
committed
Initial drafts of staffhub cmdlet reference content.
1 parent c9d9d9f commit e09f1e8

11 files changed

+1037
-6
lines changed

‎staffhub/staffhub-ps/staffhub/Add-StaffHubMember.md

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml
3+
Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Add-StaffHubMember
9+
10+
## SYNOPSIS
11+
Note: This cmdlet currently is in Beta.
12+
Adds a member or manager to the specified team
13+
14+
## SYNTAX
15+
16+
```
17+
Add-StaffHubMember [-TeamId] <String> [-FirstName] <String> [-LastName] <String> [[-Email] <String>]
18+
[[-PhoneNumber] <String>] [-IsManager] <Boolean>
19+
```
20+
21+
## DESCRIPTION
22+
Adds a member or manager to the specified team
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
```
28+
Add-StaffHubMember -TeamId "TEAM_1234" -FirstName "Abc" -LastName "123" -Email "[email protected]" -IsManager $false
29+
```
30+
31+
Adds the member with specified email/PhoneNumber to the team. Either PhoneNumber/Email is mandatory
32+
33+
## PARAMETERS
34+
35+
### -Email
36+
Office 365 email of the member to be added
37+
38+
```yaml
39+
Type: String
40+
Parameter Sets: (All)
41+
Aliases:
42+
43+
Required: False
44+
Position: 3
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
50+
### -FirstName
51+
First name of the member to be added
52+
53+
```yaml
54+
Type: String
55+
Parameter Sets: (All)
56+
Aliases:
57+
58+
Required: True
59+
Position: 1
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -IsManager
66+
Should the person be added as a manager.
67+
68+
```yaml
69+
Type: Boolean
70+
Parameter Sets: (All)
71+
Aliases:
72+
73+
Required: True
74+
Position: 5
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### -LastName
81+
Last name of the member to be added
82+
83+
```yaml
84+
Type: String
85+
Parameter Sets: (All)
86+
Aliases:
87+
88+
Required: True
89+
Position: 2
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### -PhoneNumber
96+
Phone number of the member to be added
97+
98+
```yaml
99+
Type: String
100+
Parameter Sets: (All)
101+
Aliases:
102+
103+
Required: False
104+
Position: 4
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### -TeamId
111+
ID of the team to which the member is to be added
112+
113+
```yaml
114+
Type: String
115+
Parameter Sets: (All)
116+
Aliases:
117+
118+
Required: True
119+
Position: 0
120+
Default value: None
121+
Accept pipeline input: False
122+
Accept wildcard characters: False
123+
```
124+
125+
## INPUTS
126+
127+
### None
128+
129+
130+
## OUTPUTS
131+
132+
### System.Object
133+
134+
## NOTES
135+
136+
## RELATED LINKS
137+

‎staffhub/staffhub-ps/staffhub/Add-StaffHubShift.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
---
2+
external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml
3+
Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Add-StaffHubShift
9+
10+
## SYNOPSIS
11+
Note: This cmdlet is currently in Beta.
12+
Adds a shift to the specified member in a team.
13+
14+
## SYNTAX
15+
16+
```
17+
Add-StaffHubShift [-Title] <String> [[-Notes] <String>] [-StartDateTime] <DateTime> [-EndDateTime] <DateTime>
18+
[-ShiftType] <String> [-MemberId] <String> [-TeamId] <String>
19+
```
20+
21+
## DESCRIPTION
22+
Adds a shift to the specified member in a team
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
```
28+
$startTime = Get-Date -Date "2018-01-01T00:10:00"
29+
$endTime = Get-Date -Date "2018-01-01T04:10:00"
30+
Add-StaffHubShift -Title "Title" -StartDateTime $startTime -EndDateTime $endTime -ShiftType Working -MemberId "MBER_1234" -TeamId "TEAM_1234"
31+
```
32+
33+
Creates a shift for member MBER_1234 under the team TEAM_1234
34+
35+
## PARAMETERS
36+
37+
### -EndDateTime
38+
End time of the shift
39+
40+
```yaml
41+
Type: DateTime
42+
Parameter Sets: (All)
43+
Aliases:
44+
45+
Required: True
46+
Position: 5
47+
Default value: None
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
52+
### -MemberId
53+
Member to which the shift is to be added
54+
55+
```yaml
56+
Type: String
57+
Parameter Sets: (All)
58+
Aliases:
59+
60+
Required: True
61+
Position: 1
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -Notes
68+
Additional notes for the shift
69+
70+
```yaml
71+
Type: String
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: 3
77+
Default value: None
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
### -ShiftType
83+
ShiftType - Working/Absence
84+
85+
```yaml
86+
Type: String
87+
Parameter Sets: (All)
88+
Aliases:
89+
Accepted values: Working, Absence
90+
91+
Required: True
92+
Position: 6
93+
Default value: None
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
```
97+
98+
### -StartDateTime
99+
Start time of the shift
100+
101+
```yaml
102+
Type: DateTime
103+
Parameter Sets: (All)
104+
Aliases:
105+
106+
Required: True
107+
Position: 4
108+
Default value: None
109+
Accept pipeline input: False
110+
Accept wildcard characters: False
111+
```
112+
113+
### -TeamId
114+
ID of the team to which the shift is to be added
115+
116+
```yaml
117+
Type: String
118+
Parameter Sets: (All)
119+
Aliases:
120+
121+
Required: True
122+
Position: 0
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### -Title
129+
Title of the shift
130+
131+
```yaml
132+
Type: String
133+
Parameter Sets: (All)
134+
Aliases:
135+
136+
Required: False
137+
Position: 2
138+
Default value: None
139+
Accept pipeline input: False
140+
Accept wildcard characters: False
141+
```
142+
143+
## INPUTS
144+
145+
### None
146+
147+
148+
## OUTPUTS
149+
150+
### System.Object
151+
152+
## NOTES
153+
154+
## RELATED LINKS
155+

‎staffhub/staffhub-ps/staffhub/Add-StaffHubTeam.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml
3+
Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Add-StaffHubTeam
9+
10+
## SYNOPSIS
11+
Note: This cmdlet is currently in Beta.
12+
Creates a team.
13+
14+
## SYNTAX
15+
16+
```
17+
Add-StaffHubTeam [-Name] <String> [-TimeZone] <String> [[-ManagerEmail] <String>]
18+
```
19+
20+
## DESCRIPTION
21+
Creates a team.
22+
23+
## EXAMPLES
24+
25+
### Example 1
26+
```
27+
Add-StaffHubTeam -Name "TeamFromCmdletTest" -TimeZone "Asia/Calcutta" -ManagerEmail "[email protected]"
28+
```
29+
30+
Creates a team with [email protected] as manager
31+
32+
### Example 2
33+
```
34+
Add-StaffHubTeam -Name "TeamFromCmdletTest" -TimeZone "Asia/Calcutta"
35+
```
36+
37+
Creates a team with the logged in user as manager
38+
39+
## PARAMETERS
40+
41+
### -ManagerEmail
42+
Organizational email of the member who should be the manager of the team. If not specified, the logged in user is assigned as the manager
43+
44+
```yaml
45+
Type: String
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: False
50+
Position: 2
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -Name
57+
Name of the team to be created
58+
59+
```yaml
60+
Type: String
61+
Parameter Sets: (All)
62+
Aliases:
63+
64+
Required: True
65+
Position: 0
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -TimeZone
72+
TimeZone of the team. Format - tz database
73+
Reference: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
74+
75+
```yaml
76+
Type: String
77+
Parameter Sets: (All)
78+
Aliases:
79+
80+
Required: True
81+
Position: 1
82+
Default value: None
83+
Accept pipeline input: False
84+
Accept wildcard characters: False
85+
```
86+
87+
## INPUTS
88+
89+
### None
90+
91+
92+
## OUTPUTS
93+
94+
### System.Object
95+
96+
## NOTES
97+
98+
## RELATED LINKS
99+

0 commit comments

Comments
 (0)