Sessions - Open

Service:: Azure Quantum

API-versie:: 2026-01-15-preview

Open een nieuwe sessie.

PUT {endpoint}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}?api-version=2026-01-15-preview

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Het eindpunt van de Azure Quantum-dienst. Bijvoorbeeld, https://{region}.quantum.azure.com
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$	Naam van de Azure-resourcegroep.
sessionId	path	True	string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$	Id van de sessie.
subscriptionId	path	True	string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$	De Azure-abonnements-id.
workspaceName	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$	Naam van de Azure Quantum-werkruimte.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
itemType	True	string: Session	Type van het Quantum Workspace-item
jobFailurePolicy	True	SessionJobFailurePolicy	Beleid dat het gedrag van de sessie bepaalt wanneer een taak in de sessie mislukt.
name	True	string	De naam van het artikel. Het is niet vereist dat de naam uniek is en wordt alleen gebruikt voor weergavedoeleinden.
providerId	True	string	De unieke identificatiecode voor de aanbieder.
target	True	string	De doel-id om de taak uit te voeren.
priority		Priority	Prioriteit van baan of sessie.
tags		string[]	Lijst met door de gebruiker opgegeven tags die aan de taak zijn gekoppeld.

Antwoorden

Name	Type	Description
200 OK	SessionDetails	De aanvraag is voltooid.
201 Created	SessionDetails	De aanvraag is geslaagd en er is een nieuwe resource gemaakt.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

SessionDetails

De aanvraag is voltooid.

201 Created

SessionDetails

De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

AzureEntraAuth

Azure Entra OAuth2 Authentication

Type: oauth2
Stroom: application
Token-URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Bereiken

Name	Description
https://quantum.microsoft.com/.default

x-ms-quantum-api-key

Azure Api-Key Verificatie

Type: apiKey
In: header

Voorbeelden

Open a session.

Voorbeeldaanvraag

HTTP

PUT {endpoint}/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Quantum/workspaces/my-workspace/sessions/60ba7795-6a13-4630-aec0-260b3904378c?api-version=2026-01-15-preview

{
  "name": "VQE Session",
  "id": "60ba7795-6a13-4630-aec0-260b3904378c",
  "itemType": "Session",
  "jobFailurePolicy": "Abort",
  "providerId": "ionq",
  "target": "ionq.qpu"
}

Voorbeeldrespons

Statuscode:: 200

{
  "name": "VQE Session",
  "id": "60ba7795-6a13-4630-aec0-260b3904378c",
  "itemType": "Session",
  "beginExecutionTime": null,
  "creationTime": "2020-09-30T23:57:02.3737928+00:00",
  "createdBy": "user1@example.com",
  "createdByType": "User",
  "endExecutionTime": null,
  "errorData": null,
  "jobFailurePolicy": "Abort",
  "providerId": "ionq",
  "status": "Waiting",
  "target": "ionq.qpu"
}

Statuscode:: 201

{
  "name": "VQE Session",
  "id": "60ba7795-6a13-4630-aec0-260b3904378c",
  "itemType": "Session",
  "beginExecutionTime": null,
  "creationTime": "2020-09-30T23:57:02.3737928+00:00",
  "createdBy": "user1@example.com",
  "createdByType": "User",
  "endExecutionTime": null,
  "errorData": null,
  "jobFailurePolicy": "Abort",
  "providerId": "ionq",
  "status": "Waiting",
  "target": "ionq.qpu"
}

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors
CostEstimate	De opdrachtkosten die door de aanbieder worden gefactureerd. De uiteindelijke kosten op uw rekening kunnen enigszins afwijken als gevolg van extra belastingen en wisselkoersen.
CreatedByType	Het type identiteit dat het item heeft gecreëerd.
Errors.WorkspaceItemError	Het foutobject.
ItemType	Het type van het werkruimte-item.
Priority	Prioriteitsniveaus voor banen.
SessionDetails	Sessie, een logische groepering van taken.
SessionJobFailurePolicy	Beleid dat het gedrag van de sessie bepaalt wanneer een taak in de sessie mislukt.
SessionStatus	De status van de sessie.
UsageEvent	Details van gebruiksgebeurtenissen.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

CostEstimate

Object

De opdrachtkosten die door de aanbieder worden gefactureerd. De uiteindelijke kosten op uw rekening kunnen enigszins afwijken als gevolg van extra belastingen en wisselkoersen.

Name	Type	Description
currencyCode	string	De valutacode.
estimatedTotal	number (float)	Het geschatte totaal.
events	UsageEvent[]	Lijst met gebruiksgebeurtenissen.

CreatedByType

Opsomming

Het type identiteit dat het item heeft gecreëerd.

Waarde	Description
User	Het item wordt door de gebruiker aangemaakt
Application	Het item wordt aangemaakt door applicatie
ManagedIdentity	Het item wordt aangemaakt met een beheerde identiteit
Key	Het item wordt gemaakt met behulp van de sleutel

Errors.WorkspaceItemError

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ItemType

Opsomming

Het type van het werkruimte-item.

Waarde	Description
Job	Een programma, probleem of toepassing die is ingediend voor verwerking.
Session	Een logische groepering van banen.

Priority

Opsomming

Prioriteitsniveaus voor banen.

Waarde	Description
Standard	De basisprioriteit van de baan.
High	De prioriteit van het werk is verhoogd.

SessionDetails

Object

Sessie, een logische groepering van taken.

Name	Type	Description
beginExecutionTime	string (date-time)	Het tijdstip waarop de uitvoering van het item begon.
costEstimate	CostEstimate	Kostenraming.
createdBy	string	De identiteit die het voorwerp heeft gemaakt.
createdByType	CreatedByType	Het type identiteit dat het item heeft gecreëerd.
creationTime	string (date-time)	De aanmaaktijd van het item.
endExecutionTime	string (date-time)	Het tijdstip waarop het item klaar is met uitvoering.
errorData	Errors.WorkspaceItemError	Foutinformatie.
id	string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$	Id van de sessie.
itemType	string: Session	Type van het Quantum Workspace-item
jobFailurePolicy	SessionJobFailurePolicy	Beleid dat het gedrag van de sessie bepaalt wanneer een taak in de sessie mislukt.
lastModifiedBy	string	De identiteit die het item voor het laatst heeft aangepast.
lastModifiedByType	CreatedByType	Het type identiteit dat het item als laatste heeft aangepast.
lastModifiedTime	string (date-time)	De tijdstempel van de laatste wijziging van het artikel is door de klant geïnitieerd.
lastUpdatedTime	string (date-time)	De laatste keer dat het item door het systeem werd bijgewerkt.
name	string	De naam van het artikel. Het is niet vereist dat de naam uniek is en wordt alleen gebruikt voor weergavedoeleinden.
priority	Priority	Prioriteit van baan of sessie.
providerId	string	De unieke identificatiecode voor de aanbieder.
status	SessionStatus	De status van de sessie.
tags	string[]	Lijst met door de gebruiker opgegeven tags die aan de taak zijn gekoppeld.
target	string	De doel-id om de taak uit te voeren.
usage	object	Metrische gegevens over het verbruik van resources met providerspecifieke gebruiksgegevens zoals uitvoeringstijd, verbruikte kwantumshots, enz.

SessionJobFailurePolicy

Opsomming

Beleid dat het gedrag van de sessie bepaalt wanneer een taak in de sessie mislukt.

Waarde	Description
Abort	Nieuwe taken die worden ingediend nadat een taak is mislukt, worden afgewezen.
Continue	Nieuwe taken die worden ingediend nadat een taak is mislukt, worden geaccepteerd.

SessionStatus

Opsomming

De status van de sessie.

Waarde	Description
Waiting	De sessie staat in de wachtrij te wachten om uitgevoerd te worden.
Executing	De sessie wordt uitgevoerd.
Succeeded	De sessie werd met succes afgerond.
Failed	De sessie eindigde met mislukking.
Failure(s)	De sessie werd afgesloten met enkele mislukkingen.
TimedOut	Er is een time-out opgetreden in de sessie.

UsageEvent

Object

Details van gebruiksgebeurtenissen.

Name	Type	Description
amountBilled	number (float)	Het gefactureerde bedrag.
amountConsumed	number (float)	De geconsumeerde hoeveelheid.
dimensionId	string	De dimensie id.
dimensionName	string	De dimensienaam.
measureUnit	string	De maateenheid.
unitPrice	number (float)	De eenheidsprijs.