Volume Class

Article
08/11/2014

The Volume type represents information about a volume or disk partition on a computer in the SQL Server Utility domain.

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
Microsoft.SqlServer.Management.Utility.Volume

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

Syntax

'Declaration
<TypeConverterAttribute(GetType(LocalizableTypeConverter))> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Utility.FacetSR",  _
    True)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Volume _
    Inherits SfcInstance
'Usage
Dim instance As Volume

[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Utility.FacetSR", 
    true)]
[PhysicalFacetAttribute]
public sealed class Volume : SfcInstance

[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[LocalizedPropertyResourcesAttribute(L"Microsoft.SqlServer.Management.Utility.FacetSR", 
    true)]
[PhysicalFacetAttribute]
public ref class Volume sealed : public SfcInstance

[<SealedAttribute>]
[<TypeConverterAttribute(typeof(LocalizableTypeConverter))>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Utility.FacetSR", 
    true)>]
[<PhysicalFacetAttribute>]
type Volume =  
    class 
        inherit SfcInstance 
    end

public final class Volume extends SfcInstance

The Volume type exposes the following members.

Constructors

	Name	Description
	Volume()	Initializes a new instance of the Volume class.
	Volume(Computer, String)	Initializes a new instance of the Volume class with the specified connection.

Top

Properties

	Name	Description
	AbstractIdentityKey	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	DeviceId	Gets the device Id of the volume instance.
	ID	Gets the ID value that uniquely identifies the volume.
	IdentityKey	Gets the Key value that uniquely identifies the volume.
	Metadata	Returns metadata about the instance and its domain. (Inherited from SfcInstance.)
	Name	Gets the String value that specifies the name of the volume.
	Parent	Gets the Computer object value that specifies is the parent of the Volume object.
	Properties	Returns a collection instance properties. (Inherited from SfcInstance.)
	State	Returns the state of the SfcInstance object. (Inherited from SfcInstance.)
	TotalSpace	Gets the total storage capacity of the volume in megabytes.
	TotalSpaceUsed	Gets the total used storage on the volume in megabytes.
	TotalSpaceUtilization	Gets the space used as a percentage of the total storage capacity of the volume.
	Urn	Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)

Top

Methods

	Name	Description
	CreateIdentityKey	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	Discover	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	Equals	(Inherited from Object.)
	GetChildCollection	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	GetDomain	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	GetHashCode	(Inherited from Object.)
	GetObjectFactory	Gets the factory object used to create new instances.
	GetPropertySet	Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
	GetType	(Inherited from Object.)
	GetTypeMetadataImpl	Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	InitializeUIPropertyState	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	OnPropertyMetadataChanges	Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
	OnPropertyValueChanges	Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
	Refresh	Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
	ResetKey	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	Serialize	Serializes the instance to XML. (Inherited from SfcInstance.)
	ToString	Returns a string representation of the instance Urn. (Inherited from SfcInstance.)

Top

Events

	Name	Description
	PropertyChanged	CLS-compliant event for property changes. (Inherited from SfcInstance.)
	PropertyMetadataChanged	CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Remarks

The Volume object represents information about a volume or disk partition on a computer in the SQL Server Utility domain. Using the Volume object, you can:

Determine whether the volume is a mount point, and its location.
Determine the total disk space, the space used and the space utilization.

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.

Share via