VirtualMachineRunCommands interface
Interface representing a VirtualMachineRunCommands.
Methods
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. The name is case insensitive.
- vmName
-
string
The name of the VirtualMachine
- runCommandName
-
string
The name of the VirtualMachineRunCommand
- runCommand
- VirtualMachineRunCommand
Parameters supplied to the Create Virtual Machine RunCommand operation.
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. The name is case insensitive.
- vmName
-
string
The name of the VirtualMachine
- runCommandName
-
string
The name of the VirtualMachineRunCommand
- runCommand
- VirtualMachineRunCommand
Parameters supplied to the Create Virtual Machine RunCommand operation.
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. The name is case insensitive.
- vmName
-
string
The name of the VirtualMachine
- runCommandName
-
string
The name of the VirtualMachineRunCommand
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. The name is case insensitive.
- vmName
-
string
The name of the VirtualMachine
- runCommandName
-
string
The name of the VirtualMachineRunCommand
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<VirtualMachineRunCommandsUpdateResponse>, VirtualMachineRunCommandsUpdateResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vmName
-
string
The name of the VirtualMachine
- runCommandName
-
string
The name of the VirtualMachineRunCommand
- runCommand
- VirtualMachineRunCommandUpdate
Parameters supplied to the Update Virtual Machine RunCommand operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineRunCommandsUpdateResponse>, VirtualMachineRunCommandsUpdateResponse>>
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<VirtualMachineRunCommandsUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vmName
-
string
The name of the VirtualMachine
- runCommandName
-
string
The name of the VirtualMachineRunCommand
- runCommand
- VirtualMachineRunCommandUpdate
Parameters supplied to the Update Virtual Machine RunCommand operation.
The options parameters.
Returns
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 name of Azure region.
- commandId
-
string
Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.
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. The name is case insensitive.
- vmName
-
string
The name of the VirtualMachine
- runCommandName
-
string
The name of the VirtualMachineRunCommand
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 name of Azure region.
The options parameters.
Returns
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. The name is case insensitive.
- vmName
-
string
The name of the VirtualMachine
The options parameters.