https://github.com/tools4everbv/helloid-task-sa-target-exchangeonpremises-mailboxupdateattributes
Exchange On Premises - Mailbox update attributes
https://github.com/tools4everbv/helloid-task-sa-target-exchangeonpremises-mailboxupdateattributes
delegated-form exchange-on-premises powershell product service-automation task
Last synced: 2 months ago
JSON representation
Exchange On Premises - Mailbox update attributes
- Host: GitHub
- URL: https://github.com/tools4everbv/helloid-task-sa-target-exchangeonpremises-mailboxupdateattributes
- Owner: Tools4everBV
- Created: 2023-10-03T14:18:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-15T13:00:13.000Z (over 1 year ago)
- Last Synced: 2025-01-08T10:45:34.025Z (4 months ago)
- Topics: delegated-form, exchange-on-premises, powershell, product, service-automation, task
- Language: PowerShell
- Homepage:
- Size: 82 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# HelloID-Task-SA-Target-ExchangeOnPremises-MailboxUpdateAttributes
## Prerequisites
Before using this snippet, verify you've met with the following requirements:
- [ ] User defined variables: `$ExchangeAdminUsername`, `$ExchangeAdminPassword` and `$ExchangeConnectionUri` created in your HelloID portal. [See also Custom Variables](https://docs.helloid.com/en/variables/custom-variables.html)
## Description
This code snippet executes the following tasks:
1. Define a hash table `$formObject`. The keys of the hash table represent the properties of the `Set-Mailbox` cmdlet, while the values represent the values entered in the form.
> To view an example of the form output, please refer to the JSON code pasted below.
```json
{
"MailboxIdentity": "TestShared02",
"MailboxDisplayName": "TestShared02",
"CustomAttribute1": "Custom01",
"CustomAttribute2": "10001",
"CustomAttribute3": null,
"CustomAttribute4": null,
"CustomAttribute5": null,
"CustomAttribute6": null,
"CustomAttribute7": null
}
```
> :exclamation: It is important to note that the names of your form fields might differ. Ensure that the `$formObject` hashtable is appropriately adjusted to match your form fields.
> The **MailboxIdentity** (Identity) can hold different values [See the Microsoft Docs page](https://learn.microsoft.com/en-us/powershell/module/exchange/set-mailbox?view=exchange-ps)
2. Constructs a PowerShell credential object from the supplied administrative username and password
3. Connects with the credentials to the Exchange on premises environment by means of the `New-PSSession` cmdlet
4. Calls the `Set-Mailbox` cmdlet to update the mailbox; it updates only the ones with a value. Otherwise, a null value clears the current property.
5. Disconnects from the Exchange session by means of the `Remove-PSSession` cmdlet