Update costmanagement API to 2023-08-01 #27680
Conversation
This change updates the costmanagement API to version 2023-08-01, ensuring compatibility with both the public Azure Cloud and AzureChinaCloud. It's important to note that AzureChinaCloud has specific API version requirements, and version 2023-08-01 meets these. In addition, the `azurerm_cost_anomaly_alert` resource now includes a new optional parameter, `email_address_sender`, introduced in this API version. Should this parameter be omitted, the the TF provider will default to using the first email address listed in `email_addresses`, aligning with the default behavior observed in the Azure Portal. The ScheduledActionsClient_v2022_10_01, which previously existed alongside the ScheduledActionsClient, has been discontinued. This is because the API version 2023-08-01 seems to be compatible with all uses.
| @@ -48,6 +48,13 @@ func (AnomalyAlertResource) Arguments() map[string]*pluginsdk.Schema { | |||
| ValidateFunc: commonids.ValidateSubscriptionID, | |||
| }, | |||
|
|
|||
| "email_address_sender": { | |||
There was a problem hiding this comment.
could you explain what this property does as this is different from the API/SDK name here.
notification email and sender email seem rather different
my guess is it is the email the notification is sent from? if so perhapes it would be better as
| "email_address_sender": { | |
| "notification_from_email_address": { |
There was a problem hiding this comment.
@katbyte Based on my understanding, this email is not the sender of the notifications. In the Azure REST API specifications, the property is called notificationEmail and it is used to specify the email address of the person who should receive notifications related to the scheduled actions (e.g. if someone likes to unsubscribe from the notifications).
Email address of the point of contact that should get the unsubscribe requests and notification emails.
The reason why I used email_address_sender, is because scheduled actions already sets the field NotificationEmail for ScheduledActionProperties and called the parameter email_address_sender.
However, I agree with you that it would be odd to have a different naming than API / SDK.
I'll update the parameter to notification_email if that works for you.
|
@katbyte I added a commit to reflect the new parameter in the docs. |
Community Note
Description
This change updates the costmanagement API to version
2023-08-01, ensuring compatibility with both the public AzureCloud and AzureChinaCloud. It's important to note that AzureChinaCloud has specific API version requirements, and version2023-08-01meets these.In addition, the
azurerm_cost_anomaly_alertresource now includes a new optional parameter,email_address_sender, which is sent to the API asproperties.notificationEmail. Should this parameter be omitted, the TF provider will default to using the first email address listed inemail_addresses, aligning with the default behavior observed in the Azure Portal.The
ScheduledActionsClient_v2022_10_01, which previously existed alongside theScheduledActionsClient, has been discontinued. This is because the API version2023-08-01seems to be compatible with all uses.PR Checklist
For example: “
resource_name_here- description of change e.g. adding propertynew_property_name_here”Changes to existing Resource / Data Source
Change Log
Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.
azurerm_resource_group_cost_management_export- upgrade the API version to2023-08-01which also supports AzureChinaCloudThis is a (please select all that apply):
Note
If this PR changes meaningfully during the course of review please update the title and description as required.
Additonal Context
When creating the resource with an old API version (let's say 2022-06-01-preview), the
properties.notificationEmailisnullin the response. With API version2023-11-01, if you try to get the previously created alert, the response contains the first entry of the listproperties.notification.to.