HostPoolsClient Interface

public interface HostPoolsClient

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

Method Summary

Modifier and Type Method and Description
abstract HostPoolInner createOrUpdate(String resourceGroupName, String hostPoolName, HostPoolInner hostPool)

Create or update a host pool.

abstract reactor.core.publisher.Mono<HostPoolInner> createOrUpdateAsync(String resourceGroupName, String hostPoolName, HostPoolInner hostPool)

Create or update a host pool.

abstract Response<HostPoolInner> createOrUpdateWithResponse(String resourceGroupName, String hostPoolName, HostPoolInner hostPool, Context context)

Create or update a host pool.

abstract reactor.core.publisher.Mono<Response<HostPoolInner>> createOrUpdateWithResponseAsync(String resourceGroupName, String hostPoolName, HostPoolInner hostPool)

Create or update a host pool.

abstract void delete(String resourceGroupName, String hostPoolName)

Remove a host pool.

abstract reactor.core.publisher.Mono<Void> deleteAsync(String resourceGroupName, String hostPoolName)

Remove a host pool.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String hostPoolName, Boolean force, Context context)

Remove a host pool.

abstract reactor.core.publisher.Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String hostPoolName, Boolean force)

Remove a host pool.

abstract HostPoolInner getByResourceGroup(String resourceGroupName, String hostPoolName)

Get a host pool.

abstract reactor.core.publisher.Mono<HostPoolInner> getByResourceGroupAsync(String resourceGroupName, String hostPoolName)

Get a host pool.

abstract Response<HostPoolInner> getByResourceGroupWithResponse(String resourceGroupName, String hostPoolName, Context context)

Get a host pool.

abstract reactor.core.publisher.Mono<Response<HostPoolInner>> getByResourceGroupWithResponseAsync(String resourceGroupName, String hostPoolName)

Get a host pool.

abstract PagedIterable<HostPoolInner> list()

List hostPools in subscription.

abstract PagedIterable<HostPoolInner> list(Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List hostPools in subscription.

abstract PagedFlux<HostPoolInner> listAsync()

List hostPools in subscription.

abstract PagedFlux<HostPoolInner> listAsync(Integer pageSize, Boolean isDescending, Integer initialSkip)

List hostPools in subscription.

abstract PagedIterable<HostPoolInner> listByResourceGroup(String resourceGroupName)

List hostPools.

abstract PagedIterable<HostPoolInner> listByResourceGroup(String resourceGroupName, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List hostPools.

abstract PagedFlux<HostPoolInner> listByResourceGroupAsync(String resourceGroupName)

List hostPools.

abstract PagedFlux<HostPoolInner> listByResourceGroupAsync(String resourceGroupName, Integer pageSize, Boolean isDescending, Integer initialSkip)

List hostPools.

abstract RegistrationTokenListInner listRegistrationTokens(String resourceGroupName, String hostPoolName)

Operation to list the RegistrationTokens associated with the HostPool.

abstract reactor.core.publisher.Mono<RegistrationTokenListInner> listRegistrationTokensAsync(String resourceGroupName, String hostPoolName)

Operation to list the RegistrationTokens associated with the HostPool.

abstract Response<RegistrationTokenListInner> listRegistrationTokensWithResponse(String resourceGroupName, String hostPoolName, Context context)

Operation to list the RegistrationTokens associated with the HostPool.

abstract reactor.core.publisher.Mono<Response<RegistrationTokenListInner>> listRegistrationTokensWithResponseAsync(String resourceGroupName, String hostPoolName)

Operation to list the RegistrationTokens associated with the HostPool.

abstract RegistrationInfoInner retrieveRegistrationToken(String resourceGroupName, String hostPoolName)

Registration token of the host pool.

abstract reactor.core.publisher.Mono<RegistrationInfoInner> retrieveRegistrationTokenAsync(String resourceGroupName, String hostPoolName)

Registration token of the host pool.

abstract Response<RegistrationInfoInner> retrieveRegistrationTokenWithResponse(String resourceGroupName, String hostPoolName, Context context)

Registration token of the host pool.

abstract reactor.core.publisher.Mono<Response<RegistrationInfoInner>> retrieveRegistrationTokenWithResponseAsync(String resourceGroupName, String hostPoolName)

Registration token of the host pool.

abstract HostPoolInner update(String resourceGroupName, String hostPoolName)

Update a host pool.

abstract reactor.core.publisher.Mono<HostPoolInner> updateAsync(String resourceGroupName, String hostPoolName)

Update a host pool.

abstract Response<HostPoolInner> updateWithResponse(String resourceGroupName, String hostPoolName, HostPoolPatch hostPool, Context context)

Update a host pool.

abstract reactor.core.publisher.Mono<Response<HostPoolInner>> updateWithResponseAsync(String resourceGroupName, String hostPoolName, HostPoolPatch hostPool)

Update a host pool.

Method Details

createOrUpdate

public abstract HostPoolInner createOrUpdate(String resourceGroupName, String hostPoolName, HostPoolInner hostPool)

Create or update a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
hostPool - Object containing HostPool definitions.

Returns:

represents a HostPool definition.

createOrUpdateAsync

public abstract Mono<HostPoolInner> createOrUpdateAsync(String resourceGroupName, String hostPoolName, HostPoolInner hostPool)

Create or update a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
hostPool - Object containing HostPool definitions.

Returns:

represents a HostPool definition on successful completion of Mono.

createOrUpdateWithResponse

public abstract Response<HostPoolInner> createOrUpdateWithResponse(String resourceGroupName, String hostPoolName, HostPoolInner hostPool, Context context)

Create or update a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
hostPool - Object containing HostPool definitions.
context - The context to associate with this operation.

Returns:

represents a HostPool definition along with Response<T>.

createOrUpdateWithResponseAsync

public abstract Mono<Response<HostPoolInner>> createOrUpdateWithResponseAsync(String resourceGroupName, String hostPoolName, HostPoolInner hostPool)

Create or update a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
hostPool - Object containing HostPool definitions.

Returns:

represents a HostPool definition along with Response<T> on successful completion of Mono.

delete

public abstract void delete(String resourceGroupName, String hostPoolName)

Remove a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

deleteAsync

public abstract Mono<Void> deleteAsync(String resourceGroupName, String hostPoolName)

Remove a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

A Mono that completes when a successful response is received.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String hostPoolName, Boolean force, Context context)

Remove a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
force - Force flag to delete sessionHost.
context - The context to associate with this operation.

Returns:

deleteWithResponseAsync

public abstract Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String hostPoolName, Boolean force)

Remove a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
force - Force flag to delete sessionHost.

Returns:

the Response<T> on successful completion of Mono.

getByResourceGroup

public abstract HostPoolInner getByResourceGroup(String resourceGroupName, String hostPoolName)

Get a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

a host pool.

getByResourceGroupAsync

public abstract Mono<HostPoolInner> getByResourceGroupAsync(String resourceGroupName, String hostPoolName)

Get a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

a host pool on successful completion of Mono.

getByResourceGroupWithResponse

public abstract Response<HostPoolInner> getByResourceGroupWithResponse(String resourceGroupName, String hostPoolName, Context context)

Get a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
context - The context to associate with this operation.

Returns:

a host pool along with Response<T>.

getByResourceGroupWithResponseAsync

public abstract Mono<Response<HostPoolInner>> getByResourceGroupWithResponseAsync(String resourceGroupName, String hostPoolName)

Get a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

a host pool along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable<HostPoolInner> list()

List hostPools in subscription.

Returns:

hostPoolList as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<HostPoolInner> list(Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List hostPools in subscription.

Parameters:

pageSize - Number of items per page.
isDescending - Indicates whether the collection is descending.
initialSkip - Initial number of items to skip.
context - The context to associate with this operation.

Returns:

hostPoolList as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux<HostPoolInner> listAsync()

List hostPools in subscription.

Returns:

hostPoolList as paginated response with PagedFlux<T>.

listAsync

public abstract PagedFlux<HostPoolInner> listAsync(Integer pageSize, Boolean isDescending, Integer initialSkip)

List hostPools in subscription.

Parameters:

pageSize - Number of items per page.
isDescending - Indicates whether the collection is descending.
initialSkip - Initial number of items to skip.

Returns:

hostPoolList as paginated response with PagedFlux<T>.

listByResourceGroup

public abstract PagedIterable<HostPoolInner> listByResourceGroup(String resourceGroupName)

List hostPools.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

hostPoolList as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<HostPoolInner> listByResourceGroup(String resourceGroupName, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List hostPools.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
pageSize - Number of items per page.
isDescending - Indicates whether the collection is descending.
initialSkip - Initial number of items to skip.
context - The context to associate with this operation.

Returns:

hostPoolList as paginated response with PagedIterable<T>.

listByResourceGroupAsync

public abstract PagedFlux<HostPoolInner> listByResourceGroupAsync(String resourceGroupName)

List hostPools.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

hostPoolList as paginated response with PagedFlux<T>.

listByResourceGroupAsync

public abstract PagedFlux<HostPoolInner> listByResourceGroupAsync(String resourceGroupName, Integer pageSize, Boolean isDescending, Integer initialSkip)

List hostPools.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
pageSize - Number of items per page.
isDescending - Indicates whether the collection is descending.
initialSkip - Initial number of items to skip.

Returns:

hostPoolList as paginated response with PagedFlux<T>.

listRegistrationTokens

public abstract RegistrationTokenListInner listRegistrationTokens(String resourceGroupName, String hostPoolName)

Operation to list the RegistrationTokens associated with the HostPool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

registrationTokenList.

listRegistrationTokensAsync

public abstract Mono<RegistrationTokenListInner> listRegistrationTokensAsync(String resourceGroupName, String hostPoolName)

Operation to list the RegistrationTokens associated with the HostPool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

registrationTokenList on successful completion of Mono.

listRegistrationTokensWithResponse

public abstract Response<RegistrationTokenListInner> listRegistrationTokensWithResponse(String resourceGroupName, String hostPoolName, Context context)

Operation to list the RegistrationTokens associated with the HostPool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
context - The context to associate with this operation.

Returns:

registrationTokenList along with Response<T>.

listRegistrationTokensWithResponseAsync

public abstract Mono<Response<RegistrationTokenListInner>> listRegistrationTokensWithResponseAsync(String resourceGroupName, String hostPoolName)

Operation to list the RegistrationTokens associated with the HostPool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

registrationTokenList along with Response<T> on successful completion of Mono.

retrieveRegistrationToken

public abstract RegistrationInfoInner retrieveRegistrationToken(String resourceGroupName, String hostPoolName)

Registration token of the host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

represents a RegistrationInfo definition.

retrieveRegistrationTokenAsync

public abstract Mono<RegistrationInfoInner> retrieveRegistrationTokenAsync(String resourceGroupName, String hostPoolName)

Registration token of the host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

represents a RegistrationInfo definition on successful completion of Mono.

retrieveRegistrationTokenWithResponse

public abstract Response<RegistrationInfoInner> retrieveRegistrationTokenWithResponse(String resourceGroupName, String hostPoolName, Context context)

Registration token of the host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
context - The context to associate with this operation.

Returns:

represents a RegistrationInfo definition along with Response<T>.

retrieveRegistrationTokenWithResponseAsync

public abstract Mono<Response<RegistrationInfoInner>> retrieveRegistrationTokenWithResponseAsync(String resourceGroupName, String hostPoolName)

Registration token of the host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

represents a RegistrationInfo definition along with Response<T> on successful completion of Mono.

update

public abstract HostPoolInner update(String resourceGroupName, String hostPoolName)

Update a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

represents a HostPool definition.

updateAsync

public abstract Mono<HostPoolInner> updateAsync(String resourceGroupName, String hostPoolName)

Update a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.

Returns:

represents a HostPool definition on successful completion of Mono.

updateWithResponse

public abstract Response<HostPoolInner> updateWithResponse(String resourceGroupName, String hostPoolName, HostPoolPatch hostPool, Context context)

Update a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
hostPool - Object containing HostPool definitions.
context - The context to associate with this operation.

Returns:

represents a HostPool definition along with Response<T>.

updateWithResponseAsync

public abstract Mono<Response<HostPoolInner>> updateWithResponseAsync(String resourceGroupName, String hostPoolName, HostPoolPatch hostPool)

Update a host pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
hostPoolName - The name of the host pool within the specified resource group.
hostPool - Object containing HostPool definitions.

Returns:

represents a HostPool definition along with Response<T> on successful completion of Mono.

Applies to