https://github.com/tools4everbv/helloid-task-sa-target-exchangeonpremises-mailboxsetprimaryaddress

Exchange On Premises - Mailbox - Set PrimaryAddress
https://github.com/tools4everbv/helloid-task-sa-target-exchangeonpremises-mailboxsetprimaryaddress

delegated-form exchange-on-premises powershell product service-automation task

Last synced: about 1 month ago
JSON representation

Exchange On Premises - Mailbox - Set PrimaryAddress

• Host: GitHub
• URL: https://github.com/tools4everbv/helloid-task-sa-target-exchangeonpremises-mailboxsetprimaryaddress
• Owner: Tools4everBV
• Created: 2023-10-04T07:44:22.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-15T13:00:44.000Z (11 months ago)
• Last Synced: 2024-01-15T16:46:45.767Z (11 months ago)
• Topics: delegated-form, exchange-on-premises, powershell, product, service-automation, task
• Language: PowerShell
• Homepage:
• Size: 82 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        

# HelloID-Task-SA-Target-ExchangeOnPremises-MailboxSetPrimaryAddress

## 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":  "TestMailbox",

    "isPrimary":  true,

    "newPrimaryMail":  "[email protected]"

}

```

> :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** can hold different values [See the Microsoft Docs page](https://learn.microsoft.com/en-us/powershell/module/exchange/set-mailbox?view=exchange-ps#-emailaddresses)

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 set an existing email address as Primary Address

5. Disconnects from the Exchange session by means of the `Remove-PsSession` cmdlet