VirtualHardDisk [SPFSDK][VMMREF]
Applies To: Windows Azure Pack
The VirtualHardDisk entity represents a virtual hard disk.
A virtual hard disk can be a Windows-based .vhd file, a Citrix XenServer-based .vhd file, or a VMware-based .vmdk file. A virtual hard disk might be stored as a standalone object in the VMM library, attached to a virtual disk drive on a template, or attached to a virtual disk drive on a deployed or stored virtual machine.
Inheritance Hierarchy
VMM
VirtualHardDisk
Entity Properties
For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.
Name |
Create (POST) |
Read (GET) |
Update (PUT) |
Delete (DELETE) |
Type |
Nullable |
Description |
---|---|---|---|---|---|---|---|
ID |
- |
Optional |
- |
- |
Edm.Guid |
False |
Key Property The identifier of the entity. |
StampId |
- |
Optional |
- |
- |
Edm.Guid |
False |
Key Property The identifier of the stamp that restricts the query. |
Accessibility |
- |
Optional |
- |
- |
Edm.String |
True |
Indicates that this virtual hard disk is available for VMs (public) or is an internal disk.
|
AddedTime |
- |
Optional |
- |
- |
Edm.DateTime |
True |
When the entity was added. |
CloudId |
- |
Optional |
- |
- |
Edm.Guid |
True |
The identifier of the Cloud. |
Description |
- |
Optional |
- |
- |
Edm.String |
True |
A friendly description of this hard disk. |
Directory |
- |
Optional |
- |
- |
Edm.String |
True |
The folder location to the virtual disk. |
Enabled |
- |
Optional |
- |
- |
Edm.Boolean |
True |
When false, indicates that this hard disk cannot be deployed to a VM. |
FamilyName |
- |
Optional |
- |
- |
Edm.String |
True |
The operating system family name. |
HostVolumeId |
- |
Optional |
- |
- |
Edm.Guid |
True |
The identifier of the VMM host where this hard disk is located. |
IsOrphaned |
- |
Optional |
- |
- |
Edm.Boolean |
True |
Indicates that this hard disk is orphaned in the library. |
IsResourceGroup |
- |
Optional |
- |
- |
Edm.Boolean |
True |
Not applicable |
JobGroupId |
- |
Optional |
- |
- |
Edm.Guid |
True |
The identifier for a series of commands that will run as a set |
LibraryGroup |
- |
Optional |
- |
- |
Edm.String |
True |
The library group that the hard disk belongs to. Only applicable to hard disks in the library. |
LibraryShareId |
- |
Optional |
- |
- |
Edm.Guid |
True |
The identifier of the LibraryShare. |
Location |
- |
Optional |
- |
- |
Edm.String |
True |
The file location of the hard disk. |
MaximumSize |
- |
Optional |
- |
- |
Edm.Int64 |
True |
The maximum size of the disk in Megabytes (MB). |
ModifiedTime |
- |
Optional |
- |
- |
Edm.DateTime |
True |
When the entity was last modified. |
Name |
- |
Optional |
- |
- |
Edm.String |
True |
The name of the disk. |
Namespace |
- |
Optional |
- |
- |
Edm.String |
True |
The namespace of the hard disk generated by VMM. |
OperatingSystem |
- |
Optional |
- |
- |
Edm.String |
True |
The name of the operating system. |
OperatingSystemId |
- |
Optional |
- |
- |
Edm.Guid |
True |
The identifier of the operating system, when it is known. |
OperatingSystemInstance |
- |
Optional |
- |
- |
OperatingSystem |
True |
Describes the current operating system. |
Owner |
- |
Optional |
- |
- |
UserAndRole |
True |
The UserAndRole that owns the virtual hard disk. |
OwnerSid |
- |
Optional |
- |
- |
Edm.String |
True |
The security identifier of the owner |
ParentDiskId |
- |
Optional |
- |
- |
Edm.Guid |
True |
The identifier of the parent disk if this hard disk is a differencing disk. |
Release |
- |
Optional |
- |
- |
Edm.String |
True |
Describes the release of a library resource |
ReleaseTime |
- |
Optional |
- |
- |
Edm.DateTime |
True |
The date and time when the family and release tags were last set. |
SANCopyCapable |
- |
Optional |
- |
- |
Edm.Boolean |
True |
When true, indicates that this hard disk resides on a SAN that is clone-capable. |
SharePath |
- |
Optional |
- |
- |
Edm.String |
True |
The share path of the hard disk. |
Size |
- |
Optional |
- |
- |
Edm.Int64 |
True |
The size of the virtual hard disk in megabytes (MB) |
State |
- |
Optional |
- |
- |
Edm.String |
True |
The state of the hard disk.
|
Tag |
- |
Optional |
- |
- |
Collection(Edm.String) |
False |
Not applicable. |
TemplateId |
- |
Optional |
- |
- |
Edm.Guid |
True |
The identifier of the virtual machine template |
Type |
- |
Optional |
- |
- |
Edm.String |
True |
Not applicable. |
VHDType |
- |
Optional |
- |
- |
Edm.String |
True |
The type of hard disk.
|
VirtualizationPlatform |
- |
Optional |
- |
- |
Edm.String |
True |
The virtualization platform of the hard disk.
|
VMId |
- |
Optional |
- |
- |
Edm.Guid |
True |
The identifier of the virtual machine |
Relationships
None
OData Operations
None
Examples
See Also
Entities [SPFSDK][VMMREF]
VirtualHardDisks Collection [SPFSDK][VMMREF]