Package com.azure.resourcemanager.devtestlabs.fluent

Interface CustomImagesClient

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

  • Method Details

    • list

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

      CustomImageInner get(String resourceGroupName, String labName, String name)
      Get custom image.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      Returns:
      custom image.
      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<CustomImageInner>,CustomImageInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage)
      Create or replace an existing custom image. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      customImage - A custom image.
      Returns:
      the SyncPoller for polling of a custom image.
      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<CustomImageInner>,CustomImageInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage, com.azure.core.util.Context context)
      Create or replace an existing custom image. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      customImage - A custom image.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of a custom image.
      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

      CustomImageInner createOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage)
      Create or replace an existing custom image. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      customImage - A custom image.
      Returns:
      a custom image.
      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

      CustomImageInner createOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage, com.azure.core.util.Context context)
      Create or replace an existing custom image. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      customImage - A custom image.
      context - The context to associate with this operation.
      Returns:
      a custom image.
      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 name)
      Delete custom image. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      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 name, com.azure.core.util.Context context)
      Delete custom image. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      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 name)
      Delete custom image. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      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 name, com.azure.core.util.Context context)
      Delete custom image. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      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<CustomImageInner> updateWithResponse(String resourceGroupName, String labName, String name, CustomImageFragment customImage, com.azure.core.util.Context context)
      Allows modifying tags of custom images. All other properties will be ignored.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      customImage - A custom image.
      context - The context to associate with this operation.
      Returns:
      a custom image 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

      CustomImageInner update(String resourceGroupName, String labName, String name, CustomImageFragment customImage)
      Allows modifying tags of custom images. All other properties will be ignored.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the custom image.
      customImage - A custom image.
      Returns:
      a custom image.
      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.