VirtualMachineRunCommands interface

Package:

@azure/arm-compute

Interface representing a VirtualMachineRunCommands.

Methods

beginCreateOrUpdate(string, string, string, VirtualMachineRunCommand, VirtualMachineRunCommandsCreateOrUpdateOptionalParams)	The operation to create or update the run command.
beginCreateOrUpdateAndWait(string, string, string, VirtualMachineRunCommand, VirtualMachineRunCommandsCreateOrUpdateOptionalParams)	The operation to create or update the run command.
beginDelete(string, string, string, VirtualMachineRunCommandsDeleteOptionalParams)	The operation to delete the run command.
beginDeleteAndWait(string, string, string, VirtualMachineRunCommandsDeleteOptionalParams)	The operation to delete the run command.
beginUpdate(string, string, string, VirtualMachineRunCommandUpdate, VirtualMachineRunCommandsUpdateOptionalParams)	The operation to update the run command.
beginUpdateAndWait(string, string, string, VirtualMachineRunCommandUpdate, VirtualMachineRunCommandsUpdateOptionalParams)	The operation to update the run command.
get(string, string, VirtualMachineRunCommandsGetOptionalParams)	Gets specific run command for a subscription in a location.
getByVirtualMachine(string, string, string, VirtualMachineRunCommandsGetByVirtualMachineOptionalParams)	The operation to get the run command.
list(string, VirtualMachineRunCommandsListOptionalParams)	Lists all available run commands for a subscription in a location.
listByVirtualMachine(string, string, VirtualMachineRunCommandsListByVirtualMachineOptionalParams)	The operation to get all run commands of a Virtual Machine.

Method Details

beginCreateOrUpdate(string, string, string, VirtualMachineRunCommand, VirtualMachineRunCommandsCreateOrUpdateOptionalParams)

The operation to create or update the run command.

