Microsoft.Office.Server.Search.Administration Namespace
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.
Classes
Class | Description | |
---|---|---|
AccountAuthCredentials | Represents an object that contains the credentials used to connect to a federated search location. | |
AdminComponent | Provides access to the Search administration component in Microsoft SharePoint Server 2010 search. | |
AllContentScopeRule | Represents a scope rule that includes all items in the content index. | |
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. | |
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. | |
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. | |
CrawlComponent | Represents a crawl component in the Search service application topology. | |
CrawlComponentCollection | Represents the collection of crawl components associated with a Search service application. | |
CrawledProperty | Represents a crawled property in the SharePoint Enterprise Search metadata property schema. | |
CrawlHistory | Contains statistics for each crawl. | |
CrawlLogFilters | Contains all the filters for manipulating the crawl log data. | |
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. | |
CrawlTopology | Contains the crawl components for a given topology that provide the crawling functionality for a Search service application. | |
CrawlTopologyActivationCanceledException | The exception that is thrown when the crawl topology activation is cancelled. | |
CrawlTopologyActivationException | The exception that is thrown when an error occurs during the activation of the crawl topology for the Search service application. | |
CrawlTopologyCollection | Manages the collection of crawl components and crawl databases in the Search service application’s topology. | |
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. | |
DuplicateLocationException | Represents the exception that is thrown when users attempt to create a duplicate version of a federated search location. | |
EndOfCrawlPropagationTask | Represents the propagation task that occurs at the end of a crawl operation. | |
ExchangePublicFolderContentSource | Represents a content source for Microsoft Exchange Server public folder content. | |
ExtendedConnectorPropertyCollection | Represents a collection of properties of the FAST (Extended) Content Search Service Application connector, which provides custom content to the FAST Search Service. | |
Extension | Represents a file name extension. | |
ExtensionCollection | Represents a collection of Extension objects. | |
FASTAdminProxy | Applies to: Microsoft FAST Search Server 2010 for SharePoint This class provides access to context objects that can be used to access the FAST Search Server 2010 for SharePoint administration services. You need to be part of the FASTSearchAdministrators and/or FASTSearchKeywordAdministrators group(s) to access the contexts. |
|
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. | |
FSAbstractJobDefinitionBase | The base class for all FAST Search Server 2010 for SharePoint specific timer jobs. | |
FSAlternateAccessMapJobDefinition | Timer job that runs per search application and connects to the configured FAST Search Server 2010 for SharePoint farm deployment and fetches all managed properties that has the IsMapped flag set to true. These properties are cached locally and used for alternate access mapping scenarios. | |
FSClickThroughExtractorJobDefinition | Timer job that runs per search application and extracts click through data and exports them to the configured FAST Search Server 2010 for SharePoint farm deployment. The collected click through data is used for relevancy tuning. This timer job runs every day at 01:00 AM by default. | |
FSDictionaryManagementJobDefinition | Timer job that runs per search application and detects dictionary changes done through Central Admin and exports them to the configured FAST Search Server 2010 for SharePoint farm deployment. This timer job runs every five minutes by default. | |
FSMasterJobDefinition | Timer job that runs per search instance and provisions the FAST specific timer jobs. Runs every 15 minutes and provisions timer jobs for newly created service applications. | |
HierarchicalContentSource | Provides the base class for hierarchical content sources. | |
HostDistributionRule | Represents a host distribution rule. | |
HostDistributionRuleCollection | Provides methods to access the collection of the HostDistributionRule objects of the Search service application. | |
IndexPartition | Represents an index partition in the Microsoft SharePoint Server 2010 query architecture. | |
IndexPartitionCollection | Provides a collection that stores the IndexPartition object. | |
IndexPropagationTask | Represents a propagation task that is currently being performed by all query components. | |
IndexRefactoringException | The exception that is thrown when an error occurs during the index refactoring process. | |
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. | |
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. | |
LocationConfiguration | Contains the configuration information for a federated search location. | |
LocationConfigurationCollection | Specifies a collection of LocationConfiguration objects. | |
LogViewer | Obsolete. Represents the top-level object for filtering and viewing data from the SharePoint Enterprise Search crawl log | |
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. | |
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. | |
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. | |
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. | |
PhraseKey | Represents the key to use to look up a mapping string for a specific LanguageResourcePhrase. | |
Propagation | Represents the top-level object for retrieving status information for the propagation system in SharePoint Enterprise Search. | |
PropagationTask | Provides the base class for objects representing propagation tasks. | |
PropertyQueryScopeRule | Represents a scope rule that matches content items based on a property/value comparison. | |
PropertyStore | Represents a property database for the Search service application. | |
PropertyStoreCollection | Represents a collection of property databases in the Search service application’s topology. | |
QueryComponent | Manages an individual query component for a Search service application. | |
QueryComponentCollection | Represents a collection of QueryComponent objects. | |
QueryComponentTransitionException | The exception that is thrown when an error occurs during the transition of a query component. | |
QueryTopology | Represents a set of index partitions, query components, and metadata indexes that work together to satisfy requests for search query operations. | |
QueryTopologyActivationCanceledException | The exception that is thrown when the activation of a query topology is cancelled. | |
QueryTopologyActivationException | The exception that is thrown when a query topology fails to activate. | |
QueryTopologyCollection | Represents and manages a collection of QueryTopology objects. | |
Ranking | Provides an entry point to adjust the settings used for query-independent rank computation for calculating the relevance of search results. | |
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. | |
RemoteScopes | Provides the ability to administer a search Scope on a remote SPFarm. | |
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. | |
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. | |
SearchContext | Obsolete. Represents the search service instance for a Shared Services Provider (SSP). | |
SearchGathererDatabase | Encapsulates the search crawl database. | |
SearchPropertyStoreDatabase | Encapsulates the search property database. | |
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. | |
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. | |
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. | |
UpdatableCollection<Key, T> | Represents the base class for collections with specified value type and key type. | |
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. | |
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. |
Structures
Structure | Description | |
---|---|---|
QueryServer | Obsolete. Represents a query server in the SharePoint Enterprise Search propagation system. |
Interfaces
Interface | Description | |
---|---|---|
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. |
Enumerations
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. | |
Catalog | Specifies the catalogs types for the propagation system in SharePoint Server search. | |
CatalogType | Defines the catalog types for the AddFilter() method of the CrawlLogFilters class. | |
ComponentRole | Specifies the role of the SearchComponent. | |
ContentSourceType | Specifies the types of content sources that can be crawled by the Search service application. | |
CrawlComponentState | Specifies the crawl component state values for the CrawlComponent class. | |
CrawlHistory.CrawlStatus | Obsolete. Specifies all possible crawl stages. These values are used by GetCrawlHistory(CrawlHistory.CrawlStatus) and GetCrawlHistory(Int32, DateTime, DateTime, CrawlHistory.CrawlStatus) to filter the result set. | |
CrawlLogFilterProperty | Defines the crawl log filter properties for the AddFilter() method of the CrawlLogFilters class. | |
CrawlLogSummaryProperty | Defines the summary property types for the GetCrawlSummaryByHost() method of the LogViewer 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. | |
CrawlTopologyState | Specifies the crawl topology state values for the CrawlTopology class. | |
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. | |
FastServiceApplicationProperties | Applies to: Microsoft FAST Search Server 2010 for SharePoint The values represents a key for the configuration properties specific to the FAST Search Server 2010 for SharePoint Content Search Service Application (SSA) and Query Search Service Application. |
|
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. | |
MessageType | Defines the message types for the SharePoint Enterprise Search crawl log. | |
MonthsOfYear | Specifies the month or months of the year for the crawl schedule. | |
PropagationStatus | Defines the global propagation status values for the global propagation system. | |
PropagationTaskType | Defines the types of propagation tasks. | |
ProxyType | Specifies whether the search service uses a proxy server or connects directly when crawling content. | |
QueryComponentPropagationStatus | Specifies the propagation status of a query component. | |
QueryComponentState | Specifies the state of the QueryComponent. | |
QueryComponentTransitionStatus | Specifies the status of the query component transition sequence. | |
QueryServerState | Obsolete. This member is reserved for internal use and is not intended to be used directly from your code. | |
QueryTopologyState | Specifies the query topology state for the QueryTopology class. | |
RankingUpdateStatus | Defines the ranking update status values for the Status property of the Ranking class. | |
RankingUpdateType | Defines the different ranking update types the search component performs. | |
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 | |
SearchPerformanceLevel | Specifies the performance level of the SharePoint Enterprise Search service. | |
SearchServiceApplicationFaultType | Enumerates the types of the SearchServiceApplicationFault. | |
SearchServiceApplicationType | Specifies the types of SearchServiceApplication. | |
ServerPropagationStatus | Obsolete. Defines the propagation status values for a Query server. | |
SharePointCrawlBehavior | Specifies crawl settings for a SharePointContentSource object. | |
SiteHitRuleBehavior | Defines the site hit rule types. | |
StringFilterOperator | Defines the string filter operators for the CrawlLogFilters class. | |
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. |