Share via

DedicatedHosts interface

  • Reference
Package:
@azure/arm-compute-profile-2020-09-01-hybrid

Interface representing a DedicatedHosts.

Methods

beginCreateOrUpdate(string, string, string, DedicatedHost, DedicatedHostsCreateOrUpdateOptionalParams)

Create or update a dedicated host .
beginCreateOrUpdateAndWait(string, string, string, DedicatedHost, DedicatedHostsCreateOrUpdateOptionalParams)

Create or update a dedicated host .
beginDelete(string, string, string, DedicatedHostsDeleteOptionalParams)

Delete a dedicated host.
beginDeleteAndWait(string, string, string, DedicatedHostsDeleteOptionalParams)

Delete a dedicated host.
beginUpdate(string, string, string, DedicatedHostUpdate, DedicatedHostsUpdateOptionalParams)

Update an dedicated host .
beginUpdateAndWait(string, string, string, DedicatedHostUpdate, DedicatedHostsUpdateOptionalParams)

Update an dedicated host .
get(string, string, string, DedicatedHostsGetOptionalParams)

Retrieves information about a dedicated host.
listByHostGroup(string, string, DedicatedHostsListByHostGroupOptionalParams)

Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.

Method Details

beginCreateOrUpdate(string, string, string, DedicatedHost, DedicatedHostsCreateOrUpdateOptionalParams)

Create or update a dedicated host .

function beginCreateOrUpdate(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHost, options?: DedicatedHostsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedHost>, DedicatedHost>>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host .

parameters
DedicatedHost

Parameters supplied to the Create Dedicated Host.

options
DedicatedHostsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<DedicatedHost>, DedicatedHost>>

beginCreateOrUpdateAndWait(string, string, string, DedicatedHost, DedicatedHostsCreateOrUpdateOptionalParams)

Create or update a dedicated host .

function beginCreateOrUpdateAndWait(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHost, options?: DedicatedHostsCreateOrUpdateOptionalParams): Promise<DedicatedHost>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host .

parameters
DedicatedHost

Parameters supplied to the Create Dedicated Host.

options
DedicatedHostsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DedicatedHost>

beginDelete(string, string, string, DedicatedHostsDeleteOptionalParams)

Delete a dedicated host.

function beginDelete(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options
DedicatedHostsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, DedicatedHostsDeleteOptionalParams)

Delete a dedicated host.

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

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options
DedicatedHostsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, DedicatedHostUpdate, DedicatedHostsUpdateOptionalParams)

Update an dedicated host .

function beginUpdate(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHostUpdate, options?: DedicatedHostsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedHost>, DedicatedHost>>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host .

parameters
DedicatedHostUpdate

Parameters supplied to the Update Dedicated Host operation.

options
DedicatedHostsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<DedicatedHost>, DedicatedHost>>

beginUpdateAndWait(string, string, string, DedicatedHostUpdate, DedicatedHostsUpdateOptionalParams)

Update an dedicated host .

function beginUpdateAndWait(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHostUpdate, options?: DedicatedHostsUpdateOptionalParams): Promise<DedicatedHost>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host .

parameters
DedicatedHostUpdate

Parameters supplied to the Update Dedicated Host operation.

options
DedicatedHostsUpdateOptionalParams

The options parameters.

Returns

Promise<DedicatedHost>

get(string, string, string, DedicatedHostsGetOptionalParams)

Retrieves information about a dedicated host.

function get(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsGetOptionalParams): Promise<DedicatedHost>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options
DedicatedHostsGetOptionalParams

The options parameters.

Returns

Promise<DedicatedHost>

listByHostGroup(string, string, DedicatedHostsListByHostGroupOptionalParams)

Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.

function listByHostGroup(resourceGroupName: string, hostGroupName: string, options?: DedicatedHostsListByHostGroupOptionalParams): PagedAsyncIterableIterator<DedicatedHost, DedicatedHost[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

options
DedicatedHostsListByHostGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DedicatedHost, DedicatedHost[], PageSettings>