PoolOperations Class
PoolOperations 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.objectPoolOperations
Constructor
PoolOperations(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_delete |
Deletes the specified pool. |
| create |
Creates a new pool inside the specified account. |
| disable_auto_scale |
Disables automatic scaling for a pool. |
| get |
Gets information about the specified pool. |
| list_by_batch_account |
Lists all of the pools in the specified account. |
| stop_resize |
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. |
| update |
Updates the properties of an existing pool. |
begin_delete
Deletes the specified pool.
begin_delete(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[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 PollingMethod
By default, your polling method will be ARMPolling. 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 LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
create
Creates a new pool inside the specified account.
create(resource_group_name: str, account_name: str, pool_name: str, parameters: azure.mgmt.batch.models._models_py3.Pool, if_match: Optional[str] = None, if_none_match: Optional[str] = None, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.PoolParameters
- 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. Default value is None.
- 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. Default value is None.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Pool, or the result of cls(response)
Return type
Exceptions
disable_auto_scale
Disables automatic scaling for a pool.
disable_auto_scale(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.PoolParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Pool, or the result of cls(response)
Return type
Exceptions
get
Gets information about the specified pool.
get(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.PoolParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Pool, or the result of cls(response)
Return type
Exceptions
list_by_batch_account
Lists all of the pools in the specified account.
list_by_batch_account(resource_group_name: str, account_name: str, maxresults: Optional[int] = None, select: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.batch.models._models_py3.ListPoolsResult]Parameters
- maxresults
- int
The maximum number of items to return in the response. Default value is None.
- 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. Default value is None.
- 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. Default value is None.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ListPoolsResult or the result of cls(response)
Return type
Exceptions
stop_resize
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.
stop_resize(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.PoolParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Pool, or the result of cls(response)
Return type
Exceptions
update
Updates the properties of an existing pool.
update(resource_group_name: str, account_name: str, pool_name: str, parameters: azure.mgmt.batch.models._models_py3.Pool, if_match: Optional[str] = None, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.PoolParameters
- 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. Default value is None.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Pool, 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