BackupDevice Class

Article
08/11/2014

The BackupDevice object provides programmatic access to SQL Server backup devices.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.BackupDevice

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class BackupDevice _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IDroppable, IScriptable
'Usage
Dim instance As BackupDevice

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class BackupDevice : ScriptNameObjectBase, 
    ICreatable, IDroppable, IScriptable

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class BackupDevice sealed : public ScriptNameObjectBase, 
    ICreatable, IDroppable, IScriptable

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type BackupDevice =  
    class 
        inherit ScriptNameObjectBase 
        interface ICreatable 
        interface IDroppable 
        interface IScriptable 
    end

public final class BackupDevice extends ScriptNameObjectBase implements ICreatable, IDroppable, IScriptable

The BackupDevice type exposes the following members.

Constructors

	Name	Description
	BackupDevice()	Initializes a new instance of the BackupDevice class.
	BackupDevice(Server, String)	Initializes a new instance of the BackupDevice class with the specified name and on the specified instance of SQL Server.

Top

Properties

	Name	Description
	BackupDeviceType	Gets or sets the type of backup device of the backup device.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	Parent	Gets the Server object that owns the BackupDevice object.
	PhysicalLocation	Gets or sets the path to the device or operating system file that represents the physical backup location.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	SkipTapeLabel	Gets or sets a Boolean property value that specifies whether to check that the tape label is correct or not.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Create	Creates a new backup device on the instance of SQL Server as defined by the BackupDevice object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops an existing backup device.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	ReadBackupHeader	Enumerates the contents of the media maintained by a backup device or operating system file.
	ReadMediaHeader	Enumerates the values of a backup media header record.
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Script()	Generates a Transact-SQL script that can be used to re-create the backup device.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the backup device as specified by the script options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

SQL Server backup devices specify the behavior of specific backup media, usually tape. Backup devices are not required when issuing a BACKUP or RESTORE statement and are not required by the Backup object.

With the BackupDevice object, you can:

Define a new backup device for a server running Microsoft SQL Server.
Change the definition of an existing Microsoft SQL Server backup device.

The BackupDeviceType property must match the definition of the sysname SQL Server data type.

To get BackupDevice object properties, users can be a member of the public fixed server role.

To set BackupDevice object properties, users must have BACKUP DATABASE or BACKUP LOG permissions on the database, or be a member of the db_owner and db_backupoperator fixed database role and the sysadmin fixed server role.

Examples

Backing Up and Restoring Databases and Transaction Logs

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.