Skip to content

Commit aa65c64

Browse files
satyajit-mssatyajit-ms
committed
md files for new cmdlets
1 parent fd8954c commit aa65c64

File tree

3 files changed

+268
-0
lines changed

3 files changed

+268
-0
lines changed

‎staffhub/staffhub-ps/staffhub/Get-StaffHubShifts.md

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
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+
# Get-StaffHubShifts
9+
10+
## SYNOPSIS
11+
Note: This cmdlet is currently in Beta.
12+
Get details of shifts for all team members or for a specified team member for the given time window.
13+
14+
## SYNTAX
15+
16+
```
17+
Get-StaffHubShifts [-TeamId] <String> [-StartDateTime] <DateTime> [-EndDateTime] <DateTime>
18+
[[-MemberId] <String>] [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
Get details of the shifts for all team members or for a specified team member
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+
Get-StaffHubShifts -TeamId "TEAM_1234" -StartDateTime $startTime -EndDateTime $endTime -MemberId MBER_1234
31+
```
32+
Get the details of the shifts for MBER_1234 in the team TEAM_1234 between start time and end time
33+
34+
### Example 2
35+
```
36+
$startTime = Get-Date -Date "2018-01-01T00:10:00"
37+
$endTime = Get-Date -Date "2018-01-01T04:10:00"
38+
Get-StaffHubShifts -TeamId "TEAM_1234" -StartDateTime $startTime -EndDateTime $endTime
39+
```
40+
41+
Get the details of the shifts for all the members in team TEAM_1234 between start time and end time
42+
43+
## PARAMETERS
44+
45+
### -EndDateTime
46+
EndDateTime for the time window between which shifts are to be fetched
47+
48+
```yaml
49+
Type: DateTime
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: True
54+
Position: 2
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -MemberId
61+
MemberId of the member for which the shifts are to be fetched
62+
63+
```yaml
64+
Type: String
65+
Parameter Sets: (All)
66+
Aliases:
67+
68+
Required: False
69+
Position: 3
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### -StartDateTime
76+
StartDateTime for the time window between which shifts are to be fetched
77+
78+
```yaml
79+
Type: DateTime
80+
Parameter Sets: (All)
81+
Aliases:
82+
83+
Required: True
84+
Position: 1
85+
Default value: None
86+
Accept pipeline input: False
87+
Accept wildcard characters: False
88+
```
89+
90+
### -TeamId
91+
TeamId of the team for which the shifts are to be fetched
92+
93+
```yaml
94+
Type: String
95+
Parameter Sets: (All)
96+
Aliases:
97+
98+
Required: True
99+
Position: 0
100+
Default value: None
101+
Accept pipeline input: False
102+
Accept wildcard characters: False
103+
```
104+
105+
### CommonParameters
106+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
107+
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
108+
109+
## INPUTS
110+
111+
### None
112+
113+
114+
## OUTPUTS
115+
116+
### System.Object
117+
118+
## NOTES
119+
120+
## RELATED LINKS

‎staffhub/staffhub-ps/staffhub/Get-StaffHubUsersForTenant.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
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+
# Get-StaffHubUsersForTenant
9+
10+
## SYNOPSIS
11+
Note: This cmdlet is currently in Beta.
12+
Get all the StaffHub users in the tenant of the logged in user.
13+
14+
## SYNTAX
15+
16+
```
17+
Get-StaffHubUsersForTenant [[-ContinuationToken] <String>] [[-Top] <Int32>]
18+
```
19+
20+
## DESCRIPTION
21+
Get all the StaffHub users in the tenant of the logged in user.
22+
ContinuationToken from the call is stored in $nextToken variable.
23+
Here is an example of the next call that can be made: Get-StaffHubUsersForTenant -Top 10 -ContinuationToken $nextToken
24+
25+
## EXAMPLES
26+
27+
### Example 1
28+
```
29+
Get-StaffHubUsersForTenant -Top 10
30+
```
31+
32+
Get first 10 StaffHub users in the tenant by ascending creation time order.
33+
If 'Top' parameter is not specified, then it defaults to 1000.
34+
This returns a continuation token stored in $nextToken variable which can be used by the following call.
35+
Eg: Get-StaffHubUsersForTenant -Top 10 -ContinuationToken $nextToken
36+
37+
### Example 2
38+
```
39+
Get-StaffHubUsersForTenant
40+
```
41+
42+
Get all StaffHub users in the tenant with page size restricted to 1000 by default.
43+
44+
## PARAMETERS
45+
46+
### -ContinuationToken
47+
Continuation Token returned by the previous call
48+
49+
```yaml
50+
Type: String
51+
Parameter Sets: (All)
52+
Aliases:
53+
54+
Required: False
55+
Position: 1
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -Top
62+
Top 'n' items to be fetched sorted by ascending creation time order.
63+
64+
```yaml
65+
Type: Int32
66+
Parameter Sets: (All)
67+
Aliases:
68+
69+
Required: False
70+
Position: 0
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
## INPUTS
77+
78+
### None
79+
80+
81+
## OUTPUTS
82+
83+
### System.Object
84+
85+
## NOTES
86+
87+
## RELATED LINKS

‎staffhub/staffhub-ps/staffhub/Remove-StaffHubUser.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
# Remove-StaffHubUser
9+
10+
## SYNOPSIS
11+
Note: This cmdlet is currently in Beta.
12+
Removes the specified user from StaffHub (Only for users deleted in AAD already)
13+
14+
## SYNTAX
15+
16+
```
17+
Remove-StaffHubUser [-UserId] <String>
18+
```
19+
20+
## DESCRIPTION
21+
Removes the specified user from StaffHub.
22+
Pre-requisite is to delete the user from AAD.
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
```
28+
Remove-StaffHubUser -UserId "USER_1234"
29+
```
30+
31+
This removes the user "USER_1234" from StaffHub, if the user has been deleted in AAD already.
32+
33+
## PARAMETERS
34+
35+
### -UserId
36+
UserId of the user to be removed from StaffHub
37+
38+
```yaml
39+
Type: String
40+
Parameter Sets: (All)
41+
Aliases:
42+
43+
Required: True
44+
Position: 0
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
50+
## INPUTS
51+
52+
### None
53+
54+
55+
## OUTPUTS
56+
57+
### System.Object
58+
59+
## NOTES
60+
61+
## RELATED LINKS

0 commit comments

Comments
 (0)