Sign in

v10

latestSwagger 2.02026-07-13153575.7 KB

Open a new session.

put/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}

Path parameters

subscriptionIdstring required

The Azure subscription ID.

resourceGroupNamestring required

Name of the Azure resource group.

workspaceNamestring required

Name of the Azure Quantum workspace.

sessionIdstring required

Id of the session.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

idstring required

Id of the workspace item.

namestring required

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

providerIdstring required

The unique identifier for the provider.

targetstring required

The target identifier to run the job.

itemType'Job' | 'Session' required

The type of the workspace item.

creationTimestring date-time

The creation time of the item.

createdBystring

The identity that created the item.

createdByType'User' | 'Application' | 'ManagedIdentity' | 'Key'

The type of identity that created the item.

lastModifiedTimestring date-time

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

lastModifiedBystring

The identity that last modified the item.

lastModifiedByType'User' | 'Application' | 'ManagedIdentity' | 'Key'

The type of identity that created the item.

lastUpdatedTimestring date-time

The last time the item was updated by the system.

beginExecutionTimestring date-time

The time when the item began execution.

endExecutionTimestring date-time

The time when the item finished execution.

priority'Standard' | 'High'

Job priority levels.

tagsstring[]

List of user-supplied tags associated with the job.

usageUsage

Resource usage metrics represented as key-value pairs. Keys are provider-defined metric names (e.g. "standardMinutes", "shots") and values are the corresponding consumption amounts. The specific metrics available depend on the quantum provider and target used.

Response

The request has succeeded.

idstring required

Id of the workspace item.

namestring required

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

providerIdstring required

The unique identifier for the provider.

targetstring required

The target identifier to run the job.

itemType'Job' | 'Session' required

The type of the workspace item.

creationTimestring date-time

The creation time of the item.

createdBystring

The identity that created the item.

createdByType'User' | 'Application' | 'ManagedIdentity' | 'Key'

The type of identity that created the item.

lastModifiedTimestring date-time

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

lastModifiedBystring

The identity that last modified the item.

lastModifiedByType'User' | 'Application' | 'ManagedIdentity' | 'Key'

The type of identity that created the item.

lastUpdatedTimestring date-time

The last time the item was updated by the system.

beginExecutionTimestring date-time

The time when the item began execution.

endExecutionTimestring date-time

The time when the item finished execution.

priority'Standard' | 'High'

Job priority levels.

tagsstring[]

List of user-supplied tags associated with the job.

usageUsage

Resource usage metrics represented as key-value pairs. Keys are provider-defined metric names (e.g. "standardMinutes", "shots") and values are the corresponding consumption amounts. The specific metrics available depend on the quantum provider and target used.