Workspace 類別

參考

代表 Azure Quantum 工作區。

建立 Workspace 物件時，呼叫端有兩個選項可用來識別 Azure Quantum 工作區 (優先順序) ：

指定有效的位置和資源識別碼;或
指定有效的位置、訂用帳戶標識碼、資源群組和工作區名稱。

您也可以使用連接字串，藉由呼叫 from_connection_string來指定 Azure Quantum Workspace 的連線參數。

如果 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)

參數

名稱	Description
subscription_id	Azure 訂用帳戶識別碼。如果指定resource_id，則會忽略。預設值: None
resource_group	Azure 資源群組名稱。如果指定resource_id，則會忽略。預設值: None
name	Azure Quantum 工作區名稱。如果指定resource_id，則會忽略。預設值: None
storage	Azure 記憶體帳戶連接字串。只有在指定的 Azure Quantum 工作區沒有連結記憶體時才需要。預設值: None
resource_id	Azure Quantum 工作區的資源標識碼。預設值: None
location	布建 Azure Quantum 工作區的 Azure 區域。這可以指定為區域名稱，例如“East US” 或位置名稱，例如 “eastus”。預設值: None
credential	用來連線到 Azure 服務的認證。通常來自 Azure.Identity 的其中一個認證類型。默認為 “DefaultAzureCredential”，這會嘗試多種形式的驗證。預設值: None
user_agent	在與 Azure Quantum 服務通訊時，將指定的值新增為 HTTP User-Agent 標頭的前置詞。預設值: None

方法

append_user_agent	將新值附加至工作區的UserAgent。這些值會使用虛線附加。
cancel_job	要求工作區取消作業的執行。
close_session	如果工作階段不在終端機狀態，則會關閉指定工作區中的工作階段。否則，只要重新整理會話詳細數據即可。
from_connection_string	從連接字串建立新的 Azure Quantum Workspace 用戶端。
get_container_uri	根據作業標識碼或容器名稱取得容器 URI。如果容器尚不存在，請建立新的容器。
get_job	傳回對應至指定標識碼的作業。
get_quotas	取得指定工作區的配額清單。每個配額都會以字典表示，其中包含該配額的屬性。常見的配額屬性包括： “dimension”：套用配額的維度。 “scope”：套用配額的範圍。 “provider_id”：套用配額的提供者。「使用率」：配額的目前使用率。 “limit”：配額的限制。 “period”：套用配額的期間。
get_session	從工作區取得會話。
get_targets	傳回依 [目標名稱] 和 [提供者標識符] 篩選之此工作區的所有可用目標。如果傳遞目標名稱，則會傳回單一 Target 物件。否則，它會傳回 Target 物件的可反覆運算/清單，並選擇性地依提供者標識碼進行篩選。
list_jobs	傳回符合選擇性 (有限) 篩選準則的作業清單。
list_session_jobs	取得與會話相關聯的所有作業。
list_sessions	取得指定工作區中的會話清單。
list_top_level_items	取得指定工作區的最上層專案清單，這可以是獨立作業 (與工作階段) 或會話 (相關聯的作業) 。
open_session	在指定的工作區中開啟/建立會話。
refresh_session	匯報會話詳細數據，以及工作區中的最新資訊。
submit_job	提交在工作區中要處理的作業。

append_user_agent

將新值附加至工作區的UserAgent。這些值會使用虛線附加。

append_user_agent(value: str) -> None

參數

名稱	Description
value 必要	要新增的 UserAgent 值，例如 “azure-quantum-”

cancel_job

要求工作區取消作業的執行。

cancel_job(job: Job) -> Job

參數

名稱	Description
job 必要	要取消的作業。

傳回

類型	Description
Job	要求取消的 Azure Quantum 作業，且狀態已更新。

close_session

如果工作階段不在終端機狀態，則會關閉指定工作區中的工作階段。否則，只要重新整理會話詳細數據即可。

close_session(session: Session) -> None

參數

名稱	Description
session 必要	要關閉的工作階段。

from_connection_string

從連接字串建立新的 Azure Quantum Workspace 用戶端。

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

參數

名稱	Description
connection_string 必要	有效的連接字串，通常是從 Azure 入口網站中的 [量子工作區 -> 作業 -> 存取金鑰] 刀鋒視窗取得。

傳回

類型	Description
Workspace	新的 Azure Quantum Workspace 用戶端。

get_container_uri

根據作業標識碼或容器名稱取得容器 URI。如果容器尚不存在，請建立新的容器。

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

參數

名稱	Description
job_id	作業標識碼，預設為 [無]。預設值: None
container_name	容器名稱，預設為 None。預設值: None
container_name_format	容器名稱格式，預設為「job-{job_id}」。。預設值: job-{job_id}

傳回

類型	Description
str	容器 URI。

get_job

傳回對應至指定標識碼的作業。

get_job(job_id: str) -> Job

參數

名稱	Description
job_id 必要	要擷取的作業標識碼。

傳回

類型	Description
Job	Azure Quantum 作業。

get_quotas

取得指定工作區的配額清單。每個配額都會以字典表示，其中包含該配額的屬性。

常見的配額屬性包括：

“dimension”：套用配額的維度。
“scope”：套用配額的範圍。
“provider_id”：套用配額的提供者。
「使用率」：配額的目前使用率。
“limit”：配額的限制。
“period”：套用配額的期間。

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

傳回

類型	Description
List[Dict[str, Any]	工作區配額。

get_session

從工作區取得會話。

get_session(session_id: str) -> Session

參數

名稱	Description
session_id 必要	要擷取的會話標識碼。

傳回

類型	Description
Session	Azure Quantum 會話

get_targets

傳回依 [目標名稱] 和 [提供者標識符] 篩選之此工作區的所有可用目標。如果傳遞目標名稱，則會傳回單一 Target 物件。否則，它會傳回 Target 物件的可 反覆運算/清單，並選擇性地依提供者標識碼進行篩選。

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

參數

名稱	Description
name	要篩選的選擇性目標名稱，預設為 [無]。預設值: None
provider_id	要篩選的選擇性提供者標識符，預設為 [無]。預設值: None

傳回

類型	Description
Union[Target, Iterable[Target]]	單一 Azure Quantum Target 或可反覆運算/目標清單。

list_jobs

傳回符合選擇性 (有限) 篩選準則的作業清單。

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

參數

名稱	Description
name_match	作業名稱比對的選擇性正則表達式。默認值為 [無]。預設值: None
status	依作業狀態的選擇性篩選。默認值為 [無]。預設值: None
created_after	選擇性篩選指定時間之後所建立的作業。默認值為 [無]。預設值: None

傳回

類型	Description
List[Job]	符合搜尋準則的作業。

list_session_jobs

取得與會話相關聯的所有作業。

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

參數

名稱	Description
session_id 必要	會話的標識碼。

傳回

類型	Description
List[Job]	與會話相關聯的所有作業清單。

list_sessions

取得指定工作區中的會話清單。

list_sessions() -> List[Session]

傳回

類型	Description
List[Session]	工作區會話的清單。

list_top_level_items

取得指定工作區的最上層專案清單，這可以是獨立作業 (與工作階段) 或會話 (相關聯的作業) 。

list_top_level_items() -> List[Job | Session]

傳回

類型	Description
List[Union[Job, Session]]	工作區最上層作業或會話的清單。

open_session

在指定的工作區中開啟/建立會話。

open_session(session: Session) -> None

參數

名稱	Description
session 必要	要開啟/建立的會話。

傳回

類型	Description
Session	新的開啟 Azure Quantum 作業階段。

refresh_session

匯報會話詳細數據，以及工作區中的最新資訊。

refresh_session(session: Session) -> None

參數

名稱	Description
session 必要	要重新整理的會話。

submit_job

提交在工作區中要處理的作業。

submit_job(job: Job) -> Job

參數

名稱	Description
job 必要	要提交的作業。

傳回

類型	Description
Job	已提交且狀態已更新的 Azure Quantum 作業。

屬性

credential

傳回用來連線到 Quantum Workspace 的認證。

傳回

類型	Description
Any	來自 Azure.Identity 的 Azure SDK 認證。

location

傳回 Quantum Workspace 的 Azure 位置。

傳回

類型	Description
str	Azure 位置名稱。

name

傳回 Quantum 工作區的名稱。

傳回

類型	Description
str	Azure Quantum Workspace 名稱。

resource_group

傳回 Quantum 工作區的 Azure 資源群組。

傳回

類型	Description
str	Azure 資源群組名稱。

storage

傳回與 Quantum Workspace 相關聯的 Azure 記憶體帳戶名稱。

傳回

類型	Description
str	Azure 記憶體帳戶名稱。

subscription_id

傳回 Quantum 工作區的 Azure 訂用帳戶標識碼。

傳回

類型	Description
str	Azure 訂用帳戶識別碼。

user_agent

傳回透過UserAgent標頭傳送至服務的 Workspace UserAgent 字串。

傳回

類型	Description
str	使用者代理程式字串。

共用方式為