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

> Gerencie as revisões de JavaScript do Classic CloudScript e os registros do Azure Functions que o CloudScript usa.

A família de comandos `playfab cloudscript` é Experimental. Sua interface de CLI pode mudar
ou ser removida com base em comentários.

Gerencie o Classic CloudScript, o JavaScript que o PlayFab hospeda, com `classic`, e as funções do Azure
Functions que o CloudScript chama, com `function`. Nenhum destes comandos pergunta antes de ser
executado.

## `playfab cloudscript classic`

| Comando | Caminho da API do PlayFab | Opções |
| - | - | - |
| `playfab cloudscript classic revision get` | `/Admin/GetCloudScriptRevision` | `--version` e `--revision` opcionais; ambas usam a mais recente como padrão. |
| `playfab cloudscript classic version list` | `/Admin/GetCloudScriptVersions` | Nenhuma. |
| `playfab cloudscript classic revision create` | `/Admin/UpdateCloudScript` | `--file` (obrigatória), um arquivo JavaScript a ser carregado como uma nova revisão. `--publish` também coloca a nova revisão em produção. |
| `playfab cloudscript classic revision publish` | `/Admin/SetPublishedRevision` | `--version` e `--revision` (ambas obrigatórias). |

## `playfab cloudscript function`

`function` registra funções existentes do Azure Functions no PlayFab, para que o CloudScript possa chamá-las. Ele
não cria nem altera nada no Azure.

| Comando | Caminho da API do PlayFab | Opções |
| - | - | - |
| `playfab cloudscript function list` | `/CloudScript/ListFunctions` ou, com `--type`, `/CloudScript/ListHttpFunctions`, `/CloudScript/ListQueuedFunctions` ou `/CloudScript/ListEventHubFunctions` | `--type` opcional: `http`, `queued` ou `eventhub`. Omita-a para listar todos os registros. |
| `playfab cloudscript function register` | `/CloudScript/RegisterHttpFunction` | `--type http`, `--name` e `--url` (todas obrigatórias); `--key-file` opcional. `http` é o único tipo que você pode registrar. |
| `playfab cloudscript function unregister` | `/CloudScript/UnregisterFunction` | `--name` (obrigatória). |

### Chaves de função

Uma função do Azure Functions disparada por HTTP com autorização em nível de função, o padrão do Azure, precisa
da chave de função dela. Passe a chave em um arquivo, e não na URL, para que ela fique fora do histórico
do shell e das listagens de processos:

| Opção | Descrição |
| - | - |
| `--url <url>` | A URL da função, sem a chave dela. Uma URL com um parâmetro de consulta `code` é recusada. |
| `--key-file <path>` | Um arquivo que contém a chave de função, como o portal do Azure a mostra, ou `-` para lê-la de stdin redirecionado. Os espaços em branco ao redor são removidos. Omita-a para uma função que não precisa de chave. |

A CLI adiciona a chave à URL como `code` e registra a mesma URL que a opção **Get function URL** do
portal do Azure mostra.

## Saída em tabela

Estes comandos aceitam `--output table`; os demais não. Consulte
[Saída em tabela](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands.md#table-output).

| Comando | Colunas |
| - | - |
| `playfab cloudscript classic version list` | `VERSION`, `PUBLISHED REVISION`, `LATEST REVISION` |
| `playfab cloudscript function list` | `FUNCTION NAME` |

Para ver a URL e outros detalhes de um registro, use a saída 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
```

## Exemplos

Verificar a versão publicada e ler uma revisão:

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

Carregar `main.js` como uma nova revisão:

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

`create` retorna a `Version` e a `Revision` da nova revisão. Depois de revisá-la,
publique-a com esses números:

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

Listar os registros de funções HTTP:

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

Registrar uma função cuja chave está em `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
```

Para ler a chave de stdin, por exemplo, de um repositório de segredos:

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

Registrar uma função que não precisa de chave:

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

Cancelar o registro de `MatchWebhook`:

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


## Related topics

- [CloudScript](https://docs.xbox.com/pt-BR/services/playfab/live-service-management/service-gateway/automation/cloudscript/index.md)
- [Escrever CloudScript personalizado](https://docs.xbox.com/pt-BR/services/playfab/live-service-management/service-gateway/automation/cloudscript/writing-custom-cloudscript.md)
- [Execute Cloud Script](https://docs.xbox.com/api-reference/server-side-cloud-script/execute-cloud-script.md)
- [Executar Cloud Script](https://docs.xbox.com/pt-BR/services/playfab/api-references/rest/client/server-side-cloud-script/execute-cloud-script.md)
- [Início rápido do CloudScript](https://docs.xbox.com/pt-BR/services/playfab/live-service-management/service-gateway/automation/cloudscript/quickstart.md)
