Add-HVEAppAccess
This cmdlet is available only in the cloud-based service.
Use the Add-HVEAppAccess cmdlet to add applications to the Allowed Apps list of a High Volume Email (HVE) account.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Default (Default)
Add-HVEAppAccess
[-Identity] <MailUserIdParameter>
-AppIds <MultiValuedProperty>
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Description
An HVE account is a special type of mail user (also known as a mail-enabled user) used to send large amounts of email. For more information, see High Volume Email.
The Allowed Apps list defines which Microsoft Entra applications are authorized to authenticate and send email via OAuth using the specified HVE account. Each HVE account can have up to ten allowed apps assigned. For more information, see OAuth authentication for High Volume Email.
Changes can take up to 5 minutes to take effect.
You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
Add-HVEAppAccess -Identity HVEAccount01@tailspintoys.com -AppIds "11111111-1111-1111-1111-111111111111"
This example adds the specified application to the Allowed Apps list of the specified HVE account.
Example 1
Add-HVEAppAccess -Identity HVEAccount01@tailspintoys.com -AppIds "11111111-1111-1111-1111-111111111111","22222222-2222-2222-2222-222222222222"
This example adds the specified applications to the Allowed Apps list of the specified HVE account.
Parameters
-AppIds
Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
The AppIds parameter specifies the Microsoft Entra application to add to the Allowed Apps list of the HVE account.
A valid value for this parameter is the Object ID (GUID) value of the application from the Enterprise applications | All Applications page in the Microsoft Azure Portal. You can specify a maximum of 10 GUID values separated by commas.
Note: Don't use Application (client) ID (GUID) values from the App Registrations page in the Microsoft Azure Portal or other GUID values. Values that aren't valid Object ID values result in validation errors. For more information about applications, see Authenticate an IMAP, POP or SMTP connection using OAuth.
Parameter properties
| Type: | MultiValuedProperty |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Confirm
Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
The Identity parameter specifies the email address of the HVE account you want to modify.
Parameter properties
| Type: | MailUserIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.