> ## 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

> Classic CloudScript の JavaScript リビジョンと、CloudScript が使用する Azure Functions の登録を管理します。

`playfab cloudscript` コマンド ファミリーは試験段階 (Experimental) です。CLI インターフェイスは、フィードバックに基づいて
変更または削除される可能性があります。

PlayFab がホストする JavaScript である Classic CloudScript は `classic` で、CloudScript が呼び出す Azure
Functions は `function` で管理します。これらのコマンドはいずれも、実行前に確認を
求めません。

## `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` は、既存の Azure Functions を PlayFab に登録し、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 Function には、
関数キーが必要です。キーはシェルの履歴やプロセスの一覧に残らないように、URL ではなくファイルで
渡してください。

| オプション | 説明 |
| - | - |
| `--url <url>` | キーを含まない関数の URL。`code` クエリ パラメーターを含む URL は拒否されます。 |
| `--key-file <path>` | Azure portal に表示される関数キーを格納したファイル。パイプされた stdin から読み取る場合は `-`。前後の空白は削除されます。キーが不要な関数の場合は省略します。 |

CLI はキーを `code` として URL に追加し、Azure portal の **\[関数の URL の取得]** に表示されるものと同じ URL を
登録します。

## 表形式の出力

次のコマンドは `--output table` を受け付けます。その他のコマンドは受け付けません。
[テーブル出力](https://docs.xbox.com/ja-jp/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/ja-jp/services/playfab/live-service-management/service-gateway/automation/cloudscript/index.md)
- [Execute Cloud Script](https://docs.xbox.com/api-reference/server-side-cloud-script/execute-cloud-script.md)
- [cloudscript_executed](https://docs.xbox.com/ja-jp/services/playfab/api-references/events/CloudScript/cloudscript-executed.md)
- [Cloud Script の実行](https://docs.xbox.com/ja-jp/services/playfab/api-references/rest/client/server-side-cloud-script/execute-cloud-script.md)
- [Execute Entity Cloud Script](https://docs.xbox.com/api-reference/server-side-cloud-script/execute-entity-cloud-script.md)
