Pular para o conteúdo principal
A XBOX CLI não precisa de arquivo de configuração. Suas configurações vêm de padrões integrados ao executável, que você pode substituir para um shell com variáveis de ambiente ou para um único comando com opções.

Fontes de configuração e precedência

As configurações vêm de três fontes, e as fontes posteriores substituem as anteriores:
  1. Padrões internos, compilados no executável. Consulte Configurações.
  2. Variáveis de ambiente. Consulte Variáveis de ambiente.
  3. Opções de linha de comando. Consulte Substituições por opções da CLI.
Uma nova versão traz os próprios padrões; portanto, não há arquivo de configurações para levar adiante. O vendedor, o título do PlayFab, o título do XBOX e a sandbox não são configurações; consulte Contexto para saber de onde um comando os obtém.

Configurações

  • AzureAd:* configuram o login do usuário; consulte Autenticação.
  • PlayFab:StudioBaseUrl é o ponto de extremidade do PlayFab para APIs de estúdio (/Studio/*), como as que playfab service-principal chama.
  • XboxPartner:TimeoutSeconds é o tempo limite de solicitação, em segundos, para comandos como game e precisa ser um número positivo.
  • XblPCSandbox:Path é o XblPCSandbox.exe que os comandos pc sandbox executam. Quando ele não está definido, a CLI procura no próprio diretório e, em seguida, em PATH.
  • AuditLog:Enabled ativa o log de auditoria.
  • Telemetry:* são descritas em Telemetria.
Quando PlayFab:BaseUrlTemplate, PlayFab:StudioBaseUrl ou XboxPartner:BaseUrl não é o padrão interno, todos os comandos que enviam um token a esse ponto de extremidade primeiro gravam um aviso em stderr.

Variáveis de ambiente

A variável de uma configuração é XBOX_ seguido da chave, com __ (dois sublinhados) no lugar de cada :; assim, Telemetry:Enabled é XBOX_TELEMETRY__ENABLED. Escreva os nomes em maiúsculas. Uma variável se aplica ao shell que a define e a todos os comandos que esse shell inicia:
Todas as configurações em Configurações têm uma variável. A CLI também lê estas: As configurações XBOX_AUTHENTICATION__ são lidas somente de variáveis de ambiente, nunca de padrões internos nem de opções. Consulte Autenticação de automação (entidade de serviço).

Substituições por opções da CLI

As opções substituem todas as outras fontes, para um único comando. Consulte Comandos para ver as outras opções globais.

Configuração da telemetria

As versões oficiais coletam telemetria anônima limitada, a menos que você a desative. Para desativá-la para um único comando:
Para desativá-la para um shell:
Consulte Telemetria para saber o que é coletado.

Atualizar a partir de uma versão que lia appsettings.json

As versões anteriores liam appsettings.json ao lado do executável. Se você alterou um valor nele, defina a variável XBOX_ correspondente: por exemplo, "AzureAd": { "ClientId": "..." } passa a ser XBOX_AZUREAD__CLIENTID. Você pode ver estas mensagens até concluir:
  • --config-env falha com este erro. Remova a opção e defina variáveis XBOX_ em vez disso.
  • Enquanto houver um arquivo appsettings*.json ao lado do executável, os comandos gravarão esta observação em stderr. Exclua o arquivo.
  • Os comandos do PlayFab falham com um erro que nomeia XBOX_PLAYFAB__REQUESTHEADERS__0__VALUE se uma mensagem de erro anterior levou você a defini-la. Remova a variável.
Última modificação em 19 de novembro de 2026