Skip to content

Commit fdaf5a5

Browse files
Adding Missing Documentation for Privacy Configuration
1 parent d91170c commit fdaf5a5

File tree

1 file changed

+230
-0
lines changed

1 file changed

+230
-0
lines changed
Lines changed: 230 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,230 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
applicable: Microsoft Teams
5+
online version: https://learn.microsoft.com/powershell/module/teams/Set-CsPrivacyConfiguration
6+
schema: 2.0.0
7+
---
8+
9+
# Set-CsPrivacyConfiguration
10+
11+
## SYNOPSIS
12+
13+
Modifies an existing set of privacy configuration settings.
14+
Privacy configuration settings help determine how much information users make available to other users.
15+
This cmdlet was introduced in Lync Server 2010.
16+
17+
## SYNTAX
18+
19+
```powershell
20+
Set-CsPrivacyConfiguration [-AutoInitiateContacts <Boolean>] [-DisplayPublishedPhotoDefault <Boolean>]
21+
[-EnablePrivacyMode <Boolean>] [[-Identity] <String>] [-PublishLocationDataDefault <Boolean>]
22+
[-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
Privacy configuration settings can be applied at the global scope, the site scope, and at the service scope (albeit only for the User Server service).
28+
The Set-CsPrivacyConfiguration cmdlet enables you to modify any of the privacy configuration settings currently in use in your organization.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Set-CsPrivacyConfiguration -Identity site:Redmond -EnablePrivacyMode $False -AutoInitiateContacts $True -PublishLocationDataDefault $True -DisplayPublishedPhotoDefault $True
36+
```
37+
38+
The command shown in Example 1 modifies three property values for the privacy configuration settings with the Identity site:Redmond.
39+
The three property values modified are AutoInitiateContacts, PublishLocationDataDefault and DisplayPublishedPhotoDefault.
40+
41+
### Example 2
42+
43+
```powershell
44+
Get-CsPrivacyConfiguration | Set-CsPrivacyConfiguration -EnablePrivacyMode $True
45+
```
46+
47+
Example 2 enables privacy mode for all the privacy configuration settings currently in use in the organization.
48+
To do this, the command first calls the \`Get-CsPrivacyConfiguration\` cmdlet without any parameters; this returns the complete collection of privacy settings.
49+
This collection is then piped to the \`Set-CsPrivacyConfiguration\` cmdlet, which takes each item in the collection and sets the EnablePrivacyMode property to True.
50+
51+
### Example 3
52+
53+
```powershell
54+
Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq $False} | Set-CsPrivacyConfiguration -AutoInitiateContacts $True -PublishLocationDataDefault $True -DisplayPublishedPhotoDefault $True
55+
```
56+
57+
In Example 3, modifications are made to all the privacy configuration settings that are not currently using privacy mode.
58+
To carry out this task, the \`Get-CsPrivacyConfiguration\` cmdlet is first used in order to return a collection of all the privacy configuration settings.
59+
This collection is piped to the \`Where-Object\` cmdlet, which selects only those settings where the EnablePrivacyMode property is equal to False.
60+
The filtered collection is then piped to the \`Set-CsPrivacyConfiguration\` cmdlet, which assigns values to the AutoInitiateContacts, PublishLocationDataDefault, and DisplayPublishedPhotoDefault properties for each item in the collection.
61+
62+
## PARAMETERS
63+
64+
### -Identity
65+
66+
Unique identifier for the privacy configuration settings to be modified.
67+
To modify the global settings, use this syntax:
68+
69+
\`-Identity global\`
70+
71+
To modify settings configured at the site scope, use syntax similar to this:
72+
73+
\`-Identity site:Redmond\`
74+
75+
To modify settings at the service level, use syntax like this:
76+
77+
\`-Identity service:Redmond-UserServices-1\`
78+
79+
Note that privacy settings can only be applied to the User Server service.
80+
An error will occur if you try to apply these settings to any other service.
81+
82+
If this parameter is not specified then the global settings will be updated when you call the \`Set-CsPrivacyConfiguration\` cmdlet.
83+
84+
```yaml
85+
Type: String
86+
Parameter Sets: (All)
87+
Aliases:
88+
89+
Required: False
90+
Position: 2
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### -AutoInitiateContacts
97+
98+
If True, Skype for Business will automatically add your manager and your direct reports to your Contacts list.
99+
The default value is True.
100+
101+
```yaml
102+
Type: Boolean
103+
Parameter Sets: (All)
104+
Aliases:
105+
106+
Required: False
107+
Position: Named
108+
Default value: None
109+
Accept pipeline input: False
110+
Accept wildcard characters: False
111+
```
112+
113+
### -DisplayPublishedPhotoDefault
114+
115+
If True, the user's photo will automatically be published in Skype for Business.
116+
If False, the user's photo will not be available unless he or she explicitly selects the option Let others see my photo.
117+
The default value is True.
118+
119+
```yaml
120+
Type: Boolean
121+
Parameter Sets: (All)
122+
Aliases:
123+
124+
Required: False
125+
Position: Named
126+
Default value: None
127+
Accept pipeline input: False
128+
Accept wildcard characters: False
129+
```
130+
131+
### -EnablePrivacyMode
132+
133+
If True, gives users the opportunity to enable the advanced privacy mode.
134+
In advanced privacy mode, only people on your Contacts list will be allowed to view your presence information.
135+
If False, your presence information will be available to anyone in your organization.
136+
The default value is False.
137+
138+
For information about privacy mode in Microsoft Teams, see User presence in Teams (/microsoftteams/presence-admins).
139+
140+
```yaml
141+
Type: Boolean
142+
Parameter Sets: (All)
143+
Aliases:
144+
145+
Required: False
146+
Position: Named
147+
Default value: None
148+
Accept pipeline input: False
149+
Accept wildcard characters: False
150+
```
151+
152+
### -PublishLocationDataDefault
153+
154+
If True, location data will automatically be published in Skype for Business.
155+
If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location.
156+
The default value is True.
157+
158+
```yaml
159+
Type: Boolean
160+
Parameter Sets: (All)
161+
Aliases:
162+
163+
Required: False
164+
Position: Named
165+
Default value: None
166+
Accept pipeline input: False
167+
Accept wildcard characters: False
168+
```
169+
170+
### -WhatIf
171+
172+
Describes what would happen if you executed the command without actually executing the command.
173+
174+
```yaml
175+
Type: SwitchParameter
176+
Parameter Sets: (All)
177+
Aliases: wi
178+
179+
Required: False
180+
Position: Named
181+
Default value: False
182+
Accept pipeline input: False
183+
Accept wildcard characters: False
184+
```
185+
186+
### -Confirm
187+
188+
Prompts you for confirmation before executing the command.
189+
190+
```yaml
191+
Type: SwitchParameter
192+
Parameter Sets: (All)
193+
Aliases: cf
194+
195+
Required: False
196+
Position: Named
197+
Default value: False
198+
Accept pipeline input: False
199+
Accept wildcard characters: False
200+
```
201+
202+
### -MsftInternalProcessingMode
203+
204+
For internal use only.
205+
206+
```yaml
207+
Type: String
208+
Parameter Sets: (All)
209+
Aliases:
210+
211+
Required: False
212+
Position: Named
213+
Default value: None
214+
Accept pipeline input: False
215+
Accept wildcard characters: False
216+
```
217+
218+
### CommonParameters
219+
220+
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).
221+
222+
## INPUTS
223+
224+
## OUTPUTS
225+
226+
## NOTES
227+
228+
## RELATED LINKS
229+
230+
[Get-CsPrivacyConfiguration](Get-CsPrivacyConfiguration.md)

0 commit comments

Comments
 (0)