PowerShell/API を使用したビルドのデプロイ

この記事では、Windows 10 開発デバイスの PowerShell で Windows OS を使用する VM のビルドをデプロイ/作成する方法の概要を説明します。 PowerShell/API を使用してビルドをデプロイする際、Game Manager と API を組み合わせて使用する可能性があります。そのため、PowerShell/API コマンドは以下に機能別に一覧表示しています。初めてビルドをデプロイする場合は、実際にサーバーをデプロイするのに必要なすべてのアセットが含まれている Wrapper サンプルを使用してビルドをデプロイすることをお勧めします。

PlayFab Multiplayer Servers を使用および表示するには、機能を有効にする必要があります。新規ユーザーの場合、Game Manager 方式を使用してこの機能を有効にすることをお勧めします。手順については、PlayFab Server 機能を有効化するを参照してください。

タイトル ID と開発者シークレットキーの取得

PlayFab タイトル ID の取得
- PlayFab.com の開発者アカウントにログインします
- Game Manager で My Studios and Titles ページに移動します。ゲームタイトルを探し、PlayFab ゲームタイトル ID を取得します
タイトルの開発者シークレットキーの取得
- Game Manager で、タイトル > 設定 (歯車アイコン) を選択します
- Title settings を選択し、次に Secret Keys タブを選択して開発者シークレットキーを取得します

シークレットキーの詳細については、シークレットキー管理を参照してください。

PlayFab MultiplayerAPI PowerShell モジュールのインストール

Windows PowerShell を管理者として開きます
以前に PlayFab Multiplayer PowerShell モジュールをインストールしていた場合は、次のコマンドでアンインストールします。このモジュールは廃止されました。

Uninstall-Package PlayFabMultiplayer

新しいモジュールへの移行を支援するために、新しい同等のコマンドを見つけるにはコマンドのマッピングを参照してください。コマンドと引数の両方が変更されている可能性があることに注意してください。

新しい PlayFabMultiplayer API モジュールをインストールします

各コマンドの詳細なドキュメントについては、Cmdlet ドキュメントを参照してください。

Install-Module -Name PlayFabMultiplayerApi

モジュールをインストールする前に、まず PowerShell で Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser を実行して実行ポリシーを設定する必要がある場合があります。詳細については、PowerShell 実行ポリシーを参照してください。

次のコマンドを実行して、PlayFab Multiplayer PowerShell モジュール内の cmdlets について詳しく確認してください。または、PlayFabMultiplayerApi cmdlet リファレンスドキュメントを参照できます。

Get-Command -Module PlayFabMultiplayerApi | Get-Help

タイトルの EntityToken の取得

タイトル ID と関連する開発者キーを使用して、以下のコマンドを実行してください。PlayFabMultiplayerApi PowerShell モジュールを使用するセッションの開始時に必ずこのコマンドを実行する必要があります。これは GetEntityToken API を呼び出して EntityToken を取得し、将来の cmdlets で使用するために環境変数に保存します。

Set-PfTitle -TitleID "mytitleID" -SecretKey "mysecretkey"

タイトルの multiplayer servers 機能の有効化

Multiplayer Servers 機能を有効にするために、以下の cmdlet を実行します。これは enable multiplayer servers API を呼び出します。

Enable-PfMultiplayerServer

Title must have a valid payment instrument associated with it in order to enable Multiplayer Servers というエラーが表示された場合は、Game Manager を使用して支払い情報を追加するために PlayFab Multiplayer Servers を有効化するを参照してください。

アセットのアップロード

Windows サーバー用のビルドをデプロイする際、アセットのアップロードは必須です。これは、アセットがマネージド Windows コンテナーイメージをカスタマイズするためです。ただし、Linux サーバー用のビルドをデプロイする際は、Linux コンテナーイメージをカスタマイズできるため、オプションです。詳細については、Linux ビルドの作成とデプロイを参照してください。アセットをアップロードするには、次のコマンドを実行します。

New-PfAsset -FilePath C:\MyAsset.zip -AssetName MyAsset.zip

パラメーター:

