Server-Side Cloud Script - List Event Hub Functions
Lists all currently registered Event Hub triggered Azure Functions for a given title.
POST https://titleId.playfabapi.com/CloudScript/ListEventHubFunctionsRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Event |
|
|
List |
|
|
List |
A title can have many functions, ListHttpFunctions will return a list of all the currently registered HTTP triggered functions for a given title. |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
EventHubFunctionModel
| Name | Type | Description |
|---|---|---|
| ConnectionString |
string |
The connection string for the event hub. |
| EventHubName |
string |
The name of the event hub that triggers the Azure Function. |
| FunctionName |
string |
The name the function was registered under. |
ListEventHubFunctionsResult
| Name | Type | Description |
|---|---|---|
| Functions |
The list of EventHub triggered functions that are currently registered for the title. |
ListFunctionsRequest
A title can have many functions, ListHttpFunctions will return a list of all the currently registered HTTP triggered functions for a given title.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |