Server-Side Cloud Script - List Event Hub Functions

Service:

CloudScript

API Version:

251121

Lists all currently registered Event Hub triggered Azure Functions for a given title.

Allowed entity token types: title

POST https://titleId.playfabapi.com/CloudScript/ListEventHubFunctions

Request 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	ListEventHubFunctionsResult
400 Bad Request	ApiErrorWrapper	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
ApiErrorWrapper	The basic wrapper around every failed API response
EventHubFunctionModel
ListEventHubFunctionsResult
ListFunctionsRequest	A title can have many functions, ListHttpFunctions will return a list of all the currently registered HTTP triggered functions for a given title.

ApiErrorWrapper

Object

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

Object

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

Object

Name	Type	Description
Functions	EventHubFunctionModel[]	The list of EventHub triggered functions that are currently registered for the title.

ListFunctionsRequest

Object

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.).