azure.batch.models.BatchNodeRemoveContent.yml

### YamlMime:PythonClass
uid: azure.batch.models.BatchNodeRemoveContent
name: BatchNodeRemoveContent
fullName: azure.batch.models.BatchNodeRemoveContent
module: azure.batch.models
summary: 'Parameters for removing nodes from an Azure Batch Pool.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'BatchNodeRemoveContent(*args: Any, **kwargs: Any)'
variables:
- description: 'A list containing the IDs of the Compute Nodes to be removed from
    the

    specified Pool. A maximum of 100 nodes may be removed per request. Required.'
  name: node_list
  types:
  - <xref:list>[<xref:str>]
- description: 'The timeout for removal of Compute Nodes to 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) after it has been selected for deallocation. 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.BatchNodeRemoveContent.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.BatchNodeRemoveContent.clear
  name: clear
  signature: clear() -> None
- uid: azure.batch.models.BatchNodeRemoveContent.copy
  name: copy
  signature: copy() -> Model
- uid: azure.batch.models.BatchNodeRemoveContent.get
  name: get
  signature: 'get(key: str, default: Any = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.batch.models.BatchNodeRemoveContent.items
  name: items
  signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.BatchNodeRemoveContent.keys
  name: keys
  signature: keys() -> KeysView[str]
- uid: azure.batch.models.BatchNodeRemoveContent.pop
  name: pop
  signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchNodeRemoveContent.popitem
  name: popitem
  signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.BatchNodeRemoveContent.setdefault
  name: setdefault
  signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchNodeRemoveContent.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.BatchNodeRemoveContent.values
  name: values
  signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.BatchNodeRemoveContent.node_deallocation_option
  name: node_deallocation_option
  summary: 'Determines what to do with a Compute Node and its running task(s) after
    it has been selected

    for deallocation. 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.BatchNodeRemoveContent.node_list
  name: node_list
  summary: 'A list containing the IDs of the Compute Nodes to be removed from the
    specified Pool. A maximum

    of 100 nodes may be removed per request. Required.'
  signature: 'node_list: List[str]'
- uid: azure.batch.models.BatchNodeRemoveContent.resize_timeout
  name: resize_timeout
  summary: 'The timeout for removal of Compute Nodes to 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'