Workspace Klasse

Stellt einen Azure Quantum-Arbeitsbereich dar.

Beim Erstellen eines Workspace-Objekts haben Aufrufer mehrere Optionen zum Identifizieren des Azure Quantum Arbeitsbereichs (in Der Reihenfolge der Rangfolge):

geben Sie eine gültige Ressourcen-ID an; Oder
geben Sie eine gültige Abonnement-ID, Ressourcengruppe und arbeitsbereichsnamen an; Oder
geben Sie einen gültigen Arbeitsbereichsnamen an.

Sie können auch eine Verbindungszeichenfolge verwenden, um die Verbindungsparameter für einen Azure Quantum Workspace anzugeben, indem Sie from_connection_stringaufrufen.

Wenn der Azure Quantum-Arbeitsbereich keinen verknüpften Speicher hat, muss der Aufrufer auch eine gültige Azure Storage Account-Verbindungszeichenfolge übergeben.

Konstruktor

Workspace(subscription_id: str | None = None, resource_group: str | None = None, name: str | None = None, storage: str | None = None, resource_id: str | None = None, location: str | None = None, credential: object | None = None, user_agent: str | None = None, **kwargs: Any)

Parameter

Name	Beschreibung
subscription_id	Die Azure-Abonnement-ID. Wird ignoriert, wenn resource_id angegeben ist. Standardwert: None
resource_group	Der Name der Azure-Ressourcengruppe. Wird ignoriert, wenn resource_id angegeben ist. Standardwert: None
name	Der Name des Azure Quantum-Arbeitsbereichs. Wird ignoriert, wenn resource_id angegeben ist. Standardwert: None
storage	Die Verbindungszeichenfolge des Azure-Speicherkontos. Nur erforderlich, wenn der angegebene Azure Quantum-Arbeitsbereich keinen verknüpften Speicher hat. Standardwert: None
resource_id	Die Ressourcen-ID des Azure Quantum-Arbeitsbereichs. Standardwert: None
location	Die Azure-Region, in der der Azure Quantum-Arbeitsbereich bereitgestellt wird. Dies kann als Regionsname wie "East US" oder einen Ortsnamen wie "eastus" angegeben werden. Standardwert: None
credential	Die Anmeldeinformationen, die zum Herstellen einer Verbindung mit Azure-Diensten verwendet werden sollen. Normalerweise ist einer der Anmeldeinformationstypen aus Azure.Identity. Standardmäßig wird "DefaultAzureCredential" verwendet, wodurch mehrere Authentifizierungsformen versucht werden. Standardwert: None
user_agent	Fügen Sie den angegebenen Wert als Präfix zum HTTP-User-Agent-Header bei der Kommunikation mit dem Azure Quantum-Dienst hinzu. Standardwert: None

Methoden

append_user_agent	Fügen Sie einen neuen Wert an den UserAgent des Arbeitsbereichs an. Die Werte werden mit einem Gedankenstrich angefügt.
cancel_job	Fordert den Arbeitsbereich auf, die Ausführung eines Auftrags abzubrechen.
close
close_session	Schließt eine Sitzung im angegebenen Arbeitsbereich, wenn sich die Sitzung nicht im Terminalzustand befindet. Andernfalls werden nur die Sitzungsdetails aktualisiert.
from_connection_string	Erstellt einen neuen Azure Quantum Workspace-Client aus einer Verbindungszeichenfolge.
get_container_uri	Abrufen des Container-URI basierend auf Auftrags-ID oder Containername. Erstellt einen neuen Container, falls er noch nicht vorhanden ist.
get_job	Gibt den Auftrag zurück, der der angegebenen ID entspricht.
get_quotas	Dient zum Abrufen einer Liste von Kontingenten für den angegebenen Arbeitsbereich. Jedes Kontingent wird als Wörterbuch dargestellt, das die Eigenschaften für dieses Kontingent enthält. Allgemeine Kontingenteigenschaften sind: "dimension": Die Dimension, auf die das Kontingent angewendet wird. "scope": Der Bereich, auf den das Kontingent angewendet wird. "provider_id": Der Anbieter, auf den das Kontingent angewendet wird. "auslastung": Die aktuelle Auslastung des Kontingents. "limit": Der Grenzwert des Kontingents. "period": Der Zeitraum, auf den das Kontingent angewendet wird.
get_session	Ruft eine Sitzung aus dem Arbeitsbereich ab.
get_targets	Gibt alle verfügbaren Ziele für diesen Arbeitsbereich zurück, gefiltert nach Zielname und Anbieter-ID. Wenn der Zielname übergeben wird, wird ein einzelnes Target-Objekt zurückgegeben. Andernfalls wird eine iterable/liste von Target-Objekten zurückgegeben, optional nach der Anbieter-ID gefiltert.
list_jobs	Gibt eine Liste von Aufträgen zurück, die optionale (eingeschränkte) Filterkriterien erfüllen.
list_jobs_paginated
list_session_jobs	Ruft alle Aufträge ab, die einer Sitzung zugeordnet sind.
list_session_jobs_paginated	Ruft alle Aufträge ab, die einer Sitzung zugeordnet sind.
list_sessions	Ruft die Liste der Sitzungen im angegebenen Arbeitsbereich ab.
list_sessions_paginated	Ruft die Liste der Sitzungen im angegebenen Arbeitsbereich ab.
list_top_level_items	Rufen Sie eine Liste der Elemente der obersten Ebene für den angegebenen Arbeitsbereich ab, die eigenständige Aufträge (Aufträge, die keiner Sitzung zugeordnet sind) oder Sitzungen (die Aufträge enthalten können).
list_top_level_items_paginated
open_session	Öffnet/erstellt eine Sitzung im angegebenen Arbeitsbereich.
refresh_session	Aktualisiert die Sitzungsdetails mit den neuesten Informationen aus dem Arbeitsbereich.
submit_job	Sendet einen Auftrag, der im Arbeitsbereich verarbeitet werden soll.

append_user_agent

Fügen Sie einen neuen Wert an den UserAgent des Arbeitsbereichs an. Die Werte werden mit einem Gedankenstrich angefügt.

append_user_agent(value: str) -> None

Parameter

Name	Beschreibung
value Erforderlich	UserAgent-Wert zum Hinzufügen, z. B. "azure-quantum-plugin<>"

cancel_job

Fordert den Arbeitsbereich auf, die Ausführung eines Auftrags abzubrechen.

cancel_job(job: Job) -> Job

Parameter

Name	Beschreibung
job Erforderlich	Auftrag, der abgebrochen werden soll.

Gibt zurück

Typ	Beschreibung
Job	Azure Quantum Job, der angefordert wurde, um gekündigt zu werden, mit einem aktualisierten Status.

close

close() -> None

close_session

Schließt eine Sitzung im angegebenen Arbeitsbereich, wenn sich die Sitzung nicht im Terminalzustand befindet. Andernfalls werden nur die Sitzungsdetails aktualisiert.

close_session(session: Session) -> None

Parameter

Name	Beschreibung
session Erforderlich	Die sitzung, die geschlossen werden soll.

from_connection_string

Erstellt einen neuen Azure Quantum Workspace-Client aus einer Verbindungszeichenfolge.

from_connection_string(connection_string: str, **kwargs) -> Workspace

Parameter

Name	Beschreibung
connection_string Erforderlich	Eine gültige Verbindungszeichenfolge, die in der Regel aus dem Quantum Workspace -> Operations -> Access Keys Blatt im Azure-Portal abgerufen wird.

Gibt zurück

Typ	Beschreibung
Workspace	Neuer Azure Quantum Workspace-Client.

get_container_uri

Abrufen des Container-URI basierend auf Auftrags-ID oder Containername. Erstellt einen neuen Container, falls er noch nicht vorhanden ist.

get_container_uri(job_id: str | None = None, container_name: str | None = None, container_name_format: str | None = 'job-{job_id}') -> str

Parameter

Name	Beschreibung
job_id	Auftrags-ID, standardmäßig auf None. Standardwert: None
container_name	Containername, standardmäßig None. Standardwert: None
container_name_format	Containernamenformat, standardmäßig "job-{job_id}". Standardwert: job-{job_id}

Gibt zurück

Typ	Beschreibung
str	Container-URI.

get_job

Gibt den Auftrag zurück, der der angegebenen ID entspricht.

get_job(job_id: str) -> Job

Parameter

Name	Beschreibung
job_id Erforderlich	Id eines abzurufenden Auftrags.

Gibt zurück

Typ	Beschreibung
Job	Azure Quantum Auftrag.

get_quotas

Dient zum Abrufen einer Liste von Kontingenten für den angegebenen Arbeitsbereich. Jedes Kontingent wird als Wörterbuch dargestellt, das die Eigenschaften für dieses Kontingent enthält.

Allgemeine Kontingenteigenschaften sind:

"dimension": Die Dimension, auf die das Kontingent angewendet wird.
"scope": Der Bereich, auf den das Kontingent angewendet wird.
"provider_id": Der Anbieter, auf den das Kontingent angewendet wird.
"auslastung": Die aktuelle Auslastung des Kontingents.
"limit": Der Grenzwert des Kontingents.
"period": Der Zeitraum, auf den das Kontingent angewendet wird.

get_quotas() -> List[Dict[str, Any]]

Gibt zurück

Typ	Beschreibung
List[Dict[str, Any]	Arbeitsbereichskontingente.

get_session

Ruft eine Sitzung aus dem Arbeitsbereich ab.

get_session(session_id: str) -> Session

Parameter

Name	Beschreibung
session_id Erforderlich	Die ID der abzurufenden Sitzung.

Gibt zurück

Typ	Beschreibung
Session	Azure Quantum Sitzung

get_targets

Gibt alle verfügbaren Ziele für diesen Arbeitsbereich zurück, gefiltert nach Zielname und Anbieter-ID. Wenn der Zielname übergeben wird, wird ein einzelnes Target-Objekt zurückgegeben. Andernfalls wird eine iterable/liste von Target-Objekten zurückgegeben, optional nach der Anbieter-ID gefiltert.

get_targets(name: str | None = None, provider_id: str | None = None) -> Target | Iterable[Target]

Parameter

Name	Beschreibung
name	Optionaler Zielname, nach dem gefiltert werden soll, ist standardmäßig auf Nonefestgelegt. Standardwert: None
provider_id	Optionale Anbieter-ID, nach der gefiltert werden soll, ist standardmäßig auf Nonefestgelegt. Standardwert: None

Gibt zurück

Typ	Beschreibung
Union[Target, Iterable[Target]]	Ein einzelnes Azure Quantum Target oder eine iterierbare/Liste von Zielen.

list_jobs

Gibt eine Liste von Aufträgen zurück, die optionale (eingeschränkte) Filterkriterien erfüllen.

list_jobs(name_match: str | None = None, job_type: list[str] | None = None, provider: list[str] | None = None, target: list[str] | None = None, status: list[azure.quantum._client.models._enums.JobStatus] | None = None, created_after: datetime | None = None, created_before: datetime | None = None, orderby_property: str | None = None, is_asc: bool | None = True) -> List[Job]

Parameter

Name	Beschreibung
name_match	Optionaler regulärer Ausdruck für den Auftragsnamenabgleich. Standardmäßig wird Keine. Standardwert: None
status	Optionaler Filter nach Auftragsstatus. Standardmäßig wird Keine. Standardwert: None
created_after	Optionaler Filter nach Aufträgen, die nach dem angegebenen Zeitpunkt erstellt wurden. Standardmäßig wird Keine. Standardwert: None
job_type	Standardwert: None
provider	Standardwert: None
target	Standardwert: None
created_before	Standardwert: None
orderby_property	Standardwert: None
is_asc	Standardwert: True

Gibt zurück

Typ	Beschreibung
List[Job]	Aufträge, die den Suchkriterien entsprechen.

list_jobs_paginated

list_jobs_paginated(*, name_match: str | None = None, job_type: str | None = None, provider: list[str] | None = None, target: list[str] | None = None, status: list[azure.quantum._client.models._enums.JobStatus] | None = None, created_after: datetime | None = None, created_before: datetime | None = None, skip: int | None = 0, top: int | None = 100, orderby_property: str | None = None, is_asc: bool | None = True) -> ItemPaged[JobDetails]

Nur Schlüsselwortparameter

Name	Beschreibung
name_match	Standardwert: None
job_type	Standardwert: None
provider	Standardwert: None
target	Standardwert: None
status	Standardwert: None
created_after	Standardwert: None
created_before	Standardwert: None
skip	Standardwert: 0
top	Standardwert: 100
orderby_property	Standardwert: None
is_asc	Standardwert: True

list_session_jobs

Ruft alle Aufträge ab, die einer Sitzung zugeordnet sind.

list_session_jobs(session_id: str, name_match: str | None = None, status: list[azure.quantum._client.models._enums.JobStatus] | None = None, orderby_property: str | None = None, is_asc: bool | None = True) -> List[Job]

Parameter

Name	Beschreibung
session_id Erforderlich	Die ID der Sitzung.
name_match	Standardwert: None
status	Standardwert: None
orderby_property	Standardwert: None
is_asc	Standardwert: True

Gibt zurück

Typ	Beschreibung
List[Job]	Liste aller Aufträge, die einer Sitzung zugeordnet sind.

list_session_jobs_paginated

Ruft alle Aufträge ab, die einer Sitzung zugeordnet sind.

list_session_jobs_paginated(*, session_id: str, name_match: str | None = None, status: list[azure.quantum._client.models._enums.JobStatus] | None = None, skip: int | None = 0, top: int | None = 100, orderby_property: str | None = None, is_asc: bool | None = True) -> ItemPaged[JobDetails]

Parameter

Name	Beschreibung
session_id Erforderlich	Die ID der Sitzung.

Nur Schlüsselwortparameter

Name	Beschreibung
session_id Erforderlich
name_match	Standardwert: None
status	Standardwert: None
skip	Standardwert: 0
top	Standardwert: 100
orderby_property	Standardwert: None
is_asc	Standardwert: True

Gibt zurück

Typ	Beschreibung
List[Job]	Liste aller Aufträge, die einer Sitzung zugeordnet sind.

list_sessions

Ruft die Liste der Sitzungen im angegebenen Arbeitsbereich ab.

list_sessions(provider: list[str] | None = None, target: list[str] | None = None, status: list[azure.quantum._client.models._enums.JobStatus] | None = None, created_after: datetime | None = None, created_before: datetime | None = None, orderby_property: str | None = None, is_asc: bool | None = True) -> List[Session]

Parameter

Name	Beschreibung
provider	Standardwert: None
target	Standardwert: None
status	Standardwert: None
created_after	Standardwert: None
created_before	Standardwert: None
orderby_property	Standardwert: None
is_asc	Standardwert: True

Gibt zurück

Typ	Beschreibung
List[Session]	Liste der Arbeitsbereichssitzungen.

list_sessions_paginated

Ruft die Liste der Sitzungen im angegebenen Arbeitsbereich ab.

list_sessions_paginated(*, provider: list[str] | None = None, target: list[str] | None = None, status: list[azure.quantum._client.models._enums.JobStatus] | None = None, created_after: datetime | None = None, created_before: datetime | None = None, skip: int | None = 0, top: int | None = 100, orderby_property: str | None = None, is_asc: bool | None = True) -> ItemPaged[SessionDetails]

Nur Schlüsselwortparameter

Name	Beschreibung
provider	Standardwert: None
target	Standardwert: None
status	Standardwert: None
created_after	Standardwert: None
created_before	Standardwert: None
skip	Standardwert: 0
top	Standardwert: 100
orderby_property	Standardwert: None
is_asc	Standardwert: True

Gibt zurück

Typ	Beschreibung
List[Session]	Liste der Arbeitsbereichssitzungen.

list_top_level_items

Rufen Sie eine Liste der Elemente der obersten Ebene für den angegebenen Arbeitsbereich ab, die eigenständige Aufträge (Aufträge, die keiner Sitzung zugeordnet sind) oder Sitzungen (die Aufträge enthalten können).

list_top_level_items(name_match: str | None = None, item_type: list[str] | None = None, job_type: list[str] | None = None, provider: list[str] | None = None, target: list[str] | None = None, status: list[azure.quantum._client.models._enums.JobStatus] | None = None, created_after: datetime | None = None, created_before: datetime | None = None, orderby_property: str | None = None, is_asc: bool | None = True) -> List[Job | Session]

Parameter

Name	Beschreibung
name_match	Standardwert: None
item_type	Standardwert: None
job_type	Standardwert: None
provider	Standardwert: None
target	Standardwert: None
status	Standardwert: None
created_after	Standardwert: None
created_before	Standardwert: None
orderby_property	Standardwert: None
is_asc	Standardwert: True

Gibt zurück

Typ	Beschreibung
List[Union[Job, Session]]	Liste der Aufträge oder Sitzungen auf oberster Ebene des Arbeitsbereichs.

list_top_level_items_paginated

list_top_level_items_paginated(*, name_match: str | None = None, item_type: str | None = None, job_type: str | None = None, provider: list[str] | None = None, target: list[str] | None = None, status: list[azure.quantum._client.models._enums.JobStatus] | None = None, created_after: datetime | None = None, created_before: datetime | None = None, skip: int | None = 0, top: int | None = 100, orderby_property: str | None = None, is_asc: bool | None = True) -> ItemPaged[ItemDetails]

Nur Schlüsselwortparameter

Name	Beschreibung
name_match	Standardwert: None
item_type	Standardwert: None
job_type	Standardwert: None
provider	Standardwert: None
target	Standardwert: None
status	Standardwert: None
created_after	Standardwert: None
created_before	Standardwert: None
skip	Standardwert: 0
top	Standardwert: 100
orderby_property	Standardwert: None
is_asc	Standardwert: True

open_session

Öffnet/erstellt eine Sitzung im angegebenen Arbeitsbereich.

open_session(session: Session) -> None

Parameter

Name	Beschreibung
session Erforderlich	Die sitzung, die geöffnet/erstellt werden soll.

Gibt zurück

Typ	Beschreibung
Session	Eine neue offene Azure Quantum Session.

refresh_session

Aktualisiert die Sitzungsdetails mit den neuesten Informationen aus dem Arbeitsbereich.

refresh_session(session: Session) -> None

Parameter

Name	Beschreibung
session Erforderlich	Die zu aktualisierende Sitzung.

submit_job

Sendet einen Auftrag, der im Arbeitsbereich verarbeitet werden soll.

submit_job(job: Job) -> Job

Parameter

Name	Beschreibung
job Erforderlich	Auftrag, der übermittelt werden soll.

Gibt zurück

Typ	Beschreibung
Job	Azure Quantum Job, der übermittelt wurde, mit einem aktualisierten Status.

Attribute

credential

Gibt die Anmeldeinformationen zurück, die zum Herstellen einer Verbindung mit dem Quantum Workspace verwendet werden.

Gibt zurück

Typ	Beschreibung
Any	Azure SDK-Anmeldeinformationen aus Azure.Identity.

location

Gibt die Azure-Position des Quantum Workspace zurück.

Gibt zurück

Typ	Beschreibung
str	Azure-Standortname.

name

Gibt den Namen des Quantum-Arbeitsbereichs zurück.

Gibt zurück

Typ	Beschreibung
str	Azure Quantum Workspace-Name.

resource_group

Gibt die Azure-Ressourcengruppe des Quantum-Arbeitsbereichs zurück.

Gibt zurück

Typ	Beschreibung
str	Name der Azure-Ressourcengruppe.

storage

Gibt den Azure Storage-Kontonamen zurück, der dem Quantum Workspace zugeordnet ist.

Gibt zurück

Typ	Beschreibung
str	Name des Azure Storage-Kontos.

subscription_id

Gibt die Azure-Abonnement-ID des Quantum Workspace zurück.

Gibt zurück

Typ	Beschreibung
str	Azure-Abonnement-ID.

user_agent

Gibt die UserAgent-Zeichenfolge des Arbeitsbereichs zurück, die über den UserAgent-Header an den Dienst gesendet wird.

Gibt zurück

Typ	Beschreibung
str	Benutzer-Agent-Zeichenfolge.