Edit

Share via


New-CMAccessAccount

Adds users or groups to an access account.

Syntax

New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   [-InputObject] <IResultObject>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -ApplicationId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -ApplicationName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -BootImageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -BootImageName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -DriverPackageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -DriverPackageName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -OperatingSystemImageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -OperatingSystemImageName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -OperatingSystemInstallerId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -OperatingSystemInstallerName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -PackageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -PackageName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMAccessAccount
   -Access <AccessRight>
   -AccountType <AccessAccountType>
   -SoftwareUpdateDeploymentPackageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
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.

Type:AccessRight
Accepted values:NoAccess, Read, Change, FullControl
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-AccountType

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

Type:AccessAccountType
Accepted values:User, Guest, Administrator, WindowsUser, WindowsGroup
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ApplicationId

Specifies the ID of an application.

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

-ApplicationName

Specifies the name of an application.

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

-BootImageId

Specifies the ID of a boot image.

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

-BootImageName

Specifies the name of a boot image.

Type:String
Position:Named
Default value:None
Required:True
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

-DisableWildcardHandling

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

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

-DriverPackageId

Specifies the ID of a driver package.

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

-DriverPackageName

Specifies the name of a driver package.

Type:String
Position:Named
Default value:None
Required:True
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
Position:Named
Default value:None
Required:False
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
Aliases:Application, BootImage, DriverPackage, OperatingSystemImage, OperatingSystemInstaller, Package, SoftwareUpdateDeploymentPackage
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-OperatingSystemImageId

Specifies the ID of an operating system image.

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

-OperatingSystemImageName

Specifies the name of an operating system image.

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

-OperatingSystemInstallerId

Specifies the ID of an operating system installer.

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

-OperatingSystemInstallerName

Specifies the name of an operating system installer.

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

-PackageId

Specifies the ID of a deployed software script or program.

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

-PackageName

Specifies the name of a deployed software script or program.

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

-SoftwareUpdateDeploymentPackageId

Specifies the ID of a deployed software update.

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

-SoftwareUpdateDeploymentPackageName

Specifies the name of a deployed software update.

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

-UserName

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

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject