Backup.MediaDescription Property
Gets or sets a textual description of the medium that contains a backup set.
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)
Syntax
'Declaration
Public Property MediaDescription As String
Get
Set
'Usage
Dim instance As Backup
Dim value As String
value = instance.MediaDescription
instance.MediaDescription = value
public string MediaDescription { get; set; }
public:
property String^ MediaDescription {
String^ get ();
void set (String^ value);
}
member MediaDescription : string with get, set
function get MediaDescription () : String
function set MediaDescription (value : String)
Property Value
Type: System.String
A String value that contains a textual description of the medium.
Remarks
The MediaDescription is written to a tape medium when the medium is initialized.
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"
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace