Backup.MediaDescription Backup.MediaDescription Backup.MediaDescription Property

Definition

Gets or sets a textual description of the medium that contains a backup set.

public:
 property System::String ^ MediaDescription { System::String ^ get(); void set(System::String ^ value); };
public string MediaDescription { get; set; }
Public Property MediaDescription As String
Property Value

A String value that contains a textual description of the medium.

Examples

VB

'Connect to the local, default instance of SQL Server.  
Dim srv As Server  
srv = New Server  
'Reference the AdventureWorks2012 database.  
Dim db As Database  
db = srv.Databases("AdventureWorks2012")  
Dim bk As New Backup  
bk.Action = BackupActionType.Database  
bk.Database = "AdventureWorks2012"  
bk.MediaDescription = "External hard drive"  

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")  
$db = New-Object Microsoft.SqlServer.Management.Smo.Database  
$db = $srv.Databases.Item("AdventureWorks2012")  
$bk = new-object Microsoft.SqlServer.Management.Smo.Backup  
$bk.Action = [Microsoft.SqlServer.Management.Smo.BackupActionType]::Database  
$bk.Database = "AdventureWorks2012"  
$bk.MediaDescription = "External hard drive"  

Remarks

The MediaDescription is written to a tape medium when the medium is initialized.

Applies to