Get-SPExcelDataConnectionLibrary

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Banner stating end of support date for Office 2010 with link to more info

Returns a trusted data connection library or a list of trusted data connection libraries.

Syntax

Get-SPExcelDataConnectionLibrary [[-Identity] <SPExcelDCLPipeBind>] -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>]

Detailed Description

The Get-SPExcelDataConnectionLibrary cmdlet gets a library of data connection files that Excel Services Application and the Excel client use to connect to an external data source. Excel Services Application loads data connection files only if they are stored in a data connection library that is in the list of trusted data connection libraries.

Parameters

Parameter Required Type Description

Identity

Optional

Microsoft.Office.Excel.Server.Cmdlet.SPExcelDCLPipeBind

Specifies the DataConnectionLibrary object to return. If the identity parameter is not specified, this cmdlet returns all the data connection libraries that have connection files that can be loaded by Excel Services Application.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection library (for example, DataConnectionLib1); a valid URL, in the form http://server_name; or an instance of a valid SPExcelDCL object.

ExcelServiceApplication

Required

Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind

Specifies the Excel Services Application Web service application that contains the SPExcelDataConnectionLibrary list object.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

Note

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.

Input Types

Return Types

Example

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

Get-SPExcelserviceapplication -Identity "MyExcelService" | Get-SPExcelDataConnectionLibrary

This example displays all the data connection libraries that connection files can be loaded by an Excel Services Application Web service application.

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

Get-SPExcelserviceapplication -identity "MyExcelService" | Get-SPExcelDataConnectionLibrary | where {$_.Description.Contains("Sales Cube")}

This example displays all the data connection libraries that have descriptions containing the words Sales Cube from the specified Excel Services Application Web service application.