Package com.azure.resourcemanager.devtestlabs.fluent

Interface EnvironmentsClient

public interface EnvironmentsClient
An instance of this class provides access to all the operations defined in EnvironmentsClient.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<DtlEnvironmentInner> list(String resourceGroupName, String labName, String username)
      List environments in a given user profile.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      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<DtlEnvironmentInner> list(String resourceGroupName, String labName, String username, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context)
      List environments in a given user profile.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      expand - Specify the $expand query. Example: 'properties($select=deploymentProperties)'.
      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<DtlEnvironmentInner> getWithResponse(String resourceGroupName, String labName, String username, String name, String expand, com.azure.core.util.Context context)
      Get environment.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      expand - Specify the $expand query. Example: 'properties($select=deploymentProperties)'.
      context - The context to associate with this operation.
      Returns:
      environment 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

      DtlEnvironmentInner get(String resourceGroupName, String labName, String username, String name)
      Get environment.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      Returns:
      environment.
      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<DtlEnvironmentInner>,DtlEnvironmentInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, DtlEnvironmentInner dtlEnvironment)
      Create or replace an existing environment. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      dtlEnvironment - An environment, which is essentially an ARM template deployment.
      Returns:
      the SyncPoller for polling of an environment, which is essentially an ARM template deployment.
      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<DtlEnvironmentInner>,DtlEnvironmentInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, DtlEnvironmentInner dtlEnvironment, com.azure.core.util.Context context)
      Create or replace an existing environment. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      dtlEnvironment - An environment, which is essentially an ARM template deployment.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of an environment, which is essentially an ARM template deployment.
      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

      DtlEnvironmentInner createOrUpdate(String resourceGroupName, String labName, String username, String name, DtlEnvironmentInner dtlEnvironment)
      Create or replace an existing environment. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      dtlEnvironment - An environment, which is essentially an ARM template deployment.
      Returns:
      an environment, which is essentially an ARM template deployment.
      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

      DtlEnvironmentInner createOrUpdate(String resourceGroupName, String labName, String username, String name, DtlEnvironmentInner dtlEnvironment, com.azure.core.util.Context context)
      Create or replace an existing environment. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      dtlEnvironment - An environment, which is essentially an ARM template deployment.
      context - The context to associate with this operation.
      Returns:
      an environment, which is essentially an ARM template deployment.
      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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String username, String name)
      Delete environment. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      Returns:
      the SyncPoller for polling of long-running 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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String username, String name, com.azure.core.util.Context context)
      Delete environment. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running 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 labName, String username, String name)
      Delete environment. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      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 username, String name, com.azure.core.util.Context context)
      Delete environment. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      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.

    • updateWithResponse

      com.azure.core.http.rest.Response<DtlEnvironmentInner> updateWithResponse(String resourceGroupName, String labName, String username, String name, DtlEnvironmentFragment dtlEnvironment, com.azure.core.util.Context context)
      Allows modifying tags of environments. All other properties will be ignored.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      dtlEnvironment - An environment, which is essentially an ARM template deployment.
      context - The context to associate with this operation.
      Returns:
      an environment, which is essentially an ARM template deployment 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

      DtlEnvironmentInner update(String resourceGroupName, String labName, String username, String name, DtlEnvironmentFragment dtlEnvironment)
      Allows modifying tags of environments. All other properties will be ignored.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the environment.
      dtlEnvironment - An environment, which is essentially an ARM template deployment.
      Returns:
      an environment, which is essentially an ARM template deployment.
      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.