Workspace Classe

Représente un espace de travail Azure Quantum.

Lors de la création d’un objet Workspace, les appelants disposent de deux options pour identifier l’espace de travail Azure Quantum (par ordre de priorité) :

1. spécifier un emplacement et un ID de ressource valides ; Ou
2. spécifiez un emplacement, un ID d’abonnement, un groupe de ressources et un nom d’espace de travail valides.

Vous pouvez également utiliser un chaîne de connexion pour spécifier les paramètres de connexion à un espace de travail Azure Quantum en appelant from_connection_string.

Si l’espace de travail Azure Quantum n’a pas de stockage lié, l’appelant doit également passer un compte de stockage Azure valide chaîne de connexion.

Héritage

builtins.object

Workspace

Constructeur

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)

Paramètres

Nom	Description
subscription_id	L’ID d’abonnement Azure. Ignoré si resource_id est spécifié. valeur par défaut: None
resource_group	Le nom du groupe de ressources Azure. Ignoré si resource_id est spécifié. valeur par défaut: None
name	Nom de l’espace de travail Azure Quantum. Ignoré si resource_id est spécifié. valeur par défaut: None
storage	Le compte de stockage Azure chaîne de connexion. Obligatoire uniquement si l’espace de travail Azure Quantum spécifié n’a pas de stockage lié. valeur par défaut: None
resource_id	ID de ressource de l’espace de travail Azure Quantum. valeur par défaut: None
location	Région Azure où l’espace de travail Azure Quantum est approvisionné. Il peut être spécifié sous la forme d’un nom de région tel que « USA Est » ou d’un nom d’emplacement tel que « eastus ». valeur par défaut: None
credential	Informations d’identification à utiliser pour se connecter aux services Azure. Normalement l’un des types d’informations d’identification d’Azure.Identity. Par défaut, « DefaultAzureCredential », qui tente plusieurs formes d’authentification. valeur par défaut: None
user_agent	Ajoutez la valeur spécifiée en tant que préfixe à l’en-tête HTTP User-Agent lors de la communication avec le service Azure Quantum. valeur par défaut: None

Méthodes

append_user_agent	Ajoutez une nouvelle valeur à UserAgent de l’espace de travail. Les valeurs sont ajoutées à l’aide d’un tiret.
cancel_job	Demande à l’espace de travail d’annuler l’exécution d’un travail.
close_session	Ferme une session dans l’espace de travail donné si la session n’est pas dans un état terminal. Sinon, actualise simplement les détails de la session.
from_connection_string	Crée un client Azure Quantum Workspace à partir d’un chaîne de connexion.
get_container_uri	Obtenez l’URI de conteneur en fonction de l’ID de travail ou du nom du conteneur. Crée un conteneur s’il n’existe pas encore.
get_job	Retourne le travail correspondant à l’ID donné.
get_quotas	Obtenez la liste des quotas pour l’espace de travail donné. Chaque quota est représenté sous la forme d’un dictionnaire contenant les propriétés de ce quota. Les propriétés de quota courantes sont les suivantes : « dimension » : dimension à laquelle le quota est appliqué. « scope » : étendue à laquelle le quota est appliqué. « provider_id » : fournisseur auquel le quota est appliqué. « utilisation » : utilisation actuelle du quota. « limit » : limite du quota. « period » : période à laquelle le quota est appliqué.
get_session	Obtient une session à partir de l’espace de travail.
get_targets	Retourne toutes les cibles disponibles pour cet espace de travail filtrées par nom de cible et ID de fournisseur. Si le nom de la cible est transmis, un seul objet Target est retourné. Sinon, il retourne une liste/itérable d’objets cibles , éventuellement filtrés par l’ID de fournisseur.
list_jobs	Renvoie la liste des travaux qui répondent à des critères de filtre facultatifs (limités).
list_session_jobs	Obtient tous les travaux associés à une session.
list_sessions	Obtenez la liste des sessions dans l’espace de travail donné.
list_top_level_items	Obtenez la liste des éléments de niveau supérieur pour l’espace de travail donné, qui peuvent être des travaux autonomes (travaux non associés à une session) ou des sessions (qui peuvent contenir des travaux).
open_session	Ouvre/crée une session dans l’espace de travail donné.
refresh_session	Mises à jour les détails de la session avec les dernières informations de l’espace de travail.
submit_job	Envoie un travail à traiter dans l’espace de travail.

append_user_agent

Ajoutez une nouvelle valeur à UserAgent de l’espace de travail. Les valeurs sont ajoutées à l’aide d’un tiret.

append_user_agent(value: str) -> None

Paramètres

Nom	Description
value Obligatoire	Valeur UserAgent à ajouter, par exemple « azure-quantum- »

cancel_job

Demande à l’espace de travail d’annuler l’exécution d’un travail.

cancel_job(job: Job) -> Job

Paramètres

Nom	Description
job Obligatoire	Tâche à annuler.

Retours

Type	Description
Job	Tâche Azure Quantum dont l’annulation a été demandée, avec une status mise à jour.

close_session

Ferme une session dans l’espace de travail donné si la session n’est pas dans un état terminal. Sinon, actualise simplement les détails de la session.

close_session(session: Session) -> None

Paramètres

Nom	Description
session Obligatoire	Session à fermer.

from_connection_string

Crée un client Azure Quantum Workspace à partir d’un chaîne de connexion.

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

Paramètres

Nom	Description
connection_string Obligatoire	Une chaîne de connexion valide, généralement obtenue à partir du panneau Espace de travail Quantum -> Opérations -> Clés d’accès dans le portail Azure.

Retours

Type	Description
Workspace	Nouveau client Azure Quantum Workspace.

get_container_uri

