Artifacts Interface

public interface Artifacts

Resource collection API of Artifacts.

Method Summary

Modifier and Type Method and Description
abstract 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.

abstract Response<ArmTemplateInfo> generateArmTemplateWithResponse(String resourceGroupName, String labName, String artifactSourceName, String name, GenerateArmTemplateRequest generateArmTemplateRequest, Context context)

Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.

abstract Artifact get(String resourceGroupName, String labName, String artifactSourceName, String name)

Get artifact.

abstract Response<Artifact> getWithResponse(String resourceGroupName, String labName, String artifactSourceName, String name, String expand, Context context)

Get artifact.

abstract PagedIterable<Artifact> list(String resourceGroupName, String labName, String artifactSourceName)

List artifacts in a given artifact source.

abstract PagedIterable<Artifact> list(String resourceGroupName, String labName, String artifactSourceName, String expand, String filter, Integer top, String orderby, Context context)

List artifacts in a given artifact source.

Method Details

generateArmTemplate

public abstract 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. The name is case insensitive.
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.

generateArmTemplateWithResponse

public abstract Response<ArmTemplateInfo> generateArmTemplateWithResponse(String resourceGroupName, String labName, String artifactSourceName, String name, GenerateArmTemplateRequest generateArmTemplateRequest, 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. The name is case insensitive.
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<T>.

get

public abstract Artifact get(String resourceGroupName, String labName, String artifactSourceName, String name)

Get artifact.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
artifactSourceName - The name of the artifact source.
name - The name of the artifact.

Returns:

artifact.

getWithResponse

public abstract Response<Artifact> getWithResponse(String resourceGroupName, String labName, String artifactSourceName, String name, String expand, Context context)

Get artifact.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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<T>.

list

public abstract PagedIterable<Artifact> list(String resourceGroupName, String labName, String artifactSourceName)

List artifacts in a given artifact source.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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<T>.

list

public abstract PagedIterable<Artifact> list(String resourceGroupName, String labName, String artifactSourceName, String expand, String filter, Integer top, String orderby, Context context)

List artifacts in a given artifact source.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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<T>.

Applies to