This section provides the details of the application programming interface (API) for the SQL Admin Provider namespace included with the Microsoft® Provisioning System (MPS) in the Microsoft Solution for Hosted Messaging and Collaboration version 4.5 . It describes the methods of the SQL Admin Provider along with input parameters, output parameters, transaction rollback calls, and other requirements. For each method of the SQL Admin Provider, an Extensible Markup Language (XML) request is included as a usage example that you can submit to MPS. Also included for each method is the structure of a sample XML response returned by MPS after provisioning tasks are completed.
Developers should use this API document as a reference when creating XML requests that initiate provisioning tasks to manipulate Microsoft SQL ServerT functionality on a computer running Microsoft Windows 2000 or Microsoft Windows ServerT 2003.
The SQL Admin Provider namespace uses several procedures to encapsulate the process of creating and modifying database objects that are common to provisioning a user for hosted SQL services via MPS. The SQL Admin Provider has the functionality to execute direct SQL calls, but does not expose anything beyond the most basic of calls, for example, ExecuteSQL. The SQL Admin Provider also supports methods that enable you to manipulate data and log files by designating such parameters as file growth increments and file size specifications.
You can install the SQL Admin Provider with the MPS Deployment Tool, provided with MPS in Microsoft Solution for Hosted Messaging and Collaboration version 4.5 .
The purpose of the SQL Admin Provider is to provide an abstraction layer to the direct Transact- SQL calls used to create and modify items within a Microsoft SQL Server database. The SQL Admin Provider provides low-level calls to the database and makes few or no assumptions that force the database object to be created according to any pre-conceived business model or process. Namespaces can be layered on top of the SQL Admin Provider to create different layers of functional encapsulation. The higher layers provide support for integration with SQL Resource Manager and other hosting-specific business processes.
|SQL Admin Provider::CreateDatabase||Allows you to create a database on a SQL server.|
|SQL Admin Provider::DeleteDatabase||Allows you to delete a database on a SQL server.|
|SQL Admin Provider::ModifyDatabaseFile||Modifies a database file (data or log) on a SQL Server.|
|SQL Admin Provider::ListAllDatabases||Allows you to list all databases on a specific SQL server.|
|SQL Admin Provider::AddLogin||Allows you to create a standard SQL user account.|
|SQL Admin Provider::GrantLogin||Allows you to grant SQL access to a WINNT\Windows 2000 account.|
|SQL Admin Provider::DropLogin||Allows you to delete a standard SQL user account from the SQL server.|
|SQL Admin Provider::RevokeLogin||Removes the login entries from Microsoft SQL Server for a Microsoft Windows NT user or group created with GrantLogin.|
|SQL Admin Provider::AddUserToRole||Allows you to add a user to a SQL role.|
|SQL Admin Provider::RemoveUserFromRole||Allows you to remove a user from a SQL role.|
|SQL Admin Provider::BackupDBToDisk||Allows you to create a full database backup to disk.|
|SQL Admin Provider::ListBackupInformation||Returns the information about backup events stored in particular disk file.|
|SQL Admin Provider::RestoreDBFromDisk||Allows you to restore a backup from disk.|
|SQL Admin Provider::GrantDBAccess||Allows you to grant access to a SQL account for a particular database on a Microsoft Windows NT or Microsoft Windows 2000 server.|
|SQL Admin Provider::RevokeDBAccess||Allows you to revoke the access of a SQL account for a particular database on a Windows NT or Windows 2000 server.|
|SQL Admin Provider::SetPassword||Allows you to set the password of a SQL user account.|
|SQL Admin Provider::ChangePassword||Allows you to change the password of a SQL user account.|