Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md
Original file line number Diff line number Diff line change
Expand Up @@ -1637,6 +1637,8 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line

### [Get-AuthServer](Get-AuthServer.md)

### [Get-BillingPolicy](Get-BillingPolicy.md)

### [Get-CmdletExtensionAgent](Get-CmdletExtensionAgent.md)

### [Get-ExchangeAssistanceConfig](Get-ExchangeAssistanceConfig.md)
Expand All @@ -1655,6 +1657,8 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line

### [Get-FeatureConfiguration](Get-FeatureConfiguration.md)

### [Get-HVEAccountBillingPolicy](Get-HVEAccountBillingPolicy.md)

### [Get-HVEAccountSettings](Get-HVEAccountSettings.md)

### [Get-Notification](Get-Notification.md)
Expand Down Expand Up @@ -1731,6 +1735,8 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line

### [Set-FeatureConfiguration](Set-FeatureConfiguration.md)

### [Set-HVEAccountBillingPolicy](Set-HVEAccountBillingPolicy.md)

### [Set-HVEAccountSettings](Set-HVEAccountSettings.md)

### [Set-Notification](Set-Notification.md)
Expand Down
70 changes: 70 additions & 0 deletions exchange/exchange-ps/ExchangePowerShell/Get-BillingPolicy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
external help file:
Locale: en-US
Module Name: ExchangePowerShell
online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-billingpolicy
schema: 2.0.0
title: Get-BillingPolicy
---

# Get-BillingPolicy

## SYNOPSIS
This cmdlet is available only in the cloud-based service.

Use the Get-BillingPolicy cmdlet to return detailed information about Microsoft 365 pay-as-you-go billing policies for High Volume Email configured for your organization.

For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).

## SYNTAX

```
Get-BillingPolicy [-ResourceType] <System.String> [<CommonParameters>]
```

## DESCRIPTION
Billing policies define the Microsoft Azure subscription and related billing metadata used by Microsoft services. For more information, see [Microsoft 365 pay-as-you-go services](https://learn.microsoft.com/microsoft-365/commerce/services/pay-as-you-go-overview).

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](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).

## EXAMPLES

### Example 1
```powershell
Get-BillingPolicy -ResourceType HVE
```

This example returns all billing policies in the organization that can be used with High Volume Email.

## PARAMETERS

### -ResourceType

> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

The ResourceType parameter specifies the type of billing policies to retrieve. Currently, the only supported value is HVE.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: HVE

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
external help file:
Locale: en-US
Module Name: ExchangePowerShell
online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hveaccountbillingpolicy
schema: 2.0.0
title: Get-HVEAccountBillingPolicy
---

# Get-HVEAccountBillingPolicy

## SYNOPSIS
This cmdlet is available only in the cloud-based service.

Use the Get-HVEAccountBillingPolicy cmdlet to view the billing policy mapping for a specified High Volume Email (HVE) account.

For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).

## SYNTAX

```
Get-HVEAccountBillingPolicy [-Identity] <MailUserIdParameter> [<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](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365).

In the output of this cmdlet, the BillingPolicyStatus property indicates whether the billing configuration allows the HVE account to send email. Common values include:

- BillingPolicyValid: A valid billing policy is assigned and the subscription is active.
- NoProperBillingPolicyStored: No billing policy is assigned to the account.
- BillingPolicyNotFound: The assigned billing policy no longer exists.
- BillingPolicyMismatched: The billing policy retrieved doesn't match the expected tenant or policy identity. This scenario is uncommon.
- NoConnectedBillingPolicyFound: The billing policy isn't connected to High Volume Email.
- SubscriptionIsNotActive: The subscription linked to the billing policy isn't active.
- NoSPOLicenseFound: No SharePoint Online license is available for the tenant, preventing billing policy validation.

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](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).

## EXAMPLES

### Example 1
```powershell
Get-HVEAccountBillingPolicy -Identity HVEAccount01@tailspintoys.com
```

This example retrieves the billing policy and subscription details associated with the specified HVE account.

## PARAMETERS

### -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 view.

```yaml
Type: MailUserIdParameter
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
136 changes: 136 additions & 0 deletions exchange/exchange-ps/ExchangePowerShell/Set-HVEAccountBillingPolicy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
---
applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
external help file:
Locale: en-US
Module Name: ExchangePowerShell
online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hveaccountbillingpolicy
schema: 2.0.0
title: Set-HVEAccountBillingPolicy
---

# Set-HVEAccountBillingPolicy

## SYNOPSIS
This cmdlet is available only in the cloud-based service.

Use the Set-HVEAccountBillingPolicy cmdlet to modify the billing policy mapping for a specified High Volume Email (HVE) account.

For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
## SYNTAX

```
Set-HVEAccountBillingPolicy [-Identity] <MailUserIdParameter> -BillingPolicyId <String>
[-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](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365).

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](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).

## EXAMPLES

### Example 1
```powershell
Set-HVEAccountBillingPolicy -Identity " HVEAccount01@tailspintoys.com" -BillingPolicyId "11111111-1111-1111-1111-111111111111"
```

This example assigns the specified billing policy to the specified HVE account.

### Example 2
```powershell
Set-HVEAccountBillingPolicy -Identity " HVEAccount01@tailspintoys.com" -BillingPolicyId ""
```

This example removes the billing policy mapping from the specified HVE account.

## PARAMETERS

### -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.

```yaml
Type: MailUserIdParameter
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```

### -BillingPolicyId

> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

The BillingPolicyId parameter specified the GUID of the billing policy to assign to the HVE account.

To view the available billing policies, run the following command: `Get-BillingPolicy -ResourceType HVE`.

To remove a previously assigned billing policy, use the value `""`.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Confirm

> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

This parameter is reserved for internal Microsoft use.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf

> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

This parameter is reserved for internal Microsoft use.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
3 changes: 3 additions & 0 deletions exchange/mapping/serviceMapping.json
Original file line number Diff line number Diff line change
Expand Up @@ -797,6 +797,7 @@
"Get-AuthConfig": "organization",
"Get-AuthenticationPolicy": "organization",
"Get-AuthServer": "organization",
"Get-BillingPolicy": "organization",
"Get-CmdletExtensionAgent": "organization",
"Get-ExchangeAssistanceConfig": "organization",
"Get-ExchangeDiagnosticInfo": "organization",
Expand All @@ -806,6 +807,7 @@
"Get-ExchangeServerAccessLicenseUser": "organization",
"Get-ExchangeSettings": "organization",
"Get-FeatureConfiguration": "organization",
"Get-HVEAccountBillingPolicy": "organization",
"Get-HVEAccountSettings": "organization",
"Get-Notification": "organization",
"Get-OrganizationConfig": "organization",
Expand Down Expand Up @@ -845,6 +847,7 @@
"Set-ExchangeSettings": "organization",
"Set-FeatureConfiguration": "organization",
"Set-HVEAccountSettings": "organization",
"Set-HVEAccountBillingPolicy": "organization",
"Set-Notification": "organization",
"Set-OrganizationConfig": "organization",
"Set-PartnerApplication": "organization",
Expand Down
Loading