Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-PartitionAccessPath

Add-PartitionAccessPath

partition.cdxml

Synopsis

Adds an access path such as a drive letter or folder to a partition.

Syntax

Add-PartitionAccessPath [-DiskNumber] [-PartitionNumber] [-AccessPath] [-AsJob] [-AssignDriveLetter] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-PartitionAccessPath [-AccessPath] [-AsJob] [-AssignDriveLetter] [-CimSession] [-PassThru] [-ThrottleLimit] [-DiskId] [-Offset] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-PartitionAccessPath [-AccessPath] [-AsJob] [-AssignDriveLetter] [-CimSession] [-PassThru] [-ThrottleLimit] [-DriveLetter] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-PartitionAccessPath [-AccessPath] [-AsJob] [-AssignDriveLetter] [-CimSession] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed 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.

Parameters

-AccessPath <String>

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.

Aliases

None

Required?

false

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AssignDriveLetter <SwitchParameter>

Assigns the next available drive letter to the new partition.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <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.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DiskId <String[]>

Specifies an ID used to identify a disk in the system.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DiskNumber <UInt32[]>

Specifies the number of the disk.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DriveLetter <Char[]>

Specifies a letter used to identify a drive or volume in the system.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Accepts a Partition object from the pipeline as input. Enter a Partition CIM object, which you can get by using the Get-Partition cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Offset <UInt64[]>

Specifies the starting offset, in bytes.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PartitionNumber <UInt32[]>

Specifies the number of the partition.

Aliases

Number

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Partition

Return Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Partition

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.CimInstance object 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.

Examples

Example 1: Add a drive letter to a partition by disk and partition number

This example adds the access path F: to partition 2 of disk 1.

PS C:\>Add-PartitionAccessPath -DiskNumber 1 -PartitionNumber 2 -AccessPath F:

Online Version
Get-Partition
Remove-PartitionAccessPath
Set-Partition