Add-ADPermission: Exchange 2010 Help

Add-ADPermission

[This topic's current status is: Content Complete.]

Applies to: Exchange Server 2010 Topic Last Modified: 2009-06-01

Use the Add-ADPermission cmdlet to add permissions to an Active Directory object.

Syntax


Add-ADPermission -Identity <ADRawEntryIdParameter> -User <SecurityPrincipalIdParameter> [-AccessRights <ActiveDirectoryRights[]>] [-ChildObjectTypes <ADSchemaObjectIdParameter[]>] [-Confirm [<SwitchParameter>]] [-Deny <SwitchParameter>] [-DomainController <Fqdn>] [-ExtendedRights <ExtendedRightIdParameter[]>] [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] [-InheritedObjectType <ADSchemaObjectIdParameter>] [-Properties <ADSchemaObjectIdParameter[]>] [-WhatIf [<SwitchParameter>]]


Add-ADPermission -Identity <ADRawEntryIdParameter> -Owner <SecurityPrincipalIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]


Add-ADPermission [-Identity <ADRawEntryIdParameter>] -Instance <ADAcePresentationObject> [-AccessRights <ActiveDirectoryRights[]>] [-ChildObjectTypes <ADSchemaObjectIdParameter[]>] [-Confirm [<SwitchParameter>]] [-Deny <SwitchParameter>] [-DomainController <Fqdn>] [-ExtendedRights <ExtendedRightIdParameter[]>] [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] [-InheritedObjectType <ADSchemaObjectIdParameter>] [-Properties <ADSchemaObjectIdParameter[]>] [-User <SecurityPrincipalIdParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.ADRawEntryIdParameter	The Identity parameter specifies the identity of the object that's getting permissions added. You can specify either the distinguished name (DN) of the object or the object's name if it's unique. If the DN or name contains spaces, enclose the name in quotation marks (").
Instance	Required	Microsoft.Exchange.Management.RecipientTasks.ADAcePresentationObject	The Instance parameter enables you to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command.
Owner	Required	Microsoft.Exchange.Configuration.Tasks.SecurityPrincipalIdParameter	The Owner parameter specifies the owner of the Active Directory object. If the name of the owner contains spaces, enclose the name in quotation marks ("). The Owner parameter can only be used with the Identity parameter and no other parameters.
User	Required	Microsoft.Exchange.Configuration.Tasks.SecurityPrincipalIdParameter	The User parameter specifies the user that the permissions are being granted to on the object. If the name contains spaces, enclose the name in quotation marks (").
AccessRights	Optional	System.DirectoryServices.ActiveDirectoryRights[]	The AccessRights parameter specifies the rights needed to perform the operation. Valid values include: `CreateChild` `DeleteChild` `ListChildren` `Self` `ReadProperty` `WriteProperty` `DeleteTree` `ListObject` `ExtendedRight` `Delete` `ReadControl` `GenericExecute` `GenericWrite` `GenericRead` `WriteDacl` `WriteOwner` `GenericAll` `Synchronize` `AccessSystemSecurity`
ChildObjectTypes	Optional	Microsoft.Exchange.Configuration.Tasks.ADSchemaObjectIdParameter[]	The ChildObjectTypes parameter specifies what type of object the permission should be applied to. The ChildObjectTypes parameter can only be used if the AccessRights parameter is set to `CreateChild` or `DeleteChild`.
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.
Deny	Optional	System.Management.Automation.SwitchParameter	The Deny switch specifies whether to deny permissions to the user on the Active Directory object.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
ExtendedRights	Optional	Microsoft.Exchange.Configuration.Tasks.ExtendedRightIdParameter[]	The ExtendedRights parameter specifies the extended rights needed to perform the operation.
InheritanceType	Optional	System.DirectoryServices.ActiveDirectorySecurityInheritance	The InheritanceType parameter specifies whether permissions are inherited.
InheritedObjectType	Optional	Microsoft.Exchange.Configuration.Tasks.ADSchemaObjectIdParameter	The InheritedObjectType parameter specifies what kind of object inherits this access control entry (ACE).
Properties	Optional	Microsoft.Exchange.Configuration.Tasks.ADSchemaObjectIdParameter[]	The Properties parameter specifies what properties the object contains. The Properties parameter can only be used if the AccessRights parameter is set to `ReadProperty`, `WriteProperty` or `Self`.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Detailed Description

The ADPermission cmdlets can be used to directly modify Active Directory access control lists (ACLs). Although some Microsoft Exchange Server 2010 features may continue to use the ADPermission cmdlets to manage permissions, for example transport Send and Receive connectors, Exchange 2010 no longer uses customized ACLs to manage administrative permissions. If you want to grant or deny administrative permissions in Exchange 2010, you must use the Role Based Access Control (RBAC) management cmdlets. For more information about RBAC, see Understanding Role Based Access Control.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Legacy permissions" entry in the Role Management Permissions topic.

Input Types

Return Types

Errors

Error	Description
>

Exceptions

Exceptions	Description

Examples

EXAMPLE 1

This example grants Send As permissions for Aaron Painter to Ellen Adams's mailbox.

Add-ADPermission -Identity "Ellen Adams" -User AaronPainter -AccessRights ExtendedRight -ExtendedRights "send as"

EXAMPLE 2

This example configures the IP Secured Inbound Receive connector to accept anonymous SMTP messages.

Caution:
This example assumes that another security mechanism is used to ensure the Receive connector can't be used to send unsolicited commercial e-mail messages. We recommend that you don't allow external clients to send messages anonymously through a Receive connector.

Add-AdPermission "IP Secured Inbound" -User "NT AUTHORITY\ANONYMOUS LOGON" -ExtendedRights ms-Exch-SMTP-Submit,ms-Exch-SMTP-Accept-Any-Recipient,ms-Exch-Bypass-Anti-Spam