azure.mgmt.batch.operations module

class azure.mgmt.batch.operations.BatchAccountOperations(client, config, serializer, deserializer)[source]

Bases: object

BatchAccountOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-05-01”.

create(resource_group_name, account_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (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/.

  • parameters (BatchAccountCreateParameters) – Additional parameters for account creation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns BatchAccount or ClientRawResponse<BatchAccount> if raw==True

Return type

AzureOperationPoller[BatchAccount] or AzureOperationPoller[ClientRawResponse[BatchAccount]]

Raises

CloudError

delete(resource_group_name, account_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes the specified Batch account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the specified Batch account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

BatchAccount or ClientRawResponse if raw=true

Return type

BatchAccount or ClientRawResponse

Raises

CloudError

get_keys(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the account keys for the specified Batch account.

This operation applies only to Batch accounts created with a poolAllocationMode of ‘BatchService’. If the Batch account was created with a poolAllocationMode of ‘UserSubscription’, clients cannot use access to keys to authenticate, and must use Azure Active Directory instead. In this case, getting the keys will fail.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

BatchAccountKeys or ClientRawResponse if raw=true

Return type

BatchAccountKeys or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Gets information about the Batch accounts associated with the subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of BatchAccount

Return type

BatchAccountPaged[BatchAccount]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the Batch accounts associated with the specified resource group.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of BatchAccount

Return type

BatchAccountPaged[BatchAccount]

Raises

CloudError

regenerate_key(resource_group_name, account_name, key_name, custom_headers=None, raw=False, **operation_config)[source]

Regenerates the specified account key for the Batch account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • key_name (str or AccountKeyType) – The type of account key to regenerate. Possible values include: ‘Primary’, ‘Secondary’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

BatchAccountKeys or ClientRawResponse if raw=true

Return type

BatchAccountKeys or ClientRawResponse

Raises

CloudError

synchronize_auto_storage_keys(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Synchronizes access keys for the auto-storage account configured for the specified Batch account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

update(resource_group_name, account_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Updates the properties of an existing Batch account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • parameters (BatchAccountUpdateParameters) – Additional parameters for account update.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

BatchAccount or ClientRawResponse if raw=true

Return type

BatchAccount or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.batch.models' from '/home/vsts/work/1/s/sdk/batch/azure-mgmt-batch/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batch/models/__init__.py'>
class azure.mgmt.batch.operations.ApplicationPackageOperations(client, config, serializer, deserializer)[source]

Bases: object

ApplicationPackageOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-05-01”.

activate(resource_group_name, account_name, application_name, version_name, format, custom_headers=None, raw=False, **operation_config)[source]

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

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • application_name (str) – The name of the application. This must be unique within the account.

  • version_name (str) – The version of the application.

  • format (str) – The format of the application package binary file.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationPackage or ClientRawResponse if raw=true

Return type

ApplicationPackage or ClientRawResponse

Raises

CloudError

create(resource_group_name, account_name, application_name, version_name, custom_headers=None, raw=False, **operation_config)[source]

Creates an application package record. The record contains the SAS where the package should be uploaded to. Once it is uploaded the ApplicationPackage needs to be activated using ApplicationPackageActive before it can be used.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • application_name (str) – The name of the application. This must be unique within the account.

  • version_name (str) – The version of the application.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationPackage or ClientRawResponse if raw=true

Return type

ApplicationPackage or ClientRawResponse

Raises

CloudError

delete(resource_group_name, account_name, application_name, version_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes an application package record and its associated binary file.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • application_name (str) – The name of the application. This must be unique within the account.

  • version_name (str) – The version of the application.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, account_name, application_name, version_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the specified application package.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • application_name (str) – The name of the application. This must be unique within the account.

  • version_name (str) – The version of the application.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationPackage or ClientRawResponse if raw=true

Return type

ApplicationPackage or ClientRawResponse

Raises

CloudError

list(resource_group_name, account_name, application_name, maxresults=None, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the application packages in the specified application.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • application_name (str) – The name of the application. This must be unique within the account.

  • maxresults (int) – The maximum number of items to return in the response.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ApplicationPackage

Return type

ApplicationPackagePaged[ApplicationPackage]

Raises

CloudError

models = <module 'azure.mgmt.batch.models' from '/home/vsts/work/1/s/sdk/batch/azure-mgmt-batch/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batch/models/__init__.py'>
class azure.mgmt.batch.operations.ApplicationOperations(client, config, serializer, deserializer)[source]

Bases: object

ApplicationOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-05-01”.

create(resource_group_name, account_name, application_name, parameters=None, custom_headers=None, raw=False, **operation_config)[source]

Adds an application to the specified Batch account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • application_name (str) – The name of the application. This must be unique within the account.

  • parameters (Application) – The parameters for the request.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Application or ClientRawResponse if raw=true

Return type

Application or ClientRawResponse

Raises

CloudError

delete(resource_group_name, account_name, application_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes an application.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • application_name (str) – The name of the application. This must be unique within the account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, account_name, application_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the specified application.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • application_name (str) – The name of the application. This must be unique within the account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Application or ClientRawResponse if raw=true

Return type

Application or ClientRawResponse

Raises

CloudError

list(resource_group_name, account_name, maxresults=None, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the applications in the specified account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • maxresults (int) – The maximum number of items to return in the response.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Application

Return type

ApplicationPaged[Application]

Raises

CloudError

update(resource_group_name, account_name, application_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Updates settings for the specified application.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • application_name (str) – The name of the application. This must be unique within the account.

  • parameters (Application) – The parameters for the request.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Application or ClientRawResponse if raw=true

Return type

Application or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.batch.models' from '/home/vsts/work/1/s/sdk/batch/azure-mgmt-batch/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batch/models/__init__.py'>
class azure.mgmt.batch.operations.LocationOperations(client, config, serializer, deserializer)[source]

Bases: object

LocationOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-05-01”.

check_name_availability(location_name, name, custom_headers=None, raw=False, **operation_config)[source]

Checks whether the Batch account name is available in the specified region.

Parameters

  • location_name (str) – The desired region for the name check.

  • name (str) – The name to check for availability

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CheckNameAvailabilityResult or ClientRawResponse if raw=true

Return type

CheckNameAvailabilityResult or ClientRawResponse

Raises

CloudError

get_quotas(location_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the Batch service quotas for the specified subscription at the given location.

Parameters

  • location_name (str) – The region for which to retrieve Batch service quotas.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

BatchLocationQuota or ClientRawResponse if raw=true

Return type

BatchLocationQuota or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.batch.models' from '/home/vsts/work/1/s/sdk/batch/azure-mgmt-batch/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batch/models/__init__.py'>
class azure.mgmt.batch.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-05-01”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists available operations for the Microsoft.Batch provider.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Operation

Return type

OperationPaged[Operation]

Raises

CloudError

models = <module 'azure.mgmt.batch.models' from '/home/vsts/work/1/s/sdk/batch/azure-mgmt-batch/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batch/models/__init__.py'>
class azure.mgmt.batch.operations.CertificateOperations(client, config, serializer, deserializer)[source]

Bases: object

CertificateOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-05-01”.

cancel_deletion(resource_group_name, account_name, certificate_name, custom_headers=None, raw=False, **operation_config)[source]

Cancels a failed deletion of a certificate from the specified account.

If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • certificate_name (str) – The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Certificate or ClientRawResponse if raw=true

Return type

Certificate or ClientRawResponse

Raises

CloudError

create(resource_group_name, account_name, certificate_name, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates a new certificate inside the specified account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • certificate_name (str) – The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.

  • parameters (CertificateCreateOrUpdateParameters) – Additional parameters for certificate creation.

  • if_match (str) – The entity state (ETag) version of the certificate to update. A value of “*” can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied.

  • if_none_match (str) – Set to ‘*’ to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Certificate or ClientRawResponse<Certificate> if raw==True

Return type

AzureOperationPoller[Certificate] or AzureOperationPoller[ClientRawResponse[Certificate]]

Raises

CloudError

delete(resource_group_name, account_name, certificate_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes the specified certificate.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • certificate_name (str) – The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, account_name, certificate_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the specified certificate.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • certificate_name (str) – The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Certificate or ClientRawResponse if raw=true

Return type

Certificate or ClientRawResponse

Raises

CloudError

list_by_batch_account(resource_group_name, account_name, maxresults=None, select=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the certificates in the specified account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • maxresults (int) – The maximum number of items to return in the response.

  • select (str) – Comma separated list of properties that should be returned. e.g. “properties/provisioningState”. Only top level properties under properties/ are valid for selection.

  • filter (str) – OData filter expression. Valid properties for filtering are “properties/provisioningState”, “properties/provisioningStateTransitionTime”, “name”.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Certificate

Return type

CertificatePaged[Certificate]

Raises

CloudError

update(resource_group_name, account_name, certificate_name, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the properties of an existing certificate.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • certificate_name (str) – The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.

  • parameters (CertificateCreateOrUpdateParameters) – Certificate entity to update.

  • if_match (str) – The entity state (ETag) version of the certificate to update. This value can be omitted or set to “*” to apply the operation unconditionally.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Certificate or ClientRawResponse if raw=true

Return type

Certificate or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.batch.models' from '/home/vsts/work/1/s/sdk/batch/azure-mgmt-batch/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batch/models/__init__.py'>
class azure.mgmt.batch.operations.PrivateLinkResourceOperations(client, config, serializer, deserializer)[source]

Bases: object

PrivateLinkResourceOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-05-01”.

get(resource_group_name, account_name, private_link_resource_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the specified private link resource.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • private_link_resource_name (str) – The private link resource name. This must be unique within the account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

PrivateLinkResource or ClientRawResponse if raw=true

Return type

PrivateLinkResource or ClientRawResponse

Raises

CloudError

list_by_batch_account(resource_group_name, account_name, maxresults=None, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the private link resources in the specified account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • maxresults (int) – The maximum number of items to return in the response.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of PrivateLinkResource

Return type

PrivateLinkResourcePaged[PrivateLinkResource]

Raises

CloudError

models = <module 'azure.mgmt.batch.models' from '/home/vsts/work/1/s/sdk/batch/azure-mgmt-batch/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batch/models/__init__.py'>
class azure.mgmt.batch.operations.PrivateEndpointConnectionOperations(client, config, serializer, deserializer)[source]

Bases: object

PrivateEndpointConnectionOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-05-01”.

get(resource_group_name, account_name, private_endpoint_connection_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the specified private endpoint connection.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • private_endpoint_connection_name (str) – The private endpoint connection name. This must be unique within the account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

PrivateEndpointConnection or ClientRawResponse if raw=true

Return type

PrivateEndpointConnection or ClientRawResponse

Raises

CloudError

list_by_batch_account(resource_group_name, account_name, maxresults=None, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the private endpoint connections in the specified account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • maxresults (int) – The maximum number of items to return in the response.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of PrivateEndpointConnection

Return type

PrivateEndpointConnectionPaged[PrivateEndpointConnection]

Raises

CloudError

update(resource_group_name, account_name, private_endpoint_connection_name, if_match=None, private_endpoint=None, private_link_service_connection_state=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates the properties of an existing private endpoint connection.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • private_endpoint_connection_name (str) – The private endpoint connection name. This must be unique within the account.

  • if_match (str) – The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to “*” to apply the operation unconditionally.

  • private_endpoint (PrivateEndpoint) – The ARM resource identifier of the private endpoint.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – The private link service connection state of the private endpoint connection.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PrivateEndpointConnection or ClientRawResponse<PrivateEndpointConnection> if raw==True

Return type

AzureOperationPoller[PrivateEndpointConnection] or AzureOperationPoller[ClientRawResponse[PrivateEndpointConnection]]

Raises

CloudError

models = <module 'azure.mgmt.batch.models' from '/home/vsts/work/1/s/sdk/batch/azure-mgmt-batch/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batch/models/__init__.py'>
class azure.mgmt.batch.operations.PoolOperations(client, config, serializer, deserializer)[source]

Bases: object

PoolOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-05-01”.

create(resource_group_name, account_name, pool_name, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates a new pool inside the specified account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • pool_name (str) – The pool name. This must be unique within the account.

  • parameters (Pool) – Additional parameters for pool creation.

  • if_match (str) – The entity state (ETag) version of the pool to update. A value of “*” can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied.

  • if_none_match (str) – Set to ‘*’ to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Pool or ClientRawResponse<Pool> if raw==True

Return type

AzureOperationPoller[Pool] or AzureOperationPoller[ClientRawResponse[Pool]]

Raises

CloudError

delete(resource_group_name, account_name, pool_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes the specified pool.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • pool_name (str) – The pool name. This must be unique within the account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

disable_auto_scale(resource_group_name, account_name, pool_name, custom_headers=None, raw=False, **operation_config)[source]

Disables automatic scaling for a pool.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • pool_name (str) – The pool name. This must be unique within the account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Pool or ClientRawResponse if raw=true

Return type

Pool or ClientRawResponse

Raises

CloudError

get(resource_group_name, account_name, pool_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the specified pool.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • pool_name (str) – The pool name. This must be unique within the account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Pool or ClientRawResponse if raw=true

Return type

Pool or ClientRawResponse

Raises

CloudError

list_by_batch_account(resource_group_name, account_name, maxresults=None, select=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the pools in the specified account.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • maxresults (int) – The maximum number of items to return in the response.

  • select (str) – Comma separated list of properties that should be returned. e.g. “properties/provisioningState”. Only top level properties under properties/ are valid for selection.

  • filter (str) – OData filter expression. Valid properties for filtering are: name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Pool

Return type

PoolPaged[Pool]

Raises

CloudError

stop_resize(resource_group_name, account_name, pool_name, custom_headers=None, raw=False, **operation_config)[source]

Stops an ongoing resize operation on the pool.

This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • pool_name (str) – The pool name. This must be unique within the account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Pool or ClientRawResponse if raw=true

Return type

Pool or ClientRawResponse

Raises

CloudError

update(resource_group_name, account_name, pool_name, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the properties of an existing pool.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the Batch account.

  • account_name (str) – The name of the Batch account.

  • pool_name (str) – The pool name. This must be unique within the account.

  • parameters (Pool) – Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.

  • if_match (str) – The entity state (ETag) version of the pool to update. This value can be omitted or set to “*” to apply the operation unconditionally.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Pool or ClientRawResponse if raw=true

Return type

Pool or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.batch.models' from '/home/vsts/work/1/s/sdk/batch/azure-mgmt-batch/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batch/models/__init__.py'>