Remove-CMUserDataAndProfileConfigurationItem

Remove-CMUserDataAndProfileConfigurationItem

Removes user data and profile configuration items.

Syntax

Parameter Set: SearchByNameMandatory
Remove-CMUserDataAndProfileConfigurationItem -Name <String[]> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByIdMandatory
Remove-CMUserDataAndProfileConfigurationItem -Id <String[]> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByValueMandatory
Remove-CMUserDataAndProfileConfigurationItem -InputObject <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-CMUserDataAndProfileConfigurationItem cmdlet removes one or more user data and profile configuration items. You must remove all references to a configuration item before you can delete the configuration item.

After you remove a user data and profile configuration item, you cannot use the configuration item to manage folder redirection, offline files, and roaming profiles on computers that run Windows® 8 for the user collections where you deployed the user data and profile configuration item.

Parameters

-Force

Forces the command to run without asking for user confirmation.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Id<String[]>

Specifies an array of IDs of user data and profile configuration items.

Aliases

CIId

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<IResultObject>

Specifies a CMUserDataAndProfileConfigurationItem object. To obtain a CMUserDataAndProfileConfigurationItem object, use the Get-CMUserDataAndProfileConfigurationItem cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names of user data and profile configuration items.

Aliases

LocalizedDisplayName

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Remove a user data and profile configuration item

This command removes the user data and profile configuration item named UDPConfig02.

PS C:\> Remove-CMUserDataAndProfileConfigurationItem -Name "UDPConfig02"

Copy-CMUserDataAndProfileConfigurationItem

Get-CMUserDataAndProfileConfigurationItem

New-CMUserDataAndProfileConfigurationItem

Set-CMUserDataAndProfileConfigurationItem