Get-SPEnterpriseSearchMetadataCrawledProperty
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Returns a crawled property.
Syntax
Get-SPEnterpriseSearchMetadataCrawledProperty [[-Name] <String>] -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Category <CategoryPipeBind>] [-Limit <String>] [-PropSet <Nullable>] [-VariantType <Nullable>]
Detailed Description
The Get-SPEnterpriseSearchMetadataCrawledProperty cmdlet reads a CrawledProperty object when the crawled category is created, updated, or deleted. Run this cmdlet when the search functionality is initially configured 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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Name |
Optional |
System.String |
Specifies the crawled property to get. The type must be a valid name of a metadata category; for example, MetadataCategory1. |
SearchApplication |
Required |
Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind |
Specifies the search application that contains the crawled property. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; 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 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 |
Filters to return crawled properties for the specified crawled property category. 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 |
Specified the maximum number of items to return. Specify ALL to return all possible results. |
PropSet |
Optional |
System.Nullable |
Filters to return crawled properties with the specified property set. The type must be a valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh. |
VariantType |
Optional |
System.Nullable |
Filters to return crawled properties with the specified variant type. The type must be an integer that specifies the variant data type of the property set. |
Input Types
Return Types
Example
------------------EXAMPLE------------------
$searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1"
$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $searchapp -Identity People
Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat
This example returns all crawled properties for the search application SearchApp1 in the People metadata category.