Package com.azure.resourcemanager.compute.fluent

Interface DedicatedHostGroupsClient

All Superinterfaces:

InnerSupportsDelete<Void>, InnerSupportsGet<DedicatedHostGroupInner>, InnerSupportsListing<DedicatedHostGroupInner>

public interface DedicatedHostGroupsClient
extends InnerSupportsGet<DedicatedHostGroupInner>, InnerSupportsListing<DedicatedHostGroupInner>, InnerSupportsDelete<Void>

An instance of this class provides access to all the operations defined in DedicatedHostGroupsClient.

Method Summary

Modifier and Type	Method	Description
DedicatedHostGroupInner	createOrUpdate(String resourceGroupName, String hostGroupName, DedicatedHostGroupInner parameters)	Create or update a dedicated host group.
Mono<DedicatedHostGroupInner>	createOrUpdateAsync(String resourceGroupName, String hostGroupName, DedicatedHostGroupInner parameters)	Create or update a dedicated host group.
com.azure.core.http.rest.Response<DedicatedHostGroupInner>	createOrUpdateWithResponse(String resourceGroupName, String hostGroupName, DedicatedHostGroupInner parameters, com.azure.core.util.Context context)	Create or update a dedicated host group.
Mono<com.azure.core.http.rest.Response<DedicatedHostGroupInner>>	createOrUpdateWithResponseAsync(String resourceGroupName, String hostGroupName, DedicatedHostGroupInner parameters)	Create or update a dedicated host group.
void	delete(String resourceGroupName, String hostGroupName)	Delete a dedicated host group.
Mono<Void>	deleteAsync(String resourceGroupName, String hostGroupName)	Delete a dedicated host group.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String hostGroupName, com.azure.core.util.Context context)	Delete a dedicated host group.
Mono<com.azure.core.http.rest.Response<Void>>	deleteWithResponseAsync(String resourceGroupName, String hostGroupName)	Delete a dedicated host group.
DedicatedHostGroupInner	getByResourceGroup(String resourceGroupName, String hostGroupName)	Retrieves information about a dedicated host group.
Mono<DedicatedHostGroupInner>	getByResourceGroupAsync(String resourceGroupName, String hostGroupName)	Retrieves information about a dedicated host group.
Mono<DedicatedHostGroupInner>	getByResourceGroupAsync(String resourceGroupName, String hostGroupName, InstanceViewTypes expand)	Retrieves information about a dedicated host group.
com.azure.core.http.rest.Response<DedicatedHostGroupInner>	getByResourceGroupWithResponse(String resourceGroupName, String hostGroupName, InstanceViewTypes expand, com.azure.core.util.Context context)	Retrieves information about a dedicated host group.
Mono<com.azure.core.http.rest.Response<DedicatedHostGroupInner>>	getByResourceGroupWithResponseAsync(String resourceGroupName, String hostGroupName, InstanceViewTypes expand)	Retrieves information about a dedicated host group.
com.azure.core.http.rest.PagedIterable<DedicatedHostGroupInner>	list()	Lists all of the dedicated host groups in the subscription.
com.azure.core.http.rest.PagedIterable<DedicatedHostGroupInner>	list(com.azure.core.util.Context context)	Lists all of the dedicated host groups in the subscription.
com.azure.core.http.rest.PagedFlux<DedicatedHostGroupInner>	listAsync()	Lists all of the dedicated host groups in the subscription.
com.azure.core.http.rest.PagedIterable<DedicatedHostGroupInner>	listByResourceGroup(String resourceGroupName)	Lists all of the dedicated host groups in the specified resource group.
com.azure.core.http.rest.PagedIterable<DedicatedHostGroupInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Lists all of the dedicated host groups in the specified resource group.
com.azure.core.http.rest.PagedFlux<DedicatedHostGroupInner>	listByResourceGroupAsync(String resourceGroupName)	Lists all of the dedicated host groups in the specified resource group.
DedicatedHostGroupInner	update(String resourceGroupName, String hostGroupName, DedicatedHostGroupUpdate parameters)	Update an dedicated host group.
Mono<DedicatedHostGroupInner>	updateAsync(String resourceGroupName, String hostGroupName, DedicatedHostGroupUpdate parameters)	Update an dedicated host group.
com.azure.core.http.rest.Response<DedicatedHostGroupInner>	updateWithResponse(String resourceGroupName, String hostGroupName, DedicatedHostGroupUpdate parameters, com.azure.core.util.Context context)	Update an dedicated host group.
Mono<com.azure.core.http.rest.Response<DedicatedHostGroupInner>>	updateWithResponseAsync(String resourceGroupName, String hostGroupName, DedicatedHostGroupUpdate parameters)	Update an dedicated host group.

Method Detail

createOrUpdateWithResponseAsync

Mono<com.azure.core.http.rest.Response<DedicatedHostGroupInner>> createOrUpdateWithResponseAsync(String resourceGroupName,
                                                                                                 String hostGroupName,
                                                                                                 DedicatedHostGroupInner parameters)

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 - The name of the resource group.

hostGroupName - The name of the dedicated host group.

parameters - Parameters supplied to the Create Dedicated Host Group.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateAsync

Mono<DedicatedHostGroupInner> createOrUpdateAsync(String resourceGroupName,
                                                  String hostGroupName,
                                                  DedicatedHostGroupInner parameters)

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 - The name of the resource group.

hostGroupName - The name of the dedicated host group.

