SPGlobalAdmin.CreateAdminVirtualServer Method

NOTE: This API is now obsolete.

The Administration Web application is created when the server farm is created. To provision the Central Administration Web site on a server, enable the Central Administration Web service instead. (In Windows SharePoint Services 2.0 the CreateAdminVirtualServer method created an administration virtual server, and is maintained for backward compatibility.)

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<ObsoleteAttribute("The Administration Web application is now created at the same time as the server farm.  To provision the central administration site on a server, enable the central administration web service instance.",  _
    False)> _
Public Function CreateAdminVirtualServer ( _
    bCreateNewAppPool As Boolean, _
    strAppPoolId As String, _
    bConfigurableAppPoolAccount As Boolean, _
    strAppPoolUserName As String, _
    strAppPoolPassword As String _
) As Uri
'Usage
Dim instance As SPGlobalAdmin
Dim bCreateNewAppPool As Boolean
Dim strAppPoolId As String
Dim bConfigurableAppPoolAccount As Boolean
Dim strAppPoolUserName As String
Dim strAppPoolPassword As String
Dim returnValue As Uri

returnValue = instance.CreateAdminVirtualServer(bCreateNewAppPool, _
    strAppPoolId, bConfigurableAppPoolAccount, _
    strAppPoolUserName, strAppPoolPassword)
[ObsoleteAttribute("The Administration Web application is now created at the same time as the server farm.  To provision the central administration site on a server, enable the central administration web service instance.", 
    false)]
public Uri CreateAdminVirtualServer(
    bool bCreateNewAppPool,
    string strAppPoolId,
    bool bConfigurableAppPoolAccount,
    string strAppPoolUserName,
    string strAppPoolPassword
)

Parameters

  • bCreateNewAppPool
    Type: System.Boolean

    Windows SharePoint Services 3.0 uses information in the configuration database to create an administrative Web application and ignores this parameter. In Windows SharePoint Services 2.0, true to create an application pool; otherwise, false.

  • strAppPoolId
    Type: System.String

    Windows SharePoint Services 3.0 uses information in the configuration database to create an administrative Web application and ignores this parameter. In Windows SharePoint Services 2.0, a string that specifies an ID for the application pool.

  • bConfigurableAppPoolAccount
    Type: System.Boolean

    Windows SharePoint Services 3.0 uses information in the configuration database to create an administrative Web application and ignores this parameter. In Windows SharePoint Services 2.0, true to specify that the application pool account is configurable; otherwise, false.

  • strAppPoolUserName
    Type: System.String

    Windows SharePoint Services 3.0 uses information in the configuration database to create an administrative Web application and ignores this parameter. In Windows SharePoint Services 2.0, a string that specifies a user name for the administrator account of the application pool. This parameter is required only if the bConfigurableAppPoolAccount parameter contains true.

  • strAppPoolPassword
    Type: System.String

    Windows SharePoint Services 3.0 uses information in the configuration database to create an administrative Web application and ignores this parameter. In Windows SharePoint Services 2.0, a string that specifies a password for the administrator account of the application pool. This parameter is required only if the bConfigurableAppPoolAccount parameter contains true.

Return Value

Type: System.Uri
An absolute URI that represents the new administration virtual server.

See Also

Reference

SPGlobalAdmin Class

SPGlobalAdmin Members

Microsoft.SharePoint.Administration Namespace