Microsoft.SharePoint.Portal.Topology Namespace
The Microsoft.SharePoint.Portal.Topology namespace contains classes that configure and manage the topology of a server or server farm deployment for Microsoft Office SharePoint Portal Server 2003. These classes allow you to identify, configure, and manage various server components and services such as database or search components across a deployment of SharePoint Portal Server.
There are numerous supported topology configurations for SharePoint Portal Server. While it is possible to use a single server to deploy SharePoint Portal Server, these topics assume that you are managing a topology across a server farm deployment of SharePoint Portal Server. A server farm is a centralized grouping of network servers maintained by an enterprise or by an Internet service provider (ISP). A server farm provides a network with load balancing, scalability, and fault tolerance. Individual servers may be connected in such a way that they appear to represent a single resource. In a single server deployment of SharePoint Portal Server, all service and component objects reside on the single server.
For additional information about deployment scenarios for SharePoint Portal Server, see the Microsoft Office SharePoint Portal Server 2003 Administrator's Guide.
To use the properties and methods of the objects in the Topology namespace you must be a member of the local STS_WPG and SPS_WPG security groups, and a member of the db_owner database role for the configuration database.
In addition, for certain methods, such as those that create a portal site, you must be a member of the local Administrators group, and have membership in the Database Creators and Security Administrators server roles in the SQL Server instance that hosts the configuration database.
Classes
The following table shows the classes of the Microsoft.SharePoint.Portal.Topology namespace and a brief description of each.
| Name | Description |
|---|---|
| AdministrationCredentials | Reserved for internal use only. |
| AlertsService | Represents an instance of the SharePoint Portal Alert Service. |
| AlertsServiceCollection | Represents a collection of AlertsService objects. |
| ApplicationCredentials | Reserved for internal use only. |
| ConcurrencyException | Provides the exception thrown when database update and delete conflicts exist. |
| ConfigurationDatabase | Represents the configuration database. |
| Database | Represents a content database for one or more SharePoint sites. |
| DatabaseCapacityException | Represents the exception thrown when a content database approaches capacity. |
| DatabaseCollection | Represents a collection of content databases. |
| DatabaseException | Represents an exception thrown while accessing data in the configuration database. |
| DatabaseService | Represents a Microsoft SQL Server instance. |
| DatabaseServiceCollection | Represents a collection of DatabaseService objects. |
| DeletedConcurrencyException | Represents the exception thrown when delete conflicts are detected in the content database. |
| DocumentService | Represents a component that manages DocumentWorkspace objects. |
| DocumentServiceCollection | Represents a collection of DocumentService objects. |
| DocumentWorkspace | Represents the services and components that compose a backward-compatible document library (Web Storage System-based). |
| DocumentWorkspaceCollection | Represents a collection of DocumentWorkspace objects. |
| DuplicatePortalUrlException | Represents the exception thrown when a duplicate portal site URL exists. |
| ExtendedStatus | Represents a set of properties that report the progress when applying SharePoint Portal Server-based schema to a site based on Microsoft Windows SharePoint Services. |
| GlobalProperties | Provides a set of properties specific to Windows SharePoint Services that apply across a server or server farm. |
| Globals | Provides a set of properties that apply across a server or server farm. |
| IndexService | Represents an instance of the Microsoft SharePoint Portal Server Search service that creates content indexes. |
| IndexServiceCollection | Represents a collection of IndexService objects. |
| InvalidConfigurationException | Represents the exception thrown when an invalid topology configuration exists. |
| InvalidServiceClassException | Represents the exception thrown when an invalid Service object exists. |
| PortalSite | Represents a portal site in the topology of a server farm. |
| PortalSiteCollection | Represents a collection of portal sites in the topology of a server farm. |
| PortalUrl | Provides a URL used to access a portal site. |
| PortalUrlCollection | Represents a collection of PortalURL objects. |
| ProductKeyNullException | Represents an exception thrown when a missing product key is encountered. |
| ResourceAccess | Reserved for internal use only. |
| SearchService | Represents an instance of the Microsoft SharePoint Portal Server Search service that provides search. |
| SearchServiceCollection | Represents a collection of SearchService objects. |
| Server | Represents a server computer in the topology of the server farm. |
| ServerCollection | Represents a collection of Server objects in the topology of the server farm. |
| Service | Represents one of the components or services in the topology of a server farm. Service is the base class from which other classes that represent all components or services in the topology are derived. |
| ServiceCollection | Represents a collection of Service objects. |
| SmtpService | Represents an instance of the Simple Mail Transfer Protocol (SMTP) service associated with the topology of the server farm. |
| SmtpServiceCollection | Represents a collection of SmtpService objects. |
| SqlCollectionBase | Provides a base class for collections of objects whose definitions are stored in databases in the topology of the server farm. |
| SqlCollectionBase.SqlEnumerator | Provides a nested class that supports iterating through the members of collections that inherit from the SqlCollectionBase class. |
| SqlConnectionString | Represents a connection string for a Database object. |
| TeamSite | Represents an instance of a Web site based on Windows SharePoint Services in the topology of a server farm. |
| TeamSiteCollection | Represents a collection of TeamSite objects in the topology of a server farm. |
| TeamWebService | Represents an instance of a Windows SharePoint Services-based Web service in the topology of a server farm. |
| TeamWebServiceCollection | Represents a collection of TeamWebService objects in the topology of a server farm. |
| TopologyLock | Provides a set of properties for managing temporary locks on the topology of a server farm. |
| TopologyManager | Represents the top-level class for configuring and managing the topology of a server farm. |
| TopologyObjectBase | Represents the base class for objects in the topology of a server farm. |
| TopologyObjectCollectionBase | Represents the base class for collections of objects in the topology of the server farm. |
| UpdatedConcurrencyException | Represents the exception thrown when update conflicts to the configuration database exist. |
| VirtualServer | Represents a virtual server created under the Web Sites node in Internet Information Services (IIS). |
| VirtualServerCollection | Represents a collection of VirtualServer objects in the topology of a server farm. |
| WebService | Represents an instance of World Wide Web Publishing Service (W3SVC) in the topology of a server farm. |
| WebServiceCollection | Represents a collection of WebService objects in the topology of a server farm. |
Enumerations
The following table shows the enumerations of the Microsoft.SharePoint.Portal.Topology namespace and a brief description of each.
| Name | Description |
|---|---|
| ConfigurationDatabaseStatus | Indicates the status of the configuration database. |
| PortalZone | Indicates the Web content zone of a URL in Microsoft Internet Explorer for security settings. |
| ProxyType | Indicates whether the portal site uses a proxy server or accesses Web sites directly when crawling content. |
| ServiceCredential | Reserved for internal use only. |
| TopologyClassification | Indicates the configuration of the topology of a server farm. |
| TopologyStatus | Indicates the status of a topology configuration. |