New-CMAccessAccount
New-CMAccessAccount
Adds users or groups to an access account.
Syntax
Parameter Set: SearchByApplicationName
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -ApplicationName <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByApplication
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -Application <IResultObject> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByApplicationId
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -ApplicationId <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByBootImage
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -BootImage <IResultObject> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByBootImageId
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -BootImageId <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByBootImageName
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -BootImageName <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByDriverPackage
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -DriverPackage <IResultObject> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByDriverPackageId
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -DriverPackageId <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByDriverPackageName
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -DriverPackageName <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSImage
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemImage <IResultObject> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSImageId
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemImageId <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSImageName
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemImageName <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSInstaller
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemInstaller <IResultObject> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSInstallerId
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemInstallerId <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSInstallerName
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemInstallerName <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByPackage
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -Package <IResultObject> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByPackageId
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -PackageId <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByPackageName
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -PackageName <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchBySoftwareUpdateDeploymentPackage
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -SoftwareUpdateDeploymentPackage <IResultObject> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchBySoftwareUpdateDeploymentPackageId
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -SoftwareUpdateDeploymentPackageId <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchBySoftwareUpdateDeploymentPackageName
New-CMAccessAccount -Access <AccessRight> {Change | FullControl | NoAccess | Read} -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -SoftwareUpdateDeploymentPackageName <String> [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-Access<AccessRight>
Specifies the access rights that are associated with an access account. Valid values are: No Access, Read, Change, and Full Control.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AccountType<AccessAccountType>
Specifies an account type. The acceptable values for this parameter are: Guest, User, WindowsGroup, and WindowsUser.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Application<IResultObject>
Specifies a deployed application object. You can get an application object by using the Get-CMApplication cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ApplicationId<String>
Specifies the ID of an application object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ApplicationName<String>
Specifies the name of an application object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-BootImage<IResultObject>
Specifies a boot image object. A boot image object contains the Windows files that are required to prepare a computer for the installation of an operating system. You can get a boot image object by using the Get-CMBootImage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-BootImageId<String>
Specifies the ID of a boot image object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-BootImageName<String>
Specifies the name of a boot image object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DriverPackage<IResultObject>
Specifies a driver package object. A driver package object specifies a group of hardware drivers that are required to install an operating system. You can get a driver package object by using the Get-CMDriverPackage object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DriverPackageId<String>
Specifies the ID of a driver package object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DriverPackageName<String>
Specifies the name of a driver package object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemImage<IResultObject>
Specifies an operating system image object. An operating system image object contains the Windows files that compose a complete Windows installation. You can get an operating system image object by using the Get-CMOperatingSystemImage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemImageId<String>
Specifies the ID of an operating system image object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemImageName<String>
Specifies the name of an operating system image object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemInstaller<IResultObject>
Specifies an operating system installer object. An operating system installer object contains the Windows files that are required to prepare a computer for the installation of an operating system. To obtain an operating system installer object, use the Get-CMOperatingSystemInstaller cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemInstallerId<String>
Specifies the ID of an operating system installer object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemInstallerName<String>
Specifies the name of an operating system installer object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Package<IResultObject>
Specifies a deployed software script or program object. You can get a package by using the Get-CMPackage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PackageId<String>
Specifies the ID of a deployed software script or program.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PackageName<String>
Specifies the name of a deployed software script or program object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SoftwareUpdateDeploymentPackage<IResultObject>
Specifies a deployed software update object. You can get a software update deployment object by using the Get-CMSoftwareUpdateDeploymentPackage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SoftwareUpdateDeploymentPackageId<String>
Specifies the ID of a deployed software update object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SoftwareUpdateDeploymentPackageName<String>
Specifies the name of a deployed software update object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserName<String>
Specifies a Windows user account name in domain\user format.
Aliases |
none |
Required? |
false |
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: Modify access to an application by using the application ID
In this example, the first command gets an application ID and stores it in the variable $ID.
The second command gets the application that is identified by the variable $ID and adds a user to the access account. The new user's permissions are set to FullControl.
PS C:\> $ID = Get-CMAccessAccount -ApplicationID "12994680"
PS C:\> New-CMAccessAccount -ApplicationID $ID -Type WindowsUser Username "CONTOSO\JPBagel" -Access "FullControl"