Share via


ApplicationPackages Interface

public interface ApplicationPackages

Resource collection API of ApplicationPackages.

Method Summary

Modifier and Type Method and Description
abstract ApplicationPackage activate(String resourceGroupName, String accountName, String applicationName, String versionName, ActivateApplicationPackageParameters parameters)

Activates the specified application package.

abstract Response<ApplicationPackage> activateWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, ActivateApplicationPackageParameters parameters, Context context)

Activates the specified application package.

abstract Blank define(String name)

Begins definition for a new ApplicationPackage resource.

abstract void delete(String resourceGroupName, String accountName, String applicationName, String versionName)

Deletes an application package record and its associated binary file.

abstract void deleteById(String id)

Deletes an application package record and its associated binary file.

abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Deletes an application package record and its associated binary file.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, Context context)

Deletes an application package record and its associated binary file.

abstract ApplicationPackage get(String resourceGroupName, String accountName, String applicationName, String versionName)

Gets information about the specified application package.

abstract ApplicationPackage getById(String id)

Gets information about the specified application package.

abstract Response<ApplicationPackage> getByIdWithResponse(String id, Context context)

Gets information about the specified application package.

abstract Response<ApplicationPackage> getWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, Context context)

Gets information about the specified application package.

abstract PagedIterable<ApplicationPackage> list(String resourceGroupName, String accountName, String applicationName)

Lists all of the application packages in the specified application.

abstract PagedIterable<ApplicationPackage> list(String resourceGroupName, String accountName, String applicationName, Integer maxresults, Context context)

Lists all of the application packages in the specified application.

Method Details

activate

public abstract ApplicationPackage activate(String resourceGroupName, String accountName, String applicationName, String versionName, ActivateApplicationPackageParameters parameters)

Activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
applicationName - The name of the application. This must be unique within the account.
versionName - The version of the application.
parameters - The parameters for the request.

Returns:

an application package which represents a particular version of an application.

activateWithResponse

public abstract Response<ApplicationPackage> activateWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, ActivateApplicationPackageParameters parameters, Context context)

Activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
applicationName - The name of the application. This must be unique within the account.
versionName - The version of the application.
parameters - The parameters for the request.
context - The context to associate with this operation.

Returns:

an application package which represents a particular version of an application along with Response<T>.

define

public abstract ApplicationPackage.DefinitionStages.Blank define(String name)

Begins definition for a new ApplicationPackage resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ApplicationPackage definition.

delete

public abstract void delete(String resourceGroupName, String accountName, String applicationName, String versionName)

Deletes an application package record and its associated binary file.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
applicationName - The name of the application. This must be unique within the account.
versionName - The version of the application.

deleteById

public abstract void deleteById(String id)

Deletes an application package record and its associated binary file.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Deletes an application package record and its associated binary file.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, Context context)

Deletes an application package record and its associated binary file.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
applicationName - The name of the application. This must be unique within the account.
versionName - The version of the application.
context - The context to associate with this operation.

Returns:

get

public abstract ApplicationPackage get(String resourceGroupName, String accountName, String applicationName, String versionName)

Gets information about the specified application package.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
applicationName - The name of the application. This must be unique within the account.
versionName - The version of the application.

Returns:

information about the specified application package.

getById

public abstract ApplicationPackage getById(String id)

Gets information about the specified application package.

Parameters:

id - the resource ID.

Returns:

information about the specified application package along with Response<T>.

getByIdWithResponse

public abstract Response<ApplicationPackage> getByIdWithResponse(String id, Context context)

Gets information about the specified application package.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

information about the specified application package along with Response<T>.

getWithResponse

public abstract Response<ApplicationPackage> getWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, Context context)

Gets information about the specified application package.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
applicationName - The name of the application. This must be unique within the account.
versionName - The version of the application.
context - The context to associate with this operation.

Returns:

information about the specified application package along with Response<T>.

list

public abstract PagedIterable<ApplicationPackage> list(String resourceGroupName, String accountName, String applicationName)

Lists all of the application packages in the specified application.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
applicationName - The name of the application. This must be unique within the account.

Returns:

the result of performing list application packages as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ApplicationPackage> list(String resourceGroupName, String accountName, String applicationName, Integer maxresults, Context context)

Lists all of the application packages in the specified application.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
applicationName - The name of the application. This must be unique within the account.
maxresults - The maximum number of items to return in the response.
context - The context to associate with this operation.

Returns:

the result of performing list application packages as paginated response with PagedIterable<T>.

Applies to