Update-SPDataRetrievalServiceConfig
This cmdlet configures settings for data retrieval services.
Syntax
WebApplication
Update-SPDataRetrievalServiceConfig
[-WebApplication] <SPWebApplicationPipeBind>
[-Inherit]
[-Enable <Boolean>]
[-LimitResponseSize <Int32>]
[-EnableUpdateSupport <Boolean>]
[-DataSourceTimeout <Int32>]
[-EnableDataSourceControls <Boolean>]
[-AssignmentCollection <SPAssignmentCollection>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Farm
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
Applicable: SharePoint Server Subscription Edition
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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Applicable: SharePoint Server Subscription Edition
Prompts you for confirmation before executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DataSourceTimeout
Applicable: SharePoint Server Subscription Edition
Set the response timeout in second.
This setting applies to the following data retrieval services:
OLEDB/
SOAP Passthrough
XML-URL
SoapDataSource
XmlUrlDataSource
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Enable
Applicable: SharePoint Server Subscription Edition
@{Text=}
Parameter properties
| Type: | Boolean |
| Default value: | True |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableDataSourceControls
Applicable: SharePoint Server Subscription Edition
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
Parameter properties
| Type: | Boolean |
| Default value: | True |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableUpdateSupport
Applicable: SharePoint Server Subscription Edition
Enable or disable the support for update queries.
This setting applies to the following data retrieval services:
OLEDB
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Farm
Applicable: SharePoint Server Subscription Edition
Apply the setting to the farm, and to all the SharePoint Web applications inherit the config.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Farm
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Inherit
Applicable: SharePoint Server Subscription Edition
Set whether inherit the global setting of the farm.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
WebApplication
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LimitResponseSize
Applicable: SharePoint Server Subscription Edition
The maximum size of the SOAP response that the data source returns to the data retrieval service, specified by kilobytes(KB).
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WebApplication
Applicable: SharePoint Server Subscription Edition
Apply the setting to the specified SharePoint Web application.
Parameter properties
| Type: | SPWebApplicationPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
WebApplication
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Applicable: SharePoint Server Subscription Edition
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.