ApplicationPackageOperations interface
Interface representing a ApplicationPackageOperations.
Methods
| activate(string, string, string, string, Activate |
Activates the specified application package. This should be done after the |
| create(string, string, string, string, Application |
Creates an application package record. The record contains a storageUrl where the package should be
uploaded to. Once it is uploaded the |
| delete(string, string, string, string, Application |
Deletes an application package record and its associated binary file. |
| get(string, string, string, string, Application |
Gets information about the specified application package. |
| list(string, string, string, Application |
Lists all of the application packages in the specified application. |
Method Details
activate(string, string, string, string, ActivateApplicationPackageParameters, ApplicationPackageActivateOptionalParams)
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.
function activate(resourceGroupName: string, accountName: string, applicationName: string, versionName: string, parameters: ActivateApplicationPackageParameters, options?: ApplicationPackageActivateOptionalParams): Promise<ApplicationPackage>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- applicationName
-
string
The name of the application. This must be unique within the account.
- versionName
-
string
The version of the application.
- parameters
- ActivateApplicationPackageParameters
The parameters for the request.
The options parameters.
Returns
Promise<ApplicationPackage>
create(string, string, string, string, ApplicationPackageCreateOptionalParams)
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.
function create(resourceGroupName: string, accountName: string, applicationName: string, versionName: string, options?: ApplicationPackageCreateOptionalParams): Promise<ApplicationPackage>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- applicationName
-
string
The name of the application. This must be unique within the account.
- versionName
-
string
The version of the application.
The options parameters.
Returns
Promise<ApplicationPackage>
delete(string, string, string, string, ApplicationPackageDeleteOptionalParams)
Deletes an application package record and its associated binary file.
function delete(resourceGroupName: string, accountName: string, applicationName: string, versionName: string, options?: ApplicationPackageDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- applicationName
-
string
The name of the application. This must be unique within the account.
- versionName
-
string
The version of the application.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, ApplicationPackageGetOptionalParams)
Gets information about the specified application package.
function get(resourceGroupName: string, accountName: string, applicationName: string, versionName: string, options?: ApplicationPackageGetOptionalParams): Promise<ApplicationPackage>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- applicationName
-
string
The name of the application. This must be unique within the account.
- versionName
-
string
The version of the application.
The options parameters.
Returns
Promise<ApplicationPackage>
list(string, string, string, ApplicationPackageListOptionalParams)
Lists all of the application packages in the specified application.
function list(resourceGroupName: string, accountName: string, applicationName: string, options?: ApplicationPackageListOptionalParams): PagedAsyncIterableIterator<ApplicationPackage, ApplicationPackage[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- applicationName
-
string
The name of the application. This must be unique within the account.
The options parameters.