SPWebService Members

Include Protected Members
Include Inherited 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
	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.
	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.)
	BrowserCEIPEnabled	Stores the opt-in status for whether a browser is configured to provide data for the customer experience improvement program (CEIP).
	CacheSiteLookup
	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.)
	ClientRequestServiceSettings
	CoauthoringMaxAuthors
	CoauthoringVersionPeriod
	CollectSPRequestAllocationCallStacks
	ContentService	Gets the Web service associated with the content application.
	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.
	DeveloperDashboardSettings
	DisableCoauthoring
	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.)
	EnableHostHeaderSiteBasedSchemeSelection	Gets or sets a value that indicates whether the host header site scheme selection is enabled.
	ExternalApplicationSettings	Gets an object that provides information about how the Web service manages non-SharePoint applications that are hosted in Web Parts.
	ExternalSiteMapProvider
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	FeatureCacheHighWaterMark
	FeatureCacheLowWaterMark
	FeatureCacheTrimInterval
	Features	Gets the collection of globally scoped features that are activated in the farm.
	FileReadChunkSize
	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.
	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	(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.
	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.)
	OnlineHelpEnabled
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	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.
	RemoteAdministratorAccessDenied
	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.)
	RestrictedObjectModel
	RunningJobs	Gets a collection of running jobs for this service. (Inherited from SPService.)
	ScopeEveryoneToSiteCollectionOnly
	ShowUserNameOnAccessDenied
	SiteCreationProvider
	SiteRedirectionEnabled	Gets or sets a value that indicates whether the feature that redirects requests for a site to another URL is enabled.
	SMTPTimeout
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	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.)
	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.
	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	(Inherited from SPService.)
	GetCreateApplicationOptions	(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.)
	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.)
	MemberwiseClone	(Inherited from Object.)
	OnAbort	Raises the Abort (backup) event.
	OnBackup	Raises the Backup event.
	OnBackupComplete	Raises the BackupComplete event.
	OnDeserialization	(Overrides SPPersistedObject.OnDeserialization().)
	OnPostRestore	Raises the PostRestore event.
	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.
	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.)
	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