Add-PartitionAccessPath
Adds an access path such as a drive letter or folder to a partition.
Syntax
Add-PartitionAccessPath
[-WhatIf]
[-Confirm]
[<CommonParameters>] Add-PartitionAccessPath
-DiskId <String[]>
-Offset <UInt64[]>
[[-AccessPath] <String>]
[-AssignDriveLetter]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Add-PartitionAccessPath
[-DiskNumber] <UInt32[]>
[-PartitionNumber] <UInt32[]>
[[-AccessPath] <String>]
[-AssignDriveLetter]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Add-PartitionAccessPath
-DriveLetter <Char[]>
[[-AccessPath] <String>]
[-AssignDriveLetter]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Add-PartitionAccessPath
-InputObject <CimInstance[]>
[[-AccessPath] <String>]
[-AssignDriveLetter]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Add-PartitionAccessPath cmdlet adds an access path such as a drive letter or folder to a partition. Access paths can be either a drive letter or a mount point.
Examples
Example 1: Add a drive letter to a partition by disk and partition number
PS C:\>Add-PartitionAccessPath -DiskNumber 1 -PartitionNumber 2 -AccessPath F:This example adds the access path F: to partition 2 of disk 1.
Parameters
-AccessPath
Assigns an access path to the partition. An access path can be a drive letter (for example, "C:" or "C:") or a path to an empty directory on an NTFS volume. The access path string does not require a trailing backslash.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AssignDriveLetter
Assigns the next available drive letter to the new partition.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DiskId
Specifies an ID used to identify a disk in the system.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DiskNumber
Specifies an array of disk numbers.
| Type: | UInt32[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DriveLetter
Specifies a letter used to identify a drive or volume in the system.
| Type: | Char[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Offset
Specifies the starting offset, in bytes.
| Type: | UInt64[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PartitionNumber
Specifies the number of the partition.
| Type: | UInt32[] |
| Aliases: | Number |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Specifies that the cmdlet should output an object representing the partition to which you added an access path. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
You can pipe a Partition object to the InputObject parameter to specify the partition to which you want to add an access path.
Outputs
If you specify the Passthru parameter, this cmdlet outputs a Partition object representing the partition on which you added an access path.
Notes
- Mounted folders are supported only on NTFS-formatted partitions.
- You can only assign a single drive letter to a partition. To change the drive letter, use the Set-Partition cmdlet with the NewDriveLetter parameter.
- The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object. - When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).