New-SPAudienceRule

Create a new audience in the specified user profile service application.

New-SPAudienceRule -UserProfileServiceApplication <SPServiceApplicationPipeBind> [-SiteSubscription [<SPSiteSubscriptionPipeBind>]] -Identity <String> [-Clear [<SwitchParameter>]] [-GroupExisting [<SwitchParameter>]] [-Compile [<SwitchParameter>]] -Rules <XmlDocument> [-AppendOperator [<Nullable`1>]] [-AssignmentCollection [<SPAssignmentCollection>]]

New-SPAudienceRule -ContextSite <SPSitePipeBind> -Identity <String> [-Clear [<SwitchParameter>]] [-GroupExisting [<SwitchParameter>]] [-Compile [<SwitchParameter>]] -Rules <XmlDocument> [-AppendOperator [<Nullable`1>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

1

ParameterRequiredTypeDescription
UserProfileServiceApplicationTrueSPServiceApplicationPipeBind

Specifies the service application that contains the audience to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, ServiceApp1); or an instance of a valid SPServiceApplication object.

SiteSubscriptionFalseSPSiteSubscriptionPipeBind

Specifies the site subscription containing the audiences to update.

The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object.

IdentityTrueString

The name of the audience to update.

ClearFalseSwitchParameter

Clear existing rules.

GroupExistingFalseSwitchParameter

Wraps any existing rules in parantheses.

CompileFalseSwitchParameter

Compile the audiences after update.

RulesTrueXmlDocument

The rules XML should be in the following format: <rules><rule op='' field='' value='' /></rules>

Values for the "op" attribute can be any of "=,>,>=,<,<=,<>,Contains,Not contains,Reports Under,Member Of,AND,OR,(,)"

The "field" attribute is not required if "op" is any of "Reports Under,Member Of,AND,OR,(,)"

The "value" attribute is not required if "op" is any of "AND,OR,(,)"

Note that if your rules contain any grouping or mixed logic then you will not be able to manage the rule via the browser.

Example: <rules><rule op='Member of' value='sales department' /><rule op='AND' /><rule op='Contains' field='Department' value='Sales' /></rules>

AppendOperatorFalseNullable`1

Operator used to append to existing rules. Valid values are AND or OR. Default is AND

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

2

ParameterRequiredTypeDescription
ContextSiteTrueSPSitePipeBind

Specifies the URL or GUID of the Site to use for retrieving the service context. Use this parameter when the service application is not associated with the default proxy group or more than one custom proxy groups.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.

IdentityTrueString

The name of the audience to update.

ClearFalseSwitchParameter

Clear existing rules.

GroupExistingFalseSwitchParameter

Wraps any existing rules in parantheses.

CompileFalseSwitchParameter

Compile the audiences after update.

RulesTrueXmlDocument

The rules XML should be in the following format: <rules><rule op='' field='' value='' /></rules>

Values for the "op" attribute can be any of "=,>,>=,<,<=,<>,Contains,Not contains,Reports Under,Member Of,AND,OR,(,)"

The "field" attribute is not required if "op" is any of "Reports Under,Member Of,AND,OR,(,)"

The "value" attribute is not required if "op" is any of "AND,OR,(,)"

Note that if your rules contain any grouping or mixed logic then you will not be able to manage the rule via the browser.

Example: <rules><rule op='Member of' value='sales department' /><rule op='AND' /><rule op='Contains' field='Department' value='Sales' /></rules>

AppendOperatorFalseNullable`1

Operator used to append to existing rules. Valid values are AND or OR. Default is AND

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Detailed Description

Create a new audience in the specified user profile service application.

Copyright 2016 Falchion Consulting, LLC

> For more information on this cmdlet and others:

> http://blog.falchionconsulting.com/

> Use of this cmdlet is at your own risk.

> Gary Lapointe assumes no liability.

Examples

------------------EXAMPLE------------------

PS C:\> [xml]$rules = "<rules><rule op='Member of' value='sales department' /><rule op='AND' /><rule op='Contains' field='Department' value='Human Resources' /></rules>"
PS C:\> New-SPAudienceRule -UserProfileServiceApplication "30daa535-b0fe-4d10-84b0-fb04029d161a" -Identity "Human Resources" -Clear -Compile" -Rules $rules

This example adds a new rule to the audience named "Human Resources" in the user profile service application with ID "30daa535-b0fe-4d10-84b0-fb04029d161a".