Interface Schedules


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

      • listByLab

        com.azure.core.http.rest.PagedIterable<Schedule> listByLab​(String resourceGroupName,
                                                                   String labName)
        Returns a list of all schedules for a lab.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.
        Returns:
        paged list of schedules.
        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.
      • listByLab

        com.azure.core.http.rest.PagedIterable<Schedule> listByLab​(String resourceGroupName,
                                                                   String labName,
                                                                   String filter,
                                                                   com.azure.core.util.Context context)
        Returns a list of all schedules for a lab.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.
        filter - The filter to apply to the operation.
        context - The context to associate with this operation.
        Returns:
        paged list of schedules.
        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 labName,
                     String scheduleName)
        Returns the properties of a lab Schedule.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.
        scheduleName - The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
        Returns:
        schedule for automatically turning virtual machines in a lab on and off at specified times.
        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 labName,
                                                                    String scheduleName,
                                                                    com.azure.core.util.Context context)
        Returns the properties of a lab Schedule.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.
        scheduleName - The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
        context - The context to associate with this operation.
        Returns:
        schedule for automatically turning virtual machines in a lab on and off at specified times 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.
      • delete

        void delete​(String resourceGroupName,
                    String labName,
                    String scheduleName)
        Operation to delete a schedule resource.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.
        scheduleName - The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
        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 scheduleName,
                    com.azure.core.util.Context context)
        Operation to delete a schedule resource.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.
        scheduleName - The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
        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)
        Returns the properties of a lab Schedule.
        Parameters:
        id - the resource ID.
        Returns:
        schedule for automatically turning virtual machines in a lab on and off at specified times 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,
                                                                        com.azure.core.util.Context context)
        Returns the properties of a lab Schedule.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        schedule for automatically turning virtual machines in a lab on and off at specified times 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)
        Operation to delete a schedule resource.
        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,
                                    com.azure.core.util.Context context)
        Operation to delete a schedule resource.
        Parameters:
        id - the resource ID.
        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

        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.