Sessions - Close

Usługa:: Azure Quantum

Wersja API:: 2026-01-15-preview

Zamknij istniejącą sesję.

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Endpoint usługi Azure Quantum. Na przykład https://{region}.quantum.azure.com
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$	Nazwa grupy zasobów platformy Azure.
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}$	Identyfikator sesji.
subscriptionId	path	True	string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$	Identyfikator subskrypcji platformy Azure.
workspaceName	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$	Nazwa obszaru roboczego usługi Azure Quantum.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SessionDetails	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

SessionDetails

Żądanie zakończyło się pomyślnie.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

AzureEntraAuth

Uwierzytelnianie OAuth2 usługi Azure Entra

Typ: oauth2
Flow: application
URL tokena: https://login.microsoftonline.com/common/oauth2/v2.0/token

Zakresów

Nazwa	Opis
https://quantum.microsoft.com/.default

x-ms-quantum-api-key

Uwierzytelnianie usługi Azure Api-Key

Typ: apiKey
W: header

Przykłady

Closes a session by its id.

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:: 200

{
  "name": "VQE Session",
  "id": "60ba7795-6a13-4630-aec0-260b3904378c",
  "itemType": "Session",
  "beginExecutionTime": "2020-09-30T23:57:11.5659691Z",
  "creationTime": "2020-09-30T23:57:02.3737928+00:00",
  "createdBy": "user1@example.com",
  "createdByType": "User",
  "lastModifiedTime": "2020-10-01T01:05:00.0000000+00:00",
  "lastModifiedBy": "user2@example.com",
  "lastModifiedByType": "User",
  "lastUpdatedTime": "2020-10-01T01:00:00.0000000+00:00",
  "endExecutionTime": "2020-09-30T23:57:11.6180743Z",
  "errorData": null,
  "jobFailurePolicy": "Abort",
  "providerId": "ionq",
  "status": "Succeeded",
  "target": "ionq.qpu"
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
CostEstimate	Koszt zadania rozliczany przez dostawcę. Ostateczny koszt na rachunku może się nieznacznie różnić ze względu na dodane podatki i kursy wymiany walut.
CreatedByType	Typ tożsamości, która stworzyła przedmiot.
Errors.WorkspaceItemError	Obiekt błędu.
ItemType	Typ elementu obszaru roboczego.
Priority	Poziomy priorytetów zadań.
SessionDetails	Sesja, logiczne grupowanie zadań.
SessionJobFailurePolicy	Zasady kontrolujące zachowanie sesji, gdy zadanie w sesji zakończy się niepowodzeniem.
SessionStatus	Stan sesji.
UsageEvent	Szczegóły zdarzenia użycia.

Azure.Core.Foundations.Error

Sprzeciwiać się

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Sprzeciwiać się

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Sprzeciwiać się

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

CostEstimate

Sprzeciwiać się

Koszt zadania rozliczany przez dostawcę. Ostateczny koszt na rachunku może się nieznacznie różnić ze względu na dodane podatki i kursy wymiany walut.

Nazwa	Typ	Opis
currencyCode	string	Kod waluty.
estimatedTotal	number (float)	Szacowana suma.
events	UsageEvent[]	Lista zdarzeń użycia.

CreatedByType

Wyliczenie

Typ tożsamości, która stworzyła przedmiot.

Wartość	Opis
User	Element jest tworzony przez użytkownika
Application	Element jest tworzony przez aplikację
ManagedIdentity	Element jest tworzony za pomocą zarządzanej tożsamości
Key	Przedmiot jest tworzony za pomocą klucza

Errors.WorkspaceItemError

Sprzeciwiać się

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ItemType

Wyliczenie

Typ elementu obszaru roboczego.

Wartość	Opis
Job	Program, problem lub aplikacja przesłana do przetworzenia.
Session	Logiczne grupowanie zadań.

Priority

Wyliczenie

Poziomy priorytetów zadań.

Wartość	Opis
Standard	Podstawowy priorytet zadania.
High	Priorytet zadania jest podniesiony.

SessionDetails

Sprzeciwiać się

Sesja, logiczne grupowanie zadań.

Nazwa	Typ	Opis
beginExecutionTime	string (date-time)	Godzina, w której element został wykonany.
costEstimate	CostEstimate	Kosztorys.
createdBy	string	Tożsamość, która stworzyła przedmiot.
createdByType	CreatedByType	Typ tożsamości, która stworzyła przedmiot.
creationTime	string (date-time)	Czas utworzenia elementu.
endExecutionTime	string (date-time)	Czas, w którym element został zakończony wykonywania.
errorData	Errors.WorkspaceItemError	Informacje o błędzie.
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}$	Identyfikator sesji.
itemType	string: Session	Typ elementu Quantum Workspace
jobFailurePolicy	SessionJobFailurePolicy	Zasady kontrolujące zachowanie sesji, gdy zadanie w sesji zakończy się niepowodzeniem.
lastModifiedBy	string	Tożsamość, która ostatnio zmieniła przedmiot.
lastModifiedByType	CreatedByType	Typ tożsamości, który ostatnio zmodyfikował przedmiot.
lastModifiedTime	string (date-time)	Znacznik czasu ostatniej modyfikacji produktu zainicjowanej przez klienta.
lastUpdatedTime	string (date-time)	Ostatnim razem, gdy system zaktualizował produkt.
name	string	Nazwa towaru. Nie jest to wymagane, aby nazwa była unikatowa i służy tylko do celów wyświetlania.
priority	Priority	Priorytet zadania lub sesji.
providerId	string	Niepowtarzalny identyfikator dostawcy.
status	SessionStatus	Stan sesji.
tags	string[]	Lista tagów dostarczonych przez użytkownika skojarzonych z zadaniem.
target	string	Identyfikator docelowy do uruchomienia zadania.
usage	object	Metryki zużycia zasobów zawierające dane użycia specyficzne dla dostawcy, takie jak czas wykonywania, zużyte strzały kwantowe itp.

SessionJobFailurePolicy

Wyliczenie

Zasady kontrolujące zachowanie sesji, gdy zadanie w sesji zakończy się niepowodzeniem.

Wartość	Opis
Abort	Nowe zadania przesłane po niepowodzeniu zadania zostaną odrzucone.
Continue	Nowe zadania przesłane po niepowodzeniu zadania będą akceptowane.

SessionStatus

Wyliczenie

Stan sesji.

Wartość	Opis
Waiting	Sesja oczekuje w kolejce na wykonanie.
Executing	Sesja jest wykonywana.
Succeeded	Sesja zakończyła się sukcesem.
Failed	Sesja zakończyła się niepowodzeniem.
Failure(s)	Sesja zakończyła się kilkoma niepowodzeniami.
TimedOut	Upłynął limit czasu sesji.

UsageEvent

Sprzeciwiać się

Szczegóły zdarzenia użycia.

Nazwa	Typ	Opis
amountBilled	number (float)	Kwota faktury.
amountConsumed	number (float)	Ilość zużyta.
dimensionId	string	Identyfikator wymiaru.
dimensionName	string	Nazwa wymiaru.
measureUnit	string	Jednostka miary.
unitPrice	number (float)	Cena jednostkowa.