DiskAccessPaths.adoc

DSC Resource 'DiskAccessPaths'

DiskAccessPaths configuration is used to initialize, format and mount the partition to a folder access path.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/DiskAccessPaths
DSC Resource	StorageDSC
Documentation	DiskAccessPath

Table 1. Attributes of category 'DiskAccessPaths'

Parameter	Attribute	DataType	Description	Allowed Values
Items	Mandatory	Hashtable[]	List of disk access path specifications

Table 2. Attributes of category 'DiskAccessPaths/Items'

Parameter	Attribute	DataType	Description	Allowed Values
AccessPath	Key	String	Specifies the access path folder to the assign the disk volume to.
NoDefaultDriveLetter		Bool	Specifies no automatic drive letter assignment to the partition: Defaults to True
DiskId	Required	String	Specifies the disk identifier for the disk to modify.
DiskIdType		String	Specifies the identifier type the DiskId contains.	Number (default) UniqueId Guid Location
Size		UInt64	Specifies the size of new volume. Leave empty to use the remaining free space.
FSLabel		String	Define volume label if required.
AllocationUnitSize		UInt32	Specifies the allocation unit size to use when formatting the volume.
FSFormat		String	Specifies the file system format of the new volume.	NTFS ReFS

Example

DiskAccessPaths:
  Items:
  - AccessPath: E:\SysDB
    DiskIdType: Number
    DiskId: 2
    FSLabel: SysDB
    NoDefaultDriveLetter: true
  - AccessPath: E:\Data
    DiskIdType: Number
    DiskId: 3
    FSLabel: Data
    NoDefaultDriveLetter: true
  - AccessPath: E:\Logs
    DiskIdType: Number
    DiskId: 4
    FSLabel: Logs
    NoDefaultDriveLetter: true
  - AccessPath: E:\TempDB
    DiskIdType: Number
    DiskId: 5
    FSLabel: TempDB
    NoDefaultDriveLetter: true