[azure logs] Update docs with details about event hub name recommendations

[zmoog]

What does this PR do?

Updates the Azure Logs documentation adding recommendations about the Event Hub name, and explaining how it is used by the integration when it contains underscores (_) characters.

Checklist

• I have reviewed tips for building integrations and this pull request is aligned with them.
• I have verified that all data streams collect metrics or logs.
• I have added an entry to my package's changelog.yml file.
• I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

• [ ]

How to test this PR locally

Related issues

• Relases [azure] missing storage_account_container config option #3006

Screenshots

[elasticmachine]

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

• Start Time: 2022-05-11T10:26:55.014+0000

• Duration: 13 min 16 sec

Test stats 🧪

Test	Results
Failed	0
Passed	86
Skipped	0
Total	86

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

• /test : Re-trigger the build.

[elasticmachine]

🌐 Coverage report

Name	Metrics % (covered/total)	Diff
Packages	100.0% (6/6)	💚
Files	78.571% (11/14)	👎 -17.77
Classes	78.571% (11/14)	👎 -17.77
Methods	76.724% (89/116)	👎 -12.16
Lines	80.46% (1540/1914)	👎 -9.643
Conditionals	100.0% (0/0)	💚

[zmoog]

Hey @ravikesarwani, here's the first edit of the Azure Logs documentation to inform the users about what characters to use for the Event Hub name to maximize compatibility.

I made some minor changes to the docs, but I want to know your perspective on how far we want to update the docs right now.

The full details are in the files changed section, but I also added a screenshot with the rendering of the main README file.

[ravikesarwani]

"Elastic recommends using only letters, numbers, and the hyphen (-) character for Event Hub names to maximize compatibility. You can use existing Event Hubs having underscores (_) in the name, and the integration will adjust the settings when required" This is great but leaves users wanting to know more. I think its okay to expand this a little more and explain the reason "why".

[zmoog]

"Elastic recommends using only letters, numbers, and the hyphen (-) character for Event Hub names to maximize compatibility. You can use existing Event Hubs having underscores (_) in the name, and the integration will adjust the settings when required" This is great but leaves users wanting to know more. I think its okay to expand this a little more and explain the reason "why".

Yeah, I was puzzled about telling users more, or keeping things high level.

Let's expand it a little, what about:

It is a fully managed, real-time data ingestion service. Elastic recommends using only letters, numbers, and the hyphen (-) character for Event Hub names to maximize compatibility. You can use existing Event Hubs having underscores (_) in the Event Hub name. The integration will replace underscores with hyphens (-) when it uses the Event Hub name to create dependent Azure resources behind the scenes (e.g., the storage account container to store Event Hub consumer offsets).

[zmoog]

@ravikesarwani added a final rendering in the PR description: is there anything else you want to change in the Azure docs?

[ravikesarwani]

Good from my side.