VirtualMachines interface
Interface representing a VirtualMachines.
Methods
Method Details
beginCreateOrUpdate(string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
Create a new virtual machine or update the properties of the existing virtual machine.
function beginCreateOrUpdate(resourceGroupName: string, virtualMachineName: string, virtualMachineParameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
- virtualMachineParameters
- VirtualMachine
The request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>
beginCreateOrUpdateAndWait(string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
Create a new virtual machine or update the properties of the existing virtual machine.
function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualMachineName: string, virtualMachineParameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<VirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
- virtualMachineParameters
- VirtualMachine
The request body.
The options parameters.
Returns
Promise<VirtualMachine>
beginDelete(string, string, VirtualMachinesDeleteOptionalParams)
Delete the provided virtual machine.
function beginDelete(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualMachinesDeleteOptionalParams)
Delete the provided virtual machine.
function beginDeleteAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<void>
beginPowerOff(string, string, VirtualMachinesPowerOffOptionalParams)
Power off the provided virtual machine.
function beginPowerOff(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesPowerOffOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginPowerOffAndWait(string, string, VirtualMachinesPowerOffOptionalParams)
Power off the provided virtual machine.
function beginPowerOffAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesPowerOffOptionalParams): Promise<OperationStatusResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginReimage(string, string, VirtualMachinesReimageOptionalParams)
Reimage the provided virtual machine.
function beginReimage(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesReimageOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginReimageAndWait(string, string, VirtualMachinesReimageOptionalParams)
Reimage the provided virtual machine.
function beginReimageAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesReimageOptionalParams): Promise<OperationStatusResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginRestart(string, string, VirtualMachinesRestartOptionalParams)
Restart the provided virtual machine.
function beginRestart(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginRestartAndWait(string, string, VirtualMachinesRestartOptionalParams)
Restart the provided virtual machine.
function beginRestartAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams): Promise<OperationStatusResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginStart(string, string, VirtualMachinesStartOptionalParams)
Start the provided virtual machine.
function beginStart(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginStartAndWait(string, string, VirtualMachinesStartOptionalParams)
Start the provided virtual machine.
function beginStartAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams): Promise<OperationStatusResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginUpdate(string, string, VirtualMachinesUpdateOptionalParams)
Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.
function beginUpdate(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>
beginUpdateAndWait(string, string, VirtualMachinesUpdateOptionalParams)
Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.
function beginUpdateAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesUpdateOptionalParams): Promise<VirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<VirtualMachine>
get(string, string, VirtualMachinesGetOptionalParams)
Get properties of the provided virtual machine.
function get(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesGetOptionalParams): Promise<VirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- virtualMachineName
-
string
The name of the virtual machine.
- options
- VirtualMachinesGetOptionalParams
The options parameters.
Returns
Promise<VirtualMachine>
listByResourceGroup(string, VirtualMachinesListByResourceGroupOptionalParams)
Get a list of virtual machines in the provided resource group.
function listByResourceGroup(resourceGroupName: string, options?: VirtualMachinesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(VirtualMachinesListBySubscriptionOptionalParams)
Get a list of virtual machines in the provided subscription.
function listBySubscription(options?: VirtualMachinesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>Parameters
The options parameters.