Microsoft.Office.Server.Search.Administration namespace
SharePoint 2013
Provides administrative types and members for managing a Shared Service Provider's instance of SharePoint Enterprise Search.
For information about programming with the SharePoint Enterprise Search Administration object model, see Getting Started with the SharePoint Server Search Administration Object Model.
| Class | Description | |
|---|---|---|
 | AccountAuthCredentials | Represents an object that contains the credentials used to connect to a federated search location. |
| AliasInfo | This class represents a managed property alias in the Search schema. |
| AliasInfoCollection | This class represents a collection of managed property aliases in the Search schema. |
| AllContentScopeRule | Represents a scope rule that includes all items in the content index. |
| AnalyticsReportingStore | |
| AnalyticsReportingStoreCollection | |
| AttributeException | The exception that is thrown when an error occurs while accessing classes that inherit from Attribute. |
| AuthenticationData | Provides the base class for the objects containing the authentication data that is used to connect to federated search locations. |
| AuthenticationInformation | Provides access to the authentication information used to connect to a federated search location. |
| AuthorityPage | Represents an authoritative page for SharePoint Server search. |
| AuthorityPageCollection | Represents a collection of AuthorityPage objects. |
| BaseInfo | This class is a base class for all information objects of the Search schema. |
| BaseInfoCollection<T> | This class is a base class for all collection of information objects of the Search schema. |
| BestBet | Represents a best bet in the SharePoint Server search keyword and best bet management system. |
| BestBetCollection | Represents a collection of BestBet objects. |
| BestBetsEnumerator | Supports iterating over a BestBetCollection and reading its individual BestBet objects. |
| BusinessDataContentSource | Represents a content source for Business Data Connectivity (BDC) service content. |
| CategoriesEnumerator | Supports iterating over a CategoryCollection object and reading its individual Category objects. |
| Category | Represents a category in the SharePoint Server search metadata property schema. |
| CategoryCollection | Represents a collection of Category objects. |
| CategoryInfo | This class represents a crawled property category in the Search schema. |
| CategoryInfoCollection | This class represents a collection of categories in the Search schema. |
| ConcurrencyException | Represents the exception that is thrown when multiple users attempt to modify data at the same time. |
| ConsumerInfo | Represents information about search scope consumers, search scope display groups, and search scopes. |
| ConsumerInformation | Provides the information that represents a unit of the level of SPSite administration. |
| Content | Represents the top-level object for administration of the content sources for a Search service application. |
| ContentSource | Provides the base class for all content sources. |
| ContentSourceCollection | Represents a collection of ContentSource objects. |
| CookieAuthData | Represents an object that contains authentication data used to connect to federated search locations that are configured to use cookie-based authentication. |
| CouldNotModifySchemaException | Thrown whenever there was an error modifying a schema. |
| CrawlDatabaseInfo | |
| CrawlDatabasePartitionInfo | |
| CrawledProperty | Represents a crawled property in the SharePoint Enterprise Search metadata property schema. |
| CrawledPropertyInfo | This class represents a crawled property in the Search schema. |
| CrawledPropertyInfoCollection | This class represents a collection of crawled properties in the Search schema. |
| CrawlLog | The CrawlLog class provides an API for obtaining information about a search service application's crawled content. |
| CrawlMapping | Represents a gatherer crawl mapping. |
| CrawlMappingCollection | Represents a collection of CrawlMapping objects. |
| CrawlRule | Represents a crawl rule. |
| CrawlRuleCollection | Represents a collection of CrawlRule objects. |
| CrawlStore | Represents a crawl database for the Search service application. |
| CrawlStoreCollection | Represents a collection of crawl databases. |
| CrawlStorePartitionManager | This class is intended to be used in PowerShell and other admin-created C# applications for two purposes: 1. To rebalance crawl stores. 2. To move data out of crawl stores in preparation for delete. Both of these operations are potentially long-running, on the order of hours, depending on the amount of data that needs to be moved. Because of this, these operations are both asynchronous. The general pattern of use for this class is to call one of the 'Begin...' methods which will start the operation and return the Guid that identifies your job. Then, poll the 'Completed' method until it return 'true'. When you are moving data out of crawl stores in preparation to delete them, you should absolutely verify the state of your crawl stores (via the CrawlLog class) to ensure that the crawl stores are indeed empty before deleting them. |
| CustomConnector | Allows SharePoint Server search to connect to and crawl custom content repositories that are not supported by Microsoft Business Connectivity Services (BCS). |
| CustomConnectorContentSource | Represents a content source for external FAST Search Server 2010 for SharePoint and SharePoint Server search data sources. |
| CustomContentSource | Represents a custom content source. |
| DailySchedule | Represents a crawl schedule used to specify the number of days between crawls. |
| DatabaseException | Represents the exception that is thrown when a database error occurs while working with the objects in the Administration namespace. |
| DeletedConcurrencyException | Represents the exception that is thrown when the object that is the target of a delete operation is updated by another user after the database record was last retrieved. |
| DemotedSite | Represents a demoted site for SharePoint Server search. |
| DemotedSiteCollection | Represents a collection of DemotedSite objects. |
| DisplayGroupInfo | Represents information about a search ScopeDisplayGroup. |
| DisplayGroupMembership | Represents the relationship of information between the search Scope and the search ScopeDisplayGroup. |
| DocumentCrawlLog | |
| DocumentParserFileFormat | Representation of a file format supported by the document parser. |
| DocumentParserFileFormatState | Parsing status of a file format. |
| DuplicateLocationException | Represents the exception that is thrown when users attempt to create a duplicate version of a federated search location. |
| ExchangePublicFolderContentSource | Represents a content source for Microsoft Exchange Server public folder content. |
| Extension | Represents a file name extension. |
| ExtensionCollection | Represents a collection of Extension objects. |
| FileShareContentSource | Represents a content source for file share content. |
| FormsAuthCredentials | Represents an object that contains the forms authentication credentials for connecting to federated search locations. |
| HierarchicalContentSource | Provides the base class for hierarchical content sources. |
| InvalidAccountException | Indicates that the account name for the SharePoint Enterprise Search service is invalid or does not exist, or the password is invalid for the account name. |
| InvalidCanaryException | Represents an exception that is thrown when the form digest request is not valid. |
| InvalidManagedPropertyValue | Thrown when a managed property is given an invalid value. |
| InvalidMappingException | Thrown when a invalid mapping is found. |
| InvalidNameException | Thrown when a category, crawled property or managed property is given an invalid name. |
| InvalidPropertyTypeException | Thrown when a managed property is given an invalid type. |
| Keyword | Represents a keyword in the SharePoint Enterprise Search keyword and best bet management system. |
| KeywordCollection | Represents a collection of Keyword objects. |
| Keywords | Represents the top-level object for managing keywords and best bets in SharePoint Enterprise Search. |
| KeywordsEnumerator | Supports iterating over a KeywordCollection and reading its individual Keyword objects. |
| LanguageResource | Provides a set of LanguageResourcePhraseList objects in which to store the language resource phrases and their mappings. |
| LanguageResourcePhrase | Represents a language resource phrase that is used to enhance the effectiveness of the search. |
| LanguageResourcePhraseList | Represents the list of language resource phrases used to enhance the effectiveness of a search. |
| LanguageResourcesCollection | Represents a collection of language resources. |
| LinguisticComponentsStatusProperties | A class wrapping all properties for the activation status of the linguistic components. The properties are read from and written to the Juno nodes as a DLL that can be accessed like other flow resources. |
| LinksStore | |
| LinksStoreCollection | |
| LinksStoreSettingsBase<T> | |
| LinksStoresRefactoring | |
| LocationConfiguration | Contains the configuration information for a federated search location. |
| LocationConfigurationCollection | Specifies a collection of LocationConfiguration objects. |
| LotusNotesContentSource | Represents a content source for Lotus Notes content. |
| ManagedProperty | Represents a managed property in the SharePoint Server search metadata property schema. |
| ManagedPropertyCollection | Represents a collection of ManagedProperty objects. |
| ManagedPropertyInfo | Represents information about a managed property in the SharePoint Server search. |
| ManagedPropertyInfoCollection | This class represents a collection of managed properties in the Search schema. |
| Mapping | Represents a crawled property mapping to a managed property in the SharePoint Server search metadata property schema. |
| MappingCollection | Represents a collection of Mapping objects. |
| MappingInfo | This class represents a managed property mapping in the Search schema. |
| MappingInfoCollection | This class represents a collection of managed property mappings in the Search schema. |
| MetadataServiceNotificationHandler | |
| MonthlyDateSchedule | Represents a crawl schedule used to specify the days of the month, and months of the year, when the crawl should occur. |
| MonthlyDayOfWeekSchedule | Represents a crawl schedule used to specify the days of the month, the weeks of the month, and the months of the year when the crawl should occur. |
| ObjectNotFoundException | Thrown when an object (category, crawled property or managed property) could not be found. |
| OOTBSchemaInformation | |
| OpenSearchDescription | This member is reserved for internal use and is not intended to be used directly from your code. |
| OpenSearchExtension | This member is reserved for internal use and is not intended to be used directly from your code. |
| OverrideInfo | This class represents a managed property override in the Search schema. |
| OverrideInfoCollection | This class represents a collection of managed property overrides in the Search schema. |
| PhraseKey | Represents the key to use to look up a mapping string for a specific LanguageResourcePhrase. |
| PropertyCannotHaveMappingsException | Thrown when mappings are added/modified or deleted from a managed property that is defined not to have any mappings. |
| PropertyIsReadOnlyException | Thrown before a read only managed property is modified. |
| PropertyQueryScopeRule | Represents a scope rule that matches content items based on a property/value comparison. |
| PropertyRule | |
| PropertyRule.MappedPropertyRules | |
| PropertyRuleCollection | |
| PropertyRuleOperator | |
| QueryConfigurationImportException | |
| QueryLogPageImpressionBlockFeatures | |
| QuerySpellingCorrectionProperties | A class wrapping all query spelling correction properties. The properties are read from and written to Ceres as a DLL that can be accessed like other flow resources. |
| Ranking | Provides an entry point to adjust the settings used for query-independent rank computation for calculating the relevance of search results. |
| RankingFeature | |
| RankingManager | |
| RankingModel | Defines a ranking model for search queries. |
| RankingModelCollection | Represents a collection of ranking models for a Search service application. |
| RankingParameter | Represents a ranking parameter used for rank computation in SharePoint Server search. |
| RankParamCollection | Represents a collection of RankingParameter objects. |
| RecommendationsProperties | A class wrapping all properties for the activation status of the recommendations properties The properties are read from and written to the Juno nodes as a DLL that can be accessed like other flow resources. |
| RefinementCategory | |
| RefinerConfiguration | Represents the refiner configuration containing refiner settings for the managed property. |
| RemoteRanking | |
| RemoteScopes | Provides the ability to administer a search Scope on a remote SPFarm. |
| ResultItemType | |
| ResultItemTypeManager | |
| RuleInfo | Represents information about a ScopeRule. |
| Schedule | Provides the base class for SharePoint Enterprise Search crawl schedules. |
| Schema | Provides access to the property metadata management system for SharePoint Server search. |
| SchemaException | A superclass for all exceptions thrown by schema related functionality. |
| SchemaExportException | Thrown when a schema cannot be exported. |
| SchemaImportException | Thrown when a schema cannot be imported. |
| Scope | Represents a search scope in SharePoint Server search. |
| ScopeCollection | Represents a collection of Scope objects. |
| ScopeDisplayGroup | Represents a scope display group. |
| ScopeDisplayGroupCollection | Represents a collection of ScopeDisplayGroup objects. |
| ScopeDisplayGroupEnumerator | Supports iterating over a ScopeCollection object and reading its individual Scope objects. |
| ScopeDisplayGroupsEnumerator | Supports iterating over a ScopeDisplayGroupsCollection object and reading its individual ScopeDisplayGroup objects. |
| ScopeInfo | Represents information about a search scope. |
| ScopeRule | Provides the base class for all SharePoint Enterprise Search scope rules. |
| ScopeRuleCollection | Represents a collection of scope rules. |
| ScopeRulesEnumerator | Supports iterating over a ScopeRuleCollection object and reading its individual ScopeRule objects. |
| Scopes | Provides access to the search scope management system for SharePoint Enterprise Search. |
| ScopesManager | Defines the functionality to administer Search scopes in a farm. |
| ScopesManagerInfo | Represents a group of global settings for the search Scopes system in a Search application. |
| SearchAdminDatabase | Encapsulates the search administration database. |
| SearchAdminWebServiceInstance | Represents an instance of a Search administration Web service that runs on a server. |
| SearchAnalyticsReportingDatabase | |
| SearchContext | Obsolete. Represents the search service instance for a Shared Services Provider (SSP). |
| SearchGathererDatabase | Encapsulates the search crawl database. |
| SearchLinksDatabase | |
| SearchObjectFilter | |
| SearchObjectOwner | |
| SearchProvisionUtils | |
| SearchProxyInfo | Represents the HTTP proxy configuration information of a Search service application. |
| SearchQueryAndSiteSettingsService | Represents the search query and site settings service. |
| SearchQueryAndSiteSettingsServiceInstance | Represents an instance of the SearchQueryAndSiteSettingsService that is installed on a single server in a server farm. |
| SearchQueryAndSiteSettingsServiceProxy | Represents a SPIisWebServiceProxy for the SearchQueryAndSiteSettingsService in a server farm. |
| SearchRuntimeService | Represents the Search Runtime (Host Controller) service. |
| SearchRuntimeServiceInstance | |
| SearchService | Represents an instance of the search service. |
| SearchServiceApplication | Provides an SPIisWebServiceApplication that allows for administration and management of Search components on a server. |
| SearchServiceApplicationFault | Represents a Windows Communication Foundation (WCF) fault that is raised by the SearchServiceApplication. |
| SearchServiceApplicationProxy | Represents a Search service application proxy. |
| SearchServiceInstance | Represents an instance of the search index and query service. |
| SearchServiceProxy | Represents a search service proxy installed in a server farm. |
| SecurableAuthData | Represents an object that contains credentials used to connect to federated search locations. Provides the base class for the FormsAuthCredentials class. |
| SharePointContentSource | Represents a content source for Windows SharePoint Services 3.0 content. |
| SiteHitRule | Represents a site hit rule, which is used by the SharePoint Enterprise Search index engine to determine how many simultaneous requests are allowed, and the time interval between sequential requests, for a specified server. |
| SiteHitRulesCollection | Specifies a prioritized collection of SiteHitRule objects. |
| SiteSettings | upgrades best bet keywords from SS14 and FS14 to the keyword rules with best bet actions |
| SsoAuthData | Provides information about the single sign-on (SSO) provider for the credentials used to connect to the federated location. |
| StartAddressCollection | A collection of start addresses for a content source. |
| Synonym | Represents a synonym in the SharePoint Enterprise Search keyword and best bet management system. |
| SynonymCollection | Represents a collection of Synonym objects. |
| SynonymsEnumerator | Supports iterating over a SynonymCollection and reading its individual Synonym objects. |
| TenantSiteCollectionMismatchException | Thrown when a schema is found with an inconsistent tenant/site collection pair. |
| TopicPagesContentSource | |
| UpdatedConcurrencyException | Represents the exception that is thrown when the object that is the target of an update operation is updated by another user after the database record was last retrieved. |
| UrlMappingConstants | |
| UrlScopeRule | Represents a scope rule that matches content items based on the display URL of the item. |
| UserPreference | Provides methods to access the Search user preference. |
| UserPreferenceSerializeHelper | Provides functionality to serialize the Search preferences associated with a user. |
| Visualization | Specifies the display format for the federated search location results. |
| VolatileScopesManagerInfo | Represents the information that is likely to change for a Search scopes system in the Search application. |
| WebContentSource | Represents a content source for Web content. |
| WeeklySchedule | Represents a crawl schedule used to specify the number of weeks between crawls. |
| Interface | Description | |
|---|---|---|
 | IInternalSearchServiceApplication | This interface declares methods that are defined in SearchServiceApplication, but not exposed in SearchServiceApplicationProxy. |
