> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CloudScript

> 管理傳統 CloudScript JavaScript 修訂，以及 CloudScript 所使用的 Azure Functions 註冊。

`playfab cloudscript` 命令系列為實驗性功能。其 CLI 介面可能會根據意見反應而變更或移除。

使用 `classic` 管理傳統 CloudScript (由 PlayFab 裝載的 JavaScript)，並使用 `function` 管理 CloudScript 所呼叫的 Azure Functions。這些命令在執行之前都不會先詢問。

## `playfab cloudscript classic`

| 命令 | PlayFab API 路徑 | 選項 |
| - | - | - |
| `playfab cloudscript classic revision get` | `/Admin/GetCloudScriptRevision` | 選用的 `--version` 和 `--revision`；兩者預設皆為最新。 |
| `playfab cloudscript classic version list` | `/Admin/GetCloudScriptVersions` | 無。 |
| `playfab cloudscript classic revision create` | `/Admin/UpdateCloudScript` | `--file` (必要)，要以新修訂上傳的 JavaScript 檔案。`--publish` 也會讓新修訂上線。 |
| `playfab cloudscript classic revision publish` | `/Admin/SetPublishedRevision` | `--version` 和 `--revision` (兩者皆為必要)。 |

## `playfab cloudscript function`

`function` 會向 PlayFab 註冊現有的 Azure Functions，讓 CloudScript 可以呼叫它們。它不會在 Azure 中建立或變更任何內容。

| 命令 | PlayFab API 路徑 | 選項 |
| - | - | - |
| `playfab cloudscript function list` | `/CloudScript/ListFunctions`，或搭配 `--type` 時為 `/CloudScript/ListHttpFunctions`、`/CloudScript/ListQueuedFunctions` 或 `/CloudScript/ListEventHubFunctions` | 選用的 `--type`：`http`、`queued` 或 `eventhub`。省略此選項即可列出每個註冊。 |
| `playfab cloudscript function register` | `/CloudScript/RegisterHttpFunction` | `--type http`、`--name` 和 `--url` (皆為必要)；選用的 `--key-file`。`http` 是您唯一可以註冊的類型。 |
| `playfab cloudscript function unregister` | `/CloudScript/UnregisterFunction` | `--name` (必要)。 |

### 函式金鑰

使用函式層級授權 (Azure 的預設值) 的 HTTP 觸發 Azure 函式需要其函式金鑰。請在檔案中傳遞金鑰，而不是放在 URL 中，這樣金鑰就不會出現在殼層歷程記錄和處理序清單中：

| 選項 | 描述 |
| - | - |
| `--url <url>` | 函式的 URL，不含其金鑰。含有 `code` 查詢參數的 URL 會遭到拒絕。 |
| `--key-file <path>` | 保存函式金鑰 (如 Azure 入口網站所顯示) 的檔案，或以 `-` 從管道傳送的 stdin 讀取。前後的空白字元會被修剪。若函式不需要金鑰，請省略此選項。 |

CLI 會將金鑰以 `code` 加入 URL，並註冊與 Azure 入口網站的 **Get function URL** 所顯示的相同 URL。

## 表格輸出

這些命令接受 `--output table`；其他命令則不接受。請參閱[表格輸出](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands.md#table-output)。

| 命令 | 欄 |
| - | - |
| `playfab cloudscript classic version list` | `VERSION`、`PUBLISHED REVISION`、`LATEST REVISION` |
| `playfab cloudscript function list` | `FUNCTION NAME` |

若要查看註冊的 URL 和其他詳細資料，請使用 JSON 輸出。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab cloudscript classic version list --output table
```

```text theme={null}
VERSION  PUBLISHED REVISION  LATEST REVISION
-------  ------------------  ---------------
1        3                   5
2        1                   1
```

## 範例

檢查已發佈的版本，並讀取修訂：

```bash theme={null}
xbox --playfab-title-id ABC123 playfab cloudscript classic version list
xbox --playfab-title-id ABC123 playfab cloudscript classic revision get --version 1 --revision 2
```

將 `main.js` 上傳為新修訂：

```bash theme={null}
xbox --playfab-title-id ABC123 playfab cloudscript classic revision create --file main.js
```

`create` 會傳回新修訂的 `Version` 和 `Revision`。檢閱修訂之後，請使用這些編號將其發佈：

```bash theme={null}
xbox --playfab-title-id ABC123 playfab cloudscript classic revision publish --version 1 --revision 3
```

列出 HTTP 函式註冊：

```bash theme={null}
xbox --playfab-title-id ABC123 playfab cloudscript function list --type http
```

註冊金鑰位於 `function-key.txt` 中的函式：

```bash theme={null}
xbox --playfab-title-id ABC123 playfab cloudscript function register --type http --name MatchWebhook --url https://nodpublishers.azurewebsites.net/api/MatchWebhook --key-file ./function-key.txt
```

若要改為從 stdin 讀取金鑰 (例如從秘密存放區)：

```bash theme={null}
get-function-key | xbox --playfab-title-id ABC123 playfab cloudscript function register --type http --name MatchWebhook --url https://nodpublishers.azurewebsites.net/api/MatchWebhook --key-file -
```

註冊不需要金鑰的函式：

```bash theme={null}
xbox --playfab-title-id ABC123 playfab cloudscript function register --type http --name PublicStatus --url https://nodpublishers.azurewebsites.net/api/PublicStatus
```

取消註冊 `MatchWebhook`：

```bash theme={null}
xbox --playfab-title-id ABC123 playfab cloudscript function unregister --name MatchWebhook
```


## Related topics

- [CloudScript](https://docs.xbox.com/zh-TW/services/playfab/live-service-management/service-gateway/automation/cloudscript/index.md)
- [執行 Cloud Script](https://docs.xbox.com/zh-TW/services/playfab/api-references/rest/client/server-side-cloud-script/execute-cloud-script.md)
- [Execute Cloud Script](https://docs.xbox.com/api-reference/server-side-cloud-script/execute-cloud-script.md)
- [撰寫自訂 CloudScript](https://docs.xbox.com/zh-TW/services/playfab/live-service-management/service-gateway/automation/cloudscript/writing-custom-cloudscript.md)
- [CloudScript 快速入門](https://docs.xbox.com/zh-TW/services/playfab/live-service-management/service-gateway/automation/cloudscript/quickstart.md)
