PHP Class Scalr\Service\Azure\Services\Compute\Api\VirtualMachines

Since: 5.8.6
Author: Vlad Dobrovolskiy ([email protected])
Inheritance: extends Scalr\Service\Azure\Services\AbstractApi
Show file Open project: scalr/scalr

Public Methods

Method Description
create ( string $subscriptionId, string $resourceGroup, array | Scalr\Service\Azure\Services\Compute\DataType\CreateVirtualMachine | Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineData $requestData, boolean $validating = false ) : Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineData Create or update a virtual machine in a given subscription.
deallocate ( string $subscriptionId, string $resourceGroup, string $name ) : boolean Stop and deallocate a virtual machine.
delete ( string $subscriptionId, string $resourceGroup, string $name ) : boolean Deletes a virtual machine.
generalize ( string $subscriptionId, string $resourceGroup, string $name ) : boolean This API is used to mark a Virtual Machine as generalized in Azure.
getInstanceViewInfo ( string $subscriptionId, string $resourceGroup, string $name ) : Scalr\Service\Azure\Services\Compute\DataType\VirtualInstanceViewData Get information about the instance view of a virtual machine.
getList ( string $subscriptionId, string $resourceGroup ) : Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineList Lists all of the virtual machine in the specified resource group.
getModelViewInfo ( string $subscriptionId, string $resourceGroup, string $name, boolean $expandInstanceView = true ) : Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineData Get information about the model view of a virtual machine.
poweroff ( string $subscriptionId, string $resourceGroup, string $name ) : boolean Stop a virtual machine.
restart ( string $subscriptionId, string $resourceGroup, string $name ) : boolean Restart a virtual machine.
saveImage ( string $subscriptionId, string $resourceGroup, string $name, array | Scalr\Service\Azure\Services\Compute\DataType\SaveImage $requestData ) : string Save an image that is associated with a generalized virtual machine.
start ( string $subscriptionId, string $resourceGroup, string $name ) : boolean Start a virtual machine.

Method Details

create() public method

In the update scenario, these APIs will be specifically used for detaching a data disk from a VM.
public create ( string $subscriptionId, string $resourceGroup, array | Scalr\Service\Azure\Services\Compute\DataType\CreateVirtualMachine | Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineData $requestData, boolean $validating = false ) : Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineData
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$requestData array | Scalr\Service\Azure\Services\Compute\DataType\CreateVirtualMachine | Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineData Request data
$validating boolean optional Validating
return Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineData

deallocate() public method

Stop and deallocate a virtual machine.
public deallocate ( string $subscriptionId, string $resourceGroup, string $name ) : boolean
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$name string Name of the Virtual Machine
return boolean True if operation finished successful, otherwise False

delete() public method

Deletes a virtual machine.
public delete ( string $subscriptionId, string $resourceGroup, string $name ) : boolean
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$name string Name of the Virtual Machine
return boolean True if VM is deleted successful, otherwise False

generalize() public method

This API is used to mark a Virtual Machine as generalized in Azure.
public generalize ( string $subscriptionId, string $resourceGroup, string $name ) : boolean
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$name string Name of the Virtual Machine
return boolean True if VM is generalized successful, otherwise False

getInstanceViewInfo() public method

Get information about the instance view of a virtual machine.
public getInstanceViewInfo ( string $subscriptionId, string $resourceGroup, string $name ) : Scalr\Service\Azure\Services\Compute\DataType\VirtualInstanceViewData
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$name string Name of the needle Virtual Machine
return Scalr\Service\Azure\Services\Compute\DataType\VirtualInstanceViewData Object with Virtual Machine instance-view info

getList() public method

Lists all of the virtual machine in the specified resource group.
public getList ( string $subscriptionId, string $resourceGroup ) : Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineList
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
return Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineList Object with list of Virtual Machines

getModelViewInfo() public method

Get information about the model view of a virtual machine.
public getModelViewInfo ( string $subscriptionId, string $resourceGroup, string $name, boolean $expandInstanceView = true ) : Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineData
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$name string Name of the needle Virtual Machine
$expandInstanceView boolean If true - adds instance view info to response
return Scalr\Service\Azure\Services\Compute\DataType\VirtualMachineData Object with Virtual Machine model-view info

poweroff() public method

Stop a virtual machine.
public poweroff ( string $subscriptionId, string $resourceGroup, string $name ) : boolean
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$name string Name of the Virtual Machine
return boolean True if VM is stopped successful, otherwise False

restart() public method

Restart a virtual machine.
public restart ( string $subscriptionId, string $resourceGroup, string $name ) : boolean
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$name string Name of the Virtual Machine
return boolean True if VM is restarted successful, otherwise False

saveImage() public method

Save an image that is associated with a generalized virtual machine.
public saveImage ( string $subscriptionId, string $resourceGroup, string $name, array | Scalr\Service\Azure\Services\Compute\DataType\SaveImage $requestData ) : string
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$name string Name of the Virtual Machine
$requestData array | Scalr\Service\Azure\Services\Compute\DataType\SaveImage Request data
return string Returns image uri

start() public method

Start a virtual machine.
public start ( string $subscriptionId, string $resourceGroup, string $name ) : boolean
$subscriptionId string Subscription Id
$resourceGroup string Name of Resource Group
$name string Name of the Virtual Machine
return boolean True if VM is started successful, otherwise False