Skip to content

Commit 89edd1e

Browse files
American-DipperAmerican-Dipper
authored
Merge pull request #11917 from krammerliu/patch-1
Create the doc for TeamsExternalAccessConfiguration
2 parents 53fb8aa + 8c4f218 commit 89edd1e

File tree

2 files changed

+210
-0
lines changed

2 files changed

+210
-0
lines changed

‎teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version:
5+
schema: 1.0.0
6+
---
7+
8+
# Get-CsTeamsExternalAccessConfiguration
9+
10+
## SYNOPSIS
11+
The TeamsExternalAccessConfiguration contains all configurations that can be used to enhance the security of the entire organization, such as managing blocked users. This cmdlet returns the current settings of your organization.
12+
13+
## SYNTAX
14+
15+
### Identity (Default)
16+
```
17+
Get-CsTeamsExternalAccessConfiguration [[-Identity] <XdsIdentity>] [<CommonParameters>]
18+
```
19+
20+
### Filter
21+
```
22+
Get-CsTeamsExternalAccessConfiguration [-Filter <String>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
Retrieves the current Teams External Access Configuration in the organization.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Get-CsTeamsExternalAccessConfiguration
33+
```
34+
35+
In this example, we retrieve the Teams External Access Configuration in the organization.
36+
37+
## PARAMETERS
38+
39+
### -Filter
40+
Internal Microsoft use.
41+
42+
```yaml
43+
Type: String
44+
Parameter Sets: (All)
45+
Aliases:
46+
47+
Required: False
48+
Position: Named
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -Identity
55+
The only value accepted is Global
56+
57+
```yaml
58+
Type: XdsIdentity
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: False
63+
Position: 1
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### CommonParameters
70+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
71+
72+
## INPUTS
73+
74+
### None
75+
76+
## OUTPUTS
77+
78+
### TeamsExternalAccessConfiguration.Cmdlets.TeamsExternalAccessConfiguration
79+
80+
## NOTES
81+
82+
## RELATED LINKS

‎teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version:
5+
schema: 1.0.0
6+
---
7+
# Set-CsTeamsExternalAccessConfiguration
8+
9+
## SYNOPSIS
10+
11+
12+
## SYNTAX
13+
14+
### Identity (Default)
15+
```
16+
Set-CsTeamsExternalAccessConfiguration [-BlockedUsers <List>] [-BlockExternalUserAccess <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Allows admins to set values in the TeamsExternalAccessConfiguration, which specifies configs that can be used to improve entire org security. This configuration primarily allows admins to block malicious external users from the organization.
21+
22+
## EXAMPLES
23+
24+
### Example 1
25+
```powershell
26+
PS C:\> Set-CsTeamsExternalAccessConfiguration -Identity Global -BlockExternalAccessUserAccess $true
27+
```
28+
29+
In this example, the admin has enabled the BlockExternalUserAccess. The users in the BlockedUsers will be blocked from communicating with the internal users.
30+
31+
### Example 2
32+
```powershell
33+
PS C:\> Set-CsTeamsExternalAccessConfiguration -Identity Global -BlockedUsers @("[email protected]", "[email protected]")
34+
```
35+
36+
In this example, the admin has added two malicious users into the blocked list. These blocked users can't communicate with internal users anymore.
37+
38+
## PARAMETERS
39+
40+
### -BlockExternalAccessUserAccess
41+
Designates whether BlockedUsers list is taking effect or not. $true means BlockedUsers are blocked and can't communicate with internal users.
42+
43+
```yaml
44+
Type: Boolean
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: False
49+
Position: Named
50+
Default value: False
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### -BlockedUsers
56+
You can specify blocked users using a List object that contains either the user email or the MRI from the external user you want to block. The user in the list will not able to communicate with the internal users in your organization.
57+
58+
```yaml
59+
Type: List
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: False
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### -Force
71+
Bypass confirmation
72+
73+
```yaml
74+
Type: SwitchParameter
75+
Parameter Sets: (All)
76+
Aliases:
77+
78+
Required: False
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### -Identity
86+
The only option is Global
87+
88+
```yaml
89+
Type: XdsIdentity
90+
Parameter Sets: (All)
91+
Aliases:
92+
93+
Required: False
94+
Position: 1
95+
Default value: None
96+
Accept pipeline input: False
97+
Accept wildcard characters: False
98+
```
99+
100+
### -WhatIf
101+
Shows what would happen if the cmdlet runs.
102+
The cmdlet is not run.
103+
104+
```yaml
105+
Type: SwitchParameter
106+
Parameter Sets: (All)
107+
Aliases: wi
108+
109+
Required: False
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
116+
### CommonParameters
117+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
118+
For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
119+
120+
## INPUTS
121+
122+
### System.Management.Automation.PSObject
123+
## OUTPUTS
124+
125+
### System.Object
126+
## NOTES
127+
128+
## RELATED LINKS

0 commit comments

Comments
 (0)