Update-SPDataRetrievalServiceConfig

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

This cmdlet configures settings for data retrieval services.

Syntax

Update-SPDataRetrievalServiceConfig
      [-WebApplication] <SPWebApplicationPipeBind>
      [-Inherit]
      [-Enable <Boolean>]
      [-LimitResponseSize <Int32>]
      [-EnableUpdateSupport <Boolean>]
      [-DataSourceTimeout <Int32>]
      [-EnableDataSourceControls <Boolean>]
      [-AssignmentCollection <SPAssignmentCollection>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-SPDataRetrievalServiceConfig
      [-Farm]
      [-Enable <Boolean>]
      [-LimitResponseSize <Int32>]
      [-EnableUpdateSupport <Boolean>]
      [-DataSourceTimeout <Int32>]
      [-EnableDataSourceControls <Boolean>]
      [-AssignmentCollection <SPAssignmentCollection>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810).

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715).

Examples

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

Update-SPDataRetrievalServiceConfig -Farm -Enable $false

This example turns off the data retrieval service for the farm.

-------------EXAMPLE 2-------------

Update-SPDataRetrievalServiceConfig -WebApplication http://MyOfficeApp1 -Inherit

This example enables the Web application, MyOfficeApp1, to inherit the global settings.

-------------EXAMPLE 3-------------

Update-SPDataRetrievalServiceConfig -WebApplication http://MyOfficeApp1 -Enable $false

This example turns off the data retrieval service for the Web application, MyOfficeApp1.

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.

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

-DataSourceTimeout

Set the response timeout in second.

This setting applies to the following data retrieval services:

OLEDB/

SOAP Passthrough

XML-URL

SoapDataSource

XmlUrlDataSource

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

-Enable

@{Text=}

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

-EnableDataSourceControls

Enable or disable the set of data source controls on this server.

This setting applies to the following data source controls:

SPXmlDataSource

XmlUrlDataSource

SoapDataSource

AggregateDataSource

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

-EnableUpdateSupport

Enable or disable the support for update queries.

This setting applies to the following data retrieval services:

OLEDB

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

-Farm

Apply the setting to the farm, and to all the SharePoint Web applications inherit the config.

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

-Inherit

Set whether inherit the global setting of the farm.

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

-LimitResponseSize

The maximum size of the SOAP response that the data source returns to the data retrieval service, specified by kilobytes(KB).

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

-WebApplication

Apply the setting to the specified SharePoint Web application.

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

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

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