Skip to content

Latest commit

 

History

History
258 lines (202 loc) · 7.8 KB

Request-PfMultiplayerServer.md

File metadata and controls

258 lines (202 loc) · 7.8 KB
Raw
external help file Module Name online version schema
PlayFabMultiplayerApi
2.0.0

Request-PfMultiplayerServer

SYNOPSIS

Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client to request a server with player entity token.

SYNTAX

RequestExpanded (Default)

Request-PfMultiplayerServer -PreferredRegions <String[]> -SessionId <String>
 [-BuildAliasParams <IBuildAliasParams>] [-BuildId <String>] [-CustomTags <IAny>] [-InitialPlayers <String[]>]
 [-SessionCookie <String>] [-Confirm] [-WhatIf] [<CommonParameters>]

Request

Request-PfMultiplayerServer -RequestMultiplayerServerRequest <IRequestMultiplayerServerRequest> [-Confirm]
 [-WhatIf] [<CommonParameters>]

DESCRIPTION

Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client to request a server with player entity token.

EXAMPLES

Example 1: Request a multiplayer server

PS C:\> Request-PfMultiplayerServer -PreferredRegions @('AustraliaEast', 'WestEurope') -SessionId 0352cf0f-2e7a-4aee-801d-7f27f8344c77 -BuildId 9968f71f-f3ec-49df-82d7-d00b12c92e12 | ConvertTo-Json -depth 5

{
  "Code": 200,
  "Data": {
    "ConnectedPlayers": [],
    "Fqdn": "dnsefebd26e-bd3e-4e77-9460-b95ced4023aa-azurebatch-cloudservice.australiaeast.cloudapp.azure.com",
    "Ipv4Address": "20.193.28.131",
    "LastStateTransitionTime": "2021-02-16T21:15:42.935Z",
    "Ports": [
      {
        "Name": "udp",
        "Num": 30000.0,
        "Protocol": "UDP"
      }
    ],
    "Region": "AustraliaEast",
    "ServerId": "99d2022ae82600fab857fd356917697ca116054e185cd2c5f05d31397529e333",
    "SessionId": "0352cf0f-2e7a-4aee-801d-7f27f8344c77",
    "State": "Active",
    "VMId": "xcloudeau4u4yyxj4xymu:AustraliaEast:1E03_909ab8a8-7597-4518-b38b-e431c004fcef:tvmps_64b21aec66cb890adfb4bacd1ccfe5a2d79abd2378e31896ffab49c9eb88cd72_d"
  },
  "Status": "OK"
}

PARAMETERS

-BuildAliasParams

The identifiers of the build alias to use for the request. To construct, see NOTES section for BUILDALIASPARAMS properties and create a hash table.

Type: PlayFab.Multiplayer.Models.IBuildAliasParams
Parameter Sets: RequestExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BuildId

The guid string build ID of the multiplayer server to request.

Type: System.String
Parameter Sets: RequestExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CustomTags

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Type: PlayFab.Multiplayer.Models.IAny
Parameter Sets: RequestExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InitialPlayers

Initial list of players (potentially matchmade) allowed to connect to the game. This list is passed to the game server when requested (via GSDK) and can be used to validate players connecting to it.

Type: System.String[]
Parameter Sets: RequestExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PreferredRegions

The preferred regions to request a multiplayer server from. The Multiplayer Service will iterate through the regions in the specified order and allocate a server from the first one that has servers available.

Type: System.String[]
Parameter Sets: RequestExpanded
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RequestMultiplayerServerRequest

Requests a multiplayer server session from a particular build in any of the given preferred regions. To construct, see NOTES section for REQUESTMULTIPLAYERSERVERREQUEST properties and create a hash table.

Type: PlayFab.Multiplayer.Models.IRequestMultiplayerServerRequest
Parameter Sets: Request
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SessionCookie

Data encoded as a string that is passed to the game server when requested. This can be used to to communicate information such as game mode or map through the request flow.

Type: System.String
Parameter Sets: RequestExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SessionId

A guid string session ID created track the multiplayer server session over its life.

Type: System.String
Parameter Sets: RequestExpanded
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

PlayFab.Multiplayer.Models.IRequestMultiplayerServerRequest

OUTPUTS

PlayFab.Multiplayer.Models.IComponentsGlu3TjResponsesRequestmultiplayerserverresponseContentApplicationJsonSchema

NOTES

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BUILDALIASPARAMS : The identifiers of the build alias to use for the request.

  • AliasId <String>: The guid string alias ID to use for the request.

REQUESTMULTIPLAYERSERVERREQUEST : Requests a multiplayer server session from a particular build in any of the given preferred regions.

  • PreferredRegions <String[]>: The preferred regions to request a multiplayer server from. The Multiplayer Service will iterate through the regions in the specified order and allocate a server from the first one that has servers available.
  • SessionId <String>: A guid string session ID created track the multiplayer server session over its life.
  • [BuildAliasParams <IBuildAliasParams>]: The identifiers of the build alias to use for the request.
    • AliasId <String>: The guid string alias ID to use for the request.
  • [BuildId <String>]: The guid string build ID of the multiplayer server to request.
  • [CustomTags <IAny>]: The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
  • [InitialPlayers <String[]>]: Initial list of players (potentially matchmade) allowed to connect to the game. This list is passed to the game server when requested (via GSDK) and can be used to validate players connecting to it.
  • [SessionCookie <String>]: Data encoded as a string that is passed to the game server when requested. This can be used to to communicate information such as game mode or map through the request flow.

RELATED LINKS