Package com.azure.resourcemanager.batch.models

Interface ApplicationPackages

public interface ApplicationPackages
Resource collection API of ApplicationPackages.

  • Method Details

    • activateWithResponse

      com.azure.core.http.rest.Response<ApplicationPackage> 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

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

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

    • getById

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

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ApplicationPackage> getByIdWithResponse(String id, com.azure.core.util.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.
      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.

    • deleteById

      void deleteById(String id)
      Deletes an application package record and its associated binary file.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.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:
      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.

    • define

      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.