azure.batch.models.BatchPoolInfo.yml

### YamlMime:PythonClass
uid: azure.batch.models.BatchPoolInfo
name: BatchPoolInfo
fullName: azure.batch.models.BatchPoolInfo
module: azure.batch.models
summary: Specifies how a Job should be assigned to a Pool.
constructor:
  syntax: 'BatchPoolInfo(*args: Any, **kwargs: Any)'
variables:
- description: 'The ID of an existing Pool. All the Tasks of the Job will run on the
    specified

    Pool. You must ensure that the Pool referenced by this property exists. If the
    Pool does not

    exist at the time the Batch service tries to schedule a Job, no Tasks for the
    Job will run

    until you create a Pool with that id. Note that the Batch service will not reject
    the Job

    request; it will simply not run Tasks until the Pool exists. You must specify
    either the Pool

    ID or the auto Pool specification, but not both.'
  name: pool_id
  types:
  - <xref:str>
- description: 'Characteristics for a temporary ''auto pool''. The Batch service

    will create this auto Pool when the Job is submitted. If auto Pool creation fails,
    the Batch

    service moves the Job to a completed state, and the Pool creation error is set
    in the Job''s

    scheduling error property. The Batch service manages the lifetime (both creation
    and, unless

    keepAlive is specified, deletion) of the auto Pool. Any user actions that affect
    the lifetime

    of the auto Pool while the Job is active will result in unexpected behavior. You
    must specify

    either the Pool ID or the auto Pool specification, but not both.'
  name: auto_pool_specification
  types:
  - <xref:azure.batch.models.BatchAutoPoolSpecification>
methods:
- uid: azure.batch.models.BatchPoolInfo.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.BatchPoolInfo.clear
  name: clear
  signature: clear() -> None
- uid: azure.batch.models.BatchPoolInfo.copy
  name: copy
  signature: copy() -> Model
- uid: azure.batch.models.BatchPoolInfo.get
  name: get
  signature: 'get(key: str, default: Any = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.batch.models.BatchPoolInfo.items
  name: items
  signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.BatchPoolInfo.keys
  name: keys
  signature: keys() -> KeysView[str]
- uid: azure.batch.models.BatchPoolInfo.pop
  name: pop
  signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchPoolInfo.popitem
  name: popitem
  signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.BatchPoolInfo.setdefault
  name: setdefault
  signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchPoolInfo.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.BatchPoolInfo.values
  name: values
  signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.BatchPoolInfo.auto_pool_specification
  name: auto_pool_specification
  summary: 'Characteristics for a temporary ''auto pool''. The Batch service will
    create this auto Pool when

    the Job is submitted. If auto Pool creation fails, the Batch service moves the
    Job to a

    completed state, and the Pool creation error is set in the Job''s scheduling error
    property. The

    Batch service manages the lifetime (both creation and, unless keepAlive is specified,
    deletion)

    of the auto Pool. Any user actions that affect the lifetime of the auto Pool while
    the Job is

    active will result in unexpected behavior. You must specify either the Pool ID
    or the auto Pool

    specification, but not both.'
  signature: 'auto_pool_specification: _models.BatchAutoPoolSpecification | None'
- uid: azure.batch.models.BatchPoolInfo.pool_id
  name: pool_id
  summary: 'The ID of an existing Pool. All the Tasks of the Job will run on the specified
    Pool. You must

    ensure that the Pool referenced by this property exists. If the Pool does not
    exist at the time

    the Batch service tries to schedule a Job, no Tasks for the Job will run until
    you create a

    Pool with that id. Note that the Batch service will not reject the Job request;
    it will simply

    not run Tasks until the Pool exists. You must specify either the Pool ID or the
    auto Pool

    specification, but not both.'
  signature: 'pool_id: str | None'