azure.mgmt.batch.models.TaskContainerSettings.yml

### YamlMime:PythonClass
uid: azure.mgmt.batch.models.TaskContainerSettings
name: TaskContainerSettings
fullName: azure.mgmt.batch.models.TaskContainerSettings
module: azure.mgmt.batch.models
inheritances:
- azure.mgmt.batch._serialization.Model
summary: 'The container settings for a task.


  All required parameters must be populated in order to send to Azure.'
constructor:
  syntax: 'TaskContainerSettings(*, image_name: str, container_run_options: str |
    None = None, registry: _models.ContainerRegistry | None = None, working_directory:
    str | _models.ContainerWorkingDirectory | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: container_run_options
    description: 'These additional options are supplied as arguments to the

      "docker create" command, in addition to those controlled by the Batch Service.'
    types:
    - <xref:str>
  - name: image_name
    description: 'This is the full image reference, as would be specified to "docker
      pull".

      If no tag is provided as part of the image name, the tag ":latest" is used as
      a default.

      Required.'
    types:
    - <xref:str>
  - name: registry
    description: This setting can be omitted if was already provided at pool creation.
    types:
    - <xref:azure.mgmt.batch.models.ContainerRegistry>
  - name: working_directory
    description: 'A flag to indicate where the container task working directory is.

      The default is ''taskWorkingDirectory''. Known values are: "TaskWorkingDirectory"
      and

      "ContainerImageDefault".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.batch.models.ContainerWorkingDirectory>
variables:
- description: 'These additional options are supplied as arguments to the "docker

    create" command, in addition to those controlled by the Batch Service.'
  name: container_run_options
  types:
  - <xref:str>
- description: 'This is the full image reference, as would be specified to "docker
    pull". If

    no tag is provided as part of the image name, the tag ":latest" is used as a default.
    Required.'
  name: image_name
  types:
  - <xref:str>
- description: This setting can be omitted if was already provided at pool creation.
  name: registry
  types:
  - <xref:azure.mgmt.batch.models.ContainerRegistry>
- description: 'A flag to indicate where the container task working directory is.
    The

    default is ''taskWorkingDirectory''. Known values are: "TaskWorkingDirectory"
    and

    "ContainerImageDefault".'
  name: working_directory
  types:
  - <xref:str>
  - <xref:azure.mgmt.batch.models.ContainerWorkingDirectory>