Skip to content

Commit ef2e631

Browse files
kenwithkenwith
authored
Merge pull request MicrosoftDocs#52 from nkramer/w/nkramer/teams
Improved docs for Teams cmdlets
2 parents 70965d7 + de12cdc commit ef2e631

File tree

7 files changed

+132
-86
lines changed

7 files changed

+132
-86
lines changed

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,15 @@ schema: 2.0.0
1212
## SYNOPSIS
1313
Note: This cmdlet is currently in Beta.
1414

15-
Adds an owner or member to the team.
15+
Adds an owner or member to the team,
16+
and to the unified group which backs the team.
17+
18+
Note: the command will return immediately, but the Teams application will not reflect the update immediately.
19+
The Teams application may need to be open for up to an hour before changes are reflected.
20+
21+
To turn an existing Member into an Owner,
22+
first Add-TeamUser -Role Owner -User foo to add them to the owners list,
23+
then Remove-TeamUser -User foo to remove them from the members list.
1624

1725
## SYNTAX
1826

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

Lines changed: 80 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ schema: 2.0.0
1212
## SYNOPSIS
1313
Note: This cmdlet is currently in Beta.
1414

15+
The Connect-MicrosoftTeams cmdlet connects an authenticated account to use for Microsoft Teams cmdlet requests.
16+
You can use this authenticated account only with Microsoft Teams cmdlets.
17+
1518
## SYNTAX
1619

