SPWebApplication methods

  • Article

The SPWebApplication type exposes the following members.

Methods

  Name Description
Public method AddBackupObjects Adds the Web application and its children to the backup/restore job.
Public method AddMigrateUserToClaimsPolicy Add the permissions necessary to perform migration from legacy auth to claims based auth for the given windows account name (domain\username)
Public method 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.)
Public method CurrentUserIgnoreThrottle Detects whether throttling can be ignored for the current Web application. Throttling can be ignored if the current user has administrator-level privileges for computer or if throttling is not set to occur in the current window of time.
Public method Delete Removes the Web application and some of the resources that it owns. (Overrides SPPersistedObject.Delete().)
Public method EnsureDefaultJobs Ensures that the default timer job definitions exist for the Web application.
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetDeletedSites() Gets a list of deleted sites using a default query.
Public method GetDeletedSites(Guid) Gets a list of deleted sites with the specified site collection identifier (ID).
Public method GetDeletedSites(String) Gets a list of deleted sites with the specified prefix of a server-relative URL.
Public method GetDeletedSites(SPDeletedSiteQuery) Gets a list of deleted sites using the specified query.
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetIisSettingsWithFallback Returns the set of Internet Information Services (IIS) settings for the specified zone.
Public method GetListItemLastModifiedDates For a collections of list URLs, return the list item last modified dates of each list.
Public method GetMappedPage(String) Returns the location of the customized application page.
Public method GetMappedPage(SPWebApplication.SPCustomPage) Returns the location of the customized application page.
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Protected methodStatic member GetRequestPath Obsolete. This member is reserved for internal use and is not intended to be used directly from your code.
Public method GetResponseUri(SPUrlZone) Returns the absolute root of the URI for the given zone.
Public method GetResponseUri(SPUrlZone, String) Retrieves the absolute root of the URI for the given zone and appends the specified path to the end.
Public method GetSecurityTokenServiceEndPointAddress Returns the endpoint URI of the security token service based on the specified request zone.
Public method GetSelfServiceCreationPageUrl Determines the appropriate Url for the Self Service Create page.
Public method GetType (Inherited from Object.)
Public method GetVersionedMappedPage(String)
Public method GetVersionedMappedPage(SPWebApplication.SPCustomPage, Int32)
Public method GrantAccessToProcessIdentity(String) Grants the specified process identity account access to the Web application based on the username. Access to the process identity provides the permissions that are specified in the policy role parameter.
Public method GrantAccessToProcessIdentity(String, SPPolicyRoleType) Grants the specified process identity account access to the Web application based on the name of the user and the level of access. Access to the process identity provides full control of the SharePoint Web application.
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Protected method InstallClaimsAuthFiles This member is reserved for internal use and is not intended to be used directly from your code.
Protected method InstallFiles Installs the Microsoft ASP .NET configuration and resource files that are required to provision the application.
Public method Invalidate Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
Public method IsUnthrottledPrivilegedOperationsAllowed Returns a Boolean value that indicates whether the current time is included in the unthrottled service window.
Public method IsUserLicensedForEntity Checks if the currently logged in user has the proper license to access the specified entity.
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Public methodStatic member Lookup Finds the Web application that is located at the specified URL.
Protected method MemberwiseClone (Inherited from Object.)
Public method Migrate() Obsolete. Migrates the settings from a Windows SharePoint Services 2.0 Web application with which the Web application is paired.
Public method Migrate(Boolean) Obsolete. Migrates the settings from a Windows SharePoint Services 2.0 Web application with which the Web application is paired, with the option of including all children.
Public method MigrateEntities(IMigrateEntityForWebApplicationCallback, SPMigrateEntitiesOperationParameters)
Public method MigrateEntities(SPWebApplication.IMigrateUserCallback, SPMigrateEntitiesOperationParameters)
Public method MigrateUsers(Boolean) Obsolete. Converts existing users to or from accounts that use claims authentication.
Public method MigrateUsers(SPWebApplication.IMigrateUserCallback) Migrates users to claims authentication.
Public method MigrateUsers(SPWebApplication.IMigrateUserCallback, SPWebApplication.SPMigrateUserParameters) Migrates users to claims authentication.
Public method MigrateUsersToClaims(NTAccount, Boolean) Migrates users from legacy authentication to claims-based authentication.
Public method MigrateUsersToClaims(NTAccount, Boolean, SPWebApplication.SPMigrateUserParameters) Migrates users from legacy authentication to claims-based authentication.
Public method OnAbort Raises the Abort (backup) event.
Public method OnBackup Raises the Backup event.
Public method OnBackupComplete Raises the BackupComplete event.
Protected method OnDeserialization Called after the object has been deserialized from the file system cache or the database. (Overrides SPPersistedObject.OnDeserialization().)
Protected method OnPostCreate (Overrides SPPersistedObject.OnPostCreate().)
Public method OnPostRestore Raises the PostRestore event.
Protected method OnPreCreate (Overrides SPPersistedObject.OnPreCreate().)
Public method OnPrepareBackup Raises the PreBackup event.
Public method OnPreRestore Raises the PreRestore event.
Public method OnRestore Raises the Restore event.
Public method Provision Provisions the application on the local server, including content databases if necessary. (Overrides SPPersistedObject.Provision().)
Public method ProvisionGlobally Provisions the Web application to all servers that are running the current object's parent Web service.
Public method QueryFeatures(Guid) Retrieves all features in the current Web application that are scoped to Site or Web and have the specified feature identifier.
Public method QueryFeatures(SPFeatureScope, Boolean) Retrieves all features in the current Web application that are scoped to Site or Web and have a specific needsUpgrade state.
Public method QueryFeatures(Guid, Boolean) Retrieves all features in the current Web application that are scoped to Site or Web and have the specified feature identifier and requirement for upgrade.
Public method QueryFeatures(Guid, Version) Retrieves all features in the current Web application that are scoped to Site or Web and have the specified feature and version identifiers.
Protected method RemoveIdentityFromLocalGroups Removes the current application pool from local groups if it is not used by other Web applications on the server.
Public method RenameApplicationPool Renames the application pool on all servers and updates the database.
Public method RequireDynamicCanary If this UrlZone requires dynamic canary
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method SelfServiceCreate(SPWeb, String, String, String, String, String, String) Creates SPSite or SPWeb object use the SPWebApplication.MaxSiteVersion.
Public method SelfServiceCreate(SPWeb, String, String, String, String, String, String, Int32) Creates SPSite or SPWeb object, depending on the self service creation mode set in the SPWebApplication, based on a simple set of input parameters. The site owner will be the user calling this method. The site will be created using the "STS#0" site template, without a description, the title will be the same as the relative URL and the LCID will match that of the input context Web. NOTE: If an Individual Site will be created, it will have unique permissions and a link to its homepage will be placed in the parent web's top navigation bar.
Public method SelfServiceCreate(SPWeb, String, String, String, String, String, String, Int32, Boolean)
Public method SetDailyUnthrottledPrivilegedOperationWindow Sets the daily unthrottled window.
Public method SetRequireDynamicCanary If this UrlZone requires dynamic canary
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision() Unprovisions the Web application and removes it from all local Internet Information Services (IIS) Web sites. (Overrides SPPersistedObject.Unprovision().)
Public method Unprovision(Boolean) Unprovisions the Web application and optionally removes the application from all local Internet Information Services (IIS) Web sites.
Public method UnprovisionGlobally() Removes the Web application from all front-end Web servers.
Public method UnprovisionGlobally(Boolean) Removes the Web application from all front-end Web servers and optionally removes the Internet Information Services (IIS) Web sites.
Public method Update() Causes the Web application to serialize its state and propagate changes throughout the server farm. (Overrides SPPersistedObject.Update().)
Public method 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.)
Public method UpdateCredentials Updates credentials in the database when a username or password changes.
Public method UpdateMailSettings(String, String, String, Int32) Updates the e-mail settings that are used when SharePoint Foundation sends email.
Public method UpdateMailSettings(String, String, String, Int32, Nullable<Boolean>, Int32)
Public method UpdateMappedPage Updates the custom application page mapping.
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateSmsAccount Assigns to the Web application the account with a mobile messaging service provider that is used by mobile alerts.
Public method UpdateVersionedMappedPage
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Public method UpdateWorkflowConfigurationSettings Reads the web.config file and copies its content as settings.
Public method Upgrade() Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
Protected method Validate Validates the state of the Web application before persisting the object. (Overrides SPPersistedObject.Validate().)
Public method 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.)
Public method ValidateMigrateUserParameters Validates a given set of migration parameters to determine if they are valid.
Public method ZonePolicies Returns the set of policies that apply to the specified zone.

Top

See also

Reference

SPWebApplication class

Microsoft.SharePoint.Administration namespace