parameters - Parameters supplied to the Create Dedicated Host Group.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

DedicatedHostGroupInner createOrUpdate(String resourceGroupName,
                                       String hostGroupName,
                                       DedicatedHostGroupInner parameters)

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 - The name of the resource group.

hostGroupName - The name of the dedicated host group.

parameters - Parameters supplied to the Create Dedicated Host Group.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<DedicatedHostGroupInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                      String hostGroupName,
                                                                                      DedicatedHostGroupInner parameters,
                                                                                      com.azure.core.util.Context context)

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 - The name of the resource group.

hostGroupName - The name of the dedicated host group.

parameters - Parameters supplied to the Create Dedicated Host Group.

context - The context to associate with this operation.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponseAsync

Mono<com.azure.core.http.rest.Response<DedicatedHostGroupInner>> updateWithResponseAsync(String resourceGroupName,
                                                                                         String hostGroupName,
                                                                                         DedicatedHostGroupUpdate parameters)

Update an dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

parameters - Parameters supplied to the Update Dedicated Host Group operation.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateAsync

Mono<DedicatedHostGroupInner> updateAsync(String resourceGroupName,
                                          String hostGroupName,
                                          DedicatedHostGroupUpdate parameters)

Update an dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

parameters - Parameters supplied to the Update Dedicated Host Group operation.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

DedicatedHostGroupInner update(String resourceGroupName,
                               String hostGroupName,
                               DedicatedHostGroupUpdate parameters)

Update an dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

parameters - Parameters supplied to the Update Dedicated Host Group operation.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponse

com.azure.core.http.rest.Response<DedicatedHostGroupInner> updateWithResponse(String resourceGroupName,
                                                                              String hostGroupName,
                                                                              DedicatedHostGroupUpdate parameters,
                                                                              com.azure.core.util.Context context)

Update an dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

parameters - Parameters supplied to the Update Dedicated Host Group operation.

context - The context to associate with this operation.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponseAsync

Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync(String resourceGroupName,
                                                                      String hostGroupName)

Delete a dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteAsync

Mono<Void> deleteAsync(String resourceGroupName,
                       String hostGroupName)

Delete a dedicated host group.

Specified by:

deleteAsync in interface InnerSupportsDelete<Void>

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String hostGroupName)

Delete a dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String hostGroupName,
                                                           com.azure.core.util.Context context)

Delete a dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponseAsync

Mono<com.azure.core.http.rest.Response<DedicatedHostGroupInner>> getByResourceGroupWithResponseAsync(String resourceGroupName,
                                                                                                     String hostGroupName,
                                                                                                     InstanceViewTypes expand)

Retrieves information about a dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

expand - The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupAsync

Mono<DedicatedHostGroupInner> getByResourceGroupAsync(String resourceGroupName,
                                                      String hostGroupName,
                                                      InstanceViewTypes expand)

Retrieves information about a dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

expand - The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupAsync

Mono<DedicatedHostGroupInner> getByResourceGroupAsync(String resourceGroupName,
                                                      String hostGroupName)

Retrieves information about a dedicated host group.

Specified by:

getByResourceGroupAsync in interface InnerSupportsGet<DedicatedHostGroupInner>

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

DedicatedHostGroupInner getByResourceGroup(String resourceGroupName,
                                           String hostGroupName)

Retrieves information about a dedicated host group.

Specified by:

getByResourceGroup in interface InnerSupportsGet<DedicatedHostGroupInner>

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<DedicatedHostGroupInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                          String hostGroupName,
                                                                                          InstanceViewTypes expand,
                                                                                          com.azure.core.util.Context context)

Retrieves information about a dedicated host group.

Parameters:

resourceGroupName - The name of the resource group.

hostGroupName - The name of the dedicated host group.

expand - The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group.

context - The context to associate with this operation.

Returns:

specifies information about the dedicated host group that the dedicated hosts should be assigned to along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroupAsync

com.azure.core.http.rest.PagedFlux<DedicatedHostGroupInner> listByResourceGroupAsync(String resourceGroupName)

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.

Specified by:

listByResourceGroupAsync in interface InnerSupportsListing<DedicatedHostGroupInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the List Dedicated Host Group with resource group response as paginated response with PagedFlux.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<DedicatedHostGroupInner> listByResourceGroup(String resourceGroupName)

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.

Specified by:

listByResourceGroup in interface InnerSupportsListing<DedicatedHostGroupInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the List Dedicated Host Group with resource group response as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<DedicatedHostGroupInner> listByResourceGroup(String resourceGroupName,
                                                                                    com.azure.core.util.Context context)

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 - The name of the resource group.

context - The context to associate with this operation.

Returns:

the List Dedicated Host Group with resource group response as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAsync

com.azure.core.http.rest.PagedFlux<DedicatedHostGroupInner> listAsync()

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.

Specified by:

listAsync in interface InnerSupportsListing<DedicatedHostGroupInner>

Returns:

the List Dedicated Host Group with resource group response as paginated response with PagedFlux.

Throws:

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<DedicatedHostGroupInner> list()

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.

Specified by:

list in interface InnerSupportsListing<DedicatedHostGroupInner>

Returns:

the List Dedicated Host Group with resource group response as paginated response with PagedIterable.

Throws:

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<DedicatedHostGroupInner> list(com.azure.core.util.Context context)

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.

Parameters:

context - The context to associate with this operation.

Returns:

the List Dedicated Host Group with resource group response as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.