Skip to content

Commit b76ec8b

Browse files
authored
Create Set-CsTeamsExternalAccessConfiguration.md
Create Set-CsTeamsExternalAccessConfiguration.md for TeamsExternalAccessConfiguration
1 parent ba4e62d commit b76ec8b

File tree

1 file changed

+130
-0
lines changed

1 file changed

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

0 commit comments

Comments
 (0)