跳轉到主要內容
POST
Delete Remote User

授權

X-EntityToken
string
header
必填

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

主體

application/json

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.

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.

BuildId
string
必填

The guid string build ID of the multiplayer server where the remote user is to delete.

Region
enum<string>
必填

The region of the multiplayer server where the remote user is to delete.

可用選項:
AustraliaEast,
AustraliaSoutheast,
BrazilSouth,
CentralUs,
EastAsia,
EastUs,
EastUs2,
JapanEast,
JapanWest,
NorthCentralUs,
NorthEurope,
SouthCentralUs,
SoutheastAsia,
WestEurope,
WestUs,
SouthAfricaNorth,
WestCentralUs,
KoreaCentral,
FranceCentral,
WestUs2,
CentralIndia,
UaeNorth,
UkSouth,
SwedenCentral,
CanadaCentral,
MexicoCentral,
WestUs3,
CanadaEast,
UkWest,
FranceSouth,
SouthIndia,
SpainCentral,
GermanyWestCentral,
ItalyNorth,
IndonesiaCentral,
ChileCentral,
PolandCentral,
NewZealandNorth,
BrazilSoutheast,
NorwayEast,
SwitzerlandNorth,
MalaysiaWest,
IsraelCentral,
QatarCentral,
UaeCentral,
GermanyNorth,
AustriaEast,
BelgiumCentral,
DenmarkEast,
SwitzerlandWest,
SwedenSouth,
NorwayWest,
SouthAfricaWest,
MalaysiaSouth
Username
string
必填

The username of the remote user to delete.

VmId
string
必填

The virtual machine ID the multiplayer server is located on.

CustomTags
object

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

回應

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
最後修改於 2026年10月6日