ApplicationPackagesClient Interface

public interface ApplicationPackagesClient

An instance of this class provides access to all the operations defined in ApplicationPackagesClient.

Method Summary

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

Activates the specified application package.

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

Activates the specified application package.

abstract ApplicationPackageInner create(String resourceGroupName, String accountName, String applicationName, String versionName)

Creates an application package record.

abstract Response<ApplicationPackageInner> createWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, ApplicationPackageInner parameters, Context context)

Creates an application package record.

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

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 ApplicationPackageInner get(String resourceGroupName, String accountName, String applicationName, String versionName)

Gets information about the specified application package.

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

Gets information about the specified application package.

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

Lists all of the application packages in the specified application.

abstract PagedIterable<ApplicationPackageInner> 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 ApplicationPackageInner 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 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>.

create

public abstract ApplicationPackageInner create(String resourceGroupName, String accountName, String applicationName, String versionName)

Creates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used. If the auto storage account was configured to use storage keys, the URL returned will contain a SAS.

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:

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

createWithResponse

public abstract Response createWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, ApplicationPackageInner parameters, Context context)

Creates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used. If the auto storage account was configured to use storage keys, the URL returned will contain a SAS.

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>.

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.

deleteWithResponse

public abstract Response 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 ApplicationPackageInner 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.

getWithResponse

public abstract Response 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 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 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