Before running any other command you need to run Set-PfTitle. This uses your TitleId and your title's SecretKey to get an EntityToken that will be used to authenticate all future requests (the EntityToken is automatically set to an environment variable that is read by all cmdlets).
All the commands return an object containing the response body, which doesn't get printed to the console by default. This means that in order to use the response, you have to either
- Store the response in a variable:
$resp = Get-PfBuild - Print the response to the console as json:
Get-PfBuild | ConvertTo-Json -depth 5
Most commands allow you to specify the request body as either a json string or a Powershell object instead of using the standard parameters that Autorest has generated. Here is an example:
# All 3 of these examples do the same thing.
# This uses the Autorest generated parameter 'BuildId':
PS > Get-PfBuild -BuildId 9968f71f-f3ec-49df-82d7-d00b12c92e12
# You can also craft your own request body as json (the cmdlet will still validate your json against the request schema):
PS > Get-PfBuild -GetBuildRequest '{ "BuildId": "9968f71f-f3ec-49df-82d7-d00b12c92e12" }'
# Or instead of json you can use Powershell objects:
PS> Get-PfBuild -GetBuildRequest @{ BuildId = "9968f71f-f3ec-49df-82d7-d00b12c92e12" }Whenever a command receives a non-2xx response, the request and response are both printed to stderr. If you want the request and response printed to stderr even on a success, set the PF_DEBUG environment variable to "true", like this:
PS> $env:PF_DEBUG = 'true'Make sure to uninstall MultiplayerPowershell before installing MpsPowershell, because some of the cmdlet names overlap:
PS> Uninstall-Package MultiplayerApiHere are the commands found in MultiplayerPowershell and their equivalent commands in MpsPowershell:
| MultiplayerPowershell command (old) | MpsPowershell command (new) |
|---|---|
| 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 |