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

Modifies a public provider currently configured for use in your organization. A public provider is an organization that provides instant messaging, presence, and related services to the general public. Microsoft Communications Server 2010 ships with three public providers configured but not enabled: Yahoo!; AOL; and Windows Live.

Syntax


Set-CsPublicProvider [-Identity <XdsGlobalRelativeIdentity>] [-Confirm [<SwitchParameter>]] [-Enabled <$true \| $false>] [-Tenant <Nullable>] [-VerificationLevel <AlwaysVerifiable \| AlwaysUnverifiable \| UseSourceVerification>] [-WhatIf [<SwitchParameter>]]

Set-CsPublicProvider [-Identity <XdsGlobalRelativeIdentity>] [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-Tenant <Nullable>] [-VerificationLevel <AlwaysVerifiable | AlwaysUnverifiable | UseSourceVerification>] [-WhatIf [<SwitchParameter>]]


Set-CsPublicProvider [-Confirm [<SwitchParameter>]] [-Enabled <$true \| $false>] [-Instance <PSObject>] [-Tenant <Nullable>] [-VerificationLevel <AlwaysVerifiable \| AlwaysUnverifiable \| UseSourceVerification>] [-WhatIf [<SwitchParameter>]]

Set-CsPublicProvider [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-Instance <PSObject>] [-Tenant <Nullable>] [-VerificationLevel <AlwaysVerifiable | AlwaysUnverifiable | UseSourceVerification>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Optional	String	Unique identifier for the public provider to be modified. The Identity is simply a string value, and is typically the name of the Web site providing the services (e.g., Yahoo!; AOL; Windows Live; etc.).
Instance	Optional	DisplayPublicProvider object	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
VerificationLevel	Optional	String	Specifies the fully qualified domain name (for example, proxyserver.fabrikam.com) of the proxy server used by the public provider. Proxy FQDNs must be unique not only among public providers, but also among hosting providers. For example, suppose you try to create a new public provider with the proxy FQDN proxyserver.fabrikam.com. This command will fail if a public provider or a hosting provider with that proxy FQDN already exists.
Enabled	Optional	Switch Parameter	Indicates whether or not the federation between your organization and the public provider is active. If set to True, users in your organization will be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. If set to False, users in your organization will not be able to exchange instant messages and presence information with users who have accounts hosted on the public provider.
Tenant	Optional	Guid	This parameter is for testing purposes only.
LocalStore	Optional	Switch Parameter	This parameter is for testing purposes only.
WhatIf	Optional	Switch Parameter	Describes what would happen if you executed the command without actually executing the command.
Confirm	Optional	Switch Parameter	Prompts you for confirmation before executing the command.

Detailed Description

"Federation" is simply a means by which two organizations can set up a trust relationship that facilitates communication between the two groups. When a federation has been established, users in the two organizations can send each other instant messages, subscribe for presence notifications, and otherwise communicate with one another using SIP applications such as Microsoft Communicator "14". Communications Server 2010 allows for three types of federation: 1) direct federation between your organization and another; 2) federation between your organization and a public provider; and, 3) federation between your organization and a third-party hosting provider.

A public provider is an organization which provides SIP communication services for the general public. When you establish a federation relationship with a public provider, you effectively establish federation with any user who has an account hosted by that provider. For example, if you federate with Windows Live, then (depending on how you have configured your system) your users will be able to exchange instant messages and presence information with anyone who had a Windows Live instant messaging account.

In order to federate with a public provider you will need to create and enable a new public provider. (In addition, the public provider will need to create a federation relationship with you.) Communications Server 2010 includes three public providers - Yahoo!; AOL; and windows Live - that are preconfigured for you. As additional public providers become available, you create federation relationships with these new providers by using the New-CsPublicProvider cmdlet.

Note that you cannot federate with a public provider if your Access Edge servers are configured to use default routing rather than DNS server routing. For more information, type "Get-Help Set-CsAccessEdgeConfiguration" (without the quote marks) at the Windows PowerShell prompt.

Return Types

Set-CsPublicProvider does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.DisplayPublicProvider object.

Examples

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

	Copy Code
Set-CsPublicProvider -Identity "AOL" -VerificationLevel "UseSourceVerification"

The preceding command sets the VerificationLevel for the public provider with the Identity AOL. This is done by including the -VerificationLevel parameter and the parameter value UseSourceVerification.

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

	Copy Code
Get-CsPublicProvider \| Set-CsPublicProvider -VerificationLevel "UseSourceVerification"

In Example 2, the verification level is modified for all the public providers currently in use in the organization. To do this, the command first calls Get-CsPublicProvider (without any additional parameters) in order to return a collection of all the public providers currently configured for use. This collection is then piped the Set-CsPublicProvider, which takes each provider in the collection and changes the value of the VerificationLevel property to UseSourceVerification.

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

	Copy Code
Get-CsPublicProvider \| Where-Object {$_.VerificationLevel -eq "AlwaysVerifiable" \| Set-CsPublicProvider -VerificationLevel "UseSourceVerification"

The command shown in Example 3 modifies the verification level for any public provider where that level is currently set to AlwaysVerifiable. To accomplish this task, the command first calls Get-CsPublicProvider to return a collection of all the public providers currently configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those providers where the VerificationLevel property is equal to (-eq) AlwaysVerifiable. In turn, this filtered collection is piped to Set-CsPublicProvider, which changes the VerificationLevel for each provider in the collection to UseSourceVerification.