SetupTask Class

Specifies a setup task which can be used to customize the compute nodes of the cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

SetupTask

Constructor

SetupTask(*, command_line: str, std_out_err_path_prefix: str, environment_variables: Optional[List[azure.mgmt.batchai.models._models_py3.EnvironmentVariable]] = None, secrets: Optional[List[azure.mgmt.batchai.models._models_py3.EnvironmentVariableWithSecretValue]] = None, **kwargs)

Parameters

command_line

str

Required

Required. The command line to be executed on each cluster's node after it being allocated or rebooted. The command is executed in a bash subshell as a root.

environment_variables

list[<xref:batch_ai.models.EnvironmentVariable>]

Required

A collection of user defined environment variables to be set for setup task.

secrets

list[<xref:batch_ai.models.EnvironmentVariableWithSecretValue>]

Required

A collection of user defined environment variables with secret values to be set for the setup task. Server will never report values of these variables back.

std_out_err_path_prefix

str

Required

Required. The prefix of a path where the Batch AI service will upload the stdout, stderr and execution log of the setup task.

Variables

std_out_err_path_suffix

str

A path segment appended by Batch AI to stdOutErrPathPrefix to form a path where stdout, stderr and execution log of the setup task will be uploaded. Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. The full path can be obtained by concatenation of stdOutErrPathPrefix and stdOutErrPathSuffix.