Freigeben über

Workspace Klasse

  • Referenz

Stellt einen Azure Quantum-Arbeitsbereich dar.

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

  1. geben Sie einen gültigen Standort und eine Ressourcen-ID an; Oder
  2. Geben Sie einen gültigen Standort, eine Abonnement-ID, eine Ressourcengruppe und einen Arbeitsbereichsnamen an.

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

Wenn der Azure Quantum-Arbeitsbereich keinen verknüpften Speicher aufweist, muss der Aufrufer auch ein gültiges Azure-Speicherkonto 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 wird.

Standardwert: None
resource_group

Der Azure-Ressourcengruppenname. Wird ignoriert, wenn resource_id angegeben wird.

Standardwert: None
name

Der Name des Azure Quantum-Arbeitsbereichs. Wird ignoriert, wenn resource_id angegeben wird.

Standardwert: None
storage

Das Azure-Speicherkonto Verbindungszeichenfolge. 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 "USA, Osten" oder als Standortname wie "eastus" angegeben werden.

Standardwert: None
credential

Die Anmeldeinformationen, die zum Herstellen einer Verbindung mit Azure-Diensten verwendet werden sollen. Normalerweise einer der Anmeldeinformationstypen aus Azure.Identity.

Der Standardwert ist "DefaultAzureCredential", wodurch mehrere Authentifizierungsformen versucht werden.

Standardwert: None
user_agent

Fügen Sie den angegebenen Wert als Präfix zum HTTP-User-Agent-Header hinzu, wenn Sie mit dem Azure Quantum-Dienst kommunizieren.

Standardwert: None

Methoden

append_user_agent

Fügen Sie einen neuen Wert an den UserAgent des Arbeitsbereichs an. Die Werte werden mithilfe eines Bindestrichs angefügt.
cancel_job

Fordert den Arbeitsbereich auf, die Ausführung eines Auftrags abzubrechen.
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 der Auftrags-ID oder dem Containernamen. Erstellt einen neuen Container, wenn er noch nicht vorhanden ist.
get_job

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

Rufen Sie eine Liste der Kontingente für den angegebenen Arbeitsbereich ab. 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.
  • "utilization": Die aktuelle Auslastung des Kontingents.
  • "limit": Das Limit 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 iterierbare Liste von Zielobjekten zurückgegeben, optional gefiltert nach der Anbieter-ID.
list_jobs

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

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

Rufen Sie 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) sein können.
open_session

Öffnet/erstellt eine Sitzung im angegebenen Arbeitsbereich.
refresh_session

Updates 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 mithilfe eines Bindestrichs angefügt.

append_user_agent(value: str) -> None

Parameter

Name Beschreibung
value
Erforderlich

Hinzuzufügende UserAgent-Wert, z. B. "azure-quantum-"

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-Auftrag, der zum Abbrechen angefordert wurde, mit einer aktualisierten status.

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

Ein gültiger Verbindungszeichenfolge, der normalerweise über das Blatt Quantum Workspace –> Operations –> Access Keys 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 der Auftrags-ID oder dem Containernamen. Erstellt einen neuen Container, wenn 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, standardwert: Keine.

Standardwert: None
container_name

Containername, standardwert: Keine.

Standardwert: None
container_name_format

Das Containernamenformat ist 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

Rufen Sie eine Liste der Kontingente für den angegebenen Arbeitsbereich ab. 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.
  • "utilization": Die aktuelle Auslastung des Kontingents.
  • "limit": Das Limit 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 iterierbare Liste von Zielobjekten zurückgegeben, optional gefiltert nach der Anbieter-ID.

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 "None".

Standardwert: None
provider_id

Die optionale Anbieter-ID, nach der gefiltert werden soll, lautet standardmäßig Keine.

Standardwert: None

Gibt zurück

Typ Beschreibung
Union[Target, Iterable[Target]]

Ein einzelnes Azure Quantum-Ziel 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, status: JobStatus | None = None, created_after: datetime | None = None) -> List[Job]

Parameter

Name Beschreibung
name_match

Optionaler regulärer Ausdruck für den Auftragsnamensabgleich. Der Standardwert ist "None".

Standardwert: None
status

Optionaler Filter nach Auftrags-status. Der Standardwert ist "None".

Standardwert: None
created_after

Optionaler Filter nach Aufträgen, die nach der angegebenen Zeit erstellt wurden. Der Standardwert ist "None".

Standardwert: None

Gibt zurück

Typ Beschreibung
List[Job]

Aufträge, die den Suchkriterien entsprechen.

list_session_jobs

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

list_session_jobs(session_id: str) -> List[Job]

Parameter

Name Beschreibung
session_id
Erforderlich

Die ID der Sitzung.

Gibt zurück

Typ Beschreibung
List[Job]

Liste aller Aufträge, die einer Sitzung zugeordnet sind.

list_sessions

Rufen Sie die Liste der Sitzungen im angegebenen Arbeitsbereich ab.

list_sessions() -> List[Session]

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) sein können.

list_top_level_items() -> List[Job | Session]

Gibt zurück

Typ Beschreibung
List[Union[Job, Session]]

Liste der Aufträge oder Sitzungen der obersten Ebene des Arbeitsbereichs.

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 geöffnete Azure Quantum-Sitzung.

refresh_session

Updates 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 einer aktualisierten status.

Attribute

credential

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

Gibt zurück

Typ Beschreibung
Any

Azure SDK-Anmeldeinformationen aus Azure.Identity.

location

Gibt den Azure-Speicherort des Quantum-Arbeitsbereichs zurück.

Gibt zurück

Typ Beschreibung
str

Name des Azure-Standorts.

name

Gibt den Namen des Quantum-Arbeitsbereichs zurück.

Gibt zurück

Typ Beschreibung
str

Name des Azure Quantum-Arbeitsbereichs.

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-Arbeitsbereich zugeordnet ist.

Gibt zurück

Typ Beschreibung
str

Name des Azure Storage-Kontos.

subscription_id

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

Gibt zurück

Typ Beschreibung
str

Die 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.