Package com.azure.resourcemanager.reservations.fluent

Interface ReservationsClient

public interface ReservationsClient
An instance of this class provides access to all the operations defined in ReservationsClient.

  • Method Details

    • beginAvailableScopes

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AvailableScopePropertiesInner>,AvailableScopePropertiesInner> beginAvailableScopes(String reservationOrderId, String reservationId, AvailableScopeRequest body)
      Get Available Scopes for `Reservation`. Check whether the scopes from request is valid for `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      body - Scopes to be checked for eligibility.
      Returns:
      the SyncPoller for polling of the response of available scope api containing scopes and their eligibilities.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginAvailableScopes

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AvailableScopePropertiesInner>,AvailableScopePropertiesInner> beginAvailableScopes(String reservationOrderId, String reservationId, AvailableScopeRequest body, com.azure.core.util.Context context)
      Get Available Scopes for `Reservation`. Check whether the scopes from request is valid for `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      body - Scopes to be checked for eligibility.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of the response of available scope api containing scopes and their eligibilities.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • availableScopes

      AvailableScopePropertiesInner availableScopes(String reservationOrderId, String reservationId, AvailableScopeRequest body)
      Get Available Scopes for `Reservation`. Check whether the scopes from request is valid for `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      body - Scopes to be checked for eligibility.
      Returns:
      the response of available scope api containing scopes and their eligibilities.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • availableScopes

      AvailableScopePropertiesInner availableScopes(String reservationOrderId, String reservationId, AvailableScopeRequest body, com.azure.core.util.Context context)
      Get Available Scopes for `Reservation`. Check whether the scopes from request is valid for `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      body - Scopes to be checked for eligibility.
      context - The context to associate with this operation.
      Returns:
      the response of available scope api containing scopes and their eligibilities.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginSplit

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<List<ReservationResponseInner>>,List<ReservationResponseInner>> beginSplit(String reservationOrderId, SplitRequest body)
      Split the `Reservation`. Split a `Reservation` into two `Reservation`s with specified quantity distribution.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      body - Information needed to Split a reservation item.
      Returns:
      the SyncPoller for polling of array of ReservationResponse.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginSplit

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<List<ReservationResponseInner>>,List<ReservationResponseInner>> beginSplit(String reservationOrderId, SplitRequest body, com.azure.core.util.Context context)
      Split the `Reservation`. Split a `Reservation` into two `Reservation`s with specified quantity distribution.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      body - Information needed to Split a reservation item.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of array of ReservationResponse.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • split

      List<ReservationResponseInner> split(String reservationOrderId, SplitRequest body)
      Split the `Reservation`. Split a `Reservation` into two `Reservation`s with specified quantity distribution.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      body - Information needed to Split a reservation item.
      Returns:
      array of ReservationResponse.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • split

      List<ReservationResponseInner> split(String reservationOrderId, SplitRequest body, com.azure.core.util.Context context)
      Split the `Reservation`. Split a `Reservation` into two `Reservation`s with specified quantity distribution.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      body - Information needed to Split a reservation item.
      context - The context to associate with this operation.
      Returns:
      array of ReservationResponse.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginMerge

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<List<ReservationResponseInner>>,List<ReservationResponseInner>> beginMerge(String reservationOrderId, MergeRequest body)
      Merges two `Reservation`s. Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      body - Information needed for commercial request for a reservation.
      Returns:
      the SyncPoller for polling of array of ReservationResponse.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginMerge

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<List<ReservationResponseInner>>,List<ReservationResponseInner>> beginMerge(String reservationOrderId, MergeRequest body, com.azure.core.util.Context context)
      Merges two `Reservation`s. Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      body - Information needed for commercial request for a reservation.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of array of ReservationResponse.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • merge

      List<ReservationResponseInner> merge(String reservationOrderId, MergeRequest body)
      Merges two `Reservation`s. Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      body - Information needed for commercial request for a reservation.
      Returns:
      array of ReservationResponse.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • merge

      List<ReservationResponseInner> merge(String reservationOrderId, MergeRequest body, com.azure.core.util.Context context)
      Merges two `Reservation`s. Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      body - Information needed for commercial request for a reservation.
      context - The context to associate with this operation.
      Returns:
      array of ReservationResponse.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - 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<ReservationResponseInner> list(String reservationOrderId)
      Get `Reservation`s in a given reservation Order List `Reservation`s within a single `ReservationOrder`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      Returns:
      list of `Reservation`s as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - 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<ReservationResponseInner> list(String reservationOrderId, com.azure.core.util.Context context)
      Get `Reservation`s in a given reservation Order List `Reservation`s within a single `ReservationOrder`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      context - The context to associate with this operation.
      Returns:
      list of `Reservation`s as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<ReservationResponseInner> getWithResponse(String reservationOrderId, String reservationId, String expand, com.azure.core.util.Context context)
      Get `Reservation` details. Get specific `Reservation` details.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      expand - Supported value of this query is renewProperties.
      context - The context to associate with this operation.
      Returns:
      specific `Reservation` details along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      ReservationResponseInner get(String reservationOrderId, String reservationId)
      Get `Reservation` details. Get specific `Reservation` details.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      Returns:
      specific `Reservation` details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ReservationResponseInner>,ReservationResponseInner> beginUpdate(String reservationOrderId, String reservationId, PatchModel parameters)
      Updates a `Reservation`. Updates the applied scopes of the `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      parameters - Information needed to patch a reservation item.
      Returns:
      the SyncPoller for polling of the definition of the reservation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ReservationResponseInner>,ReservationResponseInner> beginUpdate(String reservationOrderId, String reservationId, PatchModel parameters, com.azure.core.util.Context context)
      Updates a `Reservation`. Updates the applied scopes of the `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      parameters - Information needed to patch a reservation item.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of the definition of the reservation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • update

      ReservationResponseInner update(String reservationOrderId, String reservationId, PatchModel parameters)
      Updates a `Reservation`. Updates the applied scopes of the `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      parameters - Information needed to patch a reservation item.
      Returns:
      the definition of the reservation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • update

      ReservationResponseInner update(String reservationOrderId, String reservationId, PatchModel parameters, com.azure.core.util.Context context)
      Updates a `Reservation`. Updates the applied scopes of the `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      parameters - Information needed to patch a reservation item.
      context - The context to associate with this operation.
      Returns:
      the definition of the reservation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • archiveWithResponse

      com.azure.core.http.rest.Response<Void> archiveWithResponse(String reservationOrderId, String reservationId, com.azure.core.util.Context context)
      Archive a `Reservation`. Archiving a `Reservation` moves it to `Archived` state.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • archive

      void archive(String reservationOrderId, String reservationId)
      Archive a `Reservation`. Archiving a `Reservation` moves it to `Archived` state.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • unarchiveWithResponse

      com.azure.core.http.rest.Response<Void> unarchiveWithResponse(String reservationOrderId, String reservationId, com.azure.core.util.Context context)
      Unarchive a `Reservation`. Restores a `Reservation` to the state it was before archiving.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • unarchive

      void unarchive(String reservationOrderId, String reservationId)
      Unarchive a `Reservation`. Restores a `Reservation` to the state it was before archiving.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listRevisions

      com.azure.core.http.rest.PagedIterable<ReservationResponseInner> listRevisions(String reservationOrderId, String reservationId)
      Get `Reservation` revisions. List of all the revisions for the `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      Returns:
      list of `Reservation`s as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listRevisions

      com.azure.core.http.rest.PagedIterable<ReservationResponseInner> listRevisions(String reservationOrderId, String reservationId, com.azure.core.util.Context context)
      Get `Reservation` revisions. List of all the revisions for the `Reservation`.
      Parameters:
      reservationOrderId - Order Id of the reservation.
      reservationId - Id of the reservation item.
      context - The context to associate with this operation.
      Returns:
      list of `Reservation`s as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listAll

      com.azure.core.http.rest.PagedIterable<ReservationResponseInner> listAll()
      List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.
      Returns:
      the list of reservations and summary of roll out count of reservations in each state as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listAll

      com.azure.core.http.rest.PagedIterable<ReservationResponseInner> listAll(String filter, String orderby, String refreshSummary, Float skiptoken, String selectedState, Float take, com.azure.core.util.Context context)
      List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.
      Parameters:
      filter - May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, expiryDateTime, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState}.
      orderby - May be used to sort order by reservation properties.
      refreshSummary - To indicate whether to refresh the roll up counts of the reservations group by provisioning states.
      skiptoken - The number of reservations to skip from the list before returning results.
      selectedState - The selected provisioning state.
      take - To number of reservations to return.
      context - The context to associate with this operation.
      Returns:
      the list of reservations and summary of roll out count of reservations in each state as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.