Filepath: アップロードするローカルファイルへのパス
AssetName: アップロードするアセットの名前

詳細については、New-PfAsset リファレンスドキュメントを参照してください。

ビルドの作成

Windows サーバー用のビルドを作成する場合、アセットをアップロードしている必要があります。まだの場合は、アセットのアップロードを参照してください。
Linux サーバー用のビルドを作成する場合、PlayFab コンテナーレジストリにカスタム Linux コンテナーイメージをアップロードしている必要があります。詳細については、Linux ビルドの作成とデプロイを参照してください。

無料評価用に提供されるリソースを活用する予定がある場合、 $vmSize__ と __$ regions に正しい値を使用するようにしてください。

Windows ゲームサーバー用のビルドをデプロイするためのサンプルコードを以下に示します。

$vmSize = "Standard_D2as_v4"
$regions = @( @{ StandbyServers = 1; MaxServers = 1; Region = 'EastUS'; ScheduledStandbySettings = $NULL } )
$ports = @( @{ Name = 'tcp_port'; Num = 8080; Protocol = 'TCP' }, @{ Name = 'udp_port'; Num = 8081; Protocol = 'UDP' } )
$gameAssets = @( @{ FileName = 'MyAsset.zip'; MountPath = 'C:\Assets' } )

$buildResponse = New-PfBuild -BuildName ExampleBuild -ContainerFlavor ManagedWindowsServerCore -StartMultiplayerServerCommand 'C:\Assets\MyCustomServer.exe' -GameAssetReferences $gameAssets -VMSize $vmSize -MultiplayerServerCountPerVM 1 -Ports $ports -RegionConfigurations $regions

# All PlayFabMultiplayerApi cmdlets return objects, so we can pass the returned object to ConvertTo-Json for human readability.
$buildResponse | ConvertTo-Json -depth 5

Linux ゲームサーバー用のビルドをデプロイするためのサンプルコードを以下に示します。

$vmSize = "Standard_D2as_v4"
$ports = @( @{ Name = 'tcp_port'; Num = 8080; Protocol = 'TCP' }, @{ Name = 'udp_port'; Num = 8081; Protocol = 'UDP' } )
$regions = @( @{ 'MaxServers' = 1; 'Region' = 'AustraliaEast'; StandbyServers = 1; 'ScheduledStandbySettings' = $NULL } )
$containerImageReference = @{ ImageName = "MyLinuxContainerImage"; Tag = "0.2" }

$buildResponse = New-PfBuild -BuildName ExampleBuild -ContainerFlavor CustomLinux -ContainerImageReference $containerImageReference -VMSize $vmSize -MultiplayerServerCountPerVM 1 -Ports $ports -RegionConfigurations $regions

# All PlayFabMultiplayerApi cmdlets return objects, so we can pass the returned object to ConvertTo-Json for human readability.
$buildResponse | ConvertTo-Json -depth 5

開発中は、VM コア時間の使用を避けるために、未使用または不健全なリージョンをすべてシャットオフしてください。コア時間の使用は VM の起動時から始まり、VM がシャットオフされるまで続きます。リージョンのターゲットスタンバイサーバーが 0 になるか、リージョンが削除されない限り、リージョン内の VM は自動的にシャットオフされません。

VM のシャットダウン

VM をシャットダウンするには 3 つの方法があります。

リージョンの target standby を 0 に設定します。これによりこのリージョンの VM のみがシャットダウンされます。
ビルドから特定のリージョンを削除します。
ビルド全体を削除します。これにより、このビルドの すべてのリージョン の VM がシャットダウンされます。

デプロイ済みビルドの一覧表示

タイトルのビルドリストを表示するには、以下のコマンドを実行します。

Get-PfBuild | ConvertTo-Json -depth 5

マルチプレイヤーサーバーのリクエスト

ビルドを作成すると、.exe ファイルを実行した後に 1 つまたは複数のサーバーが作成されます。これらのサーバーは今 “standing by” 状態です。このコマンドを使用してビルドを実行しているすべてのサーバーをリストすると、それらを見ることができます。

