Azure / Azure/Azure-Functions

Event hubs trigger documented attributes are different from Intellisense

Open
#2,435 0 comments 0 reactions 0 assignees View on GitHub
area: documentation
Dominant language
PowerShell
Stars
1.1k
Forks
215
Avg merge
4h 2m
Merged PRs (30d)
1

Description

In , some of the attributes in `extensions.eventHubs.clientRetryOptions` are different than the one shown by Intellisense.

Here is a repro

Open VS Code, add a devcontainer with a definition of

.devcontainer.json:

```json
{
"name": "Ubuntu",
"image": "mcr.microsoft.com/devcontainers/base:jammy",
"features": {
"ghcr.io/jlaundry/devcontainer-features/azure-functions-core-tools:1": {}
}
}
```

reopen in the dev container

then issue the following commands

```bash
mkdir src
cd src
func init MyProjFolder --worker-runtime typescript --model V4
cd MyProjFolder/
func new --template "Azure Event Hub trigger" --name myEHTrigger
```

edit the `src/MyProjFolder/host.json` file and add the following snippet after the `extensionBundle`:

```json
,
"extensions": {
"eventHubs": {
"clientRetryOptions": {

}
}
```

Under `clientRetryOptions` add `"` and check intellisense

The list of attributes are:
- delay
- **maxDelay**
- **maxRetries**
- mode
- tryTimeout

while documentation mentions:
- delay
- **maximumDelay**
- **maximumRetries**
- mode
- tryTimeout

![image](https://github.com/Azure/Azure-Functions/assets/929731/9cb90f08-32ad-4ab9-b626-dd4ced5f7d0f)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.