GuestAgents interface

Package:

@azure/arm-connectedvmware

Interface representing a GuestAgents.

Methods

beginCreate(string, string, string, GuestAgentsCreateOptionalParams)	Create Or Update GuestAgent.
beginCreateAndWait(string, string, string, GuestAgentsCreateOptionalParams)	Create Or Update GuestAgent.
beginDelete(string, string, string, GuestAgentsDeleteOptionalParams)	Implements GuestAgent DELETE method.
beginDeleteAndWait(string, string, string, GuestAgentsDeleteOptionalParams)	Implements GuestAgent DELETE method.
get(string, string, string, GuestAgentsGetOptionalParams)	Implements GuestAgent GET method.
listByVm(string, string, GuestAgentsListByVmOptionalParams)	Returns the list of GuestAgent of the given vm.

Method Details

beginCreate(string, string, string, GuestAgentsCreateOptionalParams)

Create Or Update GuestAgent.

function beginCreate(resourceGroupName: string, virtualMachineName: string, name: string, options?: GuestAgentsCreateOptionalParams): Promise<PollerLike<PollOperationState<GuestAgent>, GuestAgent>>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the vm.

name

string

Name of the guestAgents.

options

GuestAgentsCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<GuestAgent>, GuestAgent>>

beginCreateAndWait(string, string, string, GuestAgentsCreateOptionalParams)

Create Or Update GuestAgent.

function beginCreateAndWait(resourceGroupName: string, virtualMachineName: string, name: string, options?: GuestAgentsCreateOptionalParams): Promise<GuestAgent>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the vm.

name

string

Name of the guestAgents.

options

GuestAgentsCreateOptionalParams

The options parameters.

Returns

Promise<GuestAgent>

beginDelete(string, string, string, GuestAgentsDeleteOptionalParams)

Implements GuestAgent DELETE method.

function beginDelete(resourceGroupName: string, virtualMachineName: string, name: string, options?: GuestAgentsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the vm.

name

string

Name of the GuestAgent.

options

GuestAgentsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, GuestAgentsDeleteOptionalParams)

Implements GuestAgent DELETE method.

function beginDeleteAndWait(resourceGroupName: string, virtualMachineName: string, name: string, options?: GuestAgentsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the vm.

name

string

Name of the GuestAgent.

options

GuestAgentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, GuestAgentsGetOptionalParams)

Implements GuestAgent GET method.

function get(resourceGroupName: string, virtualMachineName: string, name: string, options?: GuestAgentsGetOptionalParams): Promise<GuestAgent>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the vm.

name

string

Name of the GuestAgent.

options

GuestAgentsGetOptionalParams

The options parameters.

Returns

Promise<GuestAgent>

listByVm(string, string, GuestAgentsListByVmOptionalParams)

Returns the list of GuestAgent of the given vm.

function listByVm(resourceGroupName: string, virtualMachineName: string, options?: GuestAgentsListByVmOptionalParams): PagedAsyncIterableIterator<GuestAgent, GuestAgent[], PageSettings>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the vm.

options

GuestAgentsListByVmOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GuestAgent, GuestAgent[], PageSettings>