Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-SPEnterpriseSearchMetadataCrawledProperty

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard | SharePoint Foundation 2013 

Returns a crawled property.

Get-SPEnterpriseSearchMetadataCrawledProperty [[-Name] <String>] -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Category <CategoryPipeBind>] [-Limit <String>] [-PropSet <Nullable>] [-SiteCollection <Guid>] [-Tenant <Guid>] [-VariantType <Nullable>]

Parameters

Parameter Required Type Description

Name

Optional

System.String

Specifies the crawled property to retrieve.

The type must be a valid crawled property name, for example “urn:schemas-microsoft-com:sharepoint:portal:profile:UserName”

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application that contains the crawled property.

The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication 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 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.

Category

Optional

Microsoft.Office.Server.Search.Cmdlet.CategoryPipeBind

Specifies the metadata category of the crawled property to return.

The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object.

Limit

Optional

System.String

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

PropSet

Optional

System.Nullable

Specifies to return crawled properties that use the specified property set. A property set belongs to one crawled property category.

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

SiteCollection

Optional

System.Guid

Specifies that the crawled 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.

Tenant

Optional

System.Guid

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

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

VariantType

Optional

System.Nullable

Specifies to return crawled properties that use the specified variant type.

The type must be an integer that specifies the variant data type of the property set.

Detailed Description

This cmdlet reads a CrawledProperty object for a crawled property that was created or updated. You should run this cmdlet when the search functionality is configured for the first time, and after new crawled properties are discovered during a crawl. If the Name parameter is not specified, this cmdlet returns all crawled properties for the specified category for the specified search application. If neither the Name nor the Category parameter is specified, this cmdlet returns all crawled properties for the specified search application.

Input Types

Return Types

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

$searchapp = Get-SPEnterpriseSearchServiceApplication
$cat = Get-SPEnterpriseSearchMetadataCategory –SearchApplication $searchapp –Identity People

Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat –Limit 1

This example returns the first crawled property in the PeopleSearch_Scope metadata category for the default search service application.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.