PlayFab.MultiplayerModels Namespace Reference

Classes
class	AssetReference
class	AssetReferenceParams
class	AssetSummary
class	BuildAliasDetailsResponse
class	BuildAliasParams
class	BuildRegion
class	BuildRegionParams
class	BuildSelectionCriterion
class	BuildSummary
class	CancelAllMatchmakingTicketsForPlayerRequest
	Cancels all tickets of which the player is a member in a given queue that are not cancelled or matched. This API is useful if you lose track of what tickets the player is a member of (if the title crashes for instance) and want to "reset". The Entity field is optional if the caller is a player and defaults to that player. Players may not cancel tickets for other people. The Entity field is required if the caller is a server (authenticated as the title). More...
class	CancelAllMatchmakingTicketsForPlayerResult
class	CancelAllServerBackfillTicketsForPlayerRequest
	Cancels all backfill tickets of which the player is a member in a given queue that are not cancelled or matched. This API is useful if you lose track of what tickets the player is a member of (if the server crashes for instance) and want to "reset". More...
class	CancelAllServerBackfillTicketsForPlayerResult
class	CancelMatchmakingTicketRequest
	Only servers and ticket members can cancel a ticket. The ticket can be in five different states when it is cancelled. 1: the ticket is waiting for members to join it, and it has not started matching. If the ticket is cancelled at this stage, it will never match. 2: the ticket is matching. If the ticket is cancelled, it will stop matching. 3: the ticket is matched. A matched ticket cannot be cancelled. 4: the ticket is already cancelled and nothing happens. 5: the ticket is waiting for a server. If the ticket is cancelled, server allocation will be stopped. A server may still be allocated due to a race condition, but that will not be reflected in the ticket. There may be race conditions between the ticket getting matched and the client making a cancellation request. The client must handle the possibility that the cancel request fails if a match is found before the cancellation request is processed. We do not allow resubmitting a cancelled ticket because players must consent to enter matchmaking again. Create a new ticket instead. More...
class	CancelMatchmakingTicketResult
class	CancelServerBackfillTicketRequest
	Only servers can cancel a backfill ticket. The ticket can be in three different states when it is cancelled. 1: the ticket is matching. If the ticket is cancelled, it will stop matching. 2: the ticket is matched. A matched ticket cannot be cancelled. 3: the ticket is already cancelled and nothing happens. There may be race conditions between the ticket getting matched and the server making a cancellation request. The server must handle the possibility that the cancel request fails if a match is found before the cancellation request is processed. We do not allow resubmitting a cancelled ticket. Create a new ticket instead. More...
class	CancelServerBackfillTicketResult
class	Certificate
class	CertificateSummary
class	ConnectedPlayer
class	ContainerImageReference
class	CoreCapacity
class	CoreCapacityChange
class	CreateBuildAliasRequest
	Creates a multiplayer server build alias and returns the created alias. More...
class	CreateBuildWithCustomContainerRequest
	Creates a multiplayer server build with a custom container and returns information about the build creation request. More...
class	CreateBuildWithCustomContainerResponse
class	CreateBuildWithManagedContainerRequest
	Creates a multiplayer server build with a managed container and returns information about the build creation request. More...
class	CreateBuildWithManagedContainerResponse
class	CreateBuildWithProcessBasedServerRequest
	Creates a multiplayer server build with the game server running as a process and returns information about the build creation request. More...
class	CreateBuildWithProcessBasedServerResponse
class	CreateMatchmakingTicketRequest
	The client specifies the creator's attributes and optionally a list of other users to match with. More...
class	CreateMatchmakingTicketResult
class	CreateRemoteUserRequest
	Creates a remote user to log on to a VM for a multiplayer server build in a specific region. Returns user credential information necessary to log on. More...
class	CreateRemoteUserResponse
class	CreateServerBackfillTicketRequest
	The server specifies all the members, their teams and their attributes, and the server details if applicable. More...
class	CreateServerBackfillTicketResult
class	CreateServerMatchmakingTicketRequest
	The server specifies all the members and their attributes. More...
class	CreateTitleMultiplayerServersQuotaChangeRequest
	Creates a request to change a title's multiplayer server quotas. More...
class	CreateTitleMultiplayerServersQuotaChangeResponse
class	CurrentServerStats
class	CustomDifferenceRuleExpansion
class	CustomRegionSelectionRuleExpansion
class	CustomSetIntersectionRuleExpansion
class	CustomTeamDifferenceRuleExpansion
class	CustomTeamSizeBalanceRuleExpansion
class	DeleteAssetRequest
	Deletes a multiplayer server game asset for a title. More...
