Share via


Volume Class

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
Public method Volume() Initializes a new instance of the Volume class.
Public method Volume(Computer, String) Initializes a new instance of the Volume class with the specified connection.

Top

Properties

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

Top

Methods

  Name Description
Protected method CreateIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Discover Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Equals (Inherited from Object.)
Protected method GetChildCollection Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetDomain Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetObjectFactory Gets the factory object used to create new instances.
Public method GetPropertySet Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method 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.)
Protected method InitializeUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public method Refresh Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Protected method ResetKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Serialize Serializes the instance to XML. (Inherited from SfcInstance.)
Public method ToString Returns a string representation of the instance Urn. (Inherited from SfcInstance.)

Top

Events

  Name Description
Public event PropertyChanged CLS-compliant event for property changes. (Inherited from SfcInstance.)
Public event 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.

See Also

Reference

Microsoft.SqlServer.Management.Utility Namespace