### YamlMime:JavaType
uid: "com.microsoft.azure.management.batch.TaskContainerSettings"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings"
name: "TaskContainerSettings"
nameWithType: "TaskContainerSettings"
summary: "The container settings for a task."
inheritances:
- ""
inheritedClassMethods:
- classRef: ""
methodsRef:
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
syntax: "public class **TaskContainerSettings**"
constructors:
- uid: "com.microsoft.azure.management.batch.TaskContainerSettings.TaskContainerSettings()"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings.TaskContainerSettings()"
name: "TaskContainerSettings()"
nameWithType: "TaskContainerSettings.TaskContainerSettings()"
syntax: "public TaskContainerSettings()"
methods:
- uid: "com.microsoft.azure.management.batch.TaskContainerSettings.containerRunOptions()"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings.containerRunOptions()"
name: "containerRunOptions()"
nameWithType: "TaskContainerSettings.containerRunOptions()"
summary: "Get these additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service."
syntax: "public String containerRunOptions()"
desc: "Get these additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service."
returns:
description: "the containerRunOptions value"
type: ""
- uid: "com.microsoft.azure.management.batch.TaskContainerSettings.imageName()"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings.imageName()"
name: "imageName()"
nameWithType: "TaskContainerSettings.imageName()"
summary: "Get this is the full image reference, as would be specified to \"docker pull\"."
syntax: "public String imageName()"
desc: "Get 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."
returns:
description: "the imageName value"
type: ""
- uid: "com.microsoft.azure.management.batch.TaskContainerSettings.registry()"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings.registry()"
name: "registry()"
nameWithType: "TaskContainerSettings.registry()"
summary: "Get this setting can be omitted if was already provided at pool creation."
syntax: "public ContainerRegistry registry()"
desc: "Get this setting can be omitted if was already provided at pool creation."
returns:
description: "the registry value"
type: ""
- uid: "com.microsoft.azure.management.batch.TaskContainerSettings.withContainerRunOptions(java.lang.String)"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings.withContainerRunOptions(String containerRunOptions)"
name: "withContainerRunOptions(String containerRunOptions)"
nameWithType: "TaskContainerSettings.withContainerRunOptions(String containerRunOptions)"
summary: "Set these additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service."
parameters:
- description: "the containerRunOptions value to set"
name: "containerRunOptions"
type: ""
syntax: "public TaskContainerSettings withContainerRunOptions(String containerRunOptions)"
desc: "Set these additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service."
returns:
description: "the TaskContainerSettings object itself."
type: ""
- uid: "com.microsoft.azure.management.batch.TaskContainerSettings.withImageName(java.lang.String)"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings.withImageName(String imageName)"
name: "withImageName(String imageName)"
nameWithType: "TaskContainerSettings.withImageName(String imageName)"
summary: "Set this is the full image reference, as would be specified to \"docker pull\"."
parameters:
- description: "the imageName value to set"
name: "imageName"
type: ""
syntax: "public TaskContainerSettings withImageName(String imageName)"
desc: "Set 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."
returns:
description: "the TaskContainerSettings object itself."
type: ""
- uid: "com.microsoft.azure.management.batch.TaskContainerSettings.withRegistry(com.microsoft.azure.management.batch.ContainerRegistry)"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings.withRegistry(ContainerRegistry registry)"
name: "withRegistry(ContainerRegistry registry)"
nameWithType: "TaskContainerSettings.withRegistry(ContainerRegistry registry)"
summary: "Set this setting can be omitted if was already provided at pool creation."
parameters:
- description: "the registry value to set"
name: "registry"
type: ""
syntax: "public TaskContainerSettings withRegistry(ContainerRegistry registry)"
desc: "Set this setting can be omitted if was already provided at pool creation."
returns:
description: "the TaskContainerSettings object itself."
type: ""
- uid: "com.microsoft.azure.management.batch.TaskContainerSettings.withWorkingDirectory(com.microsoft.azure.management.batch.ContainerWorkingDirectory)"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings.withWorkingDirectory(ContainerWorkingDirectory workingDirectory)"
name: "withWorkingDirectory(ContainerWorkingDirectory workingDirectory)"
nameWithType: "TaskContainerSettings.withWorkingDirectory(ContainerWorkingDirectory workingDirectory)"
summary: "Set possible values include: 'TaskWorkingDirectory', 'ContainerImageDefault'."
parameters:
- description: "the workingDirectory value to set"
name: "workingDirectory"
type: ""
syntax: "public TaskContainerSettings withWorkingDirectory(ContainerWorkingDirectory workingDirectory)"
desc: "Set possible values include: 'TaskWorkingDirectory', 'ContainerImageDefault'."
returns:
description: "the TaskContainerSettings object itself."
type: ""
- uid: "com.microsoft.azure.management.batch.TaskContainerSettings.workingDirectory()"
fullName: "com.microsoft.azure.management.batch.TaskContainerSettings.workingDirectory()"
name: "workingDirectory()"
nameWithType: "TaskContainerSettings.workingDirectory()"
summary: "Get possible values include: 'TaskWorkingDirectory', 'ContainerImageDefault'."
syntax: "public ContainerWorkingDirectory workingDirectory()"
desc: "Get possible values include: 'TaskWorkingDirectory', 'ContainerImageDefault'."
returns:
description: "the workingDirectory value"
type: ""
type: "class"
desc: "The container settings for a task."
metadata: {}
package: "com.microsoft.azure.management.batch"
artifact: com.microsoft.azure:azure-mgmt-batch:1.41.4