Interface ApplicationPackagesClient
public interface ApplicationPackagesClient
An instance of this class provides access to all the operations defined in ApplicationPackagesClient.
-
Method Summary
Modifier and TypeMethodDescriptionactivate
(String resourceGroupName, String accountName, String applicationName, String versionName, ActivateApplicationPackageParameters parameters) Activates the specified application package.com.azure.core.http.rest.Response<ApplicationPackageInner>
activateWithResponse
(String resourceGroupName, String accountName, String applicationName, String versionName, ActivateApplicationPackageParameters parameters, com.azure.core.util.Context context) Activates the specified application package.Creates an application package record.com.azure.core.http.rest.Response<ApplicationPackageInner>
createWithResponse
(String resourceGroupName, String accountName, String applicationName, String versionName, ApplicationPackageInner parameters, com.azure.core.util.Context context) Creates an application package record.void
Deletes an application package record and its associated binary file.com.azure.core.http.rest.Response<Void>
deleteWithResponse
(String resourceGroupName, String accountName, String applicationName, String versionName, com.azure.core.util.Context context) Deletes an application package record and its associated binary file.Gets information about the specified application package.com.azure.core.http.rest.Response<ApplicationPackageInner>
getWithResponse
(String resourceGroupName, String accountName, String applicationName, String versionName, com.azure.core.util.Context context) Gets information about the specified application package.com.azure.core.http.rest.PagedIterable<ApplicationPackageInner>
Lists all of the application packages in the specified application.com.azure.core.http.rest.PagedIterable<ApplicationPackageInner>
list
(String resourceGroupName, String accountName, String applicationName, Integer maxresults, com.azure.core.util.Context context) Lists all of the application packages in the specified application.
-
Method Details
-
activateWithResponse
com.azure.core.http.rest.Response<ApplicationPackageInner> activateWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, ActivateApplicationPackageParameters parameters, com.azure.core.util.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
. - 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.
-
activate
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.
- 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.
-
createWithResponse
com.azure.core.http.rest.Response<ApplicationPackageInner> createWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, ApplicationPackageInner parameters, com.azure.core.util.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
. - 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.
-
create
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.
- 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.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, com.azure.core.util.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:
- the
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.
-
delete
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.- 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<ApplicationPackageInner> getWithResponse(String resourceGroupName, String accountName, String applicationName, String versionName, com.azure.core.util.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
. - 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
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.
- 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<ApplicationPackageInner> 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
. - 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<ApplicationPackageInner> list(String resourceGroupName, String accountName, String applicationName, Integer maxresults, com.azure.core.util.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
. - 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.
-