Get-SPODataConnectionSettingMetadata

Reference

Module:: SharePointServer

Applies to:: SharePoint Server 2013, SharePoint Server 2016

Returns a Business Data Connectivity service metadata object.

Syntax

Get-SPODataConnectionSettingMetadata
   -ServiceContext <SPServiceContextPipeBind>
   -Name <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Description

Use the Get-SPODataConnectionSettingMetaData cmdlet to return a Business Data Connectivity service metadata object for a specific Business Connectivity Services service application.

This cmdlet applies to an on-premises environment only. You cannot use this command in the SharePoint Online Management Shell.

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

Examples

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

Get-SPODataConnectionSettingMetadata -ServiceContext "http://contoso" -Name "ContosoServiceApp"

This example displays metadata properties of BCS connection named ContosoServiceApp

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 2013, SharePoint Server 2016

-Name

Specifies the name of the Business Connectivity Services connection whose metadata properties the user wants to see displayed.

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

-ServiceContext

Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID.

Type:	SPServiceContextPipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016