Workspace クラス

Azure Quantum ワークスペースを表します。

Workspace オブジェクトを作成する場合、呼び出し元には、(優先順位の順に) Azure Quantum ワークスペースを識別するための 2 つのオプションがあります。

  1. 有効な場所とリソース ID を指定します。または
  2. 有効な場所、サブスクリプション ID、リソース グループ、ワークスペース名を指定します。

接続文字列を使用して、 を呼び出from_connection_stringして Azure Quantum ワークスペースへの接続パラメーターを指定することもできます。

Azure Quantum ワークスペースにリンクされたストレージがない場合、呼び出し元は有効な Azure ストレージ アカウント接続文字列も渡す必要があります。

継承
builtins.object
Workspace

コンストラクター

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)

パラメーター

名前 説明
subscription_id

Azure サブスクリプション ID。 resource_idが指定されている場合は無視されます。

既定値: None
resource_group

Azure リソース グループ名です。 resource_idが指定されている場合は無視されます。

既定値: None
name

Azure Quantum ワークスペース名。 resource_idが指定されている場合は無視されます。

既定値: None
storage

Azure ストレージ アカウント接続文字列。 指定した Azure Quantum ワークスペースにリンクされたストレージがない場合にのみ必要です。

既定値: None
resource_id

Azure Quantum ワークスペースのリソース ID。

既定値: None
location

Azure Quantum ワークスペースがプロビジョニングされている Azure リージョン。 これは、"米国東部" などのリージョン名、または "eastus" などの場所名として指定できます。

既定値: None
credential

Azure サービスへの接続に使用する資格情報。 通常、 Azure.Identity の資格情報の種類の 1 つ。

既定値は "DefaultAzureCredential" で、複数の形式の認証が試行されます。

既定値: None
user_agent

Azure Quantum サービスと通信するときに、指定した値をプレフィックスとして HTTP User-Agent ヘッダーに追加します。

既定値: None

メソッド

append_user_agent

ワークスペースの UserAgent に新しい値を追加します。 値はダッシュを使用して追加されます。

cancel_job

ジョブの実行を取り消すようワークスペースに要求します。

close_session

セッションが終了状態でない場合は、指定されたワークスペース内のセッションを閉じます。 それ以外の場合は、セッションの詳細を更新するだけです。

from_connection_string

接続文字列から新しい Azure Quantum ワークスペース クライアントを作成します。

get_container_uri

ジョブ ID またはコンテナー名に基づいてコンテナー URI を取得します。 まだ存在しない場合は、新しいコンテナーを作成します。

get_job

指定された ID に対応するジョブを返します。

get_quotas

指定されたワークスペースのクォータの一覧を取得します。 各クォータは、そのクォータのプロパティを含むディクショナリとして表されます。

一般的なクォータ プロパティは次のとおりです。

  • "ディメンション": クォータが適用されるディメンション。
  • "scope": クォータが適用されるスコープ。
  • "provider_id": クォータが適用されるプロバイダー。
  • "utilization": クォータの現在の使用率。
  • "limit": クォータの制限。
  • "period": クォータが適用される期間。
get_session

ワークスペースからセッションを取得します。

get_targets

[ターゲット名] と [プロバイダー ID] でフィルター処理された、このワークスペースで使用できるすべてのターゲットを返します。 ターゲット名を渡すと、1 つの Target オブジェクトが返されます。 それ以外の場合は、プロバイダー ID でフィルター処理された Target オブジェクトの繰り返し可能/リストを返します。

list_jobs

オプションの (制限付き) フィルター条件を満たすジョブの一覧を返します。

list_session_jobs

セッションに関連付けられているすべてのジョブを取得します。

list_sessions

指定されたワークスペース内のセッションの一覧を取得します。

list_top_level_items

特定のワークスペースの最上位項目の一覧を取得します。これは、スタンドアロン ジョブ (セッションに関連付けられていないジョブ) またはセッション (ジョブを含めることができる) です。

open_session

指定されたワークスペースでセッションを開く/作成します。

refresh_session

ワークスペースの最新情報と共にセッションの詳細をUpdatesします。

submit_job

ワークスペースで処理するジョブを送信します。

append_user_agent

ワークスペースの UserAgent に新しい値を追加します。 値はダッシュを使用して追加されます。

append_user_agent(value: str) -> None

パラメーター

名前 説明
value
必須

追加する UserAgent 値 (例: "azure-quantum-")

cancel_job

ジョブの実行を取り消すようワークスペースに要求します。

cancel_job(job: Job) -> Job

パラメーター

名前 説明
job
必須

取り消すジョブ。

戻り値

説明
Job

更新された状態で、取り消しが要求された Azure Quantum ジョブ。

close_session

セッションが終了状態でない場合は、指定されたワークスペース内のセッションを閉じます。 それ以外の場合は、セッションの詳細を更新するだけです。

close_session(session: Session) -> None

パラメーター

名前 説明
session
必須

閉じるセッション。

from_connection_string

接続文字列から新しい Azure Quantum ワークスペース クライアントを作成します。

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

パラメーター

名前 説明
connection_string
必須

有効な接続文字列。通常は、Azure Portal の [Quantum ワークスペース - 操作 ->> アクセス キー] ブレードから取得されます。

