Share via

Consoles interface

  • Reference
Package:
@azure/arm-networkcloud

Interface representing a Consoles.

Methods

beginCreateOrUpdate(string, string, string, Console_2, ConsolesCreateOrUpdateOptionalParams)

Create a new virtual machine console or update the properties of the existing virtual machine console.
beginCreateOrUpdateAndWait(string, string, string, Console_2, ConsolesCreateOrUpdateOptionalParams)

Create a new virtual machine console or update the properties of the existing virtual machine console.
beginDelete(string, string, string, ConsolesDeleteOptionalParams)

Delete the provided virtual machine console.
beginDeleteAndWait(string, string, string, ConsolesDeleteOptionalParams)

Delete the provided virtual machine console.
beginUpdate(string, string, string, ConsolesUpdateOptionalParams)

Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.
beginUpdateAndWait(string, string, string, ConsolesUpdateOptionalParams)

Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.
get(string, string, string, ConsolesGetOptionalParams)

Get properties of the provided virtual machine console.
listByVirtualMachine(string, string, ConsolesListByVirtualMachineOptionalParams)

Get a list of consoles for the provided virtual machine.

Method Details

beginCreateOrUpdate(string, string, string, Console_2, ConsolesCreateOrUpdateOptionalParams)

Create a new virtual machine console or update the properties of the existing virtual machine console.

function beginCreateOrUpdate(resourceGroupName: string, virtualMachineName: string, consoleName: string, consoleParameters: Console_2, options?: ConsolesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Console_2>, Console_2>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

virtualMachineName

string

The name of the virtual machine.

consoleName

string

The name of the virtual machine console.

consoleParameters
Console

The request body.

options
ConsolesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, Console_2, ConsolesCreateOrUpdateOptionalParams)

Create a new virtual machine console or update the properties of the existing virtual machine console.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualMachineName: string, consoleName: string, consoleParameters: Console_2, options?: ConsolesCreateOrUpdateOptionalParams): Promise<Console_2>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

virtualMachineName

string

The name of the virtual machine.

consoleName

string

The name of the virtual machine console.

consoleParameters
Console

The request body.

options
ConsolesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Console>

beginDelete(string, string, string, ConsolesDeleteOptionalParams)

Delete the provided virtual machine console.

function beginDelete(resourceGroupName: string, virtualMachineName: string, consoleName: string, options?: ConsolesDeleteOptionalParams): 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.

consoleName

string

The name of the virtual machine console.

options
ConsolesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ConsolesDeleteOptionalParams)

Delete the provided virtual machine console.

function beginDeleteAndWait(resourceGroupName: string, virtualMachineName: string, consoleName: string, options?: ConsolesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

virtualMachineName

string

The name of the virtual machine.

consoleName

string

The name of the virtual machine console.

options
ConsolesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, ConsolesUpdateOptionalParams)

Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.

function beginUpdate(resourceGroupName: string, virtualMachineName: string, consoleName: string, options?: ConsolesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Console_2>, Console_2>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

virtualMachineName

string

The name of the virtual machine.

consoleName

string

The name of the virtual machine console.

options
ConsolesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, ConsolesUpdateOptionalParams)

Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.

function beginUpdateAndWait(resourceGroupName: string, virtualMachineName: string, consoleName: string, options?: ConsolesUpdateOptionalParams): Promise<Console_2>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

virtualMachineName

string

The name of the virtual machine.

consoleName

string

The name of the virtual machine console.

options
ConsolesUpdateOptionalParams

The options parameters.

Returns

Promise<Console>

get(string, string, string, ConsolesGetOptionalParams)

Get properties of the provided virtual machine console.

function get(resourceGroupName: string, virtualMachineName: string, consoleName: string, options?: ConsolesGetOptionalParams): Promise<Console_2>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

virtualMachineName

string

The name of the virtual machine.

consoleName

string

The name of the virtual machine console.

options
ConsolesGetOptionalParams

The options parameters.

Returns

Promise<Console>

listByVirtualMachine(string, string, ConsolesListByVirtualMachineOptionalParams)

Get a list of consoles for the provided virtual machine.

function listByVirtualMachine(resourceGroupName: string, virtualMachineName: string, options?: ConsolesListByVirtualMachineOptionalParams): PagedAsyncIterableIterator<Console_2, Console_2[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

virtualMachineName

string

The name of the virtual machine.

options
ConsolesListByVirtualMachineOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Console, Console[], PageSettings>