Interface Schedules


public interface Schedules
Resource collection API of Schedules.
  • Method Details

    • listByPool

      com.azure.core.http.rest.PagedIterable<Schedule> listByPool(String resourceGroupName, String projectName, String poolName)
      Lists schedules for a pool.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      Returns:
      result of the schedule 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.
    • listByPool

      com.azure.core.http.rest.PagedIterable<Schedule> listByPool(String resourceGroupName, String projectName, String poolName, Integer top, com.azure.core.util.Context context)
      Lists schedules for a pool.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      context - The context to associate with this operation.
      Returns:
      result of the schedule 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.
    • get

      Schedule get(String resourceGroupName, String projectName, String poolName, String scheduleName)
      Gets a schedule resource.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      scheduleName - The name of the schedule that uniquely identifies it.
      Returns:
      a schedule resource.
      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<Schedule> getWithResponse(String resourceGroupName, String projectName, String poolName, String scheduleName, Integer top, com.azure.core.util.Context context)
      Gets a schedule resource.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      scheduleName - The name of the schedule that uniquely identifies it.
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      context - The context to associate with this operation.
      Returns:
      a schedule resource 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

      void update(String resourceGroupName, String projectName, String poolName, String scheduleName, ScheduleUpdate body, Integer top)
      Partially updates a Scheduled.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      scheduleName - The name of the schedule that uniquely identifies it.
      body - Represents a scheduled task.
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      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

      void update(String resourceGroupName, String projectName, String poolName, String scheduleName, ScheduleUpdate body)
      Partially updates a Scheduled.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      scheduleName - The name of the schedule that uniquely identifies it.
      body - Represents a scheduled task.
      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

      void update(String resourceGroupName, String projectName, String poolName, String scheduleName, ScheduleUpdate body, Integer top, com.azure.core.util.Context context)
      Partially updates a Scheduled.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      scheduleName - The name of the schedule that uniquely identifies it.
      body - Represents a scheduled task.
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      context - The context to associate with this operation.
      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 projectName, String poolName, String scheduleName, Integer top)
      Deletes a Scheduled.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      scheduleName - The name of the schedule that uniquely identifies it.
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      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 projectName, String poolName, String scheduleName)
      Deletes a Scheduled.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      scheduleName - The name of the schedule that uniquely identifies it.
      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 projectName, String poolName, String scheduleName, Integer top, com.azure.core.util.Context context)
      Deletes a Scheduled.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      poolName - Name of the pool.
      scheduleName - The name of the schedule that uniquely identifies it.
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      context - The context to associate with this operation.
      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.
    • getById

      Schedule getById(String id)
      Gets a schedule resource.
      Parameters:
      id - the resource ID.
      Returns:
      a schedule resource 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.
    • getByIdWithResponse

      com.azure.core.http.rest.Response<Schedule> getByIdWithResponse(String id, Integer top, com.azure.core.util.Context context)
      Gets a schedule resource.
      Parameters:
      id - the resource ID.
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      context - The context to associate with this operation.
      Returns:
      a schedule resource 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.
    • deleteById

      void deleteById(String id)
      Deletes a Scheduled.
      Parameters:
      id - the resource ID.
      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.
    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, Integer top, com.azure.core.util.Context context)
      Deletes a Scheduled.
      Parameters:
      id - the resource ID.
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      context - The context to associate with this operation.
      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.
    • define

      Begins definition for a new Schedule resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Schedule definition.