Server-Side Cloud Script - Register Queued Function
Registers a queue triggered Azure Function with a title.
POST https://titleId.playfabapi.com/CloudScript/RegisterQueuedFunctionRequest 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 storage account that hosts the queue for the Azure Function. |
| FunctionName | True |
string |
The name of the function to register |
| QueueName | True |
string |
The name of the queue for the Azure Function. |
| 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 |
|
Empty |
|
|
Register |
A title can have many functions, RegisterQueuedFunction associates a function name with a queue 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
RegisterQueuedFunctionRequest
A title can have many functions, RegisterQueuedFunction associates a function name with a queue name and connection string.
| Name | Type | Description |
|---|---|---|
| ConnectionString |
string |
A connection string for the storage account that hosts the queue for the Azure Function. |
| 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 |
| QueueName |
string |
The name of the queue for the Azure Function. |