1720
### UserCredential (Default)
@@ -38,13 +41,13 @@ Connect-MicrosoftTeams [-TenantId <String>] -AadAccessToken <String> [-MsAccessT
3841

3942
## PARAMETERS
4043

41-
### -TenantId
42-
@{Text=}
44+
### -AadAccessToken
45+
Specifies a Azure Active Directory Graph access token.
4346

4447
```yaml
4548
Type: String
46-
Parameter Sets: UserCredential, AccessToken
47-
Aliases: Domain, TenantDomain
49+
Parameter Sets: AccessToken
50+
Aliases:
4851
Applicable: Microsoft Teams
4952

5053
Required: False
@@ -54,26 +57,26 @@ Accept pipeline input: False
5457
Accept wildcard characters: False
5558
```
5659
60+
### -AccountId
61+
Specifies the ID of an account. You must specify the UPN of the user when authenticating with a user access token.
62+
5763
```yaml
5864
Type: String
59-
Parameter Sets: ServicePrincipalCertificate
60-
Aliases: Domain, TenantDomain
65+
Parameter Sets: UserCredential
66+
Aliases:
6167
Applicable: Microsoft Teams
6268

63-
Required: True
69+
Required: False
6470
Position: Named
6571
Default value: None
6672
Accept pipeline input: False
6773
Accept wildcard characters: False
6874
```
6975
70-
### -Credential
71-
@{Text=}
72-
7376
```yaml
74-
Type: PSCredential
75-
Parameter Sets: UserCredential
76-
Aliases:
77+
Type: String
78+
Parameter Sets: AccessToken
79+
Aliases:
7780
Applicable: Microsoft Teams
7881

7982
Required: False
@@ -83,26 +86,29 @@ Accept pipeline input: False
8386
Accept wildcard characters: False
8487
```
8588
86-
### -AccountId
87-
@{Text=}
89+
### -ApplicationId
90+
Specifies the application ID of the service principal.
8891
8992
```yaml
9093
Type: String
91-
Parameter Sets: UserCredential
92-
Aliases:
94+
Parameter Sets: ServicePrincipalCertificate
95+
Aliases:
9396
Applicable: Microsoft Teams
9497

95-
Required: False
98+
Required: True
9699
Position: Named
97100
Default value: None
98101
Accept pipeline input: False
99102
Accept wildcard characters: False
100103
```
101104
105+
### -CertificateThumbprint
106+
Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action.
107+
102108
```yaml
103109
Type: String
104-
Parameter Sets: AccessToken
105-
Aliases:
110+
Parameter Sets: ServicePrincipalCertificate
111+
Aliases:
106112
Applicable: Microsoft Teams
107113

108114
Required: True
@@ -112,29 +118,32 @@ Accept pipeline input: False
112118
Accept wildcard characters: False
113119
```
114120
115-
### -LogLevel
116-
@{Text=}
121+
### -Confirm
122+
Prompts you for confirmation before running the cmdlet.
117123
118124
```yaml
119-
Type: LogLevel
125+
Type: SwitchParameter
120126
Parameter Sets: (All)
121-
Aliases:
127+
Aliases: cf
122128
Applicable: Microsoft Teams
123129

124130
Required: False
125131
Position: Named
126-
Default value: None
132+
Default value: False
127133
Accept pipeline input: False
128134
Accept wildcard characters: False
129135
```
130136
131-
### -LogFilePath
132-
@{Text=}
137+
### -Credential
138+
Specifies a **PSCredential** object.
139+
For more information about the **PSCredential** object, type Get-Help Get-Credential.
140+
141+
The **PSCredential** object provides the user ID and password for organizational ID credentials.
133142
134143
```yaml
135-
Type: String
136-
Parameter Sets: (All)
137-
Aliases:
144+
Type: PSCredential
145+
Parameter Sets: UserCredential
146+
Aliases:
138147
Applicable: Microsoft Teams
139148

140149
Required: False
@@ -144,13 +153,14 @@ Accept pipeline input: False
144153
Accept wildcard characters: False
145154
```
146155
147-
### -WhatIf
148-
@{Text=}
156+
### -LogFilePath
157+
The path where the log file for this PowerShell session is written to.
158+
Provide a value here if you need to deviate from the default PowerShell log file location.
149159
150160
```yaml
151-
Type: SwitchParameter
161+
Type: String
152162
Parameter Sets: (All)
153-
Aliases: wi
163+
Aliases:
154164
Applicable: Microsoft Teams
155165

156166
Required: False
@@ -160,13 +170,21 @@ Accept pipeline input: False
160170
Accept wildcard characters: False
161171
```
162172
163-
### -Confirm
164-
@{Text=}
173+
### -LogLevel
174+
Specifies the log level.
175+
The acceptable values for this parameter are:
176+
177+
- Info
178+
- Error
179+
- Warning
180+
- None
181+
182+
The default value is Info.
165183
166184
```yaml
167-
Type: SwitchParameter
185+
Type: LogLevel
168186
Parameter Sets: (All)
169-
Aliases: cf
187+
Aliases:
170188
Applicable: Microsoft Teams
171189

172190
Required: False
@@ -176,45 +194,46 @@ Accept pipeline input: False
176194
Accept wildcard characters: False
177195
```
178196
179-
### -CertificateThumbprint
180-
@{Text=}
197+
### -MsAccessToken
198+
Specifies a Microsoft Graph access token.
181199
182200
```yaml
183201
Type: String
184-
Parameter Sets: ServicePrincipalCertificate
185-
Aliases:
202+
Parameter Sets: AccessToken
203+
Aliases:
186204
Applicable: Microsoft Teams
187205

188-
Required: True
206+
Required: False
189207
Position: Named
190208
Default value: None
191209
Accept pipeline input: False
192210
Accept wildcard characters: False
193211
```
194212
195-
### -ApplicationId
196-
@{Text=}
213+
### -TenantId
214+
Specifies the ID of a tenant.
215+
216+
If you do not specify this parameter, the account is authenticated with the home tenant.
217+
218+
You must specify the *TenantId* parameter to authenticate as a service principal or when using Microsoft account.
197219
198220
```yaml
199221
Type: String
200-
Parameter Sets: ServicePrincipalCertificate
201-
Aliases:
222+
Parameter Sets: UserCredential, AccessToken
223+
Aliases: Domain, TenantDomain
202224
Applicable: Microsoft Teams
203225

204-
Required: True
226+
Required: False
205227
Position: Named
206228
Default value: None
207229
Accept pipeline input: False
208230
Accept wildcard characters: False
209231
```
210232
211-
### -AadAccessToken
212-
@{Text=}
213-
214233
```yaml
215234
Type: String
216-
Parameter Sets: AccessToken
217-
Aliases:
235+
Parameter Sets: ServicePrincipalCertificate
236+
Aliases: Domain, TenantDomain
218237
Applicable: Microsoft Teams
219238

220239
Required: True
@@ -224,18 +243,20 @@ Accept pipeline input: False
224243
Accept wildcard characters: False
225244
```
226245
227-
### -MsAccessToken
228-
@{Text=}
246+
### -WhatIf
247+
Shows what would happen if the cmdlet runs.
248+
The cmdlet is not run.
249+
229250
230251
```yaml
231-
Type: String
232-
Parameter Sets: AccessToken
233-
Aliases:
252+
Type: SwitchParameter
253+
Parameter Sets: (All)
254+
Aliases: wi
234255
Applicable: Microsoft Teams
235256

236257
Required: False
237258
Position: Named
238-
Default value: None
259+
Default value: False
239260
Accept pipeline input: False
240261
Accept wildcard characters: False
241262
```

0 commit comments

Comments
 (0)