Edit

Set-SPSiteSubscriptionEdiscoveryHub

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Sets properties for the eDiscovery hub of a site subscription.

Syntax

Set-SPSiteSubscriptionEdiscoveryHub
   -Site <SPSitePipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-SearchScope <String>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-SPSiteSubscriptionEdiscoveryHub cmdlet sets global properties and settings for the Ediscovery hub.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

Set-SPSiteSubscriptionEdiscoverySearchScope -Site https://contoso.com/sites/sitecollection1 -SearchScope 1

This example enables the search scope for the entire site subscription. A value of zero (0) disables the search scope across the entire site subscription.

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 executing the command. For more information, type the following command: get-help about_commonparameters

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

-SearchScope

Specifies the name for the search scope. The default value is All Sites.

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

-Site

Specifies the site collection for the Ediscovery hub.

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

-WhatIf

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

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