xbox context は、販売者、PlayFab タイトル、XBOX タイトル、サンドボックスの既定値を保存するため、
これらの値をすべてのコマンドに渡す必要がなくなります。このページでは、これらの値を渡さなかった場合に
コマンドがどこから値を取得するかについても説明します。コンテキストはローカルです。これらのコマンドによって
パートナー センターや PlayFab の内容が変更されることはありません。
コマンド
キー
キーは、そのキーで値を設定するオプションの名前です。
これら以外のオプションでは、保存された値や変数は使用されません。
title-id は 1234ABCD のような 16 進数の XBOX タイトル ID であり、PlayFab タイトル ID ではありません。
xbl コマンドはこの値を使用してタイトルのサービス構成識別子 (SCID) を検索します。--scid を渡した場合、
この値は無視されます。タイトルの指定を参照してください。
コマンドでの保存された値の使用方法
コマンドがこれらのオプションのいずれかを受け取る場合、最初に見つかった値が使用されます。--seller-idなどのコマンド ラインのオプション。XBOX_SELLER_IDなどのオプションに対応するXBOX_変数。空の変数は未設定として扱われます。- 選択されているプロファイルに
context setで保存された値。
XBOX_SELLER_ID: --seller-id must be a positive numeric value. のように値の取得元が示されます。
コマンドに必要な値がどこからも提供されない場合は、値の設定方法が表示されます。販売者が省略可能な
コマンドである xbl と test-account では、承認されている販売者が 1 つだけの場合、その販売者が使用されます。
変更を行うコマンドは、--confirm を指定した場合でも、設定した各値とその取得元を stderr に書き込みます。
--verbose を指定すると、すべてのコマンドがこの情報を書き込みます。
game コマンドと sandbox コマンドが、この方法で選択された販売者とは
異なる販売者を使用してしまう 2 つの問題について説明しています。
プロファイル
プロファイルは、テスト タイトル用と運用環境用など、保存された値の名前付きセットです。 コマンドは、--profile で指定されたプロファイルを使用します。指定がない場合は XBOX_PROFILE で指定されたプロファイルを使用し、それもない場合は default を使用します。
XBOX_PROFILE を設定します。
- プロファイルに最初の値を保存すると、そのプロファイルが作成されます。名前には英字、数字、ハイフンを 64 文字まで使用でき、大文字と小文字は区別されません。
-
名前のスペルを間違えた場合など、存在しないプロファイルを指定すると、
defaultにフォールバックせずに 失敗します。 -
プロファイルが
defaultの値を借用することはありません。 -
XBOX_変数は、プロファイルよりも引き続き優先されます。--profileで指定されたプロファイルよりも変数が優先された場合、 コマンドは何も変更しない場合でもその旨を表示します。 - CLI はコマンド間でプロファイルを記憶しないため、プロファイルを選択しても、別のターミナルやエージェントが 使用するプロファイルが変わることはありません。
値の保存場所
保存された値は、CLI の状態ディレクトリ内のcontext.json にあります。
各値はその値を保存したアカウントに属するため、別のアカウントがその値を使用することはありません。
auth logout を実行しても保存された値は保持され、同じアカウントで再度サインインすると値が復元されます。
引数とオプション
動作
get は、サインインしている account、profile、および key と value から成る values 配列を返します。
保存されていないキーの値は null になります。get が表示するのは保存されている値であり、コマンドが使用する値ではありません。
コマンドが使用する値を確認するには、そのコマンドを --verbose 付きで実行します。サインアウトしている場合、get は値を表示せず、
サインインの方法を表示します。
set、unset、および profile コマンドには、サインインしているアカウントが必要です。set はサービスで
値をチェックしないため、使用できない販売者を保存した場合は、その販売者を送信する最初のコマンドで失敗します。
サービス プリンシパルには保存されたコンテキストがありません。サービス プリンシパル モードでは、サインインするコマンドは
--profile と XBOX_PROFILE を拒否し、key list を除くすべての context コマンドが失敗します。
代わりに、各値をそのオプションまたは XBOX_ 変数で渡してください。
自動化 (サービス プリンシパル) 認証を参照してください。
コマンド ライン以外から取得される値
保存されたコンテキストは、OS ユーザーが実行するすべてのターミナルとエージェントで共有されます。また、環境変数は コマンド ラインに表示されません。そのため、設定した各値の名前を表示することに加えて、次のように動作します。-
対象がコンテキストの値そのものである操作では、その値をコマンド ラインで指定する必要があります。
/Admin/DeleteTitleはタイトルを削除し、playfab api-policy set --overwriteはタイトルの API アクセス ポリシー全体を置き換えます。そのため、これらの操作は保存されたコンテキストまたは変数からのタイトルを拒否し、 代わりに実行するコマンドを表示します。リクエスト本文にはシークレットが含まれる可能性があるため、表示されるコマンドには、インラインの--bodyや--statementsの値は 含まれません。<body>または<statements>の部分を元の値に置き換えてください。 - 保存された値を使用するコマンドの実行中に、たとえば確認を待っている間に別のアカウントがサインインした場合、 コマンドは何かを送信する前に停止します。コマンドをもう一度実行してください。
テーブル出力
すべての context コマンドで--output table を使用できます。
