Server-Side Cloud Script - Register Event Hub Function

Service:

CloudScript

API Version:

240524

Registers an event hub triggered Azure Function with a title.

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

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	Required	Type	Description
ConnectionString	True	string	A connection string for the namespace of the event hub for the Azure Function.
EventHubName	True	string	The name of the event hub for the Azure Function.
FunctionName	True	string	The name of the function to register
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	EmptyResult
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
EmptyResult
RegisterEventHubFunctionRequest	A title can have many functions, RegisterEventHubFunction associates a function name with an event hub name and connection string.

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

EmptyResult

RegisterEventHubFunctionRequest

A title can have many functions, RegisterEventHubFunction associates a function name with an event hub name and connection string.

Name	Type	Description
ConnectionString	string	A connection string for the namespace of the event hub for the Azure Function.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
EventHubName	string	The name of the event hub for the Azure Function.
FunctionName	string	The name of the function to register