Interface SavingsPlansClient
public interface SavingsPlansClient
An instance of this class provides access to all the operations defined in SavingsPlansClient.
-
Method Summary
Modifier and TypeMethodDescriptionGet savings plan.com.azure.core.http.rest.Response<SavingsPlanModelInner>
getWithResponse
(String savingsPlanOrderId, String savingsPlanId, String expand, com.azure.core.util.Context context) Get savings plan.com.azure.core.http.rest.PagedIterable<SavingsPlanModelInner>
List savings plans in an order.com.azure.core.http.rest.PagedIterable<SavingsPlanModelInner>
List savings plans in an order.com.azure.core.http.rest.PagedIterable<SavingsPlanModelInner>
listAll()
List savings plans.com.azure.core.http.rest.PagedIterable<SavingsPlanModelInner>
listAll
(String filter, String orderby, String refreshSummary, Float skiptoken, String selectedState, Float take, com.azure.core.util.Context context) List savings plans.update
(String savingsPlanOrderId, String savingsPlanId, SavingsPlanUpdateRequest body) Update savings plan.updateWithResponse
(String savingsPlanOrderId, String savingsPlanId, SavingsPlanUpdateRequest body, com.azure.core.util.Context context) Update savings plan.validateUpdate
(String savingsPlanOrderId, String savingsPlanId, SavingsPlanUpdateValidateRequest body) Validate savings plan patch.com.azure.core.http.rest.Response<SavingsPlanValidateResponseInner>
validateUpdateWithResponse
(String savingsPlanOrderId, String savingsPlanId, SavingsPlanUpdateValidateRequest body, com.azure.core.util.Context context) Validate savings plan patch.
-
Method Details
-
list
List savings plans in an order.- Parameters:
savingsPlanOrderId
- Order ID of the savings plan.- Returns:
- the 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<SavingsPlanModelInner> list(String savingsPlanOrderId, com.azure.core.util.Context context) List savings plans in an order.- Parameters:
savingsPlanOrderId
- Order ID of the savings plan.context
- The context to associate with this operation.- Returns:
- the 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<SavingsPlanModelInner> listAll()List savings plans.- Returns:
- the 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<SavingsPlanModelInner> listAll(String filter, String orderby, String refreshSummary, Float skiptoken, String selectedState, Float take, com.azure.core.util.Context context) List savings plans.- 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, 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 savings plans group by provisioning states.skiptoken
- The number of savings plans to skip from the list before returning results.selectedState
- The selected provisioning state.take
- To number of savings plans to return.context
- The context to associate with this operation.- Returns:
- the 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<SavingsPlanModelInner> getWithResponse(String savingsPlanOrderId, String savingsPlanId, String expand, com.azure.core.util.Context context) Get savings plan.- Parameters:
savingsPlanOrderId
- Order ID of the savings plan.savingsPlanId
- ID of the savings plan.expand
- May be used to expand the detail information of some properties.context
- The context to associate with this operation.- Returns:
- savings plan 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
Get savings plan.- Parameters:
savingsPlanOrderId
- Order ID of the savings plan.savingsPlanId
- ID of the savings plan.- Returns:
- savings plan.
- 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.
-
updateWithResponse
SavingsPlansUpdateResponse updateWithResponse(String savingsPlanOrderId, String savingsPlanId, SavingsPlanUpdateRequest body, com.azure.core.util.Context context) Update savings plan.- Parameters:
savingsPlanOrderId
- Order ID of the savings plan.savingsPlanId
- ID of the savings plan.body
- Request body for patching a savings plan order alias.context
- The context to associate with this operation.- Returns:
- savings plan.
- 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
SavingsPlanModelInner update(String savingsPlanOrderId, String savingsPlanId, SavingsPlanUpdateRequest body) Update savings plan.- Parameters:
savingsPlanOrderId
- Order ID of the savings plan.savingsPlanId
- ID of the savings plan.body
- Request body for patching a savings plan order alias.- Returns:
- savings plan.
- 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.
-
validateUpdateWithResponse
com.azure.core.http.rest.Response<SavingsPlanValidateResponseInner> validateUpdateWithResponse(String savingsPlanOrderId, String savingsPlanId, SavingsPlanUpdateValidateRequest body, com.azure.core.util.Context context) Validate savings plan patch.- Parameters:
savingsPlanOrderId
- Order ID of the savings plan.savingsPlanId
- ID of the savings plan.body
- Request body for validating a savings plan patch request.context
- The context to associate with this operation.- Returns:
- the response body 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.
-
validateUpdate
SavingsPlanValidateResponseInner validateUpdate(String savingsPlanOrderId, String savingsPlanId, SavingsPlanUpdateValidateRequest body) Validate savings plan patch.- Parameters:
savingsPlanOrderId
- Order ID of the savings plan.savingsPlanId
- ID of the savings plan.body
- Request body for validating a savings plan patch request.- 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.
-