Set-CsImFilterConfiguration

Syntax

Set-CsImFilterConfiguration
   [[-Identity] <XdsIdentity>]
   [-Action <UrlFilterAction>]
   [-AllowMessage <String>]
   [-BlockFileExtension <Boolean>]
   [-Enabled <Boolean>]
   [-IgnoreLocal <Boolean>]
   [-Prefixes <PSListModifier>]
   [-WarnMessage <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CsImFilterConfiguration
   [-Instance <PSObject>]
   [-Action <UrlFilterAction>]
   [-AllowMessage <String>]
   [-BlockFileExtension <Boolean>]
   [-Enabled <Boolean>]
   [-IgnoreLocal <Boolean>]
   [-Prefixes <PSListModifier>]
   [-WarnMessage <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

When sending instant messages, users can embed a Uniform Resource Identifier (URI) within the text of that message to refer other participants in the conversation to a particular web site or share. Skype for Business Server can be configured so that hyperlinks with certain prefixes are blocked or are not active. (In other words, the participants can't simply click the link and go to the site the URI refers to; they must copy and paste the link manually into a browser.)

The Set-CsImFilterConfiguration cmdlet allows you to modify a list of URI prefixes that will be filtered, in addition to enabling and disabling filtering altogether, either globally or within a specific site. With this cmdlet you can also update various messages that provide warnings to users.

Examples

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

Set-CsImFilterConfiguration -Identity site:Redmond -Enabled $False

The command shown in this example disables URI filtering for the IM filter configuration with the Identity site:Redmond. To carry out this task, the Enabled parameter is specified in the call to the Set-CsImFilterConfiguration cmdlet with a value of $False.

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

$x = Get-CsImFilterConfiguration -Identity site:Redmond

$x.Prefixes.Add("urn:")

Set-CsImFilterConfiguration -Instance $x

Example 2 adds a new URI prefix (urn:) to the list of prefixes prohibited by the IM filter configuration for site:Redmond. To add the new prefix, the Get-CsImFilterConfiguration cmdlet is used to retrieve the configuration for site:Redmond; the returned object representing that configuration is stored in a variable named $x. After the settings have been retrieved, the Add() method is called in line 2 to add urn: to the set of prefixes stored in the Prefixes property. This changes the value of the object reference $x. To change the actual configuration itself, line 3 calls the Set-CsImFilterConfiguration cmdlet, passing $x as the sole parameter value.

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

Set-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{add="urn:"}

Example 3 performs the exact same action as Example 2, but it does it in one line. In this command the Prefixes parameter of the Set-CsImFilterConfiguration cmdlet is used to add urn: to the list of prefixes. The add list modifier is used to add this value to the Prefixes list.

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

Set-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{remove="urn:"}

In this example the prefix urn: is removed from the list of prefixes blocked by the IM filter configuration for site:Redmond. This example is identical to Example 3 except that rather than calling the add list modifier to add a prefix to the list, the remove modifier is called to remove a prefix.

Parameters

-Action

-AllowMessage

-BlockFileExtension

-Confirm

-Enabled

-Force

-Identity

-IgnoreLocal

-Instance

-Prefixes

-WarnMessage

-WhatIf

Inputs

Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration object. Accepts pipelined input of IM filter configuration objects.

Outputs

The Set-CsImFilterConfiguration cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration object.

Related Links

• New-CsImFilterConfiguration
• Remove-CsImFilterConfiguration
• Get-CsImFilterConfiguration