VirtualMachines interface
Interface representing a VirtualMachines.
Methods
Method Details
beginCreateCheckpoint(string, string, VirtualMachinesCreateCheckpointOptionalParams)
Creates a checkpoint in virtual machine.
function beginCreateCheckpoint(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesCreateCheckpointOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<void>, void>>
beginCreateCheckpointAndWait(string, string, VirtualMachinesCreateCheckpointOptionalParams)
Creates a checkpoint in virtual machine.
function beginCreateCheckpointAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesCreateCheckpointOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<void>
beginCreateOrUpdate(string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
Creates Or Updates virtual machines deployed on scvmm fabric.
function beginCreateOrUpdate(resourceGroupName: string, virtualMachineName: string, body: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachine>, VirtualMachine>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
- body
- VirtualMachine
Request payload.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<VirtualMachine>, VirtualMachine>>
beginCreateOrUpdateAndWait(string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
Creates Or Updates virtual machines deployed on scvmm fabric.
function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualMachineName: string, body: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<VirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
- body
- VirtualMachine
Request payload.
The options parameters.
Returns
Promise<VirtualMachine>
beginDelete(string, string, VirtualMachinesDeleteOptionalParams)
Deletes a VirtualMachine deployed on ScVmm fabric.
function beginDelete(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualMachinesDeleteOptionalParams)
Deletes a VirtualMachine deployed on ScVmm fabric.
function beginDeleteAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<void>
beginDeleteCheckpoint(string, string, VirtualMachinesDeleteCheckpointOptionalParams)
Deletes a checkpoint in virtual machine.
function beginDeleteCheckpoint(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteCheckpointOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<void>, void>>
beginDeleteCheckpointAndWait(string, string, VirtualMachinesDeleteCheckpointOptionalParams)
Deletes a checkpoint in virtual machine.
function beginDeleteCheckpointAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteCheckpointOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<void>
beginRestart(string, string, VirtualMachinesRestartOptionalParams)
Restart virtual machine.
function beginRestart(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<void>, void>>
beginRestartAndWait(string, string, VirtualMachinesRestartOptionalParams)
Restart virtual machine.
function beginRestartAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<void>
beginRestoreCheckpoint(string, string, VirtualMachinesRestoreCheckpointOptionalParams)
Restores to a checkpoint in virtual machine.
function beginRestoreCheckpoint(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestoreCheckpointOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<void>, void>>
beginRestoreCheckpointAndWait(string, string, VirtualMachinesRestoreCheckpointOptionalParams)
Restores to a checkpoint in virtual machine.
function beginRestoreCheckpointAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestoreCheckpointOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<void>
beginStart(string, string, VirtualMachinesStartOptionalParams)
Start virtual machine.
function beginStart(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<void>, void>>
beginStartAndWait(string, string, VirtualMachinesStartOptionalParams)
Start virtual machine.
function beginStartAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<void>
beginStop(string, string, VirtualMachinesStopOptionalParams)
Stop virtual machine.
function beginStop(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<void>, void>>
beginStopAndWait(string, string, VirtualMachinesStopOptionalParams)
Stop virtual machine.
function beginStopAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStopOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, VirtualMachineUpdate, VirtualMachinesUpdateOptionalParams)
Updates the VirtualMachines resource.
function beginUpdate(resourceGroupName: string, virtualMachineName: string, body: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachine>, VirtualMachine>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
- body
- VirtualMachineUpdate
VirtualMachines patch payload.
The options parameters.
Returns
Promise<PollerLike<PollOperationState<VirtualMachine>, VirtualMachine>>
beginUpdateAndWait(string, string, VirtualMachineUpdate, VirtualMachinesUpdateOptionalParams)
Updates the VirtualMachines resource.
function beginUpdateAndWait(resourceGroupName: string, virtualMachineName: string, body: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<VirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
- body
- VirtualMachineUpdate
VirtualMachines patch payload.
The options parameters.
Returns
Promise<VirtualMachine>
get(string, string, VirtualMachinesGetOptionalParams)
Implements VirtualMachine GET method.
function get(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesGetOptionalParams): Promise<VirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineName
-
string
Name of the VirtualMachine.
- options
- VirtualMachinesGetOptionalParams
The options parameters.
Returns
Promise<VirtualMachine>
listByResourceGroup(string, VirtualMachinesListByResourceGroupOptionalParams)
List of VirtualMachines in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: VirtualMachinesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listBySubscription(VirtualMachinesListBySubscriptionOptionalParams)
List of VirtualMachines in a subscription.
function listBySubscription(options?: VirtualMachinesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>Parameters
The options parameters.
Returns
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for