Consoles interface
Interface representing a Consoles.
Methods
| begin |
Create a new virtual machine console or update the properties of the existing virtual machine console. |
| begin |
Create a new virtual machine console or update the properties of the existing virtual machine console. |
| begin |
Delete the provided virtual machine console. |
| begin |
Delete the provided virtual machine console. |
| begin |
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. |
| begin |
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, Consoles |
Get properties of the provided virtual machine console. |
| list |
Get a list of consoles for the provided virtual machine. |
Method Details
beginCreateOrUpdate(string, string, string, Console, 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, options?: ConsolesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Console>, Console>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Console>, Console>>
beginCreateOrUpdateAndWait(string, string, string, Console, 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, options?: ConsolesCreateOrUpdateOptionalParams): Promise<Console>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.
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<OperationStatusResult>, OperationStatusResult>>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<OperationStatusResult>, OperationStatusResult>>
beginDeleteAndWait(string, string, string, ConsolesDeleteOptionalParams)
Delete the provided virtual machine console.
function beginDeleteAndWait(resourceGroupName: string, virtualMachineName: string, consoleName: string, options?: ConsolesDeleteOptionalParams): Promise<OperationStatusResult>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<OperationStatusResult>
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>, Console>>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>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>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, Console[], PageSettings>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.