| ISchemaOperations | This class defines an interface for interacting with the Enterprise Search metadata property schema. |
| ISearchServiceApplication | Defines common functionality for applications that provide Search services on a server. |
| ISearchSiteAdministrationServiceApplication | Defines common functionality to a Search service application for administering and managing Search components on a server. |
| Enumeration | Description | |
|---|---|---|
 | AuthorityPageStatus | Defines the authority page status values for the Status property of the AuthorityPage class. |
| BestBetFilter | Defines the filter types available for the GetFilteredBestBets() method of the Keywords class. |
| BuiltInScopeIndex | Specifies the index of the built-in search Scope. |
| ComponentRole | Specifies the role of the SearchComponent. |
| ContentSourceType | Specifies the types of content sources that can be crawled by the Search service application. |
| ContinuousCrawlStatus | |
| CrawlComponentState | Specifies the crawl component state values for the CrawlComponent class. |
| CrawlPriority | Specifies the priorities for crawling the content sources in the Search service application. |
| CrawlRuleAuthenticationType | Specifies the format in which authentication credentials are provided to the crawl rule. |
| CrawlRuleType | Specifies the crawl rule types which indicate whether the crawl rule is used to include or exclude content items in the content index. |
| CrawlStatus | Defines the crawl status values for the CrawlStatus() method of the ContentSource class. |
| CrawlType | |
| DataMoveType | |
| DaysOfMonth | Specifies the day or days of the month for the crawl schedule. |
| DaysOfWeek | Specifies the day or days of the week for the crawl schedule. |
| FederationAuthType | Specifies the supported authentication protocols for connecting to federated search locations. |
| KeywordFilter | Defines the filter types that are available for the GetFilteredKeywords() method of the Keywords class. |
| KeywordView | Defines the keyword views that are available for the GetFilteredKeywords() method of the Keywords class. |
| LanguageResourceType | Defines the language resource phrase types. |
| LocationType | Specifies the type of federated search location. |
| ManagedDataType | Defines the managed property data types supported in the SharePoint Enterprise Search schema. |
| MonthsOfYear | Specifies the month or months of the year for the crawl schedule. |
| PartitionChangeType | Mutually-exclusive partition change types. Only one of these can be executing at any given time for a particular search service application. |
| PropertyRuleOperator.DefaultOperator | |
| ProxyType | Specifies whether the search service uses a proxy server or connects directly when crawling content. |
| RankingFilter | |
| RankingUpdateType | Defines the different ranking update types the search component performs. |
| RefinerAnchoring | Specifies the anchoring settings for managed property refiners. Anchoring is applicable only for managed properties of type Text. |
| RefinerType | The type of refiner created for a managed property. |
| RefreshCrawls | |
| Role | Specifies the role of the search service. |
| RuleType | Specifies the type of scope rules in SharePoint Server search. |
| ScopeCompilationState | Defines the scope compilation state values. |
| ScopeCompilationType | Defines the scope compilation types. |
| ScopeRuleFilterBehavior | Defines the scope rule filter types. |
| ScopeRuleType | Defines the types of scope rules in SharePoint Enterprise Search. |
| ScopesCompilationScheduleType | Defines the scope compilation schedule types. |
| ScopesCompilationState | Defines the scopes compilation state values for the CompilationState() property of the Scopes class |
| SearchObjectLevel | Providee an enumeration of the possible SharePoint levels a search object might be associated with. |
| SearchPerformanceLevel | Specifies the performance level of the SharePoint Enterprise Search service. |
| SearchServiceApplicationFaultType | Enumerates the types of the SearchServiceApplicationFault. |
| SharePointCrawlBehavior | Specifies crawl settings for a SharePointContentSource object. |
| SiteHitRuleBehavior | Defines the site hit rule types. |
| SiteSettingsUpgradeStatus | |
| SortableType | The type of sort info created for a managed property. |
| SpellingDictionaryType | The type of dictionaries used for spellchecking |
| UrlScopeRuleType | Specifies the URL scope rule type. |
| UserPreference.Settings | Specifies the setting for a Search user preference. |
| WeeksOfMonth | Specifies the week or weeks of the month for the crawl schedule. |
