Package version:

Interface DedicatedHostGroups

Interface representing a DedicatedHostGroups.

interface DedicatedHostGroups {
    createOrUpdate(resourceGroupName: string, hostGroupName: string, parameters: DedicatedHostGroup, options?: DedicatedHostGroupsCreateOrUpdateOptionalParams): Promise<DedicatedHostGroup>;
    delete(resourceGroupName: string, hostGroupName: string, options?: DedicatedHostGroupsDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, hostGroupName: string, options?: DedicatedHostGroupsGetOptionalParams): Promise<DedicatedHostGroup>;
    listByResourceGroup(resourceGroupName: string, options?: DedicatedHostGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DedicatedHostGroup>;
    listBySubscription(options?: DedicatedHostGroupsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DedicatedHostGroup>;
    update(resourceGroupName: string, hostGroupName: string, parameters: DedicatedHostGroupUpdate, options?: DedicatedHostGroupsUpdateOptionalParams): Promise<DedicatedHostGroup>;
}

Methods

createOrUpdate(resourceGroupName, hostGroupName, parameters, options?): Promise<DedicatedHostGroup>
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)
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.
- Optionaloptions: DedicatedHostGroupsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<DedicatedHostGroup>
- Defined in operationsInterfaces/dedicatedHostGroups.ts:53

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<DedicatedHostGroup>
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.
Parameters
- resourceGroupName: string
  The name of the resource group.
- Optionaloptions: DedicatedHostGroupsListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<DedicatedHostGroup>
- Defined in operationsInterfaces/dedicatedHostGroups.ts:33

update(resourceGroupName, hostGroupName, parameters, options?): Promise<DedicatedHostGroup>
Update an dedicated host group.
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.
- Optionaloptions: DedicatedHostGroupsUpdateOptionalParams
  The options parameters.
Returns Promise<DedicatedHostGroup>
- Defined in operationsInterfaces/dedicatedHostGroups.ts:66