function beginCreateOrUpdate(resourceGroupName: string, vmName: string, runCommandName: string, runCommand: VirtualMachineRunCommand, options?: VirtualMachineRunCommandsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineRunCommand>, VirtualMachineRunCommand>>

Parameters

resourceGroupName

string

The name of the resource group.

vmName

string

The name of the virtual machine where the run command should be created or updated.

runCommandName

string

The name of the virtual machine run command.

runCommand

VirtualMachineRunCommand

Parameters supplied to the Create Virtual Machine RunCommand operation.

options

VirtualMachineRunCommandsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineRunCommand>, VirtualMachineRunCommand>>

beginCreateOrUpdateAndWait(string, string, string, VirtualMachineRunCommand, VirtualMachineRunCommandsCreateOrUpdateOptionalParams)

The operation to create or update the run command.

function beginCreateOrUpdateAndWait(resourceGroupName: string, vmName: string, runCommandName: string, runCommand: VirtualMachineRunCommand, options?: VirtualMachineRunCommandsCreateOrUpdateOptionalParams): Promise<VirtualMachineRunCommand>

Parameters

resourceGroupName

string

The name of the resource group.

vmName

string

The name of the virtual machine where the run command should be created or updated.

runCommandName

string

The name of the virtual machine run command.

runCommand

VirtualMachineRunCommand

Parameters supplied to the Create Virtual Machine RunCommand operation.

options

VirtualMachineRunCommandsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachineRunCommand>

beginDelete(string, string, string, VirtualMachineRunCommandsDeleteOptionalParams)

The operation to delete the run command.

function beginDelete(resourceGroupName: string, vmName: string, runCommandName: string, options?: VirtualMachineRunCommandsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

vmName

string

The name of the virtual machine where the run command should be deleted.

runCommandName

string

The name of the virtual machine run command.

options

VirtualMachineRunCommandsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, VirtualMachineRunCommandsDeleteOptionalParams)

The operation to delete the run command.

function beginDeleteAndWait(resourceGroupName: string, vmName: string, runCommandName: string, options?: VirtualMachineRunCommandsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmName

string

The name of the virtual machine where the run command should be deleted.

runCommandName

string

The name of the virtual machine run command.

options

VirtualMachineRunCommandsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, VirtualMachineRunCommandUpdate, VirtualMachineRunCommandsUpdateOptionalParams)

The operation to update the run command.

function beginUpdate(resourceGroupName: string, vmName: string, runCommandName: string, runCommand: VirtualMachineRunCommandUpdate, options?: VirtualMachineRunCommandsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineRunCommand>, VirtualMachineRunCommand>>

Parameters

resourceGroupName

string

The name of the resource group.

vmName

string

The name of the virtual machine where the run command should be updated.

runCommandName

string

The name of the virtual machine run command.

runCommand

VirtualMachineRunCommandUpdate

Parameters supplied to the Update Virtual Machine RunCommand operation.

options

VirtualMachineRunCommandsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineRunCommand>, VirtualMachineRunCommand>>

beginUpdateAndWait(string, string, string, VirtualMachineRunCommandUpdate, VirtualMachineRunCommandsUpdateOptionalParams)

The operation to update the run command.

function beginUpdateAndWait(resourceGroupName: string, vmName: string, runCommandName: string, runCommand: VirtualMachineRunCommandUpdate, options?: VirtualMachineRunCommandsUpdateOptionalParams): Promise<VirtualMachineRunCommand>

Parameters

resourceGroupName

string

The name of the resource group.

vmName

string

The name of the virtual machine where the run command should be updated.

runCommandName

string

The name of the virtual machine run command.

runCommand

VirtualMachineRunCommandUpdate

Parameters supplied to the Update Virtual Machine RunCommand operation.

options

VirtualMachineRunCommandsUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachineRunCommand>

get(string, string, VirtualMachineRunCommandsGetOptionalParams)

Gets specific run command for a subscription in a location.

function get(location: string, commandId: string, options?: VirtualMachineRunCommandsGetOptionalParams): Promise<RunCommandDocument>

Parameters

location

string

The location upon which run commands is queried.

commandId

string

The command id.

options

VirtualMachineRunCommandsGetOptionalParams

The options parameters.

Returns

Promise<RunCommandDocument>

getByVirtualMachine(string, string, string, VirtualMachineRunCommandsGetByVirtualMachineOptionalParams)

The operation to get the run command.

function getByVirtualMachine(resourceGroupName: string, vmName: string, runCommandName: string, options?: VirtualMachineRunCommandsGetByVirtualMachineOptionalParams): Promise<VirtualMachineRunCommand>

Parameters

resourceGroupName

string

The name of the resource group.

vmName

string

The name of the virtual machine containing the run command.

runCommandName

string

The name of the virtual machine run command.

options

VirtualMachineRunCommandsGetByVirtualMachineOptionalParams

The options parameters.

Returns

Promise<VirtualMachineRunCommand>

list(string, VirtualMachineRunCommandsListOptionalParams)

Lists all available run commands for a subscription in a location.

function list(location: string, options?: VirtualMachineRunCommandsListOptionalParams): PagedAsyncIterableIterator<RunCommandDocumentBase, RunCommandDocumentBase[], PageSettings>

Parameters

location

string

The location upon which run commands is queried.

options

VirtualMachineRunCommandsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RunCommandDocumentBase, RunCommandDocumentBase[], PageSettings>

listByVirtualMachine(string, string, VirtualMachineRunCommandsListByVirtualMachineOptionalParams)

The operation to get all run commands of a Virtual Machine.

function listByVirtualMachine(resourceGroupName: string, vmName: string, options?: VirtualMachineRunCommandsListByVirtualMachineOptionalParams): PagedAsyncIterableIterator<VirtualMachineRunCommand, VirtualMachineRunCommand[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

vmName

string

The name of the virtual machine containing the run command.

options

VirtualMachineRunCommandsListByVirtualMachineOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachineRunCommand, VirtualMachineRunCommand[], PageSettings>