PHP Class ScalrAPI_2_3_0

Inheritance: extends ScalrAPI_2_2_0

Public Methods

Method	Description
DmApplicationCreate ( $Name, $SourceID, $PreDeployScript = null, $PostDeployScript = null )
DmApplicationDeploy ( $ApplicationID, $FarmRoleID, $RemotePath )
DmApplicationsList ( )
DmDeploymentTaskGetLog ( $DeploymentTaskID, $StartFrom, $RecordsLimit = 20 )
DmDeploymentTaskGetStatus ( $DeploymentTaskID )
DmDeploymentTasksList ( $FarmRoleID = null, $ApplicationID = null, $ServerID = null )
DmSourceCreate ( $Type, $URL, $AuthLogin = null, $AuthPassword = null )
DmSourcesList ( )
EnvironmentsList ( )
FarmAddRole ( $Alias, $FarmID, $RoleID, $Platform, $CloudLocation, array $Configuration = [] )
FarmClone ( $FarmID )
FarmCreate ( $Name, $Description = "", $ProjectID = "", array $Configuration = [] )
FarmGetDetails ( $FarmID )
FarmGetDnsEndpoints ( $FarmID )
FarmRemove ( $FarmID )
FarmRemoveRole ( $FarmID, $FarmRoleID )
FarmRoleParametersList ( $FarmRoleID )
FarmRoleUpdateParameterValue ( $FarmRoleID, $ParamName, $ParamValue )
FarmUpdateRole ( $FarmRoleID, $Alias = null, array $Configuration = [] )
FireCustomEvent ( $ServerID, $EventName, array $Params = [] )
GlobalVariableSet ( $ParamName, $ParamValue, $FarmRoleID, $FarmID, $ServerID = '', $RoleID )
GlobalVariablesList ( $ServerID = null, $FarmID = null, $FarmRoleID = null, $RoleID = null )
ScriptingLogsList ( $FarmID, $ServerID = null, $EventID = null, $StartFrom, $RecordsLimit = 20 )
ServerGetExtendedInformation ( $ServerID )

Private Methods

Method	Description
validateFarmRoleConfiguration ( array &$config ) : boolean	Validates configuration.

Method Details

DmApplicationCreate() public method

public DmApplicationCreate ( $Name, $SourceID, $PreDeployScript = null, $PostDeployScript = null )

DmApplicationDeploy() public method

public DmApplicationDeploy ( $ApplicationID, $FarmRoleID, $RemotePath )

DmApplicationsList() public method

public DmApplicationsList ( )

DmDeploymentTaskGetLog() public method

public DmDeploymentTaskGetLog ( $DeploymentTaskID, $StartFrom, $RecordsLimit = 20 )

DmDeploymentTaskGetStatus() public method

public DmDeploymentTaskGetStatus ( $DeploymentTaskID )

DmDeploymentTasksList() public method

public DmDeploymentTasksList ( $FarmRoleID = null, $ApplicationID = null, $ServerID = null )

DmSourceCreate() public method

public DmSourceCreate ( $Type, $URL, $AuthLogin = null, $AuthPassword = null )

DmSourcesList() public method

public DmSourcesList ( )

EnvironmentsList() public method

public EnvironmentsList ( )

FarmAddRole() public method

public FarmAddRole ( $Alias, $FarmID, $RoleID, $Platform, $CloudLocation, array $Configuration = [] )
$Configuration	array

FarmClone() public method

public FarmClone ( $FarmID )

FarmCreate() public method

public FarmCreate ( $Name, $Description = "", $ProjectID = "", array $Configuration = [] )
$Configuration	array

FarmGetDetails() public method

public FarmGetDetails ( $FarmID )

FarmGetDnsEndpoints() public method

public FarmGetDnsEndpoints ( $FarmID )

FarmRemove() public method

public FarmRemove ( $FarmID )

FarmRemoveRole() public method

public FarmRemoveRole ( $FarmID, $FarmRoleID )

FarmRoleParametersList() public method

public FarmRoleParametersList ( $FarmRoleID )

FarmRoleUpdateParameterValue() public method

public FarmRoleUpdateParameterValue ( $FarmRoleID, $ParamName, $ParamValue )

FarmUpdateRole() public method

public FarmUpdateRole ( $FarmRoleID, $Alias = null, array $Configuration = [] )
$Configuration	array

FireCustomEvent() public method

public FireCustomEvent ( $ServerID, $EventName, array $Params = [] )
$Params	array

GlobalVariableSet() public method

public GlobalVariableSet ( $ParamName, $ParamValue, $FarmRoleID, $FarmID, $ServerID = '', $RoleID )

GlobalVariablesList() public method

public GlobalVariablesList ( $ServerID = null, $FarmID = null, $FarmRoleID = null, $RoleID = null )

ScriptingLogsList() public method

public ScriptingLogsList ( $FarmID, $ServerID = null, $EventID = null, $StartFrom, $RecordsLimit = 20 )

ServerGetExtendedInformation() public method

public ServerGetExtendedInformation ( $ServerID )