ApplicationOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BatchManagementClient's

<xref:application> attribute.

Constructor

ApplicationOperations(*args, **kwargs)

Methods

create	Adds an application to the specified Batch account.
delete	Deletes an application.
get	Gets information about the specified application.
list	Lists all of the applications in the specified account.
update	Updates settings for the specified application.

create

Adds an application to the specified Batch account.

async create(resource_group_name: str, account_name: str, application_name: str, parameters: _models.Application | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Application

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. Required.
application_name Required	str The name of the application. This must be unique within the account. Required.
parameters	Application or <xref:JSON> or IO[bytes] The parameters for the request. Is one of the following types: Application, JSON, IO[bytes] Default value is None. Default value: None

Returns

Type	Description
Application	Application. The Application is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Deletes an application.

async delete(resource_group_name: str, account_name: str, application_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. Required.
application_name Required	str The name of the application. This must be unique within the account. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Gets information about the specified application.

async get(resource_group_name: str, account_name: str, application_name: str, **kwargs: Any) -> Application

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. Required.
application_name Required	str The name of the application. This must be unique within the account. Required.

Returns

Type	Description
Application	Application. The Application is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Lists all of the applications in the specified account.

list(resource_group_name: str, account_name: str, *, maxresults: int | None = None, **kwargs: Any) -> AsyncItemPaged[Application]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. Required.

Keyword-Only Parameters

Name	Description
maxresults	int The maximum number of items to return in the response. Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[Application]	An iterator like instance of Application

Exceptions

Type	Description
HttpResponseError

update

Updates settings for the specified application.

async update(resource_group_name: str, account_name: str, application_name: str, parameters: _models.Application, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Application

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. Required.
application_name Required	str The name of the application. This must be unique within the account. Required.
parameters Required	Application or <xref:JSON> or IO[bytes] The parameters for the request. Is one of the following types: Application, JSON, IO[bytes] Required.

Returns

Type	Description
Application	Application. The Application is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError