Skip to content

Commit ebb7393

Browse files
committed
Updating docs for our Teams PowerShell 1.0 release.
1 parent 7b3e05d commit ebb7393

23 files changed

+890
-297
lines changed

teams/teams-ps/teams/Add-TeamUser.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,31 @@
11
---
22
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
33
Module Name: MicrosoftTeams
4-
applicable: Microsoft Teams
5-
title: Add-TeamUser
6-
online version:
4+
online version:
75
schema: 2.0.0
8-
author: kenwith
9-
ms.author: kenwith
10-
ms.reviewer:
116
---
127

138
# Add-TeamUser
149

1510
## SYNOPSIS
16-
Note: This cmdlet is currently in Beta.
17-
18-
Adds an owner or member to the team, and to the unified group which backs the team.
11+
Adds an owner or member to the team, and to the unified group which backs the team.
1912

2013
Note: the command will return immediately, but the Teams application will not reflect the update immediately.
2114
The Teams application may need to be open for up to an hour before changes are reflected.
2215

23-
By default, when you run this cmdlet to add an owner, you will not add it as a member. You must run this cmdlet again to add the owner as a member as well.
16+
To turn an existing Member into an Owner, first Add-TeamUser -Role Owner -User to add them to the owners list, then Remove-TeamUser -User foo to remove them from the members list.
2417

2518
## SYNTAX
2619

2720
```
28-
Add-TeamUser -GroupId <String> -User <String> [-Role <String>]
21+
Add-TeamUser -GroupId <String> -User <String> [-Role <String>] [<CommonParameters>]
2922
```
3023

3124
## DESCRIPTION
3225

3326
## EXAMPLES
3427

35-
### -------------------------- Example 1 --------------------------
28+
### Example 1
3629
```
3730
Add-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User [email protected]
3831
```
@@ -42,13 +35,12 @@ Add user [email protected] to group.
4235
## PARAMETERS
4336

4437
### -GroupId
45-
GroupId of the team.
38+
GroupId of the team
4639

4740
```yaml
4841
Type: String
4942
Parameter Sets: (All)
5043
Aliases:
51-
Applicable: Microsoft Teams
5244

5345
Required: True
5446
Position: Named
@@ -58,13 +50,13 @@ Accept wildcard characters: False
5850
```
5951
6052
### -User
61-
User's UPN (user principal name - e.g. [email protected]).
53+
User's UPN (user principal name - e.g.
54+
6255
6356
```yaml
6457
Type: String
6558
Parameter Sets: (All)
6659
Aliases:
67-
Applicable: Microsoft Teams
6860

6961
Required: True
7062
Position: Named
@@ -74,21 +66,24 @@ Accept wildcard characters: False
7466
```
7567
7668
### -Role
77-
Member or Owner.
69+
Member or Owner
7870
7971
```yaml
8072
Type: String
8173
Parameter Sets: (All)
8274
Aliases:
83-
Applicable: Microsoft Teams
8475

8576
Required: False
8677
Position: Named
87-
Default value: Member
78+
Default value: None
8879
Accept pipeline input: True (ByPropertyName)
8980
Accept wildcard characters: False
9081
```
9182
83+
### CommonParameters
84+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
85+
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
86+
9287
## INPUTS
9388
9489
### GroupId, User, Role
@@ -98,4 +93,3 @@ Accept wildcard characters: False
9893
## NOTES
9994
10095
## RELATED LINKS
101-

teams/teams-ps/teams/Connect-MicrosoftTeams.md

Lines changed: 59 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
---
22
external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml
33
Module Name: MicrosoftTeams
4-
applicable: Microsoft Teams
5-
title: Connect-MicrosoftTeams
6-
online version:
4+
online version:
75
schema: 2.0.0
8-
author: kenwith
9-
ms.author: kenwith
10-
ms.reviewer:
116
---
127

138
# Connect-MicrosoftTeams
149

1510
## SYNOPSIS
16-
Note: This cmdlet is currently in Beta.
1711