Get-PFMultiplayerServer -BuildId $buildResponse.data.BuildId -Region "EastUS"

スタンバイサーバーがいくつか見えたら、ゲームプレイ用に 1 つリクエストしてみましょう…

$sessionId = New-Guid
$serverResponse = Request-PfMultiplayerServer -BuildId $buildResponse.data.BuildId -PreferredRegions @('EastUS') -SessionId $sessionId

その呼び出しへのレスポンスには、クライアントが接続できる IPv4 アドレスとポート番号が含まれます。WindowsRunnerCSharp.exe の場合、シンプルな Web サーバーをホストしているため、IPv4 アドレスとポート番号にブラウズしてレスポンスを取得できます。

curl "http://$($serverResponse.data.Ipv4Address):$($serverResponse.data.Ports[0].Num)"

これが PlayFab マルチプレイヤーサーバーの中核です。マッチメイキングサービスが RequestMultiplayerServer を呼び出してから 3 秒以内に、PlayFab は新しいサーバーを割り当てます。これらのサーバーは、リージョンごと、ビルドごとに構成する、継続的に補充されるスタンバイサーバープールから提供されます。

コマンドのマッピング

以下の表は、旧コマンドと新しい同等のコマンドを示しています。これは、PowerShell モジュールの以前のバージョンを使用していて、既存のコマンドを変換する必要がある人向けの簡単なマッピングです。一部の引数も変更されているため、変更の完全な詳細を確認するために各コマンドの定義を読むようにしてください。

MultiplayerPowershell コマンド (旧)	MpsPowershell API モジュール (新)
Add-PFMultiplayerAsset	New-PfAsset
Add-PFMultiplayerCertificate	Invoke-PfUploadCertificate
Enable-PFMultiplayerServer	Enable-PfMultiplayerServer
Get-PFMultiplayerAsset	Get-PfAssetSummary
Get-PFMultiplayerBuild	Get-PfBuild
Get-PFMultiplayerCertificate	Get-PfCertificateSummary
Get-PFMultiplayerContainerImages	Get-PfContainerImage
Get-PFMultiplayerImageTags	Get-PfContainerImageTag
Get-PFMultiplayerQosServer	Get-PfQosServer
Get-PFMultiplayerServer	Get-PfMultiplayerServer
Get-PFTitleEntityToken	deprecated
New-PFMultiplayerBuild	New-PfBuild
New-PFMultiplayerServer	Request-PfMultiplayerServer
Remove-PFMultiplayerAsset	Remove-PfAsset
Remove-PFMultiplayerBuild	Remove-PfBuild
Remove-PFMultiplayerCertificate	Remove-PfCertificate
Remove-PFMultiplayerContainerImageTag	Invoke-PfImageUntagContainer
Set-PFTitle	Set-PfTitle

XBOX Services

PlayFab

タイトル ID と開発者シークレットキーの取得

PlayFab MultiplayerAPI PowerShell モジュールのインストール

タイトルの EntityToken の取得

タイトルの multiplayer servers 機能の有効化

アセットのアップロード

ビルドの作成

VM のシャットダウン

デプロイ済みビルドの一覧表示

マルチプレイヤーサーバーのリクエスト

コマンドのマッピング

関連項目

​タイトル ID と開発者シークレット キーの取得

​PlayFab MultiplayerAPI PowerShell モジュールのインストール

​タイトルの EntityToken の取得

​タイトルの multiplayer servers 機能の有効化

​アセットのアップロード

​ビルドの作成

​VM のシャットダウン

​デプロイ済みビルドの一覧表示

​マルチプレイヤー サーバーのリクエスト

​コマンドのマッピング

​関連項目

タイトル ID と開発者シークレットキーの取得

PlayFab MultiplayerAPI PowerShell モジュールのインストール

タイトルの EntityToken の取得

タイトルの multiplayer servers 機能の有効化

アセットのアップロード

ビルドの作成

VM のシャットダウン

デプロイ済みビルドの一覧表示

マルチプレイヤーサーバーのリクエスト

コマンドのマッピング

関連項目