New-CMAccessAccount

Module:

ConfigurationManager Module

Adds users or groups to an access account.

Syntax

SearchByValue (Default)

New-CMAccessAccount
    [-InputObject] <IResultObject>
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByApplicationId

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -ApplicationId <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByApplicationName

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -ApplicationName <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByBootImageId

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -BootImageId <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByBootImageName

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -BootImageName <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByDriverPackageId

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -DriverPackageId <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByDriverPackageName

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -DriverPackageName <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByOSImageId

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -OperatingSystemImageId <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByOSImageName

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -OperatingSystemImageName <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByOSInstallerId

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -OperatingSystemInstallerId <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByOSInstallerName

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -OperatingSystemInstallerName <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByPackageId

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -PackageId <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByPackageName

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -PackageName <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchBySoftwareUpdateDeploymentPackageId

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -SoftwareUpdateDeploymentPackageId <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchBySoftwareUpdateDeploymentPackageName

New-CMAccessAccount
    -Access <AccessRight>
    -AccountType <AccessAccountType>
    -SoftwareUpdateDeploymentPackageName <String>
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-CMAccessAccount cmdlet adds users or groups to 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: Modify access to an application by using the application ID

PS XYZ:\> $ID = Get-CMAccessAccount -ApplicationID "12994680"
PS XYZ:\> New-CMAccessAccount -ApplicationID $ID -Type WindowsUser Username "CONTOSO\EDaugherty" -Access "FullControl"

The first command gets an application ID, and then stores it in the $ID variable.

The second command gets the application that is identified by $ID and adds a user to the access account. The permissions of the new user are set to FullControl.

Parameters

-Access

Specifies the access rights that are associated with an access account. Valid values are: No Access, Read, Change, and Full Control.

Parameter properties

Type:	AccessRight
Default value:	None
Accepted values:	NoAccess, Read, Change, FullControl
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-AccountType

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

Parameter properties

Type:	AccessAccountType
Default value:	None
Accepted values:	User, Guest, Administrator, WindowsUser, WindowsGroup
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ApplicationId

Specifies the ID of an application.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByApplicationId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ApplicationName

Specifies the name of an application.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByApplicationName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-BootImageId

Specifies the ID of a boot image.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByBootImageId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-BootImageName

Specifies the name of a boot image.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByBootImageName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DisableWildcardHandling

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DriverPackageId

Specifies the ID of a driver package.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByDriverPackageId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DriverPackageName

Specifies the name of a driver package.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByDriverPackageName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ForceWildcardHandling

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

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

Parameter properties

Type:	IResultObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Application, BootImage, DriverPackage, OperatingSystemImage, OperatingSystemInstaller, Package, SoftwareUpdateDeploymentPackage

Parameter sets

SearchByValue

Position:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OperatingSystemImageId

Specifies the ID of an operating system image.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByOSImageId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OperatingSystemImageName

Specifies the name of an operating system image.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByOSImageName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OperatingSystemInstallerId

Specifies the ID of an operating system installer.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByOSInstallerId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OperatingSystemInstallerName

Specifies the name of an operating system installer.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByOSInstallerName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PackageId

Specifies the ID of a deployed software script or program.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByPackageId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PackageName

Specifies the name of a deployed software script or program.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByPackageName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SoftwareUpdateDeploymentPackageId

Specifies the ID of a deployed software update.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchBySoftwareUpdateDeploymentPackageId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SoftwareUpdateDeploymentPackageName

Specifies the name of a deployed software update.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchBySoftwareUpdateDeploymentPackageName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UserName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject

Related Links

• Get-CMAccessAccount
• Set-CMAccessAccount
• Remove-CMAccessAccount
• Get-CMApplication
• Get-CMBootImage
• Get-CMDriverPackage
• Get-CMOperatingSystemImage
• Get-CMOperatingSystemInstaller
• Get-CMPackage
• Get-CMSoftwareUpdateDeploymentPackage