Add-SPPeoplePickerDistributionListSearchDomain

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

This cmdlet adds a domain to the People Picker distribution list search domains.

Syntax

Add-SPPeoplePickerDistributionListSearchDomain
   -WebApplication <SPWebApplicationPipeBind>
   -DomainName <String>
   [-Index <Int32>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The list of distribution list search domain restricts the search of a distribution list to a specific subset of domains. This Add-SPPeoplePickerDistributionListSearchDomain cmdlet adds a domain to the distribution list search domain list.

Examples

-------------EXAMPLE 1-------------

Add-SPPeoplePickerDistributionListSearchDomain -WebApplication http://MyOfficeApp1 -DomainName "corp.contoso.com" -Index 2

This example inserts domain "corp.contoso.com" to the distribution list search domain list of Web application MyOfficeApp1 at position 2. If the length of the list was less than 2 before the insert, an exception will be thrown.

Parameters

-AssignmentCollection

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.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-DomainName

The domain name to add in the list.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Index

The position to insert the domain in the list begin from 0.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WebApplication

The Web application to modify the distribution list search domain list to.

Type:	SPWebApplicationPipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Share via