Add maximumThroughputUnits option to template

[daviduash]

What does this PR do?

Allow users to set the maximumThroughputUnits option in Eventhub

Motivation

Set limit to Throughput when creating DD integration with Eventhub

Testing Guidelines

installed in my test env

Types of changes

• Bug fix
• New feature
• Breaking change
• Misc (docs, refactoring, dependency upgrade, etc.)

Check all that apply

• This PR's description is comprehensive
• This PR contains breaking changes that are documented in the description
• This PR introduces new APIs or parameters that are documented and unlikely to change in the foreseeable future
• This PR impacts documentation, and it has been updated (or a ticket has been logged)
• This PR's changes are covered by the automated tests
• This PR collects user input/sensitive content into Datadog
• This PR passes the integration tests (ask a Datadog member to run the tests)
• This PR passes the unit tests
• This PR passes the installation tests (ask a Datadog member to run the tests)

[mattsp1290]

Thanks for opening this PR to add more options during deployment

When attempting to use this revision to deploy to Azure, Azure responds with

{"code":"InvalidTemplate","message":"Deployment template validation failed: 'The template parameters 'isAutoInflateEnabled, maximumThroughputUnits' in the parameters file are not valid; they are not present in the original template and can therefore not be provided at deployment time. The only supported parameters for this template are 'eventHubNamespace, eventHubName, partitionCount, location'. Please see https://aka.ms/arm-pass-parameter-values for usage details.'."}

Take a look at how eventHubNamespace is used in https://github.com/DataDog/datadog-serverless-functions/blob/master/azure/deploy-to-azure/parent_template.json and https://github.com/DataDog/datadog-serverless-functions/blob/master/azure/deploy-to-azure/function_template.json

You can test your changes by replacing "master" in the following link with your latest commit hash
https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FDataDog%2Fdatadog-serverless-functions%2Fmaster%2Fazure%2Fdeploy-to-azure%2Fparent_template.json

For example the link I used to test was
https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FDataDog%2Fdatadog-serverless-functions%2F8938131929d443c8d6a532d40bcc1220c14aca2a%2Fazure%2Fdeploy-to-azure%2Fparent_template.json

I am not finding any documentation on what a 0 value for maximumThroughputUnits would result in for maximumThroughputUnits. What behavior did you see during your testing of this value?

Also would be nice to note in the description of auto inflate that it related to these throughput units.

[daviduash]

Hey
Thanks for the replay
it cannot be tested from the web b/c the eventHubTemplateLink is still directing to the master branch
i did tested it in my environment (im deploying using Terraform)
i changed the eventHubTemplateLink to by my template file
enabled isAutoInflateEnabled and set the maximumThroughputUnits to 3

regarding the value 0 in maximumThroughputUnits
i took it from here - ( '0' if AutoInflateEnabled = true)
https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.eventhub.models.ehnamespace.maximumthroughputunits?view=azure-dotnet

[mattsp1290]

Hey Thanks for the replay it cannot be tested from the web b/c the eventHubTemplateLink is still directing to the master branch i did tested it in my environment (im deploying using Terraform) i changed the eventHubTemplateLink to by my template file enabled isAutoInflateEnabled and set the maximumThroughputUnits to 3

regarding the value 0 in maximumThroughputUnits i took it from here - ( '0' if AutoInflateEnabled = true) https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.eventhub.models.ehnamespace.maximumthroughputunits?view=azure-dotnet

The current defaults appear to be invalid together. Either auto inflate should default to true or the maximum TPU should be set to the default maximum of 20.

[ashwingandhi-ddog]

Did some testing and here is what I found:

Deployment fails when:

• IsAutoInflate: false and Maximum Throughput Units is greater than 0.
• IsAutoInflate: true and Maximum Throughput Units is 0. (this conflicts with Azure's documentation)

Deployment succeeds when:

• IsAutoInflate: true and Maximum Throughput Units is greater than 0.
• IsAutoInflate: false and Maximum Throughput Units is 0.

Suggestions:

• rename Maximum Throughput Units to Auto-Inflate Maximum Throughput Units as used by azure while creating an EventHubNamespace manually. See image.
• add more descriptive label saying something like "Set Auto-Inflate Maximum Throughput Units to 0 if IsAutoInflate is disabled. If enabled, set it to a value from 1 to 20".