戻り値

説明

新しい Azure Quantum ワークスペース クライアント。

get_container_uri

ジョブ ID またはコンテナー名に基づいてコンテナー URI を取得します。 まだ存在しない場合は、新しいコンテナーを作成します。

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

パラメーター

名前 説明
job_id

ジョブ ID の既定値は None です

既定値: None
container_name

コンテナー名。既定値は None です

既定値: None
container_name_format

コンテナー名の形式。既定値は "job-{job_id}" です。

既定値: job-{job_id}

戻り値

説明
str

コンテナー URI。

get_job

指定された ID に対応するジョブを返します。

get_job(job_id: str) -> Job

パラメーター

名前 説明
job_id
必須

フェッチするジョブの ID。

戻り値

説明
Job

Azure Quantum ジョブ。

get_quotas

指定されたワークスペースのクォータの一覧を取得します。 各クォータは、そのクォータのプロパティを含むディクショナリとして表されます。

一般的なクォータ プロパティは次のとおりです。

  • "ディメンション": クォータが適用されるディメンション。
  • "scope": クォータが適用されるスコープ。
  • "provider_id": クォータが適用されるプロバイダー。
  • "utilization": クォータの現在の使用率。
  • "limit": クォータの制限。
  • "period": クォータが適用される期間。
get_quotas() -> List[Dict[str, Any]]

戻り値

説明

ワークスペース のクォータ。

get_session

ワークスペースからセッションを取得します。

get_session(session_id: str) -> Session

パラメーター

名前 説明
session_id
必須

取得するセッションの ID。

戻り値

説明

Azure Quantum セッション

get_targets

[ターゲット名] と [プロバイダー ID] でフィルター処理された、このワークスペースで使用できるすべてのターゲットを返します。 ターゲット名を渡すと、1 つの Target オブジェクトが返されます。 それ以外の場合は、プロバイダー ID でフィルター処理された Target オブジェクトの繰り返し可能/リストを返します。

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

パラメーター

名前 説明
name

フィルター処理するターゲット名 (省略可能)、既定値は [なし] です

既定値: None
provider_id

フィルター処理するプロバイダー ID (省略可能)、既定値は [なし] です

既定値: None

戻り値

説明

単一の Azure Quantum ターゲットまたはターゲットの iterable/list。

list_jobs

オプションの (制限付き) フィルター条件を満たすジョブの一覧を返します。

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

パラメーター

名前 説明
name_match

ジョブ名の一致に対する省略可能な正規表現。 既定値は None です

既定値: None
status

ジョブの状態によるフィルター処理 (省略可能)。 既定値は None です

既定値: None
created_after

指定した時刻より後に作成されたジョブによるフィルター処理 (省略可能)。 既定値は None です

既定値: None

戻り値

説明

検索条件に一致したジョブ。

list_session_jobs

セッションに関連付けられているすべてのジョブを取得します。

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

パラメーター

名前 説明
session_id
必須

セッションの ID。

戻り値

説明

セッションに関連付けられているすべてのジョブの一覧。

list_sessions

指定されたワークスペース内のセッションの一覧を取得します。

list_sessions() -> List[Session]

戻り値

説明

ワークスペース セッションの一覧。

list_top_level_items

特定のワークスペースの最上位項目の一覧を取得します。これは、スタンドアロン ジョブ (セッションに関連付けられていないジョブ) またはセッション (ジョブを含めることができる) です。

list_top_level_items() -> List[Job | Session]

戻り値

説明

ワークスペースの最上位レベルのジョブまたはセッションの一覧。

open_session

指定されたワークスペースでセッションを開く/作成します。

open_session(session: Session) -> None

パラメーター

名前 説明
session
必須

開く/作成するセッション。

戻り値

説明

新しいオープン Azure Quantum セッション。

refresh_session

ワークスペースの最新情報と共にセッションの詳細をUpdatesします。

refresh_session(session: Session) -> None

パラメーター

名前 説明
session
必須

更新するセッション。

submit_job

ワークスペースで処理するジョブを送信します。

submit_job(job: Job) -> Job

パラメーター

名前 説明
job
必須

送信するジョブ。

戻り値

説明
Job

更新された状態で送信された Azure Quantum ジョブ。

属性

credential

Quantum ワークスペースへの接続に使用される資格情報を返します。

戻り値

説明
Any

Azure.Identity からの Azure SDK 資格情報。

location

Quantum ワークスペースの Azure の場所を返します。

戻り値

説明
str

Azure の場所名。

name

Quantum ワークスペースの名前を返します。

戻り値

説明
str

Azure Quantum ワークスペース名。

resource_group

Quantum ワークスペースの Azure リソース グループを返します。

戻り値

説明
str

Azure リソース グループ名。

storage

Quantum ワークスペースに関連付けられている Azure Storage アカウント名を返します。

戻り値

説明
str

Azure Storage アカウント名。

subscription_id

Quantum ワークスペースの Azure サブスクリプション ID を返します。

戻り値

説明
str

Azure サブスクリプション ID。

user_agent

UserAgent ヘッダーを介してサービスに送信されるワークスペースの UserAgent 文字列を返します。

戻り値

説明
str

ユーザー エージェント文字列。