Set-SPExcelDataProvider
Sets properties of a safe data provider for Excel Services Application.
Syntax
Default (Default)
Set-SPExcelDataProvider
[-Identity] <SPExcelDataProviderPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-Description <String>]
[-ProviderId <String>]
[-ProviderType <DataProviderType>]
[-WhatIf]
[<CommonParameters>]
Description
The Set-SPExcelDataProvider cmdlet sets the properties of a data provider that is stored in the list of safe data providers.
Excel Services Application refreshes external data connections only if the data provider for that connection is in the list of safe data providers.
Excel Services Application include a set of common data providers in this list.
Therefore, using cmdlets to modify safe data providers is typically an operation of custom data connection scenarios.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
EXAMPLE
$provider = Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataProvider | where {$_.ProviderID -eq "SQLOLEDB" }
Set-SPExcelDataProvider $provider -Description "The SQLOLEDB provider description has changed."
$provider | format-table
This example retrieves the SQLOLEDB data provider from the list of safe data providers that is on the Excel Services Application Web service application named MyExcelService, as an object, adds a new display description and then displays the provider output in a Command Prompt window, formatted as a table.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2010, SharePoint Server 2013
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 2010, SharePoint Server 2013
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
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 |
-Description
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies a display description for the data provider.
The type must a valid a string; for example, this is a custom OLEDB provider.
Parameter properties
| Type: | String |
| 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 |
-Identity
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the SPExcelDataProvider object to update.
The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SPExcelDataProvider object.
Parameter properties
| Type: | SPExcelDataProviderPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProviderId
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the name of the data provider. This ID should be present in the connection strings generated by this data provider and the ID must be unique for the data provider type.
The type must a valid name of a provider; for example, CustomOLEDB.
Parameter properties
| Type: | String |
| 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 |
-ProviderType
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the supported type of the data provider to set.
The type must be one of the following: OleDb, Odbc, or OdbcDsn.
Parameter properties
| Type: | DataProviderType |
| 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 |
-WhatIf
Applicable: SharePoint Server 2010, SharePoint Server 2013
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
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.