• Article

Database.Backup Method (String, Boolean, Boolean, array<BackupLocation[])

Provides programmatic access to Backup operations for a Database with file, AllowOverWrite, BackupRemotePartitions, and locations parameters.

Namespace:  Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)

Syntax

'Declaration
Public Sub Backup ( _
    file As String, _
    allowOverwrite As Boolean, _
    backupRemotePartitions As Boolean, _
    locations As BackupLocation() _
)
'Usage
Dim instance As Database
Dim file As String
Dim allowOverwrite As Boolean
Dim backupRemotePartitions As Boolean
Dim locations As BackupLocation()

instance.Backup(file, allowOverwrite, _
    backupRemotePartitions, locations)

public void Backup(
    string file,
    bool allowOverwrite,
    bool backupRemotePartitions,
    BackupLocation[] locations
)

public:
void Backup(
    String^ file, 
    bool allowOverwrite, 
    bool backupRemotePartitions, 
    array<BackupLocation^>^ locations
)

member Backup : 
        file:string * 
        allowOverwrite:bool * 
        backupRemotePartitions:bool * 
        locations:BackupLocation[] -> unit 

public function Backup(
    file : String, 
    allowOverwrite : boolean, 
    backupRemotePartitions : boolean, 
    locations : BackupLocation[]
)

Parameters

  • file
    Type: System.String
    A file containing the parameters to be applied during backup of a Database.  
  • allowOverwrite
    Type: System.Boolean
    true if overwrite is allowed; otherwise, false. 
  • backupRemotePartitions
    Type: System.Boolean
    true if remote partitions are subject to backup; otherwise, false. 

Remarks

Security noteSecurity Note

For each backup file, the user who runs the backup command must have permission to write to the backup location specified for each file. Also, the user must have one of the following roles: a member of a server role for the Analysis Services instance or a member of a database role with Full Control (Administrator) permissions on the database to be backed up.