SPAdministrationWebApplication methods

  • Article

The SPAdministrationWebApplication type exposes the following members.

Methods

  Name Description
Public method AddAdministrativeTask Obsolete. Adds an item to the administration Tasks list.
Public method AddBackupObjects Adds the Web application and its children to the backup/restore job. (Inherited from SPWebApplication.)
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) (Inherited from SPWebApplication.)
Public method AdministrativeTaskExists Obsolete. Returns a Boolean value that indicates whether an administrative task item exists.
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. (Inherited from SPWebApplication.)
Public method CurrentUserIsDelegatedAdministrator Determines whether the current user is a delegated administrator of this administration Web application.
Public method Delete Removes the Web application and some of the resources that it owns. (Inherited from SPWebApplication.)
Public method EnsureDefaultJobs Ensures that the default timer job definitions exist for the Web application. (Inherited from SPWebApplication.)
Public method EnsureSystemTask Obsolete. Adds a system task to the administration Tasks list if it does not already exist.
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. (Inherited from SPWebApplication.)
Public method GetDeletedSites(Guid) Gets a list of deleted sites with the specified site collection identifier (ID). (Inherited from SPWebApplication.)
Public method GetDeletedSites(String) Gets a list of deleted sites with the specified prefix of a server-relative URL. (Inherited from SPWebApplication.)
Public method GetDeletedSites(SPDeletedSiteQuery) Gets a list of deleted sites using the specified query. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
Public methodStatic member GetInstanceLocalToFarm Returns the administration Web application that is local to the server farm.
Public method GetListItemLastModifiedDates For a collections of list URLs, return the list item last modified dates of each list. (Inherited from SPWebApplication.)
Public method GetMappedPage(String) Returns the location of the customized application page. (Inherited from SPWebApplication.)
Public method GetMappedPage(SPWebApplication.SPCustomPage) Returns the location of the customized application page. (Inherited from SPWebApplication.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetResponseUri(SPUrlZone) Returns the absolute root of the URI for the given zone. (Inherited from SPWebApplication.)
Public method GetResponseUri(SPUrlZone, String) Retrieves the absolute root of the URI for the given zone and appends the specified path to the end. (Inherited from SPWebApplication.)
Public method GetSecurityTokenServiceEndPointAddress Returns the endpoint URI of the security token service based on the specified request zone. (Inherited from SPWebApplication.)
Public method GetSelfServiceCreationPageUrl Determines the appropriate Url for the Self Service Create page. (Inherited from SPWebApplication.)
Public method GetType (Inherited from Object.)
Public method GetVersionedMappedPage(String) (Inherited from SPWebApplication.)
Public method GetVersionedMappedPage(SPWebApplication.SPCustomPage, Int32) (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
Protected method InstallFiles A helper for Provision which installs the required asp.net configuration and resource files. (Overrides SPWebApplication.InstallFiles(DirectoryInfo, String, String).)
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. (Inherited from SPWebApplication.)
Public method IsUserLicensedForEntity Checks if the currently logged in user has the proper license to access the specified entity. (Inherited from SPWebApplication.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
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. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
Public method MigrateEntities(IMigrateEntityForWebApplicationCallback, SPMigrateEntitiesOperationParameters) (Inherited from SPWebApplication.)
Public method MigrateEntities(SPWebApplication.IMigrateUserCallback, SPMigrateEntitiesOperationParameters) (Inherited from SPWebApplication.)
Public method MigrateUsers(Boolean) Obsolete. Converts existing users to or from accounts that use claims authentication. (Inherited from SPWebApplication.)
Public method MigrateUsers(SPWebApplication.IMigrateUserCallback) Migrates users to claims authentication. (Inherited from SPWebApplication.)
Public method MigrateUsers(SPWebApplication.IMigrateUserCallback, SPWebApplication.SPMigrateUserParameters) Migrates users to claims authentication. (Inherited from SPWebApplication.)
Public method MigrateUsersToClaims(NTAccount, Boolean) Migrates users from legacy authentication to claims-based authentication. (Inherited from SPWebApplication.)
Public method MigrateUsersToClaims(NTAccount, Boolean, SPWebApplication.SPMigrateUserParameters) Migrates users from legacy authentication to claims-based authentication. (Inherited from SPWebApplication.)
Public method OnAbort Raises the Abort (backup) event. (Inherited from SPWebApplication.)
Public method OnBackup Raises the Backup event. (Inherited from SPWebApplication.)
Public method OnBackupComplete Raises the BackupComplete event. (Inherited from SPWebApplication.)
Protected method OnDeserialization Called after the object has been deserialized from the file system cache or the database. (Inherited from SPWebApplication.)
Protected method OnPostCreate (Inherited from SPWebApplication.)
Public method OnPostRestore Raises the PostRestore event. (Inherited from SPWebApplication.)
Protected method OnPreCreate (Inherited from SPWebApplication.)
Public method OnPrepareBackup Raises the PreBackup event. (Inherited from SPWebApplication.)
Public method OnPreRestore Raises the PreRestore event. (Inherited from SPWebApplication.)
Public method OnRestore Handles the Restore event. (Overrides SPWebApplication.OnRestore(Object, SPRestoreInformation).)
Public method Provision Provisions the Web application with static files that are unique to the administration Web application. (Overrides SPWebApplication.Provision().)
Public method ProvisionGlobally Provisions the Web application to all servers that are running the current object's parent Web service. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
Public method RemoveAdministrativeTask Obsolete. Removes the specified item from the administration Tasks list.
Protected method RemoveIdentityFromLocalGroups Removes the current application pool from local groups if it is not used by other Web applications on the server. (Inherited from SPWebApplication.)
Public method RenameApplicationPool Renames the application pool on all servers and updates the database. (Inherited from SPWebApplication.)
Public method RequireDynamicCanary If this UrlZone requires dynamic canary (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
Public method SelfServiceCreate(SPWeb, String, String, String, String, String, String, Int32, Boolean) (Inherited from SPWebApplication.)
Public method SetDailyUnthrottledPrivilegedOperationWindow Sets the daily unthrottled window. (Inherited from SPWebApplication.)
Public method SetRequireDynamicCanary If this UrlZone requires dynamic canary (Inherited from SPWebApplication.)
Public method SwitchAdministrativeTasksView Obsolete. Switches the view that is used for the administration Tasks list to the specified view.
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() Removes the administration Web application from the current front-end Web server. (Overrides SPWebApplication.Unprovision().)
Public method Unprovision(Boolean) Unprovisions the Web application and optionally removes the application from all local Internet Information Services (IIS) Web sites. (Inherited from SPWebApplication.)
Public method UnprovisionGlobally() Removes the Web application from all front-end Web servers. (Inherited from SPWebApplication.)
Public method UnprovisionGlobally(Boolean) Removes the Web application from all front-end Web servers and optionally removes the Internet Information Services (IIS) Web sites. (Inherited from SPWebApplication.)
Public method Update() Causes the Web application to serialize its state and propagate changes throughout the server farm. (Inherited from SPWebApplication.)
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 when the user name or password of the administration Web application changes. (Overrides SPWebApplication.UpdateCredentials(String).)
Public method UpdateMailSettings(String, String, String, Int32) Updates the e-mail settings that are used when SharePoint Foundation sends email. (Inherited from SPWebApplication.)
Public method UpdateMailSettings(String, String, String, Int32, Nullable<Boolean>, Int32) (Inherited from SPWebApplication.)
Public method UpdateMappedPage Updates the custom application page mapping. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
Public method UpdateVersionedMappedPage (Inherited from SPWebApplication.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Public method UpdateWorkflowConfigurationSettings Reads the web.config file and copies its content as settings. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
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. (Inherited from SPWebApplication.)
Public method ZonePolicies Returns the set of policies that apply to the specified zone. (Inherited from SPWebApplication.)

Top

See also

Reference

SPAdministrationWebApplication class

Microsoft.SharePoint.Administration namespace