DedicatedHostGroups interface

Package:

@azure/arm-compute

Interface representing a DedicatedHostGroups.

Methods

createOrUpdate(string, string, DedicatedHostGroup, DedicatedHostGroupsCreateOrUpdateOptionalParams)	Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)
delete(string, string, DedicatedHostGroupsDeleteOptionalParams)	Delete a dedicated host group.
get(string, string, DedicatedHostGroupsGetOptionalParams)	Retrieves information about a dedicated host group.
listByResourceGroup(string, DedicatedHostGroupsListByResourceGroupOptionalParams)	Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
listBySubscription(DedicatedHostGroupsListBySubscriptionOptionalParams)	Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.
update(string, string, DedicatedHostGroupUpdate, DedicatedHostGroupsUpdateOptionalParams)	Update an dedicated host group.

Method Details

createOrUpdate(string, string, DedicatedHostGroup, DedicatedHostGroupsCreateOrUpdateOptionalParams)

Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)

function createOrUpdate(resourceGroupName: string, hostGroupName: string, parameters: DedicatedHostGroup, options?: DedicatedHostGroupsCreateOrUpdateOptionalParams): Promise<DedicatedHostGroup>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

parameters

DedicatedHostGroup

Parameters supplied to the Create Dedicated Host Group.

options

DedicatedHostGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DedicatedHostGroup>

delete(string, string, DedicatedHostGroupsDeleteOptionalParams)

Delete a dedicated host group.

function delete(resourceGroupName: string, hostGroupName: string, options?: DedicatedHostGroupsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

options

DedicatedHostGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, DedicatedHostGroupsGetOptionalParams)

Retrieves information about a dedicated host group.

function get(resourceGroupName: string, hostGroupName: string, options?: DedicatedHostGroupsGetOptionalParams): Promise<DedicatedHostGroup>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

options

DedicatedHostGroupsGetOptionalParams

The options parameters.

Returns

Promise<DedicatedHostGroup>

listByResourceGroup(string, DedicatedHostGroupsListByResourceGroupOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

options

DedicatedHostGroupsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DedicatedHostGroup, DedicatedHostGroup[], PageSettings>

listBySubscription(DedicatedHostGroupsListBySubscriptionOptionalParams)

Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.

function listBySubscription(options?: DedicatedHostGroupsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DedicatedHostGroup, DedicatedHostGroup[], PageSettings>

Parameters

options

DedicatedHostGroupsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DedicatedHostGroup, DedicatedHostGroup[], PageSettings>

update(string, string, DedicatedHostGroupUpdate, DedicatedHostGroupsUpdateOptionalParams)

Update an dedicated host group.

function update(resourceGroupName: string, hostGroupName: string, parameters: DedicatedHostGroupUpdate, options?: DedicatedHostGroupsUpdateOptionalParams): Promise<DedicatedHostGroup>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

parameters

DedicatedHostGroupUpdate

Parameters supplied to the Update Dedicated Host Group operation.

options

DedicatedHostGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<DedicatedHostGroup>