1812
The Connect-MicrosoftTeams cmdlet connects an authenticated account to use for Microsoft Teams cmdlet requests.
1913
You can use this authenticated account only with Microsoft Teams cmdlets.
@@ -23,25 +17,33 @@ You can use this authenticated account only with Microsoft Teams cmdlets.
2317
### UserCredential (Default)
2418
```
2519
Connect-MicrosoftTeams [-TenantId <String>] [-Credential <PSCredential>] [-AccountId <String>]
26-
[-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm]
20+
[-LogLevel <LogLevel>] [-LogFilePath <String>] [-TeamsEnvironmentName <String>] [-WhatIf] [-Confirm]
21+
[<CommonParameters>]
2722
```
2823

2924
### ServicePrincipalCertificate
3025
```
3126
Connect-MicrosoftTeams -TenantId <String> -CertificateThumbprint <String> -ApplicationId <String>
32-
[-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm]
27+
[-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
3328
```
3429

3530
### AccessToken
3631
```
3732
Connect-MicrosoftTeams [-TenantId <String>] -AadAccessToken <String> [-MsAccessToken <String>]
38-
-AccountId <String> [-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm]
33+
-AccountId <String> [-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
3934
```
4035

4136
## DESCRIPTION
4237

4338
## EXAMPLES
4439

40+
### Example 1
41+
```powershell
42+
PS C:\> Connect-MicrosoftTeams -TeamsEnvironmentName TeamsGCCH
43+
```
44+
45+
Specifies that the organization being managed is in the Teams GCC High environment, so connect to that environment.
46+
4547
## PARAMETERS
4648

4749
### -AadAccessToken
@@ -50,24 +52,23 @@ Specifies a Azure Active Directory Graph access token.
5052
```yaml
5153
Type: String
5254
Parameter Sets: AccessToken
53-
Aliases:
54-
Applicable: Microsoft Teams
55+
Aliases:
5556

56-
Required: False
57+
Required: True
5758
Position: Named
5859
Default value: None
5960
Accept pipeline input: False
6061
Accept wildcard characters: False
6162
```
6263
6364
### -AccountId
64-
Specifies the ID of an account. You must specify the UPN of the user when authenticating with a user access token.
65+
Specifies the ID of an account.
66+
You must specify the UPN of the user when authenticating with a user access token.
6567
6668
```yaml
6769
Type: String
6870
Parameter Sets: UserCredential
69-
Aliases:
70-
Applicable: Microsoft Teams
71+
Aliases:
7172

7273
Required: False
7374
Position: Named
@@ -79,10 +80,9 @@ Accept wildcard characters: False
7980
```yaml
8081
Type: String
8182
Parameter Sets: AccessToken
82-
Aliases:
83-
Applicable: Microsoft Teams
83+
Aliases:
8484

85-
Required: False
85+
Required: True
8686
Position: Named
8787
Default value: None
8888
Accept pipeline input: False
@@ -95,8 +95,7 @@ Specifies the application ID of the service principal.
9595
```yaml
9696
Type: String
9797
Parameter Sets: ServicePrincipalCertificate
98-
Aliases:
99-
Applicable: Microsoft Teams
98+
Aliases:
10099

101100
Required: True
102101
Position: Named
@@ -106,13 +105,12 @@ Accept wildcard characters: False
106105
```
107106
108107
### -CertificateThumbprint
109-
Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action.
108+
Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action.
110109
111110
```yaml
112111
Type: String
113112
Parameter Sets: ServicePrincipalCertificate
114-
Aliases:
115-
Applicable: Microsoft Teams
113+
Aliases:
116114

117115
Required: True
118116
Position: Named
@@ -128,7 +126,6 @@ Prompts you for confirmation before running the cmdlet.
128126
Type: SwitchParameter
129127
Parameter Sets: (All)
130128
Aliases: cf
131-
Applicable: Microsoft Teams
132129

133130
Required: False
134131
Position: Named
@@ -138,16 +135,15 @@ Accept wildcard characters: False
138135
```
139136
140137
### -Credential
141-
Specifies a **PSCredential** object.
142-
For more information about the **PSCredential** object, type Get-Help Get-Credential.
138+
Specifies a PSCredential object.
139+
For more information about the PSCredential object, type Get-Help Get-Credential.
143140
144-
The **PSCredential** object provides the user ID and password for organizational ID credentials.
141+
The PSCredential object provides the user ID and password for organizational ID credentials.
145142
146143
```yaml
147144
Type: PSCredential
148145
Parameter Sets: UserCredential
149-
Aliases:
150-
Applicable: Microsoft Teams
146+
Aliases:
151147

152148
Required: False
153149
Position: Named
@@ -164,7 +160,6 @@ Provide a value here if you need to deviate from the default PowerShell log file
164160
Type: String
165161
Parameter Sets: (All)
166162
Aliases:
167-
Applicable: Microsoft Teams
168163

169164
Required: False
170165
Position: Named
@@ -175,7 +170,7 @@ Accept wildcard characters: False
175170
176171
### -LogLevel
177172
Specifies the log level.
178-
The acceptable values for this parameter are:
173+
The acceptable values for this parameter are:
179174
180175
- Info
181176
- Error
@@ -187,8 +182,7 @@ The default value is Info.
187182
```yaml
188183
Type: LogLevel
189184
Parameter Sets: (All)
190-
Aliases:
191-
Applicable: Microsoft Teams
185+
Aliases:
192186

