[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Returns information about the privacy configuration settings currently in use in your organization. Privacy configuration settings help determine how much information users make available to other users.


Get-CsPrivacyConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>] [-Tenant <Nullable>]
Get-CsPrivacyConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>] [-Tenant <Nullable>]


Parameter Required Type Description



Xds Identity

Unique identifier for the privacy configuration settings to be retrieved. To return the global settings, use this syntax: -Identity global. To return settings configured at the site scope, use syntax similar to this: -Identity site:Redmond. To modify settings at the service level, use syntax like this: -Identity service:UserServer:atl-cs-001.litwareinc.com

If this parameter is not specified then Get-CsPrivacyConfiguration returns all the privacy configuration settings currently in use in your organization.




Enables you to use wildcards to return one or more collections of privacy configuration settings. For example, to return all the settings configured at the site scope, you can use this syntax: -Filter "site:*". To return all the settings configured at the service scope, use this syntax: -Filter "service:*".






Switch Parameter

Detailed Description

Microsoft Communicator “14” gives users the opportunity to share a wealth of presence information with other people: they can publish a photograph of themselves; they can provide detailed location information; they can have presence information automatically made available to everyone in the organization (as opposed to having this information available only to people on their contact list).

Some users will welcome the opportunity to make this information available to their colleagues; other users might be more reluctant to share this data. (For example, many people might be hesitant about having their photo included in their presence data.) As a general rule, users have control over what information they will (or will not) share; for example, users can select or deselect a checkbox in order to control whether or not their location information is shared with others. The privacy configuration cmdlets (Get-CsPrivacyConfiguration, Set-CsPrivacyConfiguration, New-CsPrivacyConfiguration, and Remove-CsPrivacyConfiguration) enable administrators to manage privacy settings for their users. In some cases, administrators can enable or disable settings; for example, if the property AutoInitiateContacts is set to True then team members will automatically be added to each user’s contact list; if set to False, team members will not be automatically be added to each user’s contact list.

In other cases, administrators can configure the default values in Communicator while still giving users the right to change these values. For example, by default location data is published for users, although users do have the right to stop location publication. By setting the PublishLocationDataByDefault property to False, administrators can change this behavior: in that case, location data will not be published by default, although users will still have the right to publish this data if they choose.

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). The Get-CsPrivacyConfiguration cmdlet enables you to retrieve information about all the privacy configuration settings currently in use in your organization.

Return Types

Get-CsPrivacyConfiguration returns existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object.


-------------------------- Example 1 ------------------------

Copy Code

The command shown in Example 1 returns all the privacy configuration settings currently in use in the organization. Returning the complete collection of privacy configuration settings means calling Get-CsPrivacyConfiguration without any additional parameters.

-------------------------- Example 2 ------------------------

Copy Code
Get-CsPrivacyConfiguration -Identity site:Redmond

The preceding command returns a single collection of privacy configuration settings: the settings that have the Identity site:Redmond. By definition, these are the settings assigned to the Redmond site.

-------------------------- Example 3 ------------------------

Copy Code
Get-CsPrivacyConfiguration -Filter "site:*"

In Example 3, information is returned for all the privacy configuration settings that have been assigned at the site scope. To do this, the -Filter parameter is included, along with the filter value "site:*". That filter value ensures that only settings where the Identity (the only property you can filter on) begins with the characters "site:".

-------------------------- Example 4 ------------------------

Copy Code
Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq True}

The command shown in Example 4 returns information about the privacy configuration settings where privacy mode has been enabled. This is done by first calling Get-CsPrivacyConfiguration (without any parameters) in order to return a collection of all the privacy settings. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EnablePrivacyMode property is equal to (-eq) True ($True).