Hosts interface

Package:

@azure/arm-connectedvmware

Interface representing a Hosts.

Methods

beginCreate(string, string, HostsCreateOptionalParams)	Create Or Update host.
beginCreateAndWait(string, string, HostsCreateOptionalParams)	Create Or Update host.
beginDelete(string, string, HostsDeleteOptionalParams)	Implements host DELETE method.
beginDeleteAndWait(string, string, HostsDeleteOptionalParams)	Implements host DELETE method.
get(string, string, HostsGetOptionalParams)	Implements host GET method.
list(HostsListOptionalParams)	List of hosts in a subscription.
listByResourceGroup(string, HostsListByResourceGroupOptionalParams)	List of hosts in a resource group.
update(string, string, HostsUpdateOptionalParams)	API to update certain properties of the host resource.

Method Details

beginCreate(string, string, HostsCreateOptionalParams)

Create Or Update host.

function beginCreate(resourceGroupName: string, hostName: string, options?: HostsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Host>, Host>>

Parameters

resourceGroupName

string

The Resource Group Name.

hostName

string

Name of the host.

options

HostsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, HostsCreateOptionalParams)

Create Or Update host.

function beginCreateAndWait(resourceGroupName: string, hostName: string, options?: HostsCreateOptionalParams): Promise<Host>

Parameters

resourceGroupName

string

The Resource Group Name.

hostName

string

Name of the host.

options

HostsCreateOptionalParams

The options parameters.

Returns

Promise<Host>

beginDelete(string, string, HostsDeleteOptionalParams)

Implements host DELETE method.

function beginDelete(resourceGroupName: string, hostName: string, options?: HostsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The Resource Group Name.

hostName

string

Name of the host.

options

HostsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, HostsDeleteOptionalParams)

Implements host DELETE method.

function beginDeleteAndWait(resourceGroupName: string, hostName: string, options?: HostsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The Resource Group Name.

hostName

string

Name of the host.

options

HostsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, HostsGetOptionalParams)

Implements host GET method.

function get(resourceGroupName: string, hostName: string, options?: HostsGetOptionalParams): Promise<Host>

Parameters

resourceGroupName

string

The Resource Group Name.

hostName

string

Name of the host.

options

HostsGetOptionalParams

The options parameters.

Returns

Promise<Host>

list(HostsListOptionalParams)

List of hosts in a subscription.

function list(options?: HostsListOptionalParams): PagedAsyncIterableIterator<Host, Host[], PageSettings>

Parameters

options

HostsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Host, Host[], PageSettings>

listByResourceGroup(string, HostsListByResourceGroupOptionalParams)

List of hosts in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: HostsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Host, Host[], PageSettings>

Parameters

resourceGroupName

string

The Resource Group Name.

options

HostsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Host, Host[], PageSettings>

update(string, string, HostsUpdateOptionalParams)

API to update certain properties of the host resource.

function update(resourceGroupName: string, hostName: string, options?: HostsUpdateOptionalParams): Promise<Host>

Parameters

resourceGroupName

string

The Resource Group Name.

hostName

string

Name of the host.

options

HostsUpdateOptionalParams

The options parameters.

Returns

Promise<Host>