azure.batch.models.BatchPoolUpdateContent.yml

### YamlMime:PythonClass
uid: azure.batch.models.BatchPoolUpdateContent
name: BatchPoolUpdateContent
fullName: azure.batch.models.BatchPoolUpdateContent
module: azure.batch.models
summary: Parameters for updating an Azure Batch Pool.
constructor:
  syntax: 'BatchPoolUpdateContent(*args: Any, **kwargs: Any)'
variables:
- description: 'A Task to run on each Compute Node as it joins the Pool. The Task
    runs when

    the Compute Node is added to the Pool or when the Compute Node is restarted. If
    this element is

    present, it overwrites any existing StartTask. If omitted, any existing StartTask
    is left

    unchanged.'
  name: start_task
  types:
  - <xref:azure.batch.models.BatchStartTask>
- description: 'A list of Packages to be installed on each Compute Node

    in the Pool. Changes to Package references affect all new Nodes joining the Pool,
    but do not

    affect Compute Nodes that are already in the Pool until they are rebooted or reimaged.
    If this

    element is present, it replaces any existing Package references. If you specify
    an empty

    collection, then all Package references are removed from the Pool. If omitted,
    any existing

    Package references are left unchanged.'
  name: application_package_references
  types:
  - <xref:list>[<xref:azure.batch.models.BatchApplicationPackageReference>]
- description: 'A list of name-value pairs associated with the Pool as metadata. If
    this

    element is present, it replaces any existing metadata configured on the Pool.
    If you specify an

    empty collection, any metadata is removed from the Pool. If omitted, any existing
    metadata is

    left unchanged.'
  name: metadata
  types:
  - <xref:list>[<xref:azure.batch.models.MetadataItem>]
- description: 'The desired node communication mode for the pool. If this

    element is present, it replaces the existing targetNodeCommunicationMode configured
    on the

    Pool. If omitted, any existing metadata is left unchanged. Known values are: "default",

    "classic", and "simplified".'
  name: target_node_communication_mode
  types:
  - <xref:str>
  - <xref:azure.batch.models.BatchNodeCommunicationMode>
methods:
- uid: azure.batch.models.BatchPoolUpdateContent.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.BatchPoolUpdateContent.clear
  name: clear
  signature: clear() -> None
- uid: azure.batch.models.BatchPoolUpdateContent.copy
  name: copy
  signature: copy() -> Model
- uid: azure.batch.models.BatchPoolUpdateContent.get
  name: get
  signature: 'get(key: str, default: Any = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.batch.models.BatchPoolUpdateContent.items
  name: items
  signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.BatchPoolUpdateContent.keys
  name: keys
  signature: keys() -> KeysView[str]
- uid: azure.batch.models.BatchPoolUpdateContent.pop
  name: pop
  signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchPoolUpdateContent.popitem
  name: popitem
  signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.BatchPoolUpdateContent.setdefault
  name: setdefault
  signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchPoolUpdateContent.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.BatchPoolUpdateContent.values
  name: values
  signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.BatchPoolUpdateContent.application_package_references
  name: application_package_references
  summary: 'A list of Packages to be installed on each Compute Node in the Pool. Changes
    to Package

    references affect all new Nodes joining the Pool, but do not affect Compute Nodes
    that are

    already in the Pool until they are rebooted or reimaged. If this element is present,
    it

    replaces any existing Package references. If you specify an empty collection,
    then all Package

    references are removed from the Pool. If omitted, any existing Package references
    are left

    unchanged.'
  signature: 'application_package_references: List[_models.BatchApplicationPackageReference]
    | None'
- uid: azure.batch.models.BatchPoolUpdateContent.metadata
  name: metadata
  summary: 'A list of name-value pairs associated with the Pool as metadata. If this
    element is present, it

    replaces any existing metadata configured on the Pool. If you specify an empty
    collection, any

    metadata is removed from the Pool. If omitted, any existing metadata is left unchanged.'
  signature: 'metadata: List[_models.MetadataItem] | None'
- uid: azure.batch.models.BatchPoolUpdateContent.start_task
  name: start_task
  summary: 'A Task to run on each Compute Node as it joins the Pool. The Task runs
    when the Compute Node is

    added to the Pool or when the Compute Node is restarted. If this element is present,
    it

    overwrites any existing StartTask. If omitted, any existing StartTask is left
    unchanged.'
  signature: 'start_task: _models.BatchStartTask | None'
- uid: azure.batch.models.BatchPoolUpdateContent.target_node_communication_mode
  name: target_node_communication_mode
  summary: 'The desired node communication mode for the pool. If this element is present,
    it replaces the

    existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing
    metadata

    is left unchanged. Known values are: "default", "classic", and "simplified".'
  signature: 'target_node_communication_mode: str | _models.BatchNodeCommunicationMode
    | None'