注册队列函数
Registers a queue triggered Azure Function with a title.
Allowed entity token types: title
POST
/
CloudScript
/
RegisterQueuedFunction
Register Queued Function
curl --request POST \
--url https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"QueueName": "fn-queue",
"ConnectionString": "SampleConnectionString",
"FunctionName": "functionName"
}
'import requests
url = "https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction"
payload = {
"QueueName": "fn-queue",
"ConnectionString": "SampleConnectionString",
"FunctionName": "functionName"
}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
QueueName: 'fn-queue',
ConnectionString: 'SampleConnectionString',
FunctionName: 'functionName'
})
};
fetch('https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'QueueName' => 'fn-queue',
'ConnectionString' => 'SampleConnectionString',
'FunctionName' => 'functionName'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction"
payload := strings.NewReader("{\n \"QueueName\": \"fn-queue\",\n \"ConnectionString\": \"SampleConnectionString\",\n \"FunctionName\": \"functionName\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"QueueName\": \"fn-queue\",\n \"ConnectionString\": \"SampleConnectionString\",\n \"FunctionName\": \"functionName\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"QueueName\": \"fn-queue\",\n \"ConnectionString\": \"SampleConnectionString\",\n \"FunctionName\": \"functionName\"\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}授权
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
请求体
application/json
A title can have many functions, RegisterQueuedFunction associates a function name with a queue name and connection string.
A title can have many functions, RegisterQueuedFunction associates a function name with a queue name and connection string.
A connection string for the storage account that hosts the queue for the Azure Function.
The name of the function to register
The name of the queue for the Azure Function.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
最后修改于 2026年10月6日
相关主题
列出队列函数使用 Azure Functions 的 PlayFab CloudScript 快速入门指南XTaskQueue注册 HTTP 函数XTaskQueueUnregisterMonitor此页面对您有帮助吗?
⌘I
Register Queued Function
curl --request POST \
--url https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"QueueName": "fn-queue",
"ConnectionString": "SampleConnectionString",
"FunctionName": "functionName"
}
'import requests
url = "https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction"
payload = {
"QueueName": "fn-queue",
"ConnectionString": "SampleConnectionString",
"FunctionName": "functionName"
}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
QueueName: 'fn-queue',
ConnectionString: 'SampleConnectionString',
FunctionName: 'functionName'
})
};
fetch('https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'QueueName' => 'fn-queue',
'ConnectionString' => 'SampleConnectionString',
'FunctionName' => 'functionName'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction"
payload := strings.NewReader("{\n \"QueueName\": \"fn-queue\",\n \"ConnectionString\": \"SampleConnectionString\",\n \"FunctionName\": \"functionName\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"QueueName\": \"fn-queue\",\n \"ConnectionString\": \"SampleConnectionString\",\n \"FunctionName\": \"functionName\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/CloudScript/RegisterQueuedFunction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"QueueName\": \"fn-queue\",\n \"ConnectionString\": \"SampleConnectionString\",\n \"FunctionName\": \"functionName\"\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}