Skip to content

Commit b27b64f

Browse files
chrisdachrisda
authored
Merge pull request #13547 from chrisda/HVE-chrisda
HVE-chrisda to Main
2 parents 2aeada0 + 71a3469 commit b27b64f

5 files changed

Lines changed: 294 additions & 0 deletions

File tree

‎exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1637,6 +1637,8 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line
16371637

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

1640+
### [Get-BillingPolicy](Get-BillingPolicy.md)
1641+
16401642
### [Get-CmdletExtensionAgent](Get-CmdletExtensionAgent.md)
16411643

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

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

1660+
### [Get-HVEAccountBillingPolicy](Get-HVEAccountBillingPolicy.md)
1661+
16581662
### [Get-HVEAccountSettings](Get-HVEAccountSettings.md)
16591663

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

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

1738+
### [Set-HVEAccountBillingPolicy](Set-HVEAccountBillingPolicy.md)
1739+
17341740
### [Set-HVEAccountSettings](Set-HVEAccountSettings.md)
17351741

17361742
### [Set-Notification](Set-Notification.md)

‎exchange/exchange-ps/ExchangePowerShell/Get-BillingPolicy.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
3+
external help file:
4+
Locale: en-US
5+
Module Name: ExchangePowerShell
6+
online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-billingpolicy
7+
schema: 2.0.0
8+
title: Get-BillingPolicy
9+
---
10+
11+
# Get-BillingPolicy
12+
13+
## SYNOPSIS
14+
This cmdlet is available only in the cloud-based service.
15+
16+
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.
17+
18+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
19+
20+
## SYNTAX
21+
22+
```
23+
Get-BillingPolicy [-ResourceType] <System.String> [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
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).
28+
29+
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).
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
Get-BillingPolicy -ResourceType HVE
36+
```
37+
38+
This example returns all billing policies in the organization that can be used with High Volume Email.
39+
40+
## PARAMETERS
41+
42+
### -ResourceType
43+
44+
> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
45+
46+
The ResourceType parameter specifies the type of billing policies to retrieve. Currently, the only supported value is HVE.
47+
48+
```yaml
49+
Type: System.String
50+
Parameter Sets: (All)
51+
Aliases:
52+
Accepted values: HVE
53+
54+
Required: True
55+
Position: 0
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### CommonParameters
62+
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).
63+
64+
## INPUTS
65+
66+
## OUTPUTS
67+
68+
## NOTES
69+
70+
## RELATED LINKS

‎exchange/exchange-ps/ExchangePowerShell/Get-HVEAccountBillingPolicy.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
3+
external help file:
4+
Locale: en-US
5+
Module Name: ExchangePowerShell
6+
online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hveaccountbillingpolicy
7+
schema: 2.0.0
8+
title: Get-HVEAccountBillingPolicy
9+
---
10+
11+
# Get-HVEAccountBillingPolicy
12+
13+
## SYNOPSIS
14+
This cmdlet is available only in the cloud-based service.
15+
16+
Use the Get-HVEAccountBillingPolicy cmdlet to view the billing policy mapping for a specified High Volume Email (HVE) account.
17+
18+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
19+
20+
## SYNTAX
21+
22+
```
23+
Get-HVEAccountBillingPolicy [-Identity] <MailUserIdParameter> [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
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).
28+
29+
In the output of this cmdlet, the BillingPolicyStatus property indicates whether the billing configuration allows the HVE account to send email. Common values include:
30+
31+
- BillingPolicyValid: A valid billing policy is assigned and the subscription is active.
32+
- NoProperBillingPolicyStored: No billing policy is assigned to the account.
33+
- BillingPolicyNotFound: The assigned billing policy no longer exists.
34+
- BillingPolicyMismatched: The billing policy retrieved doesn't match the expected tenant or policy identity. This scenario is uncommon.
35+
- NoConnectedBillingPolicyFound: The billing policy isn't connected to High Volume Email.
36+
- SubscriptionIsNotActive: The subscription linked to the billing policy isn't active.
37+
- NoSPOLicenseFound: No SharePoint Online license is available for the tenant, preventing billing policy validation.
38+
39+
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).
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
```powershell
45+
Get-HVEAccountBillingPolicy -Identity HVEAccount01@tailspintoys.com
46+
```
47+
48+
This example retrieves the billing policy and subscription details associated with the specified HVE account.
49+
50+
## PARAMETERS
51+
52+
### -Identity
53+
54+
> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
55+
56+
The Identity parameter specifies the email address of the HVE account you want to view.
57+
58+
```yaml
59+
Type: MailUserIdParameter
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: True
64+
Position: 0
65+
Default value: None
66+
Accept pipeline input: True (ByPropertyName, ByValue)
67+
Accept wildcard characters: False
68+
```
69+
70+
### CommonParameters
71+
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).
72+
73+
## INPUTS
74+
75+
## OUTPUTS
76+
77+
## NOTES
78+
79+
## RELATED LINKS

‎exchange/exchange-ps/ExchangePowerShell/Set-HVEAccountBillingPolicy.md‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
3+
external help file:
4+
Locale: en-US
5+
Module Name: ExchangePowerShell
6+
online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hveaccountbillingpolicy
7+
schema: 2.0.0
8+
title: Set-HVEAccountBillingPolicy
9+
---
10+
11+
# Set-HVEAccountBillingPolicy
12+
13+
## SYNOPSIS
14+
This cmdlet is available only in the cloud-based service.
15+
16+
Use the Set-HVEAccountBillingPolicy cmdlet to modify the billing policy mapping for a specified High Volume Email (HVE) account.
17+
18+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
19+
## SYNTAX
20+
21+
```
22+
Set-HVEAccountBillingPolicy [-Identity] <MailUserIdParameter> -BillingPolicyId <String>
23+
[-Confirm]
24+
[-WhatIf]
25+
[<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
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).
30+
31+
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).
32+
33+
## EXAMPLES
34+
35+
### Example 1
36+
```powershell
37+
Set-HVEAccountBillingPolicy -Identity " HVEAccount01@tailspintoys.com" -BillingPolicyId "11111111-1111-1111-1111-111111111111"
38+
```
39+
40+
This example assigns the specified billing policy to the specified HVE account.
41+
42+
### Example 2
43+
```powershell
44+
Set-HVEAccountBillingPolicy -Identity " HVEAccount01@tailspintoys.com" -BillingPolicyId ""
45+
```
46+
47+
This example removes the billing policy mapping from the specified HVE account.
48+
49+
## PARAMETERS
50+
51+
### -Identity
52+
53+
> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
54+
55+
The Identity parameter specifies the email address of the HVE account you want to modify.
56+
57+
```yaml
58+
Type: MailUserIdParameter
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: True
63+
Position: 0
64+
Default value: None
65+
Accept pipeline input: True (ByPropertyName, ByValue)
66+
Accept wildcard characters: False
67+
```
68+
69+
### -BillingPolicyId
70+
71+
> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
72+
73+
The BillingPolicyId parameter specified the GUID of the billing policy to assign to the HVE account.
74+
75+
To view the available billing policies, run the following command: `Get-BillingPolicy -ResourceType HVE`.
76+
77+
To remove a previously assigned billing policy, use the value `""`.
78+
79+
```yaml
80+
Type: String
81+
Parameter Sets: (All)
82+
Aliases:
83+
84+
Required: True
85+
Position: Named
86+
Default value: None
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
91+
### -Confirm
92+
93+
> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
94+
95+
This parameter is reserved for internal Microsoft use.
96+
97+
```yaml
98+
Type: SwitchParameter
99+
Parameter Sets: (All)
100+
Aliases: cf
101+
102+
Required: False
103+
Position: Named
104+
Default value: None
105+
Accept pipeline input: False
106+
Accept wildcard characters: False
107+
```
108+
109+
### -WhatIf
110+
111+
> Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes
112+
113+
This parameter is reserved for internal Microsoft use.
114+
115+
```yaml
116+
Type: SwitchParameter
117+
Parameter Sets: (All)
118+
Aliases: wi
119+
120+
Required: False
121+
Position: Named
122+
Default value: None
123+
Accept pipeline input: False
124+
Accept wildcard characters: False
125+
```
126+
127+
### CommonParameters
128+
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).
129+
130+
## INPUTS
131+
132+
## OUTPUTS
133+
134+
## NOTES
135+
136+
## RELATED LINKS

‎exchange/mapping/serviceMapping.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -797,6 +797,7 @@
797797
"Get-AuthConfig": "organization",
798798
"Get-AuthenticationPolicy": "organization",
799799
"Get-AuthServer": "organization",
800+
"Get-BillingPolicy": "organization",
800801
"Get-CmdletExtensionAgent": "organization",
801802
"Get-ExchangeAssistanceConfig": "organization",
802803
"Get-ExchangeDiagnosticInfo": "organization",
@@ -806,6 +807,7 @@
806807
"Get-ExchangeServerAccessLicenseUser": "organization",
807808
"Get-ExchangeSettings": "organization",
808809
"Get-FeatureConfiguration": "organization",
810+
"Get-HVEAccountBillingPolicy": "organization",
809811
"Get-HVEAccountSettings": "organization",
810812
"Get-Notification": "organization",
811813
"Get-OrganizationConfig": "organization",
@@ -845,6 +847,7 @@
845847
"Set-ExchangeSettings": "organization",
846848
"Set-FeatureConfiguration": "organization",
847849
"Set-HVEAccountSettings": "organization",
850+
"Set-HVEAccountBillingPolicy": "organization",
848851
"Set-Notification": "organization",
849852
"Set-OrganizationConfig": "organization",
850853
"Set-PartnerApplication": "organization",

0 commit comments

Comments
 (0)