Get-SPEnterpriseSearchMetadataManagedProperty

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Returns a managed property.

Syntax

Get-SPEnterpriseSearchMetadataManagedProperty
   [[-Identity] <ManagedPropertyPipeBind>]
   -SearchApplication <SearchServiceApplicationPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Limit <String>]
   [-SiteCollection <Guid>]
   [-Tenant <Guid>]
   [<CommonParameters>]

Description

This cmdlet reads a ManagedProperty object for managed properties that are created or updated.

If the Identity parameter is not specified, this cmdlet returns the managed property collection for the specified search application.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

------------------EXAMPLE------------------

$ssa = Get-SPEnterpriseSearchServiceApplication
Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName

This example retrieves the managed property UserName from the default search service application.

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

-Identity

Specifies the managed property to retrieve.

The type must be a valid name of metadata property, for example MetadataProperty1, or an instance of a valid ManagedProperty object.

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

-Limit

Specifies the maximum number of managed properties to return. Specify ALL to return all possible results.

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

-SearchApplication

Specifies the search application that contains the managed property collection.

The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object.

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

-SiteCollection

Specifies that the managed properties returned are to be within the scope of a site collection (SPSite).

The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh.

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

-Tenant

Specifies that the managed properties returned are to be within the scope of a tenant.