azure.batch.models.BatchNodeCounts.yml

### YamlMime:PythonClass
uid: azure.batch.models.BatchNodeCounts
name: BatchNodeCounts
fullName: azure.batch.models.BatchNodeCounts
module: azure.batch.models
summary: 'The number of Compute Nodes in each Compute Node state.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'BatchNodeCounts(*args: Any, **kwargs: Any)'
variables:
- description: The number of Compute Nodes in the creating state. Required.
  name: creating
  types:
  - <xref:int>
- description: The number of Compute Nodes in the idle state. Required.
  name: idle
  types:
  - <xref:int>
- description: The number of Compute Nodes in the offline state. Required.
  name: offline
  types:
  - <xref:int>
- description: The number of Compute Nodes in the preempted state. Required.
  name: preempted
  types:
  - <xref:int>
- description: The count of Compute Nodes in the rebooting state. Required.
  name: rebooting
  types:
  - <xref:int>
- description: The number of Compute Nodes in the reimaging state. Required.
  name: reimaging
  types:
  - <xref:int>
- description: The number of Compute Nodes in the running state. Required.
  name: running
  types:
  - <xref:int>
- description: The number of Compute Nodes in the starting state. Required.
  name: starting
  types:
  - <xref:int>
- description: The number of Compute Nodes in the startTaskFailed state. Required.
  name: start_task_failed
  types:
  - <xref:int>
- description: The number of Compute Nodes in the leavingPool state. Required.
  name: leaving_pool
  types:
  - <xref:int>
- description: The number of Compute Nodes in the unknown state. Required.
  name: unknown
  types:
  - <xref:int>
- description: The number of Compute Nodes in the unusable state. Required.
  name: unusable
  types:
  - <xref:int>
- description: 'The number of Compute Nodes in the waitingForStartTask state.

    Required.'
  name: waiting_for_start_task
  types:
  - <xref:int>
- description: The total number of Compute Nodes. Required.
  name: total
  types:
  - <xref:int>
- description: The number of Compute Nodes in the upgradingOS state. Required.
  name: upgrading_os
  types:
  - <xref:int>
methods:
- uid: azure.batch.models.BatchNodeCounts.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.BatchNodeCounts.clear
  name: clear
  signature: clear() -> None
- uid: azure.batch.models.BatchNodeCounts.copy
  name: copy
  signature: copy() -> Model
- uid: azure.batch.models.BatchNodeCounts.get
  name: get
  signature: 'get(key: str, default: Any = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.batch.models.BatchNodeCounts.items
  name: items
  signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.BatchNodeCounts.keys
  name: keys
  signature: keys() -> KeysView[str]
- uid: azure.batch.models.BatchNodeCounts.pop
  name: pop
  signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchNodeCounts.popitem
  name: popitem
  signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.BatchNodeCounts.setdefault
  name: setdefault
  signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchNodeCounts.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.BatchNodeCounts.values
  name: values
  signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.BatchNodeCounts.creating
  name: creating
  summary: The number of Compute Nodes in the creating state. Required.
  signature: 'creating: int'
- uid: azure.batch.models.BatchNodeCounts.idle
  name: idle
  summary: The number of Compute Nodes in the idle state. Required.
  signature: 'idle: int'
- uid: azure.batch.models.BatchNodeCounts.leaving_pool
  name: leaving_pool
  summary: The number of Compute Nodes in the leavingPool state. Required.
  signature: 'leaving_pool: int'
- uid: azure.batch.models.BatchNodeCounts.offline
  name: offline
  summary: The number of Compute Nodes in the offline state. Required.
  signature: 'offline: int'
- uid: azure.batch.models.BatchNodeCounts.preempted
  name: preempted
  summary: The number of Compute Nodes in the preempted state. Required.
  signature: 'preempted: int'
- uid: azure.batch.models.BatchNodeCounts.rebooting
  name: rebooting
  summary: The count of Compute Nodes in the rebooting state. Required.
  signature: 'rebooting: int'
- uid: azure.batch.models.BatchNodeCounts.reimaging
  name: reimaging
  summary: The number of Compute Nodes in the reimaging state. Required.
  signature: 'reimaging: int'
- uid: azure.batch.models.BatchNodeCounts.running
  name: running
  summary: The number of Compute Nodes in the running state. Required.
  signature: 'running: int'
- uid: azure.batch.models.BatchNodeCounts.start_task_failed
  name: start_task_failed
  summary: The number of Compute Nodes in the startTaskFailed state. Required.
  signature: 'start_task_failed: int'
- uid: azure.batch.models.BatchNodeCounts.starting
  name: starting
  summary: The number of Compute Nodes in the starting state. Required.
  signature: 'starting: int'
- uid: azure.batch.models.BatchNodeCounts.total
  name: total
  summary: The total number of Compute Nodes. Required.
  signature: 'total: int'
- uid: azure.batch.models.BatchNodeCounts.unknown
  name: unknown
  summary: The number of Compute Nodes in the unknown state. Required.
  signature: 'unknown: int'
- uid: azure.batch.models.BatchNodeCounts.unusable
  name: unusable
  summary: The number of Compute Nodes in the unusable state. Required.
  signature: 'unusable: int'
- uid: azure.batch.models.BatchNodeCounts.upgrading_os
  name: upgrading_os
  summary: The number of Compute Nodes in the upgradingOS state. Required.
  signature: 'upgrading_os: int'
- uid: azure.batch.models.BatchNodeCounts.waiting_for_start_task
  name: waiting_for_start_task
  summary: The number of Compute Nodes in the waitingForStartTask state. Required.
  signature: 'waiting_for_start_task: int'