Obtenez l’URI de conteneur en fonction de l’ID de travail ou du nom du conteneur. Crée un conteneur s’il n’existe pas encore.

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

Paramètres

Nom	Description
job_id	ID du travail, valeur par défaut None. valeur par défaut: None
container_name	Nom du conteneur, la valeur par défaut est None. valeur par défaut: None
container_name_format	Format de nom de conteneur, par défaut « job-{job_id} ». valeur par défaut: job-{job_id}

Retours

Type	Description
str	URI de conteneur.

get_job

Retourne le travail correspondant à l’ID donné.

get_job(job_id: str) -> Job

Paramètres

Nom	Description
job_id Obligatoire	ID d’un travail à récupérer.

Retours

Type	Description
Job	Tâche Azure Quantum.

get_quotas

Obtenez la liste des quotas pour l’espace de travail donné. Chaque quota est représenté sous la forme d’un dictionnaire contenant les propriétés de ce quota.

Les propriétés de quota courantes sont les suivantes :

• « dimension » : dimension à laquelle le quota est appliqué.
• « scope » : étendue à laquelle le quota est appliqué.
• « provider_id » : fournisseur auquel le quota est appliqué.
• « utilisation » : utilisation actuelle du quota.
• « limit » : limite du quota.
• « period » : période à laquelle le quota est appliqué.

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

Retours

Type	Description
List[Dict[str, Any]	Quotas d’espace de travail.

get_session

Obtient une session à partir de l’espace de travail.

get_session(session_id: str) -> Session

Paramètres

Nom	Description
session_id Obligatoire	ID de session à récupérer.

Retours

Type	Description
Session	Azure Quantum Session

get_targets

Retourne toutes les cibles disponibles pour cet espace de travail filtrées par nom de cible et ID de fournisseur. Si le nom de la cible est transmis, un seul objet Target est retourné. Sinon, il retourne une liste/itérable d’objets cibles , éventuellement filtrés par l’ID de fournisseur.

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

Paramètres

Nom	Description
name	Nom cible facultatif à filtrer, valeur par défaut Aucun. valeur par défaut: None
provider_id	Id de fournisseur facultatif à filtrer, par défaut aucun. valeur par défaut: None

Retours

Type	Description
Union[Target, Iterable[Target]]	Une seule cible Azure Quantum ou une liste itérable/liste de cibles.

list_jobs

Renvoie la liste des travaux qui répondent à des critères de filtre facultatifs (limités).

list_jobs(name_match: str | None = None, status: JobStatus | None = None, created_after: datetime | None = None) -> List[Job]

Paramètres

Nom	Description
name_match	Expression régulière facultative pour la correspondance de nom de travail. La valeur par défaut est None. valeur par défaut: None
status	Filtre facultatif par status de travail. La valeur par défaut est None. valeur par défaut: None
created_after	Filtre facultatif par travaux qui ont été créés après l’heure donnée. La valeur par défaut est None. valeur par défaut: None

Retours

Type	Description
List[Job]	Travaux correspondant aux critères de recherche.

list_session_jobs

Obtient tous les travaux associés à une session.

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

Paramètres

Nom	Description
session_id Obligatoire	ID de session.

Retours

Type	Description
List[Job]	Liste de tous les travaux associés à une session.

list_sessions

Obtenez la liste des sessions dans l’espace de travail donné.

list_sessions() -> List[Session]

Retours

Type	Description
List[Session]	Liste des sessions d’espace de travail.

list_top_level_items

Obtenez la liste des éléments de niveau supérieur pour l’espace de travail donné, qui peuvent être des travaux autonomes (travaux non associés à une session) ou des sessions (qui peuvent contenir des travaux).

list_top_level_items() -> List[Job | Session]

Retours

Type	Description
List[Union[Job, Session]]	Liste des travaux ou sessions de niveau supérieur de l’espace de travail.

open_session

Ouvre/crée une session dans l’espace de travail donné.

open_session(session: Session) -> None

Paramètres

Nom	Description
session Obligatoire	Session à ouvrir/créer.

Retours

Type	Description
Session	Nouvelle session Azure Quantum ouverte.

refresh_session

Mises à jour les détails de la session avec les dernières informations de l’espace de travail.

refresh_session(session: Session) -> None

Paramètres

Nom	Description
session Obligatoire	Session à actualiser.

submit_job

Envoie un travail à traiter dans l’espace de travail.

submit_job(job: Job) -> Job

Paramètres

Nom	Description
job Obligatoire	Tâche à envoyer.

Retours

Type	Description
Job	Tâche Azure Quantum qui a été envoyée, avec une status mise à jour.

Attributs

credential

Retourne les informations d’identification utilisées pour se connecter à l’espace de travail Quantum.

Retours

Type	Description
Any	Informations d’identification du KIT de développement logiciel (SDK) Azure à partir d’Azure.Identity.

location

Retourne l’emplacement Azure de l’espace de travail Quantum.

Retours

Type	Description
str	Nom de l’emplacement Azure.

name

Renvoie le nom de l’espace de travail Quantum.

Retours

Type	Description
str	Nom de l’espace de travail Azure Quantum.

resource_group

Retourne le groupe de ressources Azure de l’espace de travail Quantum.

Retours

Type	Description
str	Nom du groupe de ressources Azure.

storage

Retourne le nom du compte stockage Azure associé à l’espace de travail Quantum.

Retours

Type	Description
str	Nom du compte stockage Azure.

subscription_id

Retourne l’ID d’abonnement Azure de l’espace de travail Quantum.

Retours

Type	Description
str	ID d’abonnement Azure.

user_agent

Renvoie la chaîne UserAgent de l’espace de travail envoyée au service via l’en-tête UserAgent.

Retours

Type	Description
str	Chaîne de l’agent utilisateur.