SearchServiceApplication Members

Include Protected Members
Include Inherited Members

Provides an SPIisWebServiceApplication that allows for administration and management of Search components on a server.

The SearchServiceApplication type exposes the following members.

Constructors

	Name	Description
	SearchServiceApplication	Initializes a new instance of the SearchServiceApplication class.

Top

Properties

	Name	Description
	AccessRights	(Inherited from SPIisWebServiceApplication.)
	AdminComponent	Gets the component that provides the ability to administer the SearchServiceApplication.
	AdministrationAccessRights	(Inherited from SPServiceApplication.)
	AlertNotificationFormat	Gets or sets the e-mail format of the alert.
	AlertNotificationQuota	Gets or sets the quota of the alerts for the current SearchServiceApplication.
	AlertsEnabled	Gets or sets a value that indicates whether alerts are enabled in the current SearchServiceApplication.
	ApplicationClassId	Gets the GUID that represents the SearchServiceApplication class ID. (Overrides SPServiceApplication.ApplicationClassId.)
	ApplicationName	Gets the name of the SearchServiceApplication, which is a GUID that has been converted to a string.
	ApplicationPool	(Inherited from SPIisWebServiceApplication.)
	ApplicationVersion	(Inherited from SPServiceApplication.)
	CanUpgrade	(Inherited from SPPersistedUpgradableObject.)
	Comments	(Inherited from SPIisWebServiceApplication.)
	CrawlStores	Gets all of the CrawlStoreCollection objects that are managed by the current SearchServiceApplication.
	CrawlTopologies	Gets the CrawlTopologyCollection that is managed by the current SearchServiceApplication.
	DefaultEndpoint	(Inherited from SPIisWebServiceApplication.)
	DefaultEndpointName	Gets the name of the default endpoint of the current SearchServiceApplication. (Overrides SPIisWebServiceApplication.DefaultEndpointName.)
	DefaultSearchProvider	Gets or sets the default Search provider that provides the data in response to a query.
	DiacriticSensitive	Gets or sets a flag that indicates whether the Search service is configured to be diacritic sensitive.
	DisplayName	(Inherited from SPPersistedObject.)
	Endpoints	(Inherited from SPIisWebServiceApplication.)
	ExtendedConnectorProperties	Gets a ExtendedConnectorPropertyCollection of the FAST Search Content Search Service Application connector, which provides custom content to the FAST Search Service.
	Farm	(Inherited from SPPersistedObject.)
	FarmIdsForAlerts	Gets or sets the list of farm IDs to be notified when alerts are raised by the current SearchServiceApplication.
	FASTAdminProxy	Gets an object that can be used to access WCF administration services on a server running FAST Search Server 2010 for SharePoint.
	Id	(Inherited from SPPersistedObject.)
	IisVirtualDirectoryPath	(Inherited from SPIisWebServiceApplication.)
	InstallPath	Gets the fully qualified installation path of the current SearchServiceApplication. (Overrides SPIisWebServiceApplication.InstallPath.)
	IsBackwardsCompatible	(Inherited from SPPersistedUpgradableObject.)
	LocationConfigurations	Gets the LocationConfigurationCollection for a federated Search location.
	ManageLink	Gets the link to the administration page that is used to manage the current SearchServiceApplication. (Overrides SPServiceApplication.ManageLink.)
	MinimumReadyQueryComponentsPerPartition	Gets or sets the minimum number of the query components used in each index partition.
	Name	(Inherited from SPPersistedObject.)
	NeedsUpgrade	(Inherited from SPPersistedUpgradableObject.)
	NeedsUpgradeIncludeChildren	(Inherited from SPPersistedUpgradableObject.)
	Parent	(Inherited from SPPersistedObject.)
	PermissionsLink	(Inherited from SPIisWebServiceApplication.)
	Properties	(Inherited from SPPersistedObject.)
	PropertiesLink	Gets the link to the properties editing page of the current SearchServiceApplication. (Overrides SPServiceApplication.PropertiesLink.)
	PropertyStores	Gets the PropertyStoreCollection that is used by the current SearchServiceApplication.
	QueryLoggingEnabled	Gets or sets a flag that indicates whether query logging is enabled for the current SearchServiceApplication.
	QuerySuggestionsEnabled	Gets or sets a flag that indicates whether query suggestions is enabled for the current SearchServiceApplication.
	QueryTopologies	Gets a QueryTopologyCollection in the SearchServiceApplication.
	ResetAndEnableAlerts	Gets or sets a flag that indicates whether to reset and enable alerts when the current SearchServiceApplication is reset.
	SearchAdminDatabase	Gets or sets the SearchAdminDatabase of the current SearchServiceApplication.
	SearchApplicationType	Gets the type of the current SearchServiceApplication.
	Service	(Inherited from SPServiceApplication.)
	ServiceApplicationProxyGroup	(Inherited from SPServiceApplication.)
	ServiceInstances	(Inherited from SPServiceApplication.)
	Shared	(Inherited from SPIisWebServiceApplication.)
	Status	(Inherited from SPPersistedObject.)
	TempPath	Gets or sets the temporary path of the SearchServiceApplication.
	TermsOfServiceUri	(Inherited from SPIisWebServiceApplication.)
	TimeBeforeAbandoningQueryComponent	Gets or sets the time interval, in milliseconds, to abandon the current query.
	TypeName	Gets the type name that describes the current SearchServiceApplication. (Overrides SPPersistedObject.TypeName.)
	UpgradeContext	(Inherited from SPPersistedUpgradableObject.)
	UpgradedPersistedProperties	(Inherited from SPAutoSerializingObject.)
	Uri	(Inherited from SPIisWebServiceApplication.)
	VerboseQueryMonitoring	Gets or sets a flag that indicates whether verbose query logging is turned on for the current SearchServiceApplication.
	Version	(Inherited from SPPersistedObject.)
	VirtualPath	Gets the virtual path of the Search service hosted by Internet Information Services 7.0. (Overrides SPIisWebServiceApplication.VirtualPath.)
	WasCreated	(Inherited from SPPersistedObject.)

Top

Methods

	Name	Description
	AddBestBetLink	Adds an association between an existing Best Bet and a keyword to the SearchAdminDatabase.
	AddConsumer	Adds a Search scope consumer to the SearchAdminDatabase.
	AddDisplayGroup	Adds a Search scope display group for a Search scope consumer.
	AddNewBestBet	Adds a new Best Bet for the SearchAdminDatabase.
	AddNewLocationConfiguration	Adds a new federated location.
	AddRule	Adds a new Search scope rule to the SearchAdminDatabase.
	AddScope	Adds a new Search scope to the SearchAdminDatabase.
	AddServiceEndpoint(String, SPIisWebServiceBindingType)	(Inherited from SPIisWebServiceApplication.)
	AddServiceEndpoint(String, SPIisWebServiceBindingType, String)	(Inherited from SPIisWebServiceApplication.)
	AddSpecialTerm	Adds a new keyword to the SearchAdminDatabase.
	AddSynonym	Adds a synonym for the specified keyword to the SearchAdminDatabase.
	BeginProvision	(Inherited from SPServiceApplication.)
	BeginUnprovision	(Inherited from SPServiceApplication.)
	CheckAccess	(Inherited from SPIisWebServiceApplication.)
	CheckAdministrationAccess	(Inherited from SPServiceApplication.)
	Clone	(Inherited from SPPersistedObject.)
	Delete	Deletes the current SearchServiceApplication from the SharePoint Enterprise Search. (Overrides SPIisWebServiceApplication.Delete().)
	DeleteConsumer	Removes the specified Search scope consumer from the SearchAdminDatabase.
	DeleteLocationConfiguration	Deletes the federated location from the SearchAdminDatabase.
	DemandAccess	(Inherited from SPIisWebServiceApplication.)
	DemandAdministrationAccess	(Inherited from SPServiceApplication.)
	DropDisplayGroup	Deletes the specified ScopeDisplayGroup from the SearchAdminDatabase.
	DropRule	Deletes the specified SearchScopeRule from the SearchAdminDatabase.
	DropScope	Deletes the specified Scope from the SearchAdminDatabase.
	DropSpecialTerm	Deletes the specified Keyword from the SearchAdminDatabase.
	DropSynonym	Deletes a Synonym of the specified Keyword from the SearchAdminDatabase.
	EndProvision	(Inherited from SPServiceApplication.)
	EndUnprovision	(Inherited from SPServiceApplication.)
	EnsureTopologyInConfigDB	Ensures that the configuration database has been updated with the contents of the databases that are associated with the current SearchServiceApplication.
	Equals	(Inherited from SPPersistedObject.)
	Execute	Executes the Search query with the specified query properties.
	Finalize	(Inherited from Object.)
	ForceResume	Forces the SearchServiceApplication to be resumed with the specified reasons.
	GetAccessControl	(Inherited from SPIisWebServiceApplication.)
	GetAdministrationAccessControl	(Inherited from SPServiceApplication.)
	GetBestBet	Retrieves a BestBet for the specified URL and keyword consumer group.
	GetBestBetForSpecialTerm	Retrieves the information about a BestBet for the specified keyword consumer group, URL, and Keyword.
	GetBestBetsCount	Calculates the number of BestBet attributes for the specified keyword consumer group that match the specified filtering criteria.
	GetBestBetsCountForSpecialTerm	Calculates the number of BestBet attributes for the specified Keyword.
	GetBestBetsInfo	Retrieves all of the BestBet attributes that belong to the specified keyword consumer group.
	GetBestBetsInfoForSpecialTerm	Retrieves the list of BestBet attributes for the specified Keyword.
	GetBestBetsOrderInfoForSpecialTerm	Retrieves a list of BestBet attributes associated with the specified Keyword and the information about their priorities within this list.
	GetChangedConsumers	Retrieves the names of all Search scope consumers that manage a Search scope display group, SearchScope, or SearchScopeRule that has changed since the specified version.
	GetChild<T>()	(Inherited from SPPersistedObject.)
	GetChild<T>(String)	(Inherited from SPPersistedObject.)
	GetClickFrequenciesForUrl	Gets the number of times a specified URL has been clicked in the past week and the past month from the specified date.
	GetConsumerInformation
	GetConsumers	Retrieves a list of the names of all Search scope consumers.
	GetContainingDisplayGroups	Retrieves a list of SearchScopeDisplayGroup objects that contains the specified Search scope.
	GetContentSourceNames	Gets a list of ContentSource names managed by the SearchServiceApplication.
	GetDependentProcessIdentities	(Inherited from SPServiceApplication.)
	GetDisplayGroupIDFromName	Retrieves the ID of a SearchScopeDisplayGroup with the specified SearchScopeDisplayGroup name and the Search scope consumer name.
	GetDisplayGroupInfo	Retrieves information about a SearchScopeDisplayGroup.
	GetDisplayGroupListInfo	Retrieves a list of display group IDs from the scope display group membership set associated with the specified ScopeDisplayGroup.
	GetDisplayGroupsCount	Retrieves the total number of SearchScopeDisplayGroup objects.
	GetDisplayGroupsForConsumer	Retrieves a list of the DisplayGroupInfo objects that is managed by the SearchServiceApplication.
	GetDisplayGroupsInfo	Retrieves a list of the DisplayGroupInfo objects for each consumer managed by the SearchServiceApplication.
	GetHashCode	(Inherited from SPPersistedObject.)
	GetLastLocationConfigurationUpdate	Retrieves the version of the last configuration changes from the Federation Set.
	GetLocationConfigurations	Retrieves configuration information for all the federated locations.
	GetLocationDescription	Retrieves the federated location description.
	GetLocationVisualizations	Retrieves Visualization associated with the specified federated location.
	GetManagedProperties	Gets a list of ManagedPropertyInfo objects managed by the SearchServiceApplication.
	GetObjectData	(Inherited from SPAutoSerializingObject.)
	GetProperties	Returns the PropertyInformation for each property managed by the SearchServiceApplication.
	GetProperty	Gets the property of the SearchServiceApplication with the specified name.
	GetPropertyQueryRuleCount	Gets the count of query rules that match a specified property restriction, where the specified property name has the specified property value.
	GetProxyInfo	Retrieves the SearchProxyInfo information for this SearchServiceApplication.
	GetQuerySuggestions	Returns a collection of query suggestions that match the specified Search terms.
	GetRuleInfo	Retrieves the RuleInfo for the ScopeRule with the specified ID.
	GetRulesCount	Retrieves the count of the SearchScopeRule objects defined for a specified SearchScope in the SearchServiceApplication.
	GetRulesInfo	Retrieves a list of RuleInfo objects for all of the ScopeRule objects defined within the specified SearchScope.
	GetScopeIDFromName	Retrieves the ID of a Search scope with the specified name and SearchScope consumer.
	GetScopeInfo	Retrieves the ScopeInfo for the Scope with the specified ID.
	GetScopeRowCount	Returns the count of results that match a specified Search scope.
	GetScopes	Returns the SearchScopeInformation for the Search scope consumer.
	GetScopesCount	Retrieves the count of all SearchScopes that are defined in the SearchAdminDatabase.
	GetScopesForConsumer	Retrieves a list of ScopeInfo objects that is managed by the specified Search scope consumer.
	GetScopesInfo	Retrieves a list of the ScopeInfo objects, which contains one ScopeInfo object for every Scopes object.
	GetScopesManagerInfo	Retrieves the details of the Search scopes system managed by the SearchServiceApplication.
	GetSearchAlertManagerInfo	Gets information about the Search alert system.
	GetSearchAlertNotificationFormat	Gets the notification format of the Search alert system.
	GetSearchApplicationDisplayName	Returns the display name of the SearchServiceApplication.
	GetSearchApplicationName	Returns the name of the SearchServiceApplication.
	GetSearchServiceApplicationInfo	Returns the application information about the SearchServiceApplication.
	GetSearchTerms	Gets the terms to which keyword Search query has been restricted.
	GetSetting	Retrieves the value of a Search setting.
	GetSharepointLocationVisualizations	Retrieves the preselected Visualization objects for the federated location.
	GetSpecialTerm	Retrieves the Keyword from the SiteCollection given its keyword consumer group, and the keyword term.
	GetSpecialTermsCount	Calculates the number of KeyWord attributes for the specified KeyWord consumer group.
	GetSpecialTermsCountForBestBet	Retrieves the number of KeyWord attributes that are associated with the specified BestBet.
	GetSpecialTermsInfo	Retrieves a dictionary of KeyWord objects from the site collection for a specified KeyWord consumer group.
	GetSpecialTermsInfoForBestBet	Retrieves the list of KeyWord objects associated with a specified BestBet.
	GetSynonym	Retrieves the specified Synonym associated with the specified KeyWord.
	GetSynonymsCountForSpecialTerm	Calculates the number of Synonym objects that are associated with the specified KeyWord.
	GetSynonymsInfoSpecialTerm	Retrieves the Synonym that is associated with a specified Keyword.
	GetTopQueryStringsForUrl	Gets a specified number of top query strings used as a result when the user clicks a specified URL.
	GetType	(Inherited from Object.)
	GetUnusedScopesForConsumer	Returns a list of DisplayGroupInfo objects, and each object is associated with a Scope.
	GetUrlRuleCount	Gets the count of crawled items whose site URL matches a specified URL.
	GetUserPreferenceSerializeHelper	Gets the user preference serialization helper from the SearchAdminDatabase.
	GetVisibleScopesCount	Gets the count of all visible Scope objects defined in the Search application.
	GetVolatileScopeInfo	Retrieves the ScopeInfo likely to change for the specified SearchScope.
	GetVolatileScopesManagerInfo	Retrieves the VolatileScopesManagerInfo that is likely to change for a SearchScopes system in the Search application.
	HasAdditionalUpdateAccess	(Inherited from SPServiceApplication.)
	HasFailures	Indicates whether a failure has occurred during a backup or restore operation.
	HighlightStringValue	Highlights all the occurrences of the specified query terms in a specified string value.
	HighlightStringValueQuerySuggestions	Highlights all the occurrences of the specified query terms in a specified string value.
	Invalidate	(Inherited from SPPersistedUpgradableObject.)
	IsConnected	(Inherited from SPIisWebServiceApplication.)
	IsPaused	Gets the reasons that crawls are paused.
	MemberwiseClone	(Inherited from Object.)
	MigrateGroupAccount	(Inherited from SPServiceApplication.)
	MigrateUserAccount	(Inherited from SPIisWebServiceApplication.)
	OnDependentProcessIdentityChanged	(Inherited from SPServiceApplication.)
	OnDeserialization	(Inherited from SPIisWebServiceApplication.)
	OnProcessIdentityChanged	Called when the process ID is changed. (Overrides SPIisWebServiceApplication.OnProcessIdentityChanged(SecurityIdentifier).)
	OpenInstanceConfiguration	(Inherited from SPIisWebServiceApplication.)
	Pause	Pauses the SearchServiceApplication.
	Provision	Provisions the SearchServiceApplication in the server farm. (Overrides SPIisWebServiceApplication.Provision().)
	ProvisionInstances	(Inherited from SPServiceApplication.)
	ProvisionLocal	(Inherited from SPIisWebServiceApplication.)
	PutLocationVisualization	Adds a new Visualization definition for the federated location.
	RecordClick	Records the details of the clickthrough and its corresponding Search query.
	RecordOMQueryDoneEvent	Records the latency timing information about the executed Search queries.
	RecordQueryErrorEvent	Records the errors that have occurred during the processing of Search queries.
	RecordUIQueryDoneEvent	Records the information about the Search query latency on the Search results page.
	RecordWebPartQueryDoneEvent	Records the Search query latency for a query of Web Parts on the Search results page.
	ReEncryptExistingPasswords	Reencrypts the existing passwords with a new master key.
	RefreshComponents	Refreshes the Search components in the SearchServiceApplication.
	RemoveBestBetLink	Deletes the association between a specified keyword and a BestBet from the SearchAdminDatabase.
	ReRunPostRestore	Performs the restore operation again after an unsuccessful restore operation of the SearchServiceApplication.
	Reset	Resets the current SearchServiceApplication.
	RestoreDefaultSetting	Restores a specified Search setting value to the default value.
	Resume	Resumes the SearchServiceApplication.
	SetAccessControl	(Inherited from SPIisWebServiceApplication.)
	SetAdministrationAccessControl	Applies administration access to the SearchServiceApplication. (Overrides SPServiceApplication.SetAdministrationAccessControl(SPCentralAdministrationSecurity).)
	SetBestBetInfo	Updates the information about the specified BestBet.
	SetCrawlAccountMasterKey	Sets the master key that is used to encrypt the crawl account.
	SetDisplayGroupInfo	Sets the configuration information for the specified SearchScopeDisplayGroup.
	SetDisplayGroupListInfo	Updates the Search scope display group.
	SetProperty	Sets the specified property of the SearchServiceApplication.
	SetRuleInfo	Sets the details of the specified Search scope rule in the SearchServiceApplication.
	SetScopeInfo	Sets the details of the specified Search scope in the SearchServiceApplication.
	SetScopesManagerInfo	Sets the SetScopesManagerInfo(ScopesManagerInfo) in the SearchServiceApplication.
	SetSpecialTermInfo	Updates the information about the specified keyword.
	SetUserPreferenceSerializeHelper	Sets the user preference serialization helper for a specified user.
	StartScopesCompilation	Starts the Search scope compilation.
	ToString	(Inherited from SPPersistedObject.)
	Uncache	(Inherited from SPPersistedObject.)
	Unprovision()	(Inherited from SPServiceApplication.)
	Unprovision(Boolean)	Unprovisions the SearchServiceApplication and optionally deletes data associated with the application. (Overrides SPIisWebServiceApplication.Unprovision(Boolean).)
	UnprovisionInstances	(Inherited from SPServiceApplication.)
	UnprovisionLocal	(Inherited from SPIisWebServiceApplication.)
	Update()	Updates the status and properties of the SearchServiceApplication. (Overrides SPIisWebServiceApplication.Update().)
	Update(Boolean)	(Inherited from SPPersistedObject.)
	UpdateBestBetsOrder	Updates a series of BestBet attributes that have the specified IDs and the specified keyword.
	UpdateLocationConfiguration	Updates a federated Search location configuration of the SearchServiceApplication.
	UpdateParent	(Inherited from SPAutoSerializingObject.)
	UpdateSetting	Updates the value of a specified Search setting.
	Upgrade()	(Inherited from SPPersistedUpgradableObject.)
	Upgrade(Boolean)	(Inherited from SPPersistedUpgradableObject.)
	Validate	(Inherited from SPPersistedObject.)
	ValidateBackwardsCompatibility	(Inherited from SPPersistedUpgradableObject.)

Top

Explicit Interface Implementations

	Name	Description
	IBackupRestore.AddBackupObjects	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.CanRenameOnRestore	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.CanSelectForBackup	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.CanSelectForRestore	(Inherited from SPIisWebServiceApplication.)
	ISharedServiceApplication.DefaultEndpoint	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.DiskSizeRequired	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.OnAbort	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.OnBackup	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.OnBackupComplete	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.OnPostRestore	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.OnPrepareBackup	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.OnPreRestore	(Inherited from SPIisWebServiceApplication.)
	IBackupRestore.OnRestore	(Inherited from SPIisWebServiceApplication.)

Top

See Also

Reference

SearchServiceApplication Class

Microsoft.Office.Server.Search.Administration Namespace