SessionDetails Class

Session, a logical grouping of jobs.

Constructor

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

Variables

Name Description
name
str

The name of the item. It is not required for the name to be unique and it's only used for display purposes. Required.
provider_id
str

The unique identifier for the provider. Required.
target
str

The target identifier to run the job. Required.
creation_time
datetime

The creation time of the item.
created_by
str

The identity that created the item.
created_by_type
str or <xref:azure.quantum.models.CreatedByType>

The type of identity that created the item. Known values are: "User", "Application", "ManagedIdentity", and "Key".
last_modified_time
datetime

The timestamp of the item last modification initiated by the customer.
last_modified_by
str

The identity that last modified the item.
last_modified_by_type
str or <xref:azure.quantum.models.CreatedByType>

The type of identity that last modified the item. Known values are: "User", "Application", "ManagedIdentity", and "Key".
last_updated_time
datetime

The last time the item was updated by the system.
begin_execution_time
datetime

The time when the item began execution.
end_execution_time
datetime

The time when the item finished execution.
cost_estimate
<xref:azure.quantum.models.CostEstimate>

Cost estimate.
error_data
<xref:azure.quantum.models.WorkspaceItemError>

Error information.
priority
str or <xref:azure.quantum.models.Priority>

Priority of job or session. Known values are: "Standard" and "High".
tags
list[str]

List of user-supplied tags associated with the job.
usage
<xref:azure.quantum.models.Usage>

Resource consumption metrics containing provider-specific usage data such as execution time, quantum shots consumed etc.
id
str

Id of the session. Required.
item_type
str or <xref:azure.quantum.models.SESSION>

Type of the Quantum Workspace item is Session. Required. A logical grouping of jobs.
job_failure_policy
str or <xref:azure.quantum.models.SessionJobFailurePolicy>

Policy controlling the behavior of the Session when a job in the session fails. Required. Known values are: "Abort" and "Continue".
status
str or <xref:azure.quantum.models.SessionStatus>

The status of the session. Known values are: "Waiting", "Executing", "Succeeded", "Failed", "Failure(s)", and "TimedOut".

Attributes

item_type

Type of the Quantum Workspace item is Session. Required. A logical grouping of jobs.

item_type: SESSION: 'Session'>]

job_failure_policy

Policy controlling the behavior of the Session when a job in the session fails. Required. Known values are: "Abort" and "Continue".

job_failure_policy: str | _models.SessionJobFailurePolicy

status

"Waiting", "Executing", "Succeeded", "Failed", "Failure(s)", and "TimedOut".

status: str | _models.SessionStatus | None