193187
Required: False
194188
Position: Named
@@ -203,8 +197,7 @@ Specifies a Microsoft Graph access token.
203197
```yaml
204198
Type: String
205199
Parameter Sets: AccessToken
206-
Aliases:
207-
Applicable: Microsoft Teams
200+
Aliases:
208201

209202
Required: False
210203
Position: Named
@@ -218,13 +211,12 @@ Specifies the ID of a tenant.
218211
219212
If you do not specify this parameter, the account is authenticated with the home tenant.
220213
221-
You must specify the *TenantId* parameter to authenticate as a service principal or when using Microsoft account.
214+
You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account.
222215
223216
```yaml
224217
Type: String
225218
Parameter Sets: UserCredential, AccessToken
226219
Aliases: Domain, TenantDomain
227-
Applicable: Microsoft Teams
228220

229221
Required: False
230222
Position: Named
@@ -237,7 +229,6 @@ Accept wildcard characters: False
237229
Type: String
238230
Parameter Sets: ServicePrincipalCertificate
239231
Aliases: Domain, TenantDomain
240-
Applicable: Microsoft Teams
241232

242233
Required: True
243234
Position: Named
@@ -250,12 +241,10 @@ Accept wildcard characters: False
250241
Shows what would happen if the cmdlet runs.
251242
The cmdlet is not run.
252243
253-
254244
```yaml
255245
Type: SwitchParameter
256246
Parameter Sets: (All)
257247
Aliases: wi
258-
Applicable: Microsoft Teams
259248

260249
Required: False
261250
Position: Named
@@ -264,18 +253,41 @@ Accept pipeline input: False
264253
Accept wildcard characters: False
265254
```
266255
256+
### -TeamsEnvironmentName
257+
Use this setting if your organization is in one of the Teams Government Cloud environments.
258+
259+
Specify "TeamsGCCH" if your organization is in the GCC High Environment. Specify "TeamsDOD" if your organization is in the DoD Environment.
260+
261+
```yaml
262+
Type: String
263+
Parameter Sets: UserCredential
264+
Aliases:
265+
266+
Required: False
267+
Position: Named
268+
Default value: None
269+
Accept pipeline input: False
270+
Accept wildcard characters: False
271+
```
272+
273+
### CommonParameters
274+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
275+
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
276+
267277
## INPUTS
268278
269279
## OUTPUTS
270280
271281
## NOTES
272-
273-
Tips for troubleshooting:
274-
1. Confirm SAML 2.0 is being used.
275-
IDP is outputting invalid SAML information. Needs to have SAML 2.0 vs. SAML 1.0 for the module to connect.
282+
Tips for troubleshooting: 1.
283+
Confirm SAML 2.0 is being used.
284+
IDP is outputting invalid SAML information.
285+
Needs to have SAML 2.0 vs.
286+
SAML 1.0 for the module to connect.
276287
You might experience an error if the Identity Provider (IDP) only allows the use of SAML1.0 when trying to auth via basic authentication.
277288
Which in turn, isn't expected to work because the cmdlet expects either OAUTH2 (which is used when doing just connect-microsofteams), or SAML2.0.
278-
2. Confirm you have the latest version of the cmdlet. You can find the version by running: `get-module -listavailable` and then looking for the MicrosoftTeams name and the version to the left of it.
289+
2.
290+
Confirm you have the latest version of the cmdlet.
291+
You can find the version by running: \`get-module -listavailable\` and then looking for the MicrosoftTeams name and the version to the left of it.
279292
280293
## RELATED LINKS
281-

0 commit comments

Comments
 (0)