class	DeleteBuildAliasRequest
	Deletes a multiplayer server build alias. More...
class	DeleteBuildRegionRequest
	Removes a multiplayer server build's region. More...
class	DeleteBuildRequest
	Deletes a multiplayer server build. More...
class	DeleteCertificateRequest
	Deletes a multiplayer server game certificate. More...
class	DeleteContainerImageRequest
	Removes the specified container image repository. After this operation, a 'docker pull' will fail for all the tags of the specified image. Morever, ListContainerImages will not return the specified image. More...
class	DeleteRemoteUserRequest
	Deletes a remote user to log on to a VM for a multiplayer server build in a specific region. Returns user credential information necessary to log on. More...
class	DifferenceRule
class	DynamicStandbySettings
class	DynamicStandbyThreshold
class	EmptyResponse
class	EnableMultiplayerServersForTitleRequest
	Enables the multiplayer server feature for a title and returns the enabled status. The enabled status can be Initializing, Enabled, and Disabled. It can up to 20 minutes or more for the title to be enabled for the feature. On average, it can take up to 20 minutes for the title to be enabled for the feature. More...
class	EnableMultiplayerServersForTitleResponse
class	EntityKey
	Combined entity type and ID structure which uniquely identifies a single entity. More...
class	GameCertificateReference
class	GameCertificateReferenceParams
class	GetAssetDownloadUrlRequest
	Gets a URL that can be used to download the specified asset. More...
class	GetAssetDownloadUrlResponse
class	GetAssetUploadUrlRequest
	Gets the URL to upload assets to. More...
class	GetAssetUploadUrlResponse
class	GetBuildAliasRequest
	Returns the details about a multiplayer server build alias. More...
class	GetBuildRequest
	Returns the details about a multiplayer server build. More...
class	GetBuildResponse
class	GetContainerRegistryCredentialsRequest
	Gets credentials to the container registry where game developers can upload custom container images to before creating a new build. More...
class	GetContainerRegistryCredentialsResponse
class	GetMatchmakingQueueRequest
	Gets the current configuration for a queue. More...
class	GetMatchmakingQueueResult
class	GetMatchmakingTicketRequest
	The ticket includes the invited players, their attributes if they have joined, the ticket status, the match Id when applicable, etc. Only servers, the ticket creator and the invited players can get the ticket. More...
class	GetMatchmakingTicketResult
class	GetMatchRequest
	When matchmaking has successfully matched together a collection of tickets, it produces a 'match' with an Id. The match contains all of the players that were matched together, and their team assigments. Only servers and ticket members can get the match. More...
class	GetMatchResult
class	GetMultiplayerServerDetailsRequest
	Gets multiplayer server session details for a build in a specific region. More...
class	GetMultiplayerServerDetailsResponse
class	GetMultiplayerServerLogsRequest
	Gets multiplayer server logs for a specific server id in a region. The logs are available only after a server has terminated. More...
class	GetMultiplayerServerLogsResponse
class	GetMultiplayerSessionLogsBySessionIdRequest
	Gets multiplayer server logs for a specific server id in a region. The logs are available only after a server has terminated. More...
class	GetQueueStatisticsRequest
	Returns the matchmaking statistics for a queue. These include the number of players matching and the statistics related to the time to match statistics in seconds (average and percentiles). Statistics are refreshed once every 5 minutes. Servers can access all statistics no matter what the ClientStatisticsVisibility is configured to. Clients can access statistics according to the ClientStatisticsVisibility. Client requests are forbidden if all visibility fields are false. More...
class	GetQueueStatisticsResult
class	GetRemoteLoginEndpointRequest
	Gets a remote login endpoint to a VM that is hosting a multiplayer server build in a specific region. More...
class	GetRemoteLoginEndpointResponse
class	GetServerBackfillTicketRequest
	The ticket includes the players, their attributes, their teams, the ticket status, the match Id and the server details when applicable, etc. Only servers can get the ticket. More...
class	GetServerBackfillTicketResult
class	GetTitleEnabledForMultiplayerServersStatusRequest
	Gets the status of whether a title is enabled for the multiplayer server feature. The enabled status can be Initializing, Enabled, and Disabled. More...
class	GetTitleEnabledForMultiplayerServersStatusResponse
class	GetTitleMultiplayerServersQuotaChangeRequest
	Gets a title's server quota change request. More...
class	GetTitleMultiplayerServersQuotaChangeResponse
class	GetTitleMultiplayerServersQuotasRequest
	Gets the quotas for a title in relation to multiplayer servers. More...
class	GetTitleMultiplayerServersQuotasResponse
class	InstrumentationConfiguration
class	JoinMatchmakingTicketRequest
	Add the player to a matchmaking ticket and specify all of its matchmaking attributes. Players can join a ticket if and only if their EntityKeys are already listed in the ticket's Members list. The matchmaking service automatically starts matching the ticket against other matchmaking tickets once all players have joined the ticket. It is not possible to join a ticket once it has started matching. More...
class	JoinMatchmakingTicketResult
class	LinearDifferenceRuleExpansion
class	LinearRegionSelectionRuleExpansion
class	LinearSetIntersectionRuleExpansion
class	LinearTeamDifferenceRuleExpansion
class	LinearTeamSizeBalanceRuleExpansion
class	LinuxInstrumentationConfiguration
class	ListAssetSummariesRequest
	Returns a list of multiplayer server game asset summaries for a title. More...
class	ListAssetSummariesResponse
class	ListBuildAliasesRequest
	Returns a list of summarized details of all multiplayer server builds for a title. More...
class	ListBuildAliasesResponse
class	ListBuildSummariesRequest
	Returns a list of summarized details of all multiplayer server builds for a title. More...
class	ListBuildSummariesResponse
class	ListCertificateSummariesRequest
	Returns a list of multiplayer server game certificates for a title. More...
class	ListCertificateSummariesResponse
class	ListContainerImagesRequest
	Returns a list of the container images that have been uploaded to the container registry for a title. More...
class	ListContainerImagesResponse
class	ListContainerImageTagsRequest
	Returns a list of the tags for a particular container image that exists in the container registry for a title. More...
class	ListContainerImageTagsResponse
class	ListMatchmakingQueuesRequest
	Gets a list of all the matchmaking queue configurations for the title. More...
class	ListMatchmakingQueuesResult
class	ListMatchmakingTicketsForPlayerRequest
	If the caller is a title, the EntityKey in the request is required. If the caller is a player, then it is optional. If it is provided it must match the caller's entity. More...
class	ListMatchmakingTicketsForPlayerResult
class	ListMultiplayerServersRequest
	Returns a list of multiplayer servers for a build in a specific region. More...
class	ListMultiplayerServersResponse
class	ListPartyQosServersRequest
	Returns a list of quality of service servers for party. More...
class	ListPartyQosServersResponse
class	ListQosServersForTitleRequest
	Returns a list of quality of service servers for a title. More...
class	ListQosServersForTitleResponse
class	ListServerBackfillTicketsForPlayerRequest
	List all server backfill ticket Ids the user is a member of. More...
class	ListServerBackfillTicketsForPlayerResult
class	ListTitleMultiplayerServersQuotaChangesRequest
	List all server quota change requests for a title. More...
class	ListTitleMultiplayerServersQuotaChangesResponse
class	ListVirtualMachineSummariesRequest
	Returns a list of virtual machines for a title. More...
class	ListVirtualMachineSummariesResponse
class	MatchmakingPlayer
	A user in a matchmaking ticket. More...
class	MatchmakingPlayerAttributes
	The matchmaking attributes for a user. More...
class	MatchmakingPlayerWithTeamAssignment
	A player in a created matchmaking match with a team assignment. More...
class	MatchmakingQueueConfig
class	MatchmakingQueueTeam
class	MatchTotalRule
class	MatchTotalRuleExpansion
class	MultiplayerServerSummary
class	OverrideDouble
class	OverrideUnsignedInt
class	Port
class	QosServer
class	QueueRuleAttribute
class	QuotaChange
class	RegionSelectionRule
class	RemoveMatchmakingQueueRequest
	Deletes the configuration for a queue. This will permanently delete the configuration and players will no longer be able to match in the queue. All outstanding matchmaking tickets will be cancelled. More...
class	RemoveMatchmakingQueueResult
class	RequestMultiplayerServerRequest
	Requests a multiplayer server session from a particular build in any of the given preferred regions. More...
class	RequestMultiplayerServerResponse
class	RolloverContainerRegistryCredentialsRequest
	Gets new credentials to the container registry where game developers can upload custom container images to before creating a new build. More...
class	RolloverContainerRegistryCredentialsResponse
class	Schedule
class	ScheduledStandbySettings
class	ServerDetails
class	SetIntersectionRule
class	SetMatchmakingQueueRequest
	Use this API to create or update matchmaking queue configurations. The queue configuration defines the matchmaking rules. The matchmaking service will match tickets together according to the configured rules. Queue resources are not spun up by calling this API. Queues are created when the first ticket is submitted. More...
class	SetMatchmakingQueueResult
class	ShutdownMultiplayerServerRequest
	Executes the shutdown callback from the GSDK and terminates the multiplayer server session. The callback in the GSDK will allow for graceful shutdown with a 15 minute timeoutIf graceful shutdown has not been completed before 15 minutes have elapsed, the multiplayer server session will be forcefully terminated on it's own. More...
class	Statistics
class	StatisticsVisibilityToPlayers
class	StringEqualityRule
class	StringEqualityRuleExpansion
class	TeamDifferenceRule
class	TeamSizeBalanceRule
class	TeamTicketSizeSimilarityRule
class	TitleMultiplayerServersQuotas
class	UntagContainerImageRequest
	Removes the specified tag from the image. After this operation, a 'docker pull' will fail for the specified image and tag combination. Morever, ListContainerImageTags will not return the specified tag. More...
class	UpdateBuildAliasRequest
	Creates a multiplayer server build alias and returns the created alias. More...
class	UpdateBuildNameRequest
	Updates a multiplayer server build's name. More...
class	UpdateBuildRegionRequest
	Updates a multiplayer server build's region. More...
class	UpdateBuildRegionsRequest
	Updates a multiplayer server build's regions. More...
class	UploadCertificateRequest
	Uploads a multiplayer server game certificate. More...
class	VirtualMachineSummary

Enumerations
enum	AttributeMergeFunction { Min , Max , Average }
enum	AttributeNotSpecifiedBehavior { UseDefault , MatchAny }
enum	AttributeSource { User , PlayerEntity }
enum	AzureRegion {   AustraliaEast , AustraliaSoutheast , BrazilSouth , CentralUs ,   EastAsia , EastUs , EastUs2 , JapanEast ,   JapanWest , NorthCentralUs , NorthEurope , SouthCentralUs ,   SoutheastAsia , WestEurope , WestUs , SouthAfricaNorth ,   WestCentralUs , KoreaCentral , FranceCentral , WestUs2 ,   CentralIndia , UaeNorth , UkSouth }
enum	AzureVmFamily {   A , Av2 , Dv2 , Dv3 ,   F , Fsv2 , Dasv4 , Dav4 ,   Eav4 , Easv4 , Ev4 , Esv4 ,   Dsv3 , Dsv2 , NCasT4_v3 , Ddv4 ,   Ddsv4 , HBv3 }
enum	AzureVmSize {   Standard_A1 , Standard_A2 , Standard_A3 , Standard_A4 ,   Standard_A1_v2 , Standard_A2_v2 , Standard_A4_v2 , Standard_A8_v2 ,   Standard_D1_v2 , Standard_D2_v2 , Standard_D3_v2 , Standard_D4_v2 ,   Standard_D5_v2 , Standard_D2_v3 , Standard_D4_v3 , Standard_D8_v3 ,   Standard_D16_v3 , Standard_F1 , Standard_F2 , Standard_F4 ,   Standard_F8 , Standard_F16 , Standard_F2s_v2 , Standard_F4s_v2 ,   Standard_F8s_v2 , Standard_F16s_v2 , Standard_D2as_v4 , Standard_D4as_v4 ,   Standard_D8as_v4 , Standard_D16as_v4 , Standard_D2a_v4 , Standard_D4a_v4 ,   Standard_D8a_v4 , Standard_D16a_v4 , Standard_E2a_v4 , Standard_E4a_v4 ,   Standard_E8a_v4 , Standard_E16a_v4 , Standard_E2as_v4 , Standard_E4as_v4 ,   Standard_E8as_v4 , Standard_E16as_v4 , Standard_D2s_v3 , Standard_D4s_v3 ,   Standard_D8s_v3 , Standard_D16s_v3 , Standard_DS1_v2 , Standard_DS2_v2 ,   Standard_DS3_v2 , Standard_DS4_v2 , Standard_DS5_v2 , Standard_NC4as_T4_v3 ,   Standard_D2d_v4 , Standard_D4d_v4 , Standard_D8d_v4 , Standard_D16d_v4 ,   Standard_D2ds_v4 , Standard_D4ds_v4 , Standard_D8ds_v4 , Standard_D16ds_v4 ,   Standard_HB120_16rs_v3 , Standard_HB120_32rs_v3 , Standard_HB120_64rs_v3 , Standard_HB120_96rs_v3 ,   Standard_HB120rs_v3 }
enum	CancellationReason { Requested , Internal , Timeout }
enum	ContainerFlavor { ManagedWindowsServerCore , CustomLinux , ManagedWindowsServerCorePreview , Invalid }
enum	OsPlatform { Windows , Linux }
enum	ProtocolType { TCP , UDP }
enum	ServerType { Container , Process }
enum	TitleMultiplayerServerEnabledStatus { Initializing , Enabled , Disabled }