Remove-CMAccessAccount.md

description	external help file	Module Name	ms.date	schema	title
Removes users or groups from an access account.	AdminUI.PS.dll-Help.xml	ConfigurationManager	05/07/2019	2.0.0	Remove-CMAccessAccount

Remove-CMAccessAccount

SYNOPSIS

Removes users or groups from an access account.

SYNTAX

SearchByValue (Default)

Remove-CMAccessAccount -AccountType <AccessAccountType> [-Force] [-InputObject] <IResultObject>
 [-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByApplicationId

Remove-CMAccessAccount -AccountType <AccessAccountType> -ApplicationId <String> [-Force] [-UserName <String>]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByApplicationName

Remove-CMAccessAccount -AccountType <AccessAccountType> -ApplicationName <String> [-Force] [-UserName <String>]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByBootImageId

Remove-CMAccessAccount -AccountType <AccessAccountType> -BootImageId <String> [-Force] [-UserName <String>]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByBootImageName

Remove-CMAccessAccount -AccountType <AccessAccountType> -BootImageName <String> [-Force] [-UserName <String>]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByDriverPackageId

Remove-CMAccessAccount -AccountType <AccessAccountType> -DriverPackageId <String> [-Force] [-UserName <String>]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByDriverPackageName

Remove-CMAccessAccount -AccountType <AccessAccountType> -DriverPackageName <String> [-Force]
 [-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByOSImageId

Remove-CMAccessAccount -AccountType <AccessAccountType> [-Force] -OperatingSystemImageId <String>
 [-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByOSImageName

Remove-CMAccessAccount -AccountType <AccessAccountType> [-Force] -OperatingSystemImageName <String>
 [-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByOSInstallerId

Remove-CMAccessAccount -AccountType <AccessAccountType> [-Force] -OperatingSystemInstallerId <String>
 [-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByOSInstallerName

Remove-CMAccessAccount -AccountType <AccessAccountType> [-Force] -OperatingSystemInstallerName <String>
 [-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByPackageId

Remove-CMAccessAccount -AccountType <AccessAccountType> [-Force] -PackageId <String> [-UserName <String>]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByPackageName

Remove-CMAccessAccount -AccountType <AccessAccountType> [-Force] -PackageName <String> [-UserName <String>]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchBySoftwareUpdateDeploymentPackageId

Remove-CMAccessAccount -AccountType <AccessAccountType> [-Force] -SoftwareUpdateDeploymentPackageId <String>
 [-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchBySoftwareUpdateDeploymentPackageName

Remove-CMAccessAccount -AccountType <AccessAccountType> [-Force] -SoftwareUpdateDeploymentPackageName <String>
 [-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Remove-CMAccessAccount cmdlet removes users or groups from an access account.

An access account is a list of users or groups that can access an established service or application that is located on a distribution point. For example, members in the Software Update Point Connection Access Account can access two services to manage software updates: Windows Server Update Services (WSUS) and WSUS Synchronization Manager.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

EXAMPLES

Example 1: Remove a user from an access account for an application by using its name

PS XYZ:\> Remove-CMAccessAccount -ApplicationName "SharePoint 2010" -Type WindowsUser -UserName "CONTOSO\ENarvaez" -Confirm

This command removes a Windows user from the access account for an application that is specified by using its name. You must confirm the action before the command performs it.

Example 2: Remove a group from an access account for a package by using its ID

PS XYZ:\> $ID = Get-CMAccessAccount -PackageId "CM1100002"
PS XYZ:\> Remove-CMAccessAccount -PackageId $ID -Type WindowsGroup -UserName "CONTOSO\Guest"

The first command gets the package object ID, and then stores it in the variable $ID.

The second command removes a group from the access account for the specified package. No confirmation is required.

PARAMETERS

-AccountType

Specifies an account type. Valid values are: Guest, User, WindowsGroup, and WindowsUser.

Type: AccessAccountType
Parameter Sets: (All)
Aliases:
Accepted values: User, Guest, Administrator, WindowsUser, WindowsGroup

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ApplicationId

Specifies the ID of an application.

Type: String
Parameter Sets: SearchByApplicationId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ApplicationName

Specifies the name of an application.

Type: String
Parameter Sets: SearchByApplicationName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BootImageId

Specifies the ID of a boot image.

Type: String
Parameter Sets: SearchByBootImageId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BootImageName

Specifies the name of a boot image.

Type: String
Parameter Sets: SearchByBootImageName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DriverPackageId

Specifies the ID of a driver package.

Type: String
Parameter Sets: SearchByDriverPackageId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DriverPackageName

Specifies the name of a driver package.

Type: String
Parameter Sets: SearchByDriverPackageName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type: IResultObject
Parameter Sets: SearchByValue
Aliases: DriverPackage, Application, OperatingSystemImage, OperatingSystemInstaller, Package, SoftwareUpdateDeploymentPackage, BootImage

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OperatingSystemImageId

Specifies the ID of an operating system image.

Type: String
Parameter Sets: SearchByOSImageId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OperatingSystemImageName

Specifies the name of an operating system image.

Type: String
Parameter Sets: SearchByOSImageName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OperatingSystemInstallerId

Specifies the ID of an operating system installer.

Type: String
Parameter Sets: SearchByOSInstallerId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OperatingSystemInstallerName

Specifies the name of an operating system installer.

Type: String
Parameter Sets: SearchByOSInstallerName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PackageId

Specifies the ID of a deployed software script or program.

Type: String
Parameter Sets: SearchByPackageId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PackageName

Specifies the name of a deployed software script or program.

Type: String
Parameter Sets: SearchByPackageName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SoftwareUpdateDeploymentPackageId

Specifies the ID of a deployed software update.

Type: String
Parameter Sets: SearchBySoftwareUpdateDeploymentPackageId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SoftwareUpdateDeploymentPackageName

Specifies the name of a deployed software update.

Type: String
Parameter Sets: SearchBySoftwareUpdateDeploymentPackageName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserName

Specifies a Windows user account name in domain\user format.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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 doesn't run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

OUTPUTS

System.Object

NOTES

RELATED LINKS

New-CMAccessAccount

Get-CMAccessAccount

Set-CMAccessAccount

Get-CMApplication

Get-CMBootImage

Get-CMDriverPackage

Get-CMOperatingSystemImage

Get-CMOperatingSystemInstaller

Get-CMPackage

Get-CMSoftwareUpdateDeploymentPackage