Run Class

Run resource properties.

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

Constructor

Run(*, run_id: str | None = None, status: str | _models.RunStatus | None = None, last_updated_time: datetime | None = None, run_type: str | _models.RunType | None = None, agent_pool_name: str | None = None, create_time: datetime | None = None, start_time: datetime | None = None, finish_time: datetime | None = None, output_images: List[_models.ImageDescriptor] | None = None, task: str | None = None, image_update_trigger: _models.ImageUpdateTrigger | None = None, source_trigger: _models.SourceTriggerDescriptor | None = None, timer_trigger: _models.TimerTriggerDescriptor | None = None, platform: _models.PlatformProperties | None = None, agent_configuration: _models.AgentProperties | None = None, source_registry_auth: str | None = None, custom_registries: List[str] | None = None, update_trigger_token: str | None = None, provisioning_state: str | _models.ProvisioningState | None = None, is_archive_enabled: bool = False, **kwargs: Any)

Keyword-Only Parameters

Name	Description
run_id	str The unique identifier for the run. Default value: None
status	str or RunStatus The current status of the run. Known values are: "Queued", "Started", "Running", "Succeeded", "Failed", "Canceled", "Error", and "Timeout". Default value: None
last_updated_time	datetime The last updated time for the run. Default value: None
run_type	str or RunType The type of run. Known values are: "QuickBuild", "QuickRun", "AutoBuild", and "AutoRun". Default value: None
agent_pool_name	str The dedicated agent pool for the run. Default value: None
create_time	datetime The time the run was scheduled. Default value: None
start_time	datetime The time the run started. Default value: None
finish_time	datetime The time the run finished. Default value: None
output_images	list[ImageDescriptor] The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. Default value: None
task	str The task against which run was scheduled. Default value: None
image_update_trigger	ImageUpdateTrigger The image update trigger that caused the run. This is applicable if the task has base image trigger configured. Default value: None
source_trigger	SourceTriggerDescriptor The source trigger that caused the run. Default value: None
timer_trigger	TimerTriggerDescriptor The timer trigger that caused the run. Default value: None
platform	PlatformProperties The platform properties against which the run will happen. Default value: None
agent_configuration	AgentProperties The machine configuration of the run agent. Default value: None
source_registry_auth	str The scope of the credentials that were used to login to the source registry during this run. Default value: None
custom_registries	list[str] The list of custom registries that were logged in during this run. Default value: None
update_trigger_token	str The update trigger token passed for the Run. Default value: None
provisioning_state	str or ProvisioningState The provisioning state of a run. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". Default value: None
is_archive_enabled	bool The value that indicates whether archiving is enabled or not. Default value: False

Variables

Name	Description
id	str The resource ID.
name	str The name of the resource.
type	str The type of the resource.
system_data	SystemData Metadata pertaining to creation and last modification of the resource.
run_id	str The unique identifier for the run.
status	str or RunStatus The current status of the run. Known values are: "Queued", "Started", "Running", "Succeeded", "Failed", "Canceled", "Error", and "Timeout".
last_updated_time	datetime The last updated time for the run.
run_type	str or RunType The type of run. Known values are: "QuickBuild", "QuickRun", "AutoBuild", and "AutoRun".
agent_pool_name	str The dedicated agent pool for the run.
create_time	datetime The time the run was scheduled.
start_time	datetime The time the run started.
finish_time	datetime The time the run finished.
output_images	list[ImageDescriptor] The list of all images that were generated from the run. This is applicable if the run generates base image dependencies.
task	str The task against which run was scheduled.
image_update_trigger	ImageUpdateTrigger The image update trigger that caused the run. This is applicable if the task has base image trigger configured.
source_trigger	SourceTriggerDescriptor The source trigger that caused the run.
timer_trigger	TimerTriggerDescriptor The timer trigger that caused the run.
platform	PlatformProperties The platform properties against which the run will happen.
agent_configuration	AgentProperties The machine configuration of the run agent.
source_registry_auth	str The scope of the credentials that were used to login to the source registry during this run.
custom_registries	list[str] The list of custom registries that were logged in during this run.
run_error_message	str The error message received from backend systems after the run is scheduled.
update_trigger_token	str The update trigger token passed for the Run.
log_artifact	ImageDescriptor The image description for the log artifact.
provisioning_state	str or ProvisioningState The provisioning state of a run. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled".
is_archive_enabled	bool The value that indicates whether archiving is enabled or not.