> For the complete documentation index, see [llms.txt](https://gebra-it.gitbook.io/wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gebra-it.gitbook.io/wiki/client-api-reference/functions/azurefunction.md).

# azureFunction

Calls an Azure Function and returns the result

## Parameters

* functionName - the configured name of the function
* functionsParameters - (optional) JSON object with function parameters. They will be available in the function under body.parameters
* options - (optional) See examples. You can use the options to get the payload of the request or a Postman example, instead of calling the function. Can be used to debug a function on your local machine

## Example Usages

### To call a function and get the response object

```javascript
let functionResponse = app.azureFunction("myFunction", {
  name: "Hallo",
});
console.log(functionResponse.functionResult);
```

### To get an example payload based on the current app state

```javascript
let functionResponse = app.azureFunction(
  "myFunction",
  {
    name: "Hallo",
  },
  {
    payload: true,
  }
);
console.log(functionResponse.functionResult);
```

### To get an example Postman collection including the payload of the current app

```javascript
let functionResponse = app.azureFunction(
  "myFunction",
  {
    name: "Hallo",
  },
  {
    postman: true,
  }
);
console.log(functionResponse.functionResult);
```

### To change the default timeout (300 seconds)

```javascript
let functionResponse = app.azureFunction(
  "myFunction",
  {
    name: "Hallo",
  },
  {
    timeout: 500,
  }
);
console.log(functionResponse.functionResult);
```
