CapacityReservationGroupsClient Interface

Implements

public interface CapacityReservationGroupsClient
extends InnerSupportsGet<CapacityReservationGroupInner>, InnerSupportsListing<CapacityReservationGroupInner>, InnerSupportsDelete<Void>

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

Method Summary

Modifier and Type Method and Description
abstract CapacityReservationGroupInner createOrUpdate(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInner parameters)

The operation to create or update a capacity reservation group.

abstract Mono<CapacityReservationGroupInner> createOrUpdateAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInner parameters)

The operation to create or update a capacity reservation group.

abstract Response<CapacityReservationGroupInner> createOrUpdateWithResponse(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInner parameters, Context context)

The operation to create or update a capacity reservation group.

abstract Mono<Response<CapacityReservationGroupInner>> createOrUpdateWithResponseAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInner parameters)

The operation to create or update a capacity reservation group.

abstract void delete(String resourceGroupName, String capacityReservationGroupName)

The operation to delete a capacity reservation group.

abstract Mono<Void> deleteAsync(String resourceGroupName, String capacityReservationGroupName)

The operation to delete a capacity reservation group.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String capacityReservationGroupName, Context context)

The operation to delete a capacity reservation group.

abstract Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String capacityReservationGroupName)

The operation to delete a capacity reservation group.

abstract CapacityReservationGroupInner getByResourceGroup(String resourceGroupName, String capacityReservationGroupName)

The operation that retrieves information about a capacity reservation group.

abstract Mono<CapacityReservationGroupInner> getByResourceGroupAsync(String resourceGroupName, String capacityReservationGroupName)

The operation that retrieves information about a capacity reservation group.

abstract Response<CapacityReservationGroupInner> getByResourceGroupWithResponse(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInstanceViewTypes expand, Context context)

The operation that retrieves information about a capacity reservation group.

abstract Mono<Response<CapacityReservationGroupInner>> getByResourceGroupWithResponseAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInstanceViewTypes expand)

The operation that retrieves information about a capacity reservation group.

abstract PagedIterable<CapacityReservationGroupInner> list()

Lists all of the capacity reservation groups in the subscription.

abstract PagedIterable<CapacityReservationGroupInner> list(ExpandTypesForGetCapacityReservationGroups expand, ResourceIdOptionsForGetCapacityReservationGroups resourceIdsOnly, Context context)

Lists all of the capacity reservation groups in the subscription.

abstract PagedFlux<CapacityReservationGroupInner> listAsync()

Lists all of the capacity reservation groups in the subscription.

abstract PagedFlux<CapacityReservationGroupInner> listAsync(ExpandTypesForGetCapacityReservationGroups expand, ResourceIdOptionsForGetCapacityReservationGroups resourceIdsOnly)

Lists all of the capacity reservation groups in the subscription.

abstract PagedIterable<CapacityReservationGroupInner> listByResourceGroup(String resourceGroupName)

Lists all of the capacity reservation groups in the specified resource group.

abstract PagedIterable<CapacityReservationGroupInner> listByResourceGroup(String resourceGroupName, ExpandTypesForGetCapacityReservationGroups expand, Context context)

Lists all of the capacity reservation groups in the specified resource group.

abstract PagedFlux<CapacityReservationGroupInner> listByResourceGroupAsync(String resourceGroupName)

Lists all of the capacity reservation groups in the specified resource group.

abstract PagedFlux<CapacityReservationGroupInner> listByResourceGroupAsync(String resourceGroupName, ExpandTypesForGetCapacityReservationGroups expand)

Lists all of the capacity reservation groups in the specified resource group.

abstract CapacityReservationGroupInner update(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupUpdate parameters)

The operation to update a capacity reservation group.

abstract Mono<CapacityReservationGroupInner> updateAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupUpdate parameters)

The operation to update a capacity reservation group.

abstract Response<CapacityReservationGroupInner> updateWithResponse(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupUpdate parameters, Context context)

The operation to update a capacity reservation group.

abstract Mono<Response<CapacityReservationGroupInner>> updateWithResponseAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupUpdate parameters)

The operation to update a capacity reservation group.

Method Details

createOrUpdate

public abstract CapacityReservationGroupInner createOrUpdate(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInner parameters)

The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
parameters - Parameters supplied to the Create capacity reservation Group.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to.

createOrUpdateAsync

public abstract Mono createOrUpdateAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInner parameters)

The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
parameters - Parameters supplied to the Create capacity reservation Group.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to on successful completion of Mono.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInner parameters, Context context)

The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
parameters - Parameters supplied to the Create capacity reservation Group.
context - The context to associate with this operation.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to along with Response<T>.

createOrUpdateWithResponseAsync

public abstract Mono> createOrUpdateWithResponseAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInner parameters)

The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
parameters - Parameters supplied to the Create capacity reservation Group.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to along with Response<T> on successful completion of Mono.

delete

public abstract void delete(String resourceGroupName, String capacityReservationGroupName)

The operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.

deleteAsync

public abstract Mono deleteAsync(String resourceGroupName, String capacityReservationGroupName)

The operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.

Returns:

A Mono that completes when a successful response is received.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String capacityReservationGroupName, Context context)

The operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
context - The context to associate with this operation.

Returns:

deleteWithResponseAsync

public abstract Mono> deleteWithResponseAsync(String resourceGroupName, String capacityReservationGroupName)

The operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.

Returns:

the Response<T> on successful completion of Mono.

getByResourceGroup

public abstract CapacityReservationGroupInner getByResourceGroup(String resourceGroupName, String capacityReservationGroupName)

The operation that retrieves information about a capacity reservation group.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to.

getByResourceGroupAsync

public abstract Mono getByResourceGroupAsync(String resourceGroupName, String capacityReservationGroupName)

The operation that retrieves information about a capacity reservation group.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to on successful completion of Mono.

getByResourceGroupWithResponse

public abstract Response getByResourceGroupWithResponse(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInstanceViewTypes expand, Context context)

The operation that retrieves information about a capacity reservation group.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
expand - The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.
context - The context to associate with this operation.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to along with Response<T>.

getByResourceGroupWithResponseAsync

public abstract Mono> getByResourceGroupWithResponseAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInstanceViewTypes expand)

The operation that retrieves information about a capacity reservation group.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
expand - The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable list()

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

Returns:

the List capacity reservation group with resource group response as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(ExpandTypesForGetCapacityReservationGroups expand, ResourceIdOptionsForGetCapacityReservationGroups resourceIdsOnly, Context context)

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

Parameters:

expand - The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.
resourceIdsOnly - The query option to fetch Capacity Reservation Group Resource Ids. <br> 'CreatedInSubscription' enables fetching Resource Ids for all capacity reservation group resources created in the subscription. <br> 'SharedWithSubscription' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription. <br> 'All' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription and created in the subscription.
context - The context to associate with this operation.

Returns:

the List capacity reservation group with resource group response as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync()

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

Returns:

the List capacity reservation group with resource group response as paginated response with PagedFlux<T>.

listAsync

public abstract PagedFlux listAsync(ExpandTypesForGetCapacityReservationGroups expand, ResourceIdOptionsForGetCapacityReservationGroups resourceIdsOnly)

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

Parameters:

expand - The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.
resourceIdsOnly - The query option to fetch Capacity Reservation Group Resource Ids. <br> 'CreatedInSubscription' enables fetching Resource Ids for all capacity reservation group resources created in the subscription. <br> 'SharedWithSubscription' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription. <br> 'All' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription and created in the subscription.

Returns:

the List capacity reservation group with resource group response as paginated response with PagedFlux<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

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

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the List capacity reservation group with resource group response as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, ExpandTypesForGetCapacityReservationGroups expand, Context context)

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

Parameters:

resourceGroupName - The name of the resource group.
expand - The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.
context - The context to associate with this operation.

Returns:

the List capacity reservation group with resource group response as paginated response with PagedIterable<T>.

listByResourceGroupAsync

public abstract PagedFlux listByResourceGroupAsync(String resourceGroupName)

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

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the List capacity reservation group with resource group response as paginated response with PagedFlux<T>.

listByResourceGroupAsync

public abstract PagedFlux listByResourceGroupAsync(String resourceGroupName, ExpandTypesForGetCapacityReservationGroups expand)

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

Parameters:

resourceGroupName - The name of the resource group.
expand - The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.

Returns:

the List capacity reservation group with resource group response as paginated response with PagedFlux<T>.

update

public abstract CapacityReservationGroupInner update(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupUpdate parameters)

The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
parameters - Parameters supplied to the Update capacity reservation Group operation.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to.

updateAsync

public abstract Mono updateAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupUpdate parameters)

The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
parameters - Parameters supplied to the Update capacity reservation Group operation.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to on successful completion of Mono.

updateWithResponse

public abstract Response updateWithResponse(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupUpdate parameters, Context context)

The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
parameters - Parameters supplied to the Update capacity reservation Group operation.
context - The context to associate with this operation.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to along with Response<T>.

updateWithResponseAsync

public abstract Mono> updateWithResponseAsync(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupUpdate parameters)

The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.

Parameters:

resourceGroupName - The name of the resource group.
capacityReservationGroupName - The name of the capacity reservation group.
parameters - Parameters supplied to the Update capacity reservation Group operation.

Returns:

specifies information about the capacity reservation group that the capacity reservations should be assigned to along with Response<T> on successful completion of Mono.

Applies to