Server-Side Cloud Script - Get Function
Gets registered Azure Functions for a given title id and function name.
POST https://titleId.playfabapi.com/CloudScript/GetFunction
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 |
---|---|---|---|
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 | ||
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 |
Get |
|
Get |
|
Trigger |
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 |
GetFunctionRequest
Name | Type | Description |
---|---|---|
CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
FunctionName |
string |
The name of the function to register |
GetFunctionResult
Name | Type | Description |
---|---|---|
ConnectionString |
string |
The connection string for the storage account containing the queue for a queue trigger Azure Function. |
FunctionUrl |
string |
The URL to be invoked to execute an HTTP triggered function. |
QueueName |
string |
The name of the queue for a queue trigger Azure Function. |
TriggerType |
The trigger type for the function. |
TriggerType
Name | Type | Description |
---|---|---|
EventHub |
string |
|
HTTP |
string |
|
Queue |
string |
Error Codes
Name | Code |
---|---|
CloudScriptNotFound | 1136 |