Interface Artifacts


public interface Artifacts
Resource collection API of Artifacts.
  • Method Details

    • list

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

      Artifact get(String resourceGroupName, String labName, String artifactSourceName, String name)
      Get artifact.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      artifactSourceName - The name of the artifact source.
      name - The name of the artifact.
      Returns:
      artifact.
      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.
    • generateArmTemplateWithResponse

      com.azure.core.http.rest.Response<ArmTemplateInfo> generateArmTemplateWithResponse(String resourceGroupName, String labName, String artifactSourceName, String name, GenerateArmTemplateRequest generateArmTemplateRequest, com.azure.core.util.Context context)
      Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      artifactSourceName - The name of the artifact source.
      name - The name of the artifact.
      generateArmTemplateRequest - Parameters for generating an ARM template for deploying artifacts.
      context - The context to associate with this operation.
      Returns:
      information about a generated ARM template 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.
    • generateArmTemplate

      ArmTemplateInfo generateArmTemplate(String resourceGroupName, String labName, String artifactSourceName, String name, GenerateArmTemplateRequest generateArmTemplateRequest)
      Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      artifactSourceName - The name of the artifact source.
      name - The name of the artifact.
      generateArmTemplateRequest - Parameters for generating an ARM template for deploying artifacts.
      Returns:
      information about a generated ARM template.
      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.