BatchSubtask Class

Information about an Azure Batch subtask.

Constructor

BatchSubtask(*args: Any, **kwargs: Any)

Variables

Name	Description
id	int The ID of the subtask.
node_info	BatchNodeInfo Information about the Compute Node on which the subtask ran.
start_time	datetime The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running.
end_time	datetime The time at which the subtask completed. This property is set only if the subtask is in the Completed state.
exit_code	int The exit code of the program specified on the subtask command line. This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code.
container_info	BatchTaskContainerExecutionInfo Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.
failure_info	BatchTaskFailureInfo Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.
state	str or BatchSubtaskState The current state of the subtask. Known values are: "preparing", "running", and "completed".
state_transition_time	datetime The time at which the subtask entered its current state.
previous_state	str or BatchSubtaskState The previous state of the subtask. This property is not set if the subtask is in its initial running state. Known values are: "preparing", "running", and "completed".
previous_state_transition_time	datetime The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state.
result	str or BatchTaskExecutionResult The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Known values are: "success" and "failure".

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

container_info

Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.

container_info: _models.BatchTaskContainerExecutionInfo | None

end_time

The time at which the subtask completed. This property is set only if the subtask is in the Completed state.

end_time: datetime | None

exit_code

The exit code of the program specified on the subtask command line. This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

exit_code: int | None

failure_info

Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.

failure_info: _models.BatchTaskFailureInfo | None

id

The ID of the subtask.

id: int | None

node_info

Information about the Compute Node on which the subtask ran.

node_info: _models.BatchNodeInfo | None

previous_state

The previous state of the subtask. This property is not set if the subtask is in its initial running state. Known values are: "preparing", "running", and "completed".

previous_state: str | _models.BatchSubtaskState | None

previous_state_transition_time

The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state.

previous_state_transition_time: datetime | None

result

The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Known values are: "success" and "failure".

result: str | _models.BatchTaskExecutionResult | None

start_time

The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running.

start_time: datetime | None

state

"preparing", "running", and "completed".

state: str | _models.BatchSubtaskState | None

state_transition_time

The time at which the subtask entered its current state.

state_transition_time: datetime | None