[This topic is in progress.]

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-05-07

Use the Set-SharingPolicy cmdlet to modify an existing sharing policy to regulate how users inside your organization can share free/busy and contact information with users outside the organization. Users can only share this information after federation has been configured in Microsoft Exchange. After federation is configured, users can send sharing invitations that comply with a sharing policy to external recipients in other Exchange Server 2010 organizations that have federation enabled. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the level of sharing permitted for this mailbox.

Syntax

Set-SharingPolicy -Identity <SharingPolicyIdParameter> [-Confirm [<SwitchParameter>]] [-Default <SwitchParameter>] [-DomainController <Fqdn>] [-Domains <MultiValuedProperty>] [-Enabled <$true | $false>] [-Name <String>] [-WhatIf [<SwitchParameter>]]

Detailed Description

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Sharing policies" entry in the Mailbox Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.SharingPolicyIdParameter

The Identity parameter specifies the identity of the sharing policy that you want to modify. You can use one of the following values:

  • ADObjectID

  • Distinguished name (DN)

  • Legacy DN

  • GUID

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

Default

Optional

System.Management.Automation.SwitchParameter

The Default parameter specifies that this sharing policy is the default sharing policy for all mailboxes. If no sharing policy has been applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you can set the default policy to be disabled.

You don't have to specify a value with this parameter.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

Domains

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Domains parameter specifies domains to which this policy applies and the sharing policy action. Values for this parameter use the format Domain: SharingPolicyAction.

The following sharing policy action values can be used:

  • CalendarSharingFreeBusySimple   Share free/busy hours only

  • CalendarSharingFreeBusyDetail   Share free/busy hours, subject, and location

  • CalendarSharingFreeBusyReviewer   Share free/busy hours, subject, location, and the body of the message or calendar item

  • ContactsSharing   Share contacts only

The following is an example:

Copy Code 
'Contoso.com: CalendarSharingFreeBusySimple', 'Fabrikam.com: CalendarSharingFreeBusyDetail, ContactsSharing'
Note:
Adding a domain doesn't include subdomains. You must configure each subdomain separately.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether to enable the sharing policy. Valid values for this parameter are $true or $false. The default is $true.

When the sharing policy is disabled, users who are provisioned to use this policy continue to share information until the sharing policy assistant runs.

Name

Optional

System.String

The Name parameter allows you to change the name of the sharing policy.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Examples

EXAMPLE 1

This example modifies the sharing policy Contoso for contoso.com, which is a domain outside your organization. This policy allows users in the Contoso domain to see simple free/busy information.

Copy Code 
Set-SharingPolicy -Identity Contoso -Domains 'mail.contoso.com: CalendarSharingFreeBusySimple'

EXAMPLE 2

This example adds a second domain to the sharing policy SharingPolicy01. When you're adding a domain to an existing policy, you must include any previously included domains.

Copy Code 
Set-SharingPolicy -Identity SharingPolicy01 -Domains 'contoso.com: CalendarSharingFreeBusySimple', 'atlanta.contoso.com: CalendarSharingFreeBusyReviewer', 'beijing.contoso.com: CalendarSharingFreeBusyReviewer'

EXAMPLE 3

This example disables the sharing policy SharingPolicy01.

Copy Code 
Set-SharingPolicy -Identity "SharingPolicy01" -Enabled $false