Interface CapacityReservationGroupsClient

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsDelete<Void>, com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsGet<CapacityReservationGroupInner>, com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsListing<CapacityReservationGroupInner>
public interface CapacityReservationGroupsClient extends com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsGet<CapacityReservationGroupInner>, com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsListing<CapacityReservationGroupInner>, com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsDelete<Void>
An instance of this class provides access to all the operations defined in CapacityReservationGroupsClient.

  • Method Details

    • listAsync

      com.azure.core.http.rest.PagedFlux<CapacityReservationGroupInner> 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.
      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<CapacityReservationGroupInner> 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.
      Specified by:
      listAsync in interface com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsListing<CapacityReservationGroupInner>
      Returns:
      the List capacity reservation 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<CapacityReservationGroupInner> 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.
      Specified by:
      list in interface com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsListing<CapacityReservationGroupInner>
      Returns:
      the List capacity reservation 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<CapacityReservationGroupInner> list(ExpandTypesForGetCapacityReservationGroups expand, ResourceIdOptionsForGetCapacityReservationGroups resourceIdsOnly, com.azure.core.util.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.
      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<CapacityReservationGroupInner> 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. The name is case insensitive.
      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.
      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<CapacityReservationGroupInner> 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.
      Specified by:
      listByResourceGroupAsync in interface com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsListing<CapacityReservationGroupInner>
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      the List capacity reservation 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<CapacityReservationGroupInner> 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.
      Specified by:
      listByResourceGroup in interface com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsListing<CapacityReservationGroupInner>
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      the List capacity reservation 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<CapacityReservationGroupInner> listByResourceGroup(String resourceGroupName, ExpandTypesForGetCapacityReservationGroups expand, com.azure.core.util.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. The name is case insensitive.
      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.
      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<CapacityReservationGroupInner>> 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. The name is case insensitive.
      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 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<CapacityReservationGroupInner> getByResourceGroupAsync(String resourceGroupName, String capacityReservationGroupName)
      The operation that retrieves information about a capacity reservation group.
      Specified by:
      getByResourceGroupAsync in interface com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsGet<CapacityReservationGroupInner>
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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.
      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<CapacityReservationGroupInner> getByResourceGroupWithResponse(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInstanceViewTypes expand, com.azure.core.util.Context context)
      The operation that retrieves information about a capacity reservation group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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.
      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

      CapacityReservationGroupInner getByResourceGroup(String resourceGroupName, String capacityReservationGroupName)
      The operation that retrieves information about a capacity reservation group.
      Specified by:
      getByResourceGroup in interface com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsGet<CapacityReservationGroupInner>
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      capacityReservationGroupName - The name of the capacity reservation group.
      Returns:
      specifies information about the capacity reservation group that the capacity reservations 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.

    • createOrUpdateWithResponseAsync

      Mono<com.azure.core.http.rest.Response<CapacityReservationGroupInner>> 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. The name is case insensitive.
      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 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<CapacityReservationGroupInner> 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. The name is case insensitive.
      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.
      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<CapacityReservationGroupInner> createOrUpdateWithResponse(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupInner parameters, com.azure.core.util.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. The name is case insensitive.
      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.
      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

      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. The name is case insensitive.
      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.
      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<CapacityReservationGroupInner>> 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. The name is case insensitive.
      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 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<CapacityReservationGroupInner> 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. The name is case insensitive.
      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.
      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<CapacityReservationGroupInner> updateWithResponse(String resourceGroupName, String capacityReservationGroupName, CapacityReservationGroupUpdate parameters, com.azure.core.util.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. The name is case insensitive.
      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.
      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

      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. The name is case insensitive.
      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.
      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 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. The name is case insensitive.
      capacityReservationGroupName - The name of the capacity reservation 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 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.
      Specified by:
      deleteAsync in interface com.azure.resourcemanager.resources.fluentcore.collection.InnerSupportsDelete<Void>
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      capacityReservationGroupName - The name of the capacity reservation 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.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String capacityReservationGroupName, com.azure.core.util.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. The name is case insensitive.
      capacityReservationGroupName - The name of the capacity reservation 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.

    • delete

      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. The name is case insensitive.
      capacityReservationGroupName - The name of the capacity reservation 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.