SPWebService members

Represents a Web service that contains one or more Web applications. This Web service allows a Web browser to access the content in SharePoint sites.

The SPWebService type exposes the following members.

Constructors

	Name	Description
	SPWebService()	Reserved for internal use only.
	SPWebService(String, SPFarm)	Initialize a new instance of the SPWebService class.

Top

Properties

	Name	Description
	ActiveDirectoryDomain	Gets or sets the domain in which to create Active Directory accounts.
	ActiveDirectoryOrganizationalUnit	Gets or sets the organizational unit in which to create Active Directory accounts.
	AdministrationService	Gets the Web service associated with the administration application.
	AllowAggregationCalendar	Gets or sets flag for allowing aggregation on calendar view
	AllowDeclarativeWorkflowAutostartOnEmailAsAuthor
	AlternateContentEditorScript	Gets or sets the alternate editor script to include in the Content Editor Web Part.
	AntivirusSettings	Gets the collection of antivirus settings for this service.
	AppCacheToken
	ApplicationPools	Gets the collection of IIS application pools available to this service.
	Applications	Gets the collection of service applications associated with the service. (Inherited from SPService.)
	AutoProvision	(Overrides SPService.AutoProvision.)
	BackgroundFileSyncThrottlingSettings	Controls limits for background file sync requests.
	BrowserCEIPEnabled	Stores the opt-in status for whether a browser is configured to provide data for the customer experience improvement program (CEIP).
	CacheSiteLookup	If true, site lookup will be cached.
	CanRenameOnRestore	Gets a value indicating whether the service can be renamed when it is restored.
	CanSelectForBackup	Gets or sets a value indicating whether the service can be backed up.
	CanSelectForRestore	Gets or sets a value that indicates whether the service can be restored.
	CanUpgrade	Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
	CdnPrefix	If a CDN is enabled, the string to use as the prefix for generated script and style URLs
	ClientRequestServiceSettings	The settings for client.svc
	CoauthoringMaxAuthors	Default value of maximum number of users allowed to coauthor a document at a time
	CoauthoringVersionPeriod	Minimum time in minutes between new coauthoring versions Versions created during coauthoring will be created no more frequently than this time period.
	CollectSPRequestAllocationCallStacks	If true, the callstack of every SPRequest allocation will be collected.
	CommunitySearchUrl
	CompliantWithMinRole	(Inherited from SPService.)
	ContentService	Gets the Web service associated with the content application.
	CorporateCuratedGalleryAppQueryInterval	The interval that each frontend in the farm will check the app installed state of the corporate curated gallery. The setting is in seconds.
	CreateActiveDirectoryAccounts	Gets or sets a Boolean value that specifies whether to create Active Directory accounts for new site users.
	DeclarativeWorkflowAutostartOnEmailEnabled	Indicates whether or not workflows should automatically start on e-mail-enabled lists.
	DefaultDatabaseInstance	Gets or sets the default SQL installation for new content databases associated with this Web service.
	DefaultDatabasePassword	Gets or sets the default password to use for new content databases when using SQL authentication.
	DefaultDatabaseUsername	Gets or sets the default username to use for new content databases when using SQL authentication.
	DenyPermissionsMaskRefreshInterval
	DeploymentLocked	(Inherited from SPPersistedObject.)
	Description	(Overrides SPService.Description.)
	DeveloperDashboardSettings	Settings that control the build in performance monitoring tools for the services in the farm.
	DisableCoauthoring	If this property is set to false, shared file locking is enabled for coauthoring Office documents
	DiscoPage	Gets or sets the path to the Web Services Discovery page relative to the /_vti_bin virtual directory.
	DiskSizeRequired	Gets the amount of disk space that is required to back up this Web service.
	DisplayName	Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
	DynamicClaimCacheTimeout
	EnableAjaxBundling
	EnableCdn	Whether to enable a Content Delivery Network for downloading script and style files
	EnableHostHeaderSiteBasedSchemeSelection	Gets or sets a value that indicates whether the host header site scheme selection is enabled.
	EnableSideBySide
	ExternalApplicationSettings	Gets an object that provides information about how the Web service manages non-SharePoint applications that are hosted in Web Parts.
	ExternalSiteMapProvider	Registers a type which will be used in place of our configuration database for site map operations.
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	FeatureCacheHighWaterMark	High water mark for the feature XML document cache, in bytes.
	FeatureCacheLowWaterMark	Low water mark for the feature XML document cache, in bytes.
	FeatureCacheTrimInterval	Trimming interval for the feature XML document cache, in milliseconds.
	Features	Gets the collection of globally scoped features that are activated in the farm.
	FileNotFoundErrorThrottlingSettings
	FileOperationSettings	Obsolete. Gets or sets a Boolean value that specifies whether all Webs should do direct to shredded store.
	FileReadChunkSize	Chunk size in bytes for optimal reading of data from SQL or some other external storage device. Large values improve throughput, small values improve latency.
	FileWriteChunkSize	Chunk size in bytes for optimal writing of data from SQL or some other external storage device. Large values improve throughput, small values improve latency.
	Hidden	(Inherited from SPService.)
	HostHeaderPrefixes	Gets the set of prefixes for host header sites.
	HtmlTransformSettings	Gets the collection of HTML transform settings for the Web service.
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	ImagingDownloadSizeLimit	Gets or sets the maximum allowable combined size, in bytes, of all files downloaded by an imaging Web service in a single request.
	IncomingEmailAccountToModifyAD	This option allows you specify an account (username and password) that would be used when creating and deleting and modifying AD contact objects. This is primarily important if the domain in which SharePoint is in is a 1 way trust relationship. It would allow the "email-enable this list" feature to work in such an environment by providing the account to be used when interacting with AD
	Instances	Gets a collection of all instances of the service in the server farm. (Inherited from SPService.)
	IrmSettings	Gets the collection of IRM settings for the Web service.
	IsBackwardsCompatible	Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
	JobDefinitions	Gets a collection of job definitions for this service. (Inherited from SPService.)
	JobHistoryEntries	Gets an enumeration of the job history entries for this service. (Inherited from SPService.)
	LargeFileChunkSize	Gets or sets the maximum amount of data that the front-end Web server writes to the content database in a single write operation.
	MaximumFileFillersPerOperation
	MaxListsAccessedByApp	The maximun number of SharePoint lists in one web that could be accessed by one app.
	MaxTemplateDocumentSize	Gets or sets the maximum size for catalogs of list and site templates.
	MembershipUserKeyType
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	NeedsUpgrade	Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
	NeedsUpgradeIncludeChildren	Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
	O365CommunityUrl
	OfficeSupportUrl
	OnlineHelpEnabled	Indicates if the help system directs users to help sources outside the farm (e.g. Office Online)
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	PeoplePickerSearchInMultipleForests	This option allows you to resolve people picker entries using the old algorithm. Set to TRUE to use the old algorithm where entries are searched sequentially in each forest. Set to FALSE to use the Global Catalog to search for all replicated users in the current forest itself....
	PeoplePickerSearchReplicatedMasterSIDPropertyName	Specifies which ActiveDirectory attribute the people picker control uses to represent a user's SID
	PluggableParsers	The set of document parsers available to this Web service.
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	QuotaTemplates	Gets a collection of SPQuotaTemplate objects.
	RegisteredDatabaseExtensionTypes
	RemoteAdministratorAccessDenied	If true, all calls to SPFarm.CurrentUserIsAdministrator() will return false during http requests. This setting has no effect on the central administration site.
	RemoteEventServiceSettings	The settings for handling remote event receiver calls.
	RequestRoutingMode
	Required	Gets a Boolean value that indicates whether an instance of the Web service must be running on at least one computer in the server farm. (Overrides SPService.Required.)
	ResourceTag
	RestrictedObjectModel	The APIs that are not allowed to be called by client request.
	RunningJobs	Gets a collection of running jobs for this service. (Inherited from SPService.)
	ScopeEveryoneToSiteCollectionOnly	A boolean value indicating whether allowEveryoneViewItems should apply to existing user only
	ShouldDeferUpgradeActions	(Inherited from SPPersistedUpgradableObject.)
	ShowUserNameOnAccessDenied	in hosting environment, people may want to set it to false so as to prevent information disclosure to other sites hosted on the same server.
	SideBySideToken
	SiteCreationProvider	Registers a type which will be used to change the behavior of site creation.
	SiteRedirectionEnabled	Gets or sets a value that indicates whether the feature that redirects requests for a site to another URL is enabled.
	SiteSubscriptionCacheRefreshInterval
	SMTPTimeout	Timeout for SMTP server
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	SupportMultipleAppDomains
	SystemService	(Inherited from SPService.)
	TokenTimeout	Gets or sets the amount of time before a user token times out.
	TypeName	Gets the user-friendly name used to describe the Web service in the administration user interface. (Overrides SPPersistedObject.TypeName.)
	UpgradeContext	Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	UsageSettings	Obsolete. Gets the collection of usage settings for this Web service.
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	ViewStateOnServer	By default set to true, the view state will be stored in the velocity cache.
	WasCreated	Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)
	WcfServiceSettings	Gets a dictionary list that provides the settings of the WCF services that use the service factory of MultipleBaseAddressWebServiceHostFactory, MultipleBaseAddressDataServiceHostFactory, and MultipleBaseAddressBasicHttpBindingServiceHostFactory.
	WebApplications	Gets the set of Web applications that are installed with this service.
	WebConfigModifications	Gets the web.config modifications that apply to all the Web applications in the Web service.
	WebUpgradeBatchSize
	WellKnownAppPrincipals
	WorkflowCPUThrottle
	WorkflowEventDeliveryBatchSize
	WorkflowEventDeliveryThrottle
	WorkflowTimeoutMinutes
	WorkflowTimerJobCPUThrottle
	WorkItemEventDeliveryBatchSize
	WorkItemEventDeliveryThrottle

Top

Methods

	Name	Description
	AddBackupObjects	Adds the Web service to the backup/restore operation.
	ApplyApplicationContentToLocalServer	Copies the resource files and DLLs of provisioned Web applications in the Web service to folders within C:\Inetpub\wwwroot\wss\VirtualDirectories.
	ApplyWebConfigModifications	Applies the list of web.config modifications to all Web applications in this Web service across the farm.
	Clone	Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
	Delete	Removes the service and associated resources. (Inherited from SPService.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Finalize	(Inherited from Object.)
	GetChild<T>()	Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
	GetChild<T>(String)	Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
	GetCreateApplicationLink	Gets the administration user interface link that is used to create a new service application. (Inherited from SPService.)
	GetCreateApplicationOptions	Gets the options for creating a new service application. (Inherited from SPService.)
	GetFirstPreconfiguredDatabase	(Inherited from SPService.)
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetPreconfiguredDatabaseInfo	(Inherited from SPService.)
	GetType	(Inherited from Object.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	Invalidate	Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
	IsUserLicensedForEntity	Checks if the current user has the proper license to access the specified entity. (Inherited from SPService.)
	LegacyUpdate	(Inherited from SPPersistedObject.)
	MemberwiseClone	(Inherited from Object.)
	OnAbort	Raises the Abort (backup) event.
	OnBackup	Raises the Backup event.
	OnBackupComplete	Raises the BackupComplete event.
	OnDeserialization	Do some additional work immediately after the base class deserializes itself. (Overrides SPPersistedObject.OnDeserialization().)
	OnPostCreate	(Overrides SPPersistedObject.OnPostCreate().)
	OnPostRestore	Raises the PostRestore event.
	OnPreCreate	(Overrides SPPersistedObject.OnPreCreate().)
	OnPrepareBackup	Raises the PrepareBackup event.
	OnPreRestore	Raises the PreRestore event.
	OnRestore	Raises the Restore event.
	Provision	Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
	QueryFeatures(Guid)	Gets all features in the Web service that have a specific feature ID.
	QueryFeatures(SPFeatureScope, Boolean)	Gets either all features in the Web service at the specified scope that need an upgrade, or all features that do not.
	QueryFeatures(Guid, Boolean)	Gets all features in the Web service that have a specific feature ID and upgrade state.
	QueryFeatures(Guid, Version)	Gets all features in the Web service that have a specific feature ID and version.
	QueryFeaturesInAllWebServices(Guid)	Gets all features in all Web services that have a specific feature ID.
	QueryFeaturesInAllWebServices(SPFeatureScope, Boolean)	Gets all of the features in all Web services at the specified scope that need an upgrade, or gets all of the features that do not.
	QueryFeaturesInAllWebServices(Guid, Boolean)	Gets all features in all Web services that have a specific feature ID and upgrade state.
	QueryFeaturesInAllWebServices(Guid, Version)	Gets all features in all Web services that have a specific feature ID and version.
	RunWithConcurrencyRetries	(Inherited from SPPersistedObject.)
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	Uncache	Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
	Unprovision	Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
	Update()	Causes this Web service to save its state and to propagate changes to all the machines in the farm. (Overrides SPPersistedObject.Update().)
	Update(Boolean)	Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	UpdateWithNoObjectCallbackCheck	(Inherited from SPPersistedObject.)
	Upgrade()	Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
	Upgrade(Boolean)	Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
	Validate	Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
	ValidateBackwardsCompatibility	Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)

Top

Explicit interface implementations

	Name	Description
	IBackupRestoreConfiguration.CanBackupRestoreAsConfiguration	Gets a value that indicates whether the Web service can be selected for inclusion in a configuration-only backup or restore operation.

Top

See also

Reference

SPWebService class

Microsoft.SharePoint.Administration namespace