Updates the properties of the shared account specified by the Identifier parameter.
Set-DRASharedMailbox -Domain <String> [-Properties <Hashtable>] [-Replace <Hashtable>] [-Add <Hashtable>] [-Remove <Hashtable>] [-Clear <String[]>] -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Set-DRASharedMailbox cmdlet modifies the properties of the requested on-premises shared mailbox account or an Exchange Online shared mailbox that is associated with an on-premises Active Directory user account managed by DRA. The requesting shared account must have Modify Shared properties powers for each of the properties sent in the request.
NOTE:The Set-DRASharedMailbox cmdlet supports multi-values for the OtherFacsimileTelephoneNumber, ProxyAddresses, and Urls attributes.
Attribute / Description |
Parameters / Values |
||||
---|---|---|---|---|---|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
Properties <Hashtable> A hashtable of property values. The key is the name of a defined attribute in the REST interface. For example: -Properties @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value} Multiple values are specified as a comma-separated list.For example: -Properties @{Attribute1DRADisplayName=value1, value2} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Properties @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Properties @{Attribute1DRADisplayName="`"sample`" value"} |
true |
named |
|
true (ByPropertyName) |
false |
Replace [<Hashtable>] A Hashtable of property values to replace the current set of values for the specified property. The key is the name of a defined property in the REST interface. For example: -Replace @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value} Multiple values are specified as a comma-separated list and will replace currently set values.For example: -Replace @{Attribute1DRADisplayName=value1, value2} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Replace @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Replace @{Attribute1DRADisplayName="`"sample`" value"} |
false |
named |
|
true (ByPropertyName) |
false |
Add [<Hashtable>] A Hashtable of property values to add to the current set of values for the specified multi-valued property. The key is the name of a defined property in the REST interface. For example: -Add @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2} Multiple values are specified as a comma-separated list.For example: -Add @{Attribute1DRADisplayName=value1, value2}} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Add @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Add @{Attribute1DRADisplayName="`"sample`" value"} |
false |
named |
|
true (ByPropertyName) |
false |
Remove [<Hashtable>] A Hashtable of property values to remove from the current set of values for the specified multi-valued property. The key is the name of a defined property in the REST interface. For example: -Remove @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2} Multiple values are specified as a comma-separated list and will be removed from currently set values.For example: -Remove @{Attribute1DRADisplayName=value1,value2} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Remove @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Remove @{Attribute1DRADisplayName="`"sample`" value"} |
false |
named |
|
true (ByPropertyName) |
false |
Clear [<String>] An array of property names whose values will be cleared. Each name is the name of a defined property in the REST interface. For example: -Clear "Attribute1-DRA-DisplayName" Multiple values need to be separated by a comma. For example: -Clear Attribute1DRADisplayName, Attribute2DRADisplayName |
false |
named |
|
true (ByPropertyName) |
false |
Identifier [<String>] The name or distinguished name of an existing Active Directory object. When the name is specified, an additional call to the DRA Server is needed to obtain the distinguished name for the object. |
true |
named |
|
true (ByPropertyName) |
false |
Domain [<String>] The domain of the object in FQDN format. For example: mydomain.corp |
true |
named |
|
true (ByPropertyName) |
false |
DRARestServer [<String>] The name of the computer running the DRA REST Service. The requested DRA operation will be sent to the REST Service running on the specified computer. If this parameter is not specified, then the cmdlet will attempt to discover a DRA REST Service to use. |
false |
named |
true (ByPropertyName) |
false |
|
DRARestPort [<Int32>] The port number of the DRA REST Service. This parameter is only used when the DRARestServer parameter is also specified. If the DRARestServer parameter is specified but the DRARestPort is not, 8755 will be used as the default REST port. |
false |
named |
8755 |
true (ByPropertyName) |
false |
IgnoreCertificateErrors [<SwitchParameter>] Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate. |
false |
named |
false |
false |
|
Force [<SwitchParameter>] Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user. |
false |
named |
false |
false |
|
Timeout [<Int32>] The number of seconds to wait before the request to the DRA REST server times out. To specify an infinite timeout, you can set this parameter to -1. |
false |
named |
100 seconds |
true (ByPropertyName) |
false |
<CommonParameters> Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters. |
|
|
|
|
|
NOTE:For more information, type "Get-Help Set-DRASharedMailbox -detailed". For technical information, type "Get-Help Set-DRASharedMailbox -full".
Example 27-13 1
PS C:\>Set-DRASharedMailbox -Domain MyDomain.corp -Identifier "O356SMB_123" -Properties @{office365SendAsRemove="CN=AAA-Alfred Don1,OU=Tax,DC=MYDOM,DC=CORP","CN=AA TestCase6,OU=Tax,DC=MYDOM, DC=CORP";office365SendOnBehalfAdd="CN=Eric Jones,OU=Tax,DC=MYDOM,DC=CORP`","CN=Ron Jackson,OU=Tax,DC=MYDOM,DC=CORP";office365DeliverAndForward=$true;office365ForwardingAddress="CN=Aaron Jackson,OU=Tax,DC=MYDOM,DC=CORP"}
This example updates some of the Office 365 or Exchange Online mailbox properties for the Exchange Online shared mailbox O365SMB_123. The request will remove two users from the Send As list and add two different users to the Send On Behalf list. Note that these multi-valued properties must be enclosed in escaped quotation marks and separated by a comma between each value.
Example 27-14 2
PS C:\>Set-DRASharedMailbox -Domain MyDomain.corp -Identifier "SMB_123" -Properties @{Manager=CN=George,CN=Shareds,DC=MYDOMAIN,DC=corp";Description="updated description";TrustedForDelegation=$true;location="Houston"}
This example updates some of the properties of the share SMB_123 in MyDomain.corp. The Identifier specifies the name of the shared account. When the identifier format is the name, DRA resolves the name to the full distinguished name.
Example 27-15 2
PS C:\>Set-DRASharedMailbox -Domain MyDomain.corp -Identifier "CN=SMB_123,OU=Accounting,DC=MyDomain,DC=corp" -Properties @{Manager="CN=George,CN=Shareds,DC=MYDOMAIN,DC=corp"}
This example updates some of the properties of the share SMB_123 in MyDomain.corp. The identifier contains the distinguished name for the shared account. The Manager property is updated. To see the complete list of available properties, perform a Get-Member command on the object returned from any DRAShared command.