azure.batch.models.BatchPoolResourceStatistics.yml

### YamlMime:PythonClass
uid: azure.batch.models.BatchPoolResourceStatistics
name: BatchPoolResourceStatistics
fullName: azure.batch.models.BatchPoolResourceStatistics
module: azure.batch.models
summary: 'Statistics related to resource consumption by Compute Nodes in a Pool.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'BatchPoolResourceStatistics(*args: Any, **kwargs: Any)'
variables:
- description: The start time of the time range covered by the statistics. Required.
  name: start_time
  types:
  - <xref:datetime.datetime>
- description: 'The time at which the statistics were last updated. All statistics
    are

    limited to the range between startTime and lastUpdateTime. Required.'
  name: last_update_time
  types:
  - <xref:datetime.datetime>
- description: 'The average CPU usage across all Compute Nodes in the Pool

    (percentage per node). Required.'
  name: avg_cpu_percentage
  types:
  - <xref:float>
- description: 'The average memory usage in GiB across all Compute Nodes in the Pool.

    Required.'
  name: avg_memory_gi_b
  types:
  - <xref:float>
- description: 'The peak memory usage in GiB across all Compute Nodes in the Pool.

    Required.'
  name: peak_memory_gi_b
  types:
  - <xref:float>
- description: 'The average used disk space in GiB across all Compute Nodes in the
    Pool.

    Required.'
  name: avg_disk_gi_b
  types:
  - <xref:float>
- description: 'The peak used disk space in GiB across all Compute Nodes in the Pool.

    Required.'
  name: peak_disk_gi_b
  types:
  - <xref:float>
- description: 'The total number of disk read operations across all Compute Nodes
    in the

    Pool. Required.'
  name: disk_read_i_ops
  types:
  - <xref:int>
- description: 'The total number of disk write operations across all Compute Nodes
    in

    the Pool. Required.'
  name: disk_write_i_ops
  types:
  - <xref:int>
- description: 'The total amount of data in GiB of disk reads across all Compute Nodes
    in

    the Pool. Required.'
  name: disk_read_gi_b
  types:
  - <xref:float>
- description: 'The total amount of data in GiB of disk writes across all Compute
    Nodes

    in the Pool. Required.'
  name: disk_write_gi_b
  types:
  - <xref:float>
- description: 'The total amount of data in GiB of network reads across all Compute

    Nodes in the Pool. Required.'
  name: network_read_gi_b
  types:
  - <xref:float>
- description: 'The total amount of data in GiB of network writes across all Compute

    Nodes in the Pool. Required.'
  name: network_write_gi_b
  types:
  - <xref:float>
methods:
- uid: azure.batch.models.BatchPoolResourceStatistics.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.BatchPoolResourceStatistics.clear
  name: clear
  signature: clear() -> None
- uid: azure.batch.models.BatchPoolResourceStatistics.copy
  name: copy
  signature: copy() -> Model
- uid: azure.batch.models.BatchPoolResourceStatistics.get
  name: get
  signature: 'get(key: str, default: Any = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.batch.models.BatchPoolResourceStatistics.items
  name: items
  signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.BatchPoolResourceStatistics.keys
  name: keys
  signature: keys() -> KeysView[str]
- uid: azure.batch.models.BatchPoolResourceStatistics.pop
  name: pop
  signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchPoolResourceStatistics.popitem
  name: popitem
  signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.BatchPoolResourceStatistics.setdefault
  name: setdefault
  signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchPoolResourceStatistics.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.BatchPoolResourceStatistics.values
  name: values
  signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.BatchPoolResourceStatistics.avg_cpu_percentage
  name: avg_cpu_percentage
  summary: The average CPU usage across all Compute Nodes in the Pool (percentage
    per node). Required.
  signature: 'avg_cpu_percentage: float'
- uid: azure.batch.models.BatchPoolResourceStatistics.avg_disk_gi_b
  name: avg_disk_gi_b
  summary: The average used disk space in GiB across all Compute Nodes in the Pool.
    Required.
  signature: 'avg_disk_gi_b: float'
- uid: azure.batch.models.BatchPoolResourceStatistics.avg_memory_gi_b
  name: avg_memory_gi_b
  summary: The average memory usage in GiB across all Compute Nodes in the Pool. Required.
  signature: 'avg_memory_gi_b: float'
- uid: azure.batch.models.BatchPoolResourceStatistics.disk_read_gi_b
  name: disk_read_gi_b
  summary: The total amount of data in GiB of disk reads across all Compute Nodes
    in the Pool. Required.
  signature: 'disk_read_gi_b: float'
- uid: azure.batch.models.BatchPoolResourceStatistics.disk_read_i_ops
  name: disk_read_i_ops
  summary: The total number of disk read operations across all Compute Nodes in the
    Pool. Required.
  signature: 'disk_read_i_ops: int'
- uid: azure.batch.models.BatchPoolResourceStatistics.disk_write_gi_b
  name: disk_write_gi_b
  summary: The total amount of data in GiB of disk writes across all Compute Nodes
    in the Pool. Required.
  signature: 'disk_write_gi_b: float'
- uid: azure.batch.models.BatchPoolResourceStatistics.disk_write_i_ops
  name: disk_write_i_ops
  summary: The total number of disk write operations across all Compute Nodes in the
    Pool. Required.
  signature: 'disk_write_i_ops: int'
- uid: azure.batch.models.BatchPoolResourceStatistics.last_update_time
  name: last_update_time
  summary: 'The time at which the statistics were last updated. All statistics are
    limited to the range

    between startTime and lastUpdateTime. Required.'
  signature: 'last_update_time: datetime'
- uid: azure.batch.models.BatchPoolResourceStatistics.network_read_gi_b
  name: network_read_gi_b
  summary: 'The total amount of data in GiB of network reads across all Compute Nodes
    in the Pool.

    Required.'
  signature: 'network_read_gi_b: float'
- uid: azure.batch.models.BatchPoolResourceStatistics.network_write_gi_b
  name: network_write_gi_b
  summary: 'The total amount of data in GiB of network writes across all Compute Nodes
    in the Pool.

    Required.'
  signature: 'network_write_gi_b: float'
- uid: azure.batch.models.BatchPoolResourceStatistics.peak_disk_gi_b
  name: peak_disk_gi_b
  summary: The peak used disk space in GiB across all Compute Nodes in the Pool. Required.
  signature: 'peak_disk_gi_b: float'
- uid: azure.batch.models.BatchPoolResourceStatistics.peak_memory_gi_b
  name: peak_memory_gi_b
  summary: The peak memory usage in GiB across all Compute Nodes in the Pool. Required.
  signature: 'peak_memory_gi_b: float'
- uid: azure.batch.models.BatchPoolResourceStatistics.start_time
  name: start_time
  summary: The start time of the time range covered by the statistics. Required.
  signature: 'start_time: datetime'