BatchAccountOperations Class
BatchAccountOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectBatchAccountOperations
Constructor
BatchAccountOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_create |
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. |
| begin_delete |
Deletes the specified Batch account. |
| get |
Gets information about the specified Batch account. |
| get_detector |
Gets information about the given detector for a given Batch account. |
| get_keys |
Gets the account keys for the specified Batch account. This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail. |
| list |
Gets information about the Batch accounts associated with the subscription. |
| list_by_resource_group |
Gets information about the Batch accounts associated with the specified resource group. |
| list_detectors |
Gets information about the detectors available for a given Batch account. |
| list_outbound_network_dependencies_endpoints |
Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network. |
| regenerate_key |
Regenerates the specified account key for the Batch account. This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail. |
| synchronize_auto_storage_keys |
Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used. |
| update |
Updates the properties of an existing Batch account. |
begin_create
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.
async begin_create(resource_group_name: str, account_name: str, parameters: azure.mgmt.batch.models._models_py3.BatchAccountCreateParameters, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.batch.models._models_py3.BatchAccount]Parameters
- 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/.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either BatchAccount or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes the specified Batch account.
async begin_delete(resource_group_name: str, account_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
get
Gets information about the specified Batch account.
async get(resource_group_name: str, account_name: str, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.BatchAccountParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
BatchAccount, or the result of cls(response)
Return type
Exceptions
get_detector
Gets information about the given detector for a given Batch account.
async get_detector(resource_group_name: str, account_name: str, detector_id: str, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.DetectorResponseParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
DetectorResponse, or the result of cls(response)
Return type
Exceptions
get_keys
Gets the account keys for the specified Batch account.
This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.
async get_keys(resource_group_name: str, account_name: str, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.BatchAccountKeysParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
BatchAccountKeys, or the result of cls(response)
Return type
Exceptions
list
Gets information about the Batch accounts associated with the subscription.
list(**kwargs: Any) -> AsyncIterable[azure.mgmt.batch.models._models_py3.BatchAccountListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either BatchAccountListResult or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Gets information about the Batch accounts associated with the specified resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.batch.models._models_py3.BatchAccountListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either BatchAccountListResult or the result of cls(response)
Return type
Exceptions
list_detectors
Gets information about the detectors available for a given Batch account.
list_detectors(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.batch.models._models_py3.DetectorListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either DetectorListResult or the result of cls(response)
Return type
Exceptions
list_outbound_network_dependencies_endpoints
Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network.
list_outbound_network_dependencies_endpoints(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.batch.models._models_py3.OutboundEnvironmentEndpointCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either OutboundEnvironmentEndpointCollection or the result of cls(response)
Return type
Exceptions
regenerate_key
Regenerates the specified account key for the Batch account.
This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail.
async regenerate_key(resource_group_name: str, account_name: str, parameters: azure.mgmt.batch.models._models_py3.BatchAccountRegenerateKeyParameters, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.BatchAccountKeysParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
BatchAccountKeys, or the result of cls(response)
Return type
Exceptions
synchronize_auto_storage_keys
Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
async synchronize_auto_storage_keys(resource_group_name: str, account_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
update
Updates the properties of an existing Batch account.
async update(resource_group_name: str, account_name: str, parameters: azure.mgmt.batch.models._models_py3.BatchAccountUpdateParameters, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.BatchAccountParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
BatchAccount, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\batch\\models\\__init__.py'>Feedback
Submit and view feedback for