Interface FormulasClient


public interface FormulasClient
An instance of this class provides access to all the operations defined in FormulasClient.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<FormulaInner> list(String resourceGroupName, String labName)
      List formulas in a given lab.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      Returns:
      the response of a list operation 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<FormulaInner> list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context)
      List formulas in a given lab.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      expand - Specify the $expand query. Example: 'properties($select=description)'.
      filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
      context - The context to associate with this operation.
      Returns:
      the response of a list operation 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<FormulaInner> getWithResponse(String resourceGroupName, String labName, String name, String expand, com.azure.core.util.Context context)
      Get formula.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      expand - Specify the $expand query. Example: 'properties($select=description)'.
      context - The context to associate with this operation.
      Returns:
      formula 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

      FormulaInner get(String resourceGroupName, String labName, String name)
      Get formula.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      Returns:
      formula.
      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.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<FormulaInner>,FormulaInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, FormulaInner formula)
      Create or replace an existing formula. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      formula - A formula for creating a VM, specifying an image base and other parameters.
      Returns:
      the SyncPoller for polling of a formula for creating a VM, specifying an image base and other parameters.
      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.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<FormulaInner>,FormulaInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, FormulaInner formula, com.azure.core.util.Context context)
      Create or replace an existing formula. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      formula - A formula for creating a VM, specifying an image base and other parameters.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of a formula for creating a VM, specifying an image base and other parameters.
      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.
    • createOrUpdate

      FormulaInner createOrUpdate(String resourceGroupName, String labName, String name, FormulaInner formula)
      Create or replace an existing formula. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      formula - A formula for creating a VM, specifying an image base and other parameters.
      Returns:
      a formula for creating a VM, specifying an image base and other parameters.
      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.
    • createOrUpdate

      FormulaInner createOrUpdate(String resourceGroupName, String labName, String name, FormulaInner formula, com.azure.core.util.Context context)
      Create or replace an existing formula. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      formula - A formula for creating a VM, specifying an image base and other parameters.
      context - The context to associate with this operation.
      Returns:
      a formula for creating a VM, specifying an image base and other parameters.
      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.
    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String labName, String name, com.azure.core.util.Context context)
      Delete formula.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      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.
    • delete

      void delete(String resourceGroupName, String labName, String name)
      Delete formula.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      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

      com.azure.core.http.rest.Response<FormulaInner> updateWithResponse(String resourceGroupName, String labName, String name, FormulaFragment formula, com.azure.core.util.Context context)
      Allows modifying tags of formulas. All other properties will be ignored.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      formula - A formula for creating a VM, specifying an image base and other parameters.
      context - The context to associate with this operation.
      Returns:
      a formula for creating a VM, specifying an image base and other parameters 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.
    • update

      FormulaInner update(String resourceGroupName, String labName, String name, FormulaFragment formula)
      Allows modifying tags of formulas. All other properties will be ignored.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the formula.
      formula - A formula for creating a VM, specifying an image base and other parameters.
      Returns:
      a formula for creating a VM, specifying an image base and other parameters.
      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.