azure.batch.models.BatchPoolResizeContent.yml

### YamlMime:PythonClass
uid: azure.batch.models.BatchPoolResizeContent
name: BatchPoolResizeContent
fullName: azure.batch.models.BatchPoolResizeContent
module: azure.batch.models
summary: Parameters for changing the size of an Azure Batch Pool.
constructor:
  syntax: 'BatchPoolResizeContent(*args: Any, **kwargs: Any)'
variables:
- description: The desired number of dedicated Compute Nodes in the Pool.
  name: target_dedicated_nodes
  types:
  - <xref:int>
- description: 'The desired number of Spot/Low-priority Compute Nodes in the

    Pool.'
  name: target_low_priority_nodes
  types:
  - <xref:int>
- description: 'The timeout for allocation of Nodes to the Pool or removal of Compute

    Nodes from the Pool. The default value is 15 minutes. The minimum value is 5 minutes.
    If you

    specify a value less than 5 minutes, the Batch service returns an error; if you
    are calling the

    REST API directly, the HTTP status code is 400 (Bad Request).'
  name: resize_timeout
  types:
  - <xref:datetime.timedelta>
- description: 'Determines what to do with a Compute Node and its running

    task(s) if the Pool size is decreasing. The default value is requeue. Known values
    are:

    "requeue", "terminate", "taskcompletion", and "retaineddata".'
  name: node_deallocation_option
  types:
  - <xref:str>
  - <xref:azure.batch.models.BatchNodeDeallocationOption>
methods:
- uid: azure.batch.models.BatchPoolResizeContent.as_dict
  name: as_dict
  summary: Return a dict that can be JSONify using json.dump.
  signature: 'as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]'
  keywordOnlyParameters:
  - name: exclude_readonly
    description: Whether to remove the readonly properties.
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.batch.models.BatchPoolResizeContent.clear
  name: clear
  signature: clear() -> None
- uid: azure.batch.models.BatchPoolResizeContent.copy
  name: copy
  signature: copy() -> Model
- uid: azure.batch.models.BatchPoolResizeContent.get
  name: get
  signature: 'get(key: str, default: Any = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.batch.models.BatchPoolResizeContent.items
  name: items
  signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.BatchPoolResizeContent.keys
  name: keys
  signature: keys() -> KeysView[str]
- uid: azure.batch.models.BatchPoolResizeContent.pop
  name: pop
  signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchPoolResizeContent.popitem
  name: popitem
  signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.BatchPoolResizeContent.setdefault
  name: setdefault
  signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchPoolResizeContent.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.BatchPoolResizeContent.values
  name: values
  signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.BatchPoolResizeContent.node_deallocation_option
  name: node_deallocation_option
  summary: 'Determines what to do with a Compute Node and its running task(s) if the
    Pool size is

    decreasing. The default value is requeue. Known values are: "requeue", "terminate",

    "taskcompletion", and "retaineddata".'
  signature: 'node_deallocation_option: str | _models.BatchNodeDeallocationOption
    | None'
- uid: azure.batch.models.BatchPoolResizeContent.resize_timeout
  name: resize_timeout
  summary: 'The timeout for allocation of Nodes to the Pool or removal of Compute
    Nodes from the Pool. The

    default value is 15 minutes. The minimum value is 5 minutes. If you specify a
    value less than 5

    minutes, the Batch service returns an error; if you are calling the REST API directly,
    the HTTP

    status code is 400 (Bad Request).'
  signature: 'resize_timeout: timedelta | None'
- uid: azure.batch.models.BatchPoolResizeContent.target_dedicated_nodes
  name: target_dedicated_nodes
  summary: The desired number of dedicated Compute Nodes in the Pool.
  signature: 'target_dedicated_nodes: int | None'
- uid: azure.batch.models.BatchPoolResizeContent.target_low_priority_nodes
  name: target_low_priority_nodes
  summary: The desired number of Spot/Low-priority Compute Nodes in the Pool.
  signature: 'target_low_priority_nodes: int | None'