Workspace クラス

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

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

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

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

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

コンストラクター

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
close_session	セッションがターミナル状態でない場合は、特定のワークスペース内のセッションを閉じます。それ以外の場合は、セッションの詳細を更新するだけです。
from_connection_string	接続文字列から新しい Azure Quantum Workspace クライアントを作成します。
get_container_uri	ジョブ ID またはコンテナー名に基づいてコンテナー URI を取得します。新しいコンテナーがまだ存在しない場合は作成します。
get_job	指定された ID に対応するジョブを返します。
get_quotas	特定のワークスペースのクォータの一覧を取得します。各クォータはディクショナリとして表され、そのクォータのプロパティが含まれます。クォータの一般的なプロパティは次のとおりです。 "dimension": クォータが適用されるディメンション。 "scope": クォータが適用されるスコープ。 "provider_id": クォータが適用されるプロバイダー。 "utilization": クォータの現在の使用率。 "limit": クォータの制限。 "period": クォータが適用される期間。
get_session	ワークスペースからセッションを取得します。
get_targets	ターゲット名とプロバイダー ID でフィルター処理された、このワークスペースで使用可能なすべてのターゲットを返します。ターゲット名が渡された場合、1 つの Target オブジェクトが返されます。それ以外の場合は、必要に応じてプロバイダー ID でフィルター処理ターゲットオブジェクトの iterable/list を返します。
list_jobs	オプションの (制限付き) フィルター条件を満たすジョブの一覧を返します。
list_jobs_paginated
list_session_jobs	セッションに関連付けられているすべてのジョブを取得します。
list_session_jobs_paginated	セッションに関連付けられているすべてのジョブを取得します。
list_sessions	特定のワークスペース内のセッションの一覧を取得します。
list_sessions_paginated	特定のワークスペース内のセッションの一覧を取得します。
list_top_level_items	特定のワークスペースの最上位項目の一覧を取得します。スタンドアロンジョブ (セッションに関連付けられていないジョブ) またはセッション (ジョブを含めることができる) を取得できます。
list_top_level_items_paginated
open_session	特定のワークスペースでセッションを開く/作成します。
refresh_session	ワークスペースの最新情報でセッションの詳細を更新します。
submit_job	ワークスペースで処理するジョブを送信します。

append_user_agent

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

append_user_agent(value: str) -> None

パラメーター

名前	説明
value 必須	追加する UserAgent 値 (例: "azure-quantum-<plugin>"

cancel_job

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

cancel_job(job: Job) -> Job

パラメーター

名前	説明
job 必須	取り消すジョブ。

返品

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

close

close() -> None

close_session

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

close_session(session: Session) -> None

パラメーター

名前	説明
session 必須	閉じるセッション。

from_connection_string

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

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

パラメーター

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

返品

型	説明
Workspace	新しい 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
container_name	コンテナー名。既定値は [なし]。規定値: 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

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

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

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

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

返品

型	説明
List[Dict[str, Any]	ワークスペースクォータ。

get_session

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

get_session(session_id: str) -> Session

パラメーター

名前	説明
session_id 必須	取得するセッションの ID。

返品

型	説明
Session	Azure Quantum セッション

get_targets

ターゲット名とプロバイダー ID でフィルター処理された、このワークスペースで使用可能なすべてのターゲットを返します。ターゲット名が渡された場合、1 つの Target オブジェクトが返されます。それ以外の場合は、必要に応じてプロバイダー ID でフィルター処理 ターゲット オブジェクトの iterable/list を返します。

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

パラメーター

名前	説明
name	フィルター処理する省略可能なターゲット名。既定値は [なし]。規定値: None
provider_id	フィルター処理する省略可能なプロバイダー ID。既定では [なし]。規定値: None

返品

型	説明
Union[Target, Iterable[Target]]	単一の Azure Quantum ターゲットまたはターゲットの iterable/list。

list_jobs

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

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]

パラメーター

名前	説明
name_match	ジョブ名照合の省略可能な正規表現。既定値は Noneです。規定値: None
status	ジョブの状態によるオプションのフィルター処理。既定値は Noneです。規定値: None
created_after	指定された時刻より後に作成されたジョブによるオプションのフィルター。既定値は Noneです。規定値: None
job_type	規定値: None
provider	規定値: None
target	規定値: None
created_before	規定値: None
orderby_property	規定値: None
is_asc	規定値: True

返品

型	説明
List[Job]	検索条件に一致したジョブ。

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]

キーワードのみのパラメーター

名前	説明
name_match	規定値: None
job_type	規定値: None
provider	規定値: None
target	規定値: None
status	規定値: None
created_after	規定値: None
created_before	規定値: None
skip	規定値: 0
top	規定値: 100
orderby_property	規定値: None
is_asc	規定値: True

list_session_jobs

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

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]

パラメーター

名前	説明
session_id 必須	セッションの ID。
name_match	規定値: None
status	規定値: None
orderby_property	規定値: None
is_asc	規定値: True

返品

型	説明
List[Job]	セッションに関連付けられているすべてのジョブの一覧。

list_session_jobs_paginated

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

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]

パラメーター

名前	説明
session_id 必須	セッションの ID。

キーワードのみのパラメーター

名前	説明
session_id 必須
name_match	規定値: None
status	規定値: None
skip	規定値: 0
top	規定値: 100
orderby_property	規定値: None
is_asc	規定値: True

返品

型	説明
List[Job]	セッションに関連付けられているすべてのジョブの一覧。

list_sessions

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

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]

パラメーター

名前	説明
provider	規定値: None
target	規定値: None
status	規定値: None
created_after	規定値: None
created_before	規定値: None
orderby_property	規定値: None
is_asc	規定値: True

返品

型	説明
List[Session]	ワークスペースセッションの一覧。

list_sessions_paginated

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

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]

キーワードのみのパラメーター

名前	説明
provider	規定値: None
target	規定値: None
status	規定値: None
created_after	規定値: None
created_before	規定値: None
skip	規定値: 0
top	規定値: 100
orderby_property	規定値: None
is_asc	規定値: True

返品

型	説明
List[Session]	ワークスペースセッションの一覧。

list_top_level_items

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

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]

パラメーター

名前	説明
name_match	規定値: None
item_type	規定値: None
job_type	規定値: None
provider	規定値: None
target	規定値: None
status	規定値: None
created_after	規定値: None
created_before	規定値: None
orderby_property	規定値: None
is_asc	規定値: True

返品

型	説明
List[Union[Job, Session]]	ワークスペースの最上位レベルのジョブまたはセッションの一覧。

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]

キーワードのみのパラメーター

名前	説明
name_match	規定値: None
item_type	規定値: None
job_type	規定値: None
provider	規定値: None
target	規定値: None
status	規定値: None
created_after	規定値: None
created_before	規定値: None
skip	規定値: 0
top	規定値: 100
orderby_property	規定値: None
is_asc	規定値: True

open_session

特定のワークスペースでセッションを開く/作成します。

open_session(session: Session) -> None

パラメーター

名前	説明
session 必須	開く/作成するセッション。

返品

型	説明
Session	新しいオープン Azure Quantum セッション。

refresh_session

ワークスペースの最新情報でセッションの詳細を更新します。

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	ユーザーエージェント文字列。