Package com.azure.resourcemanager.labservices.models

Interface Labs

  • public interface Labs
    Resource collection API of Labs.

    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<Lab> list()
        Returns a list of all labs for a subscription.
        Returns:
        paged list of labs.
        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<Lab> list​(String filter,
                                                 com.azure.core.util.Context context)
        Returns a list of all labs for a subscription.
        Parameters:
        filter - The filter to apply to the operation.
        context - The context to associate with this operation.
        Returns:
        paged list of labs.
        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<Lab> listByResourceGroup​(String resourceGroupName)
        Returns a list of all labs in a resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        paged list of labs.
        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<Lab> listByResourceGroup​(String resourceGroupName,
                                                                com.azure.core.util.Context context)
        Returns a list of all labs in a resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        context - The context to associate with this operation.
        Returns:
        paged list of labs.
        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

        Lab getByResourceGroup​(String resourceGroupName,
                       String labName)
        Returns the properties of a lab 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.
        Returns:
        the lab 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.

      • getByResourceGroupWithResponse

        com.azure.core.http.rest.Response<Lab> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                      String labName,
                                                                      com.azure.core.util.Context context)
        Returns the properties of a lab 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.
        context - The context to associate with this operation.
        Returns:
        the lab 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.

      • deleteByResourceGroup

        void deleteByResourceGroup​(String resourceGroupName,
                           String labName)
        Operation to delete a lab 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.
        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,
            com.azure.core.util.Context context)
        Operation to delete a lab 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.
        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.

      • publish

        void publish​(String resourceGroupName,
             String labName)
        Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.
        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.
        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.

      • publish

        void publish​(String resourceGroupName,
             String labName,
             com.azure.core.util.Context context)
        Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.
        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.
        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.

      • syncGroup

        void syncGroup​(String resourceGroupName,
               String labName)
        Action used to manually kick off an AAD group sync job.
        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.
        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.

      • syncGroup

        void syncGroup​(String resourceGroupName,
               String labName,
               com.azure.core.util.Context context)
        Action used to manually kick off an AAD group sync job.
        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.
        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

        Lab getById​(String id)
        Returns the properties of a lab resource.
        Parameters:
        id - the resource ID.
        Returns:
        the lab 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<Lab> getByIdWithResponse​(String id,
                                                           com.azure.core.util.Context context)
        Returns the properties of a lab resource.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the lab 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)
        Operation to delete a lab 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 lab 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

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