Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

azurerm_eventgrid_event_subscription : Support delivery_property #13595

Merged
merged 10 commits into from
Oct 13, 2021
Merged

azurerm_eventgrid_event_subscription : Support delivery_property #13595

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
33bb4d0
Implementing event grid delivery mappings
dylanmorley Sep 17, 2021
65e8feb
Merge remote-tracking branch 'origin/main' into feature/event-grid-su…
dylanmorley Oct 2, 2021
bf6cc84
Implemented delivery mappings for supported endpoints
dylanmorley Oct 2, 2021
547d068
standardised parameters passed from expand destination
dylanmorley Oct 3, 2021
e840e93
Updated tests and documentation to use delivery_property
dylanmorley Oct 3, 2021
4c7b4ec
Updated docs
dylanmorley Oct 3, 2021
0668d0f
Handle secret value by reading and returning config
dylanmorley Oct 7, 2021
9dc8e7e
Made parameter sensitive and formatted HCL
dylanmorley Oct 8, 2021
ef89ef8
Review changes + additional test for delivery property updates
dylanmorley Oct 9, 2021
010aa80
Slight optimisation and reduce indentation
dylanmorley Oct 12, 2021
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
264 changes: 214 additions & 50 deletions internal/services/eventgrid/event_subscription.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-provider-azurerm/helpers/azure"
"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
"github.com/hashicorp/terraform-provider-azurerm/internal/tf/suppress"
"github.com/hashicorp/terraform-provider-azurerm/internal/tf/validation"
"github.com/hashicorp/terraform-provider-azurerm/utils"
)
Expand Down Expand Up @@ -89,6 +90,47 @@ func eventSubscriptionSchemaEventDeliverySchema() *pluginsdk.Schema {
}
}

func eventSubscriptionSchemaDeliveryProperty() *pluginsdk.Schema {
return &pluginsdk.Schema{
Type: pluginsdk.TypeList,
Optional: true,
Elem: &pluginsdk.Resource{
Schema: map[string]*pluginsdk.Schema{
"header_name": {
Type: pluginsdk.TypeString,
Required: true,
DiffSuppressFunc: suppress.CaseDifference,
},

"type": {
Type: pluginsdk.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice([]string{
"Static",
"Dynamic",
}, false),
},

"value": {
Type: pluginsdk.TypeString,
Optional: true,
Sensitive: true, // must mark as Sensitive, as it's possible for this to be 'Secret'
},

"source_field": {
Type: pluginsdk.TypeString,
Optional: true,
},

"secret": {
Type: pluginsdk.TypeBool,
Optional: true,
},
},
},
}
}

func eventSubscriptionSchemaExpirationTimeUTC() *pluginsdk.Schema {
return &pluginsdk.Schema{
Type: pluginsdk.TypeString,
Expand Down Expand Up @@ -816,61 +858,73 @@ func expandEventGridExpirationTime(d *schema.ResourceData) (*date.Time, error) {
}

func expandEventGridEventSubscriptionDestination(d *pluginsdk.ResourceData) eventgrid.BasicEventSubscriptionDestination {
if v, ok := d.GetOk("azure_function_endpoint"); ok {
return expandEventGridEventSubscriptionAzureFunctionEndpoint(v)
if _, ok := d.GetOk("azure_function_endpoint"); ok {
return expandEventGridEventSubscriptionAzureFunctionEndpoint(d)
}

if v, ok := d.GetOk("eventhub_endpoint_id"); ok {
return &eventgrid.EventHubEventSubscriptionDestination{
EndpointType: eventgrid.EndpointTypeEventHub,
EventHubEventSubscriptionDestinationProperties: &eventgrid.EventHubEventSubscriptionDestinationProperties{
ResourceID: utils.String(v.(string)),
},
}
if _, ok := d.GetOk("eventhub_endpoint_id"); ok {
return expandEventGridEventSubscriptionEventhubEndpoint(d)
} else if _, ok := d.GetOk("eventhub_endpoint"); ok {
return expandEventGridEventSubscriptionEventhubEndpoint(d)
}

if v, ok := d.GetOk("hybrid_connection_endpoint_id"); ok {
return &eventgrid.HybridConnectionEventSubscriptionDestination{
EndpointType: eventgrid.EndpointTypeHybridConnection,
HybridConnectionEventSubscriptionDestinationProperties: &eventgrid.HybridConnectionEventSubscriptionDestinationProperties{
ResourceID: utils.String(v.(string)),
},
}
if _, ok := d.GetOk("hybrid_connection_endpoint_id"); ok {
return expandEventGridEventSubscriptionHybridConnectionEndpoint(d)
} else if _, ok := d.GetOk("hybrid_connection_endpoint"); ok {
return expandEventGridEventSubscriptionHybridConnectionEndpoint(d)
}

if v, ok := d.GetOk("service_bus_queue_endpoint_id"); ok {
return &eventgrid.ServiceBusQueueEventSubscriptionDestination{
EndpointType: eventgrid.EndpointTypeServiceBusQueue,
ServiceBusQueueEventSubscriptionDestinationProperties: &eventgrid.ServiceBusQueueEventSubscriptionDestinationProperties{
ResourceID: utils.String(v.(string)),
},
}
if _, ok := d.GetOk("service_bus_queue_endpoint_id"); ok {
return expandEventGridEventSubscriptionServiceBusQueueEndpoint(d)
}

if v, ok := d.GetOk("service_bus_topic_endpoint_id"); ok {
return &eventgrid.ServiceBusTopicEventSubscriptionDestination{
EndpointType: eventgrid.EndpointTypeServiceBusTopic,
ServiceBusTopicEventSubscriptionDestinationProperties: &eventgrid.ServiceBusTopicEventSubscriptionDestinationProperties{
ResourceID: utils.String(v.(string)),
},
}
if _, ok := d.GetOk("service_bus_topic_endpoint_id"); ok {
return expandEventGridEventSubscriptionServiceBusTopicEndpoint(d)
}

if _, ok := d.GetOk("storage_queue_endpoint"); ok {
return expandEventGridEventSubscriptionStorageQueueEndpoint(d)
}

if v, ok := d.GetOk("webhook_endpoint"); ok {
return expandEventGridEventSubscriptionWebhookEndpoint(v)
if _, ok := d.GetOk("webhook_endpoint"); ok {
return expandEventGridEventSubscriptionWebhookEndpoint(d)
}

return nil
}

func expandEventGridEventSubscriptionServiceBusQueueEndpoint(d *pluginsdk.ResourceData) eventgrid.BasicEventSubscriptionDestination {
endpoint := d.Get("service_bus_queue_endpoint_id")

props := &eventgrid.ServiceBusQueueEventSubscriptionDestinationProperties{
ResourceID: utils.String(endpoint.(string)),
}

deliveryMappings := expandDeliveryProperties(d)
props.DeliveryAttributeMappings = &deliveryMappings

return &eventgrid.ServiceBusQueueEventSubscriptionDestination{
EndpointType: eventgrid.EndpointTypeServiceBusQueue,
ServiceBusQueueEventSubscriptionDestinationProperties: props,
}
}

func expandEventGridEventSubscriptionServiceBusTopicEndpoint(d *pluginsdk.ResourceData) eventgrid.BasicEventSubscriptionDestination {
endpoint := d.Get("service_bus_topic_endpoint_id")

props := &eventgrid.ServiceBusTopicEventSubscriptionDestinationProperties{
ResourceID: utils.String(endpoint.(string)),
}

deliveryMappings := expandDeliveryProperties(d)
props.DeliveryAttributeMappings = &deliveryMappings

return &eventgrid.ServiceBusTopicEventSubscriptionDestination{
EndpointType: eventgrid.EndpointTypeServiceBusTopic,
ServiceBusTopicEventSubscriptionDestinationProperties: props,
}
}

func expandEventGridEventSubscriptionStorageQueueEndpoint(d *pluginsdk.ResourceData) eventgrid.BasicEventSubscriptionDestination {
props := d.Get("storage_queue_endpoint").([]interface{})[0].(map[string]interface{})
storageAccountID := props["storage_account_id"].(string)
Expand All @@ -886,38 +940,59 @@ func expandEventGridEventSubscriptionStorageQueueEndpoint(d *pluginsdk.ResourceD
}

func expandEventGridEventSubscriptionEventhubEndpoint(d *pluginsdk.ResourceData) eventgrid.BasicEventSubscriptionDestination {
ep := d.Get("eventhub_endpoint").([]interface{})
if len(ep) == 0 || ep[0] == nil {
return eventgrid.EventHubEventSubscriptionDestination{}

destinationProps := &eventgrid.EventHubEventSubscriptionDestinationProperties{}

if _, ok := d.GetOk("eventhub_endpoint_id"); ok {
endpoint := d.Get("eventhub_endpoint_id")
destinationProps.ResourceID = utils.String(endpoint.(string))
} else if _, ok := d.GetOk("eventhub_endpoint"); ok {
ep := d.Get("eventhub_endpoint").([]interface{})
if len(ep) == 0 || ep[0] == nil {
return eventgrid.EventHubEventSubscriptionDestination{}
}
props := ep[0].(map[string]interface{})
eventHubID := props["eventhub_id"].(string)
destinationProps.ResourceID = &eventHubID
}
props := ep[0].(map[string]interface{})
eventHubID := props["eventhub_id"].(string)

deliveryMappings := expandDeliveryProperties(d)
destinationProps.DeliveryAttributeMappings = &deliveryMappings

return eventgrid.EventHubEventSubscriptionDestination{
EndpointType: eventgrid.EndpointTypeEventHub,
EventHubEventSubscriptionDestinationProperties: &eventgrid.EventHubEventSubscriptionDestinationProperties{
ResourceID: &eventHubID,
},
EventHubEventSubscriptionDestinationProperties: destinationProps,
}
}

func expandEventGridEventSubscriptionHybridConnectionEndpoint(d *pluginsdk.ResourceData) eventgrid.BasicEventSubscriptionDestination {
ep := d.Get("hybrid_connection_endpoint").([]interface{})
if len(ep) == 0 || ep[0] == nil {
return eventgrid.HybridConnectionEventSubscriptionDestination{}

destinationProps := &eventgrid.HybridConnectionEventSubscriptionDestinationProperties{}

if v, ok := d.GetOk("hybrid_connection_endpoint_id"); ok {
destinationProps.ResourceID = utils.String(v.(string))
} else if _, ok := d.GetOk("hybrid_connection_endpoint"); ok {
ep := d.Get("hybrid_connection_endpoint").([]interface{})
if len(ep) == 0 || ep[0] == nil {
return eventgrid.HybridConnectionEventSubscriptionDestination{}
}
props := ep[0].(map[string]interface{})
hybridConnectionID := props["hybrid_connection_id"].(string)
destinationProps.ResourceID = &hybridConnectionID
}
props := ep[0].(map[string]interface{})
hybridConnectionID := props["hybrid_connection_id"].(string)

deliveryMappings := expandDeliveryProperties(d)
destinationProps.DeliveryAttributeMappings = &deliveryMappings

return eventgrid.HybridConnectionEventSubscriptionDestination{
EndpointType: eventgrid.EndpointTypeHybridConnection,
HybridConnectionEventSubscriptionDestinationProperties: &eventgrid.HybridConnectionEventSubscriptionDestinationProperties{
ResourceID: &hybridConnectionID,
},
HybridConnectionEventSubscriptionDestinationProperties: destinationProps,
}
}

func expandEventGridEventSubscriptionAzureFunctionEndpoint(input interface{}) eventgrid.BasicEventSubscriptionDestination {
func expandEventGridEventSubscriptionAzureFunctionEndpoint(d *pluginsdk.ResourceData) eventgrid.BasicEventSubscriptionDestination {

input := d.Get("azure_function_endpoint")
configs := input.([]interface{})

props := eventgrid.AzureFunctionEventSubscriptionDestinationProperties{}
Expand All @@ -944,10 +1019,55 @@ func expandEventGridEventSubscriptionAzureFunctionEndpoint(input interface{}) ev
props.PreferredBatchSizeInKilobytes = utils.Int32(int32(v.(int)))
}

deliveryMappings := expandDeliveryProperties(d)
props.DeliveryAttributeMappings = &deliveryMappings

return azureFunctionDestination
}

func expandEventGridEventSubscriptionWebhookEndpoint(input interface{}) eventgrid.BasicEventSubscriptionDestination {
func expandDeliveryProperties(d *pluginsdk.ResourceData) []eventgrid.BasicDeliveryAttributeMapping {

var basicDeliveryAttributeMapping []eventgrid.BasicDeliveryAttributeMapping

if deliveryMappingsConfig, ok := d.GetOk("delivery_property"); ok {
input := deliveryMappingsConfig.([]interface{})

if len(input) == 0 {
return nil
}

for _, r := range input {
mappingBlock := r.(map[string]interface{})

if mappingBlock["type"].(string) == "Static" {
basicDeliveryAttributeMapping = append(basicDeliveryAttributeMapping, eventgrid.StaticDeliveryAttributeMapping{
Name: utils.String(mappingBlock["header_name"].(string)),
Type: eventgrid.TypeStatic,
StaticDeliveryAttributeMappingProperties: &eventgrid.StaticDeliveryAttributeMappingProperties{
Value: utils.String(mappingBlock["value"].(string)),
IsSecret: utils.Bool(mappingBlock["secret"].(bool)),
},
})
}

if mappingBlock["type"].(string) == "Dynamic" {
basicDeliveryAttributeMapping = append(basicDeliveryAttributeMapping, eventgrid.DynamicDeliveryAttributeMapping{
Name: utils.String(mappingBlock["header_name"].(string)),
Type: eventgrid.TypeDynamic,
DynamicDeliveryAttributeMappingProperties: &eventgrid.DynamicDeliveryAttributeMappingProperties{
SourceField: utils.String(mappingBlock["source_field"].(string)),
},
})
}
}
}

return basicDeliveryAttributeMapping
}

func expandEventGridEventSubscriptionWebhookEndpoint(d *pluginsdk.ResourceData) eventgrid.BasicEventSubscriptionDestination {

input := d.Get("webhook_endpoint")
configs := input.([]interface{})

props := eventgrid.WebHookEventSubscriptionDestinationProperties{}
Expand Down Expand Up @@ -982,6 +1102,9 @@ func expandEventGridEventSubscriptionWebhookEndpoint(input interface{}) eventgri
props.AzureActiveDirectoryApplicationIDOrURI = utils.String(v.(string))
}

deliveryMappings := expandDeliveryProperties(d)
props.DeliveryAttributeMappings = &deliveryMappings

return webhookDestination
}

Expand Down Expand Up @@ -1150,6 +1273,47 @@ func flattenEventGridEventSubscriptionEventhubEndpoint(input *eventgrid.EventHub
return []interface{}{result}
}

func flattenDeliveryProperties(d *pluginsdk.ResourceData, input *[]eventgrid.BasicDeliveryAttributeMapping) []interface{} {
dylanmorley marked this conversation as resolved.
Show resolved Hide resolved

deliveryProperties := make([]interface{}, len(*input))

for i, element := range *input {
attributeMapping := make(map[string]interface{})

if staticMapping, ok := element.AsStaticDeliveryAttributeMapping(); ok {
attributeMapping["type"] = staticMapping.Type
dylanmorley marked this conversation as resolved.
Show resolved Hide resolved
attributeMapping["header_name"] = staticMapping.Name
attributeMapping["secret"] = staticMapping.IsSecret

if *staticMapping.IsSecret {
// If this is a secret, the value doesn't get returned by the Azure API which just returns a value of 'Secret',
// so we need to lookup the value that was provided from config to return, so that we don't generate Diffs
propertiesFromConfig := expandDeliveryProperties(d)
for _, v := range propertiesFromConfig {
if cofigMap, ok := v.AsStaticDeliveryAttributeMapping(); ok {
dylanmorley marked this conversation as resolved.
Show resolved Hide resolved
if *cofigMap.Name == *staticMapping.Name {
attributeMapping["value"] = cofigMap.Value
break
}
}
}
} else {
attributeMapping["value"] = staticMapping.Value
}
}

if dynamicMapping, ok := element.AsDynamicDeliveryAttributeMapping(); ok {
attributeMapping["type"] = dynamicMapping.Type
attributeMapping["header_name"] = dynamicMapping.Name
attributeMapping["source_field"] = dynamicMapping.SourceField
}

deliveryProperties[i] = attributeMapping
}

return deliveryProperties
}

func flattenEventGridEventSubscriptionHybridConnectionEndpoint(input *eventgrid.HybridConnectionEventSubscriptionDestination) []interface{} {
if input == nil {
return nil
Expand Down
Loading