Package com.azure.resourcemanager.devtestlabs.models

Interface GlobalSchedules

public interface GlobalSchedules
Resource collection API of GlobalSchedules.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<Schedule> list()
      List schedules in a subscription.
      Returns:
      the response of a list operation 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.

    • list

      com.azure.core.http.rest.PagedIterable<Schedule> list(String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context)
      List schedules in a subscription.
      Parameters:
      expand - Specify the $expand query. Example: 'properties($select=status)'.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Schedule> listByResourceGroup(String resourceGroupName)
      List schedules in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Schedule> listByResourceGroup(String resourceGroupName, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context)
      List schedules in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group.
      expand - Specify the $expand query. Example: 'properties($select=status)'.
      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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Schedule> getByResourceGroupWithResponse(String resourceGroupName, String name, String expand, com.azure.core.util.Context context)
      Get schedule.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the schedule.
      expand - Specify the $expand query. Example: 'properties($select=status)'.
      context - The context to associate with this operation.
      Returns:
      schedule 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.

    • getByResourceGroup

      Schedule getByResourceGroup(String resourceGroupName, String name)
      Get schedule.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the schedule.
      Returns:
      schedule.
      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.

    • deleteByResourceGroupWithResponse

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

    • deleteByResourceGroup

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

    • execute

      void execute(String resourceGroupName, String name)
      Execute a schedule. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the schedule.
      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.

    • execute

      void execute(String resourceGroupName, String name, com.azure.core.util.Context context)
      Execute a schedule. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the schedule.
      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.

    • retarget

      void retarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties)
      Updates a schedule's target resource Id. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the schedule.
      retargetScheduleProperties - Properties for retargeting a virtual machine schedule.
      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.

    • retarget

      void retarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties, com.azure.core.util.Context context)
      Updates a schedule's target resource Id. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the schedule.
      retargetScheduleProperties - Properties for retargeting a virtual machine schedule.
      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)
      Get schedule.
      Parameters:
      id - the resource ID.
      Returns:
      schedule 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, String expand, com.azure.core.util.Context context)
      Get schedule.
      Parameters:
      id - the resource ID.
      expand - Specify the $expand query. Example: 'properties($select=status)'.
      context - The context to associate with this operation.
      Returns:
      schedule 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)
      Delete schedule.
      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

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete schedule.
      Parameters:
      id - the resource ID.
      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.

    • define

      Schedule.DefinitionStages.Blank define(String name)
      Begins definition for a new Schedule resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Schedule definition.