New-NAVServerUserPermissionSet
Assigns a permission set to a Business Central user.
Syntax
New-NAVServerUserPermissionSet
[-Scope <PermissionScope>]
[-AppName <String>]
[-AppPublisher <String>]
[-Tenant <TenantId>]
[-CompanyName <String>]
-PermissionSetId <String>
-WindowsAccount <String>
[-ServerInstance] <String>
[-Force]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-NAVServerUserPermissionSet
[-Scope <PermissionScope>]
[-AppName <String>]
[-AppPublisher <String>]
[-Tenant <TenantId>]
[-CompanyName <String>]
-PermissionSetId <String>
-Sid <String>
[-ServerInstance] <String>
[-Force]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-NAVServerUserPermissionSet
[-Scope <PermissionScope>]
[-AppName <String>]
[-AppPublisher <String>]
[-Tenant <TenantId>]
[-CompanyName <String>]
-PermissionSetId <String>
-UserName <String>
[-ServerInstance] <String>
[-Force]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Use the New-NAVServerUserPermissionSet cmdlet to assign a permission set to a Business Central user.
Use the UserName, Sid or the WindowsAccount parameter to identify the user. Use the PermissionSetID parameter to identify the permission set.
Examples
EXAMPLE 1
New-NAVServerUserPermissionSet BC -WindowsAccount cronus\chris -PermissionSetId BASIC
This example adds the BASIC permission set for Windows user Cronus\Chris.
Parameters
-AppName
Specifies the name of the Business Central extension.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AppPublisher
Specifies the publisher of the Business Central extension.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CompanyName
The name of the Business Central company on which to apply the permission set.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before executing the command.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PermissionSetId
The ID of an existing permission set in the Business Central database, such as SUPER, CASHFLOW, or BASIC.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProgressAction
A common PowerShell parameter that determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider. Learn more.
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Scope
Specifies whether the permission set that you want to apply is a System or Tenant permission set. A System permission set is a permission set that is stored in table 2000000004 Permission Set of the application database, and will apply to all tenants in the system. A Tenant permission set is a permission set that is stored in table 2000000166 Tenant Permission Set of the tenant database, and will apply to specific tenants. Tenant permission sets are primarily used with NAV extensions.
Type: | PermissionScope |
Accepted values: | System, Tenant |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ServerInstance
Specifies the name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name such as myinstance.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Sid
Specifies a security identifier (SID) for a Business Central user. The SID is a unique value that identifies a Windows user account.
You can use the Sid, UserName, or WindowsAccount parameters to identify the user. If you use the Sid parameter, then do not set the UserName or WindowsAccount parameters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tenant
Specifies a ID of the tenant that is mounted on the Business Central Server instance.
You can omit the Tenant parameter only if the Business Central Server instance is not configured to run multiple tenants.
Type: | TenantId |
Aliases: | Id |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-UserName
Specifies the user name of the Business Central user to assign the permission set to. The user name is defined by the User Name field in a user's account in Business Central.
You can use the UserName, WindowsAccount or Sid parameters to identify the user. If you use the Username parameter, then you cannot use the Windows Account or Sid parameters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WindowsAccount
Specifies the Windows user name of a Business Central user to assign the permission set to. The value has the domain\username format.
You can use the WindowsAccount, UserName, or Sid parameters to identify the user. If you use the WindowsAccount parameter, then you cannot use the UserName or Sid parameters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
System.String
You can pipe a string that contains a Business Central Server instance name to the cmdlet.
Outputs
None