%azure.connect

  • Artikel

Warnung

Diese Dokumentation bezieht sich auf das klassische QDK, das durch das moderne QDK ersetzt wurde.

Das moderne QDK unterstützt nur den Magic-Befehl "%%qsharp".

Zusammenfassung

Stellt eine Verbindung mit einem Azure Quantum-Arbeitsbereich her oder zeigt den aktuellen Verbindungsstatus an.

BESCHREIBUNG

Dieser magic-Befehl ermöglicht das Herstellen einer Verbindung mit einem Azure Quantum-Arbeitsbereich, wie durch die Ressourcen-ID und den Speicherort des Arbeitsbereichs oder durch eine Kombination aus Abonnement-ID, Ressourcengruppenname, Arbeitsbereichsname und Standort angegeben.

Wenn die Verbindung erfolgreich ist, wird eine Liste der verfügbaren Q#-Ausführungsziele im Azure Quantum-Arbeitsbereich angezeigt.

Erforderliche Parameter

Der Azure Quantum-Arbeitsbereich kann anhand der Ressourcen-ID identifiziert werden:

  • resourceId=<string>: Die Ressourcen-ID des Azure Quantum-Arbeitsbereichs. Dies kann auf der Arbeitsbereichsseite im Azure-Portal abgerufen werden. Das resourceId= Präfix ist für diesen Parameter optional, solange die Ressourcen-ID gültig ist.

Alternativ kann sie anhand der Abonnement-ID, des Ressourcengruppennamens und des Arbeitsbereichsnamens identifiziert werden:

  • subscription=<string>: Die Azure-Abonnement-ID für den Azure Quantum-Arbeitsbereich.
  • resourceGroup=<string>: Der Name der Azure-Ressourcengruppe für den Azure Quantum-Arbeitsbereich.
  • workspace=<string>: Der Name des Azure Quantum-Arbeitsbereichs.

Zusammen mit den obigen Bezeichnern ist ein gültiger Speicherort erforderlich.

  • location=<string>: Die Azure-Region, in der der Azure Quantum-Arbeitsbereich bereitgestellt wird. Dies kann als Regionsname oder "East US" als Standortname wie angegeben "eastus"werden.

Optionale Parameter

  • storage=<string>: Der Verbindungszeichenfolge zum Azure-Speicherkonto. Erforderlich, wenn der angegebene Azure Quantum-Arbeitsbereich zur Erstellungszeit des Arbeitsbereichs nicht mit einem Speicherkonto verknüpft war.
  • credential=<CredentialType>: Der Typ der Anmeldeinformationen, die für die Authentifizierung bei Azure verwendet werden sollen. HINWEIS: Zur Authentifizierung nutzen wir die Azure Identity-Bibliothek. Basierend auf diesem Parameter erstellen wir eine instance einer Anmeldeinformationsklasse. Folgende Optionen sind möglich:
    • Environment: Authentifiziert einen Dienstprinzipal oder Benutzer über die in den Umgebungsvariablen angegebenen Anmeldeinformationen.
    • ManagedIdentity: Authentifiziert die verwaltete Identität einer Azure-Ressource.
    • CLI: Authentifizieren Sie sich in einer Entwicklungsumgebung mit der Azure CLI.
    • SharedToken: Authentifizieren Sie sich mithilfe von Token im lokalen Cache, der von Microsoft-Anwendungen gemeinsam genutzt wird.
    • VisualStudio: Authentifizieren Sie sich mithilfe von Daten aus Visual Studio.
    • VisualStudioCode: Authentifizieren Sie sich in einer Entwicklungsumgebung mit Visual Studio Code.
    • Interaktiv: Öffnet ein neues Browserfenster, um einen Benutzer interaktiv zu authentifizieren und ein Zugriffstoken abzurufen.
    • DeviceCode: Authentifiziert einen Benutzer mithilfe des Gerätecodeflows, um ein Zugriffstoken abzurufen. Falls nicht angegeben, wird jeder Anmeldeinformationstyp in der Reihenfolge ausprobiert, und es wird der erste Typ ausgewählt, der sich erfolgreich bei Azure authentifizieren kann.

Mögliche Fehler:

  • WorkspaceNotFound: Es wurde kein Azure Quantum-Arbeitsbereich gefunden, der den angegebenen Kriterien entspricht.
  • AuthenticationFailed: Fehler bei der Authentifizierung beim angegebenen Azure Quantum-Arbeitsbereich.

Beispiele für %azure.connect

Beispiel 1

Stellen Sie mithilfe der Ressourcen-ID eine Verbindung mit einem Azure Quantum-Arbeitsbereich mit der Region "Usa, Westen" her:

In []: %azure.connect "/subscriptions/.../Microsoft.Quantum/Workspaces/WORKSPACE_NAME" location="West US"
Out[]: Connected to Azure Quantum workspace WORKSPACE_NAME in location westus.
        <list of Q# execution targets available in the Azure Quantum workspace>

Beispiel 2

Stellen Sie mithilfe der Ressourcen-ID, eines Speicherkontos Verbindungszeichenfolge und eines Speicherorts eine Verbindung mit einem Azure Quantum-Arbeitsbereich her:

In []: %azure.connect resourceId="/subscriptions/.../Microsoft.Quantum/Workspaces/WORKSPACE_NAME"
                      storage="STORAGE_ACCOUNT_CONNECTION_STRING"
                      location="East US"
Out[]: Connected to Azure Quantum workspace WORKSPACE_NAME in location eastus.
        <list of Q# execution targets available in the Azure Quantum workspace>

Beispiel 3

Stellen Sie eine Verbindung mit einem Azure Quantum-Arbeitsbereich her, indem Sie eine einzelne Abonnement-ID und ressourcengruppennamen verwenden und einen Browser verwenden, um benutzeranmeldeinformationen bei Azure einzugeben:

In []: %azure.connect subscription="SUBSCRIPTION_ID"
                      resourceGroup="RESOURCE_GROUP_NAME"
                      workspace="WORKSPACE_NAME"
                      location="West US"
                      credential="interactive"
Out[]: Connected to Azure Quantum workspace WORKSPACE_NAME in location westus.
        <list of Q# execution targets available in the Azure Quantum workspace>

Beispiel 4

Drucken Sie Informationen zum derzeit verbundenen Azure Quantum-Arbeitsbereich:

In []: %azure.connect
Out[]: Connected to Azure Quantum workspace WORKSPACE_NAME in location westus.
        <list of Q# execution targets available in the Azure Quantum workspace>