Workspace Kelas

Mewakili ruang kerja Azure Quantum.

Saat membuat objek Ruang Kerja, penelepon memiliki beberapa opsi untuk mengidentifikasi ruang kerja Azure Quantum (dalam urutan prioritas):

  1. tentukan ID sumber daya yang valid; Atau
  2. tentukan ID langganan, grup sumber daya, dan nama ruang kerja yang valid; Atau
  3. tentukan nama ruang kerja yang valid.

Anda juga dapat menggunakan string koneksi untuk menentukan parameter koneksi ke Ruang Kerja Azure Quantum dengan memanggil from_connection_string.

Jika ruang kerja Azure Quantum tidak memiliki penyimpanan tertaut, pemanggil juga harus meneruskan string koneksi akun penyimpanan Azure yang valid.

Konstruktor

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)

Parameter

Nama Deskripsi
subscription_id

ID langganan Azure. Diabaikan jika resource_id ditentukan.

Nilai default: None
resource_group

Nama grup sumber daya Azure. Diabaikan jika resource_id ditentukan.

Nilai default: None
name

Nama ruang kerja Azure Quantum. Diabaikan jika resource_id ditentukan.

Nilai default: None
storage

String koneksi akun penyimpanan Azure. Diperlukan hanya jika ruang kerja Azure Quantum yang ditentukan tidak memiliki penyimpanan tertaut.

Nilai default: None
resource_id

ID sumber daya ruang kerja Azure Quantum.

Nilai default: None
location

Wilayah Azure tempat ruang kerja Azure Quantum disediakan. Ini dapat ditentukan sebagai nama wilayah seperti "US Timur" atau nama lokasi seperti "eastus".

Nilai default: None
credential

Kredensial yang digunakan untuk menyambungkan ke layanan Azure. Biasanya salah satu jenis kredensial dari Azure.Identity.

Default ke "DefaultAzureCredential", yang akan mencoba beberapa bentuk autentikasi.

Nilai default: None
user_agent

Tambahkan nilai yang ditentukan sebagai awalan ke header http User-Agent saat berkomunikasi ke layanan Azure Quantum.

Nilai default: None

Metode

append_user_agent

Tambahkan nilai baru ke UserAgent Ruang Kerja. Nilai ditambahkan menggunakan tanda hubung.
cancel_job

Meminta Ruang Kerja untuk membatalkan eksekusi pekerjaan.
close
close_session

Menutup sesi di ruang kerja yang diberikan jika sesi tidak dalam status terminal. Jika tidak, cukup refresh detail sesi.
from_connection_string

Membuat klien Azure Quantum Workspace baru dari string koneksi.
get_container_uri

Dapatkan URI kontainer berdasarkan ID pekerjaan atau nama kontainer. Membuat kontainer baru jika belum ada.
get_job

Mengembalikan pekerjaan yang sesuai dengan id yang diberikan.
get_quotas

Dapatkan daftar kuota untuk ruang kerja yang diberikan. Setiap kuota direpresentasikan sebagai kamus, yang berisi properti untuk kuota tersebut.

Properti Kuota Umum adalah:

  • "dimensi": Dimensi tempat kuota diterapkan.
  • "cakupan": Cakupan tempat kuota diterapkan.
  • "provider_id": Penyedia tempat kuota diterapkan.
  • "pemanfaatan": Pemanfaatan kuota saat ini.
  • "limit": Batas kuota.
  • "period": Periode kuota diterapkan.
get_session

Mendapatkan sesi dari ruang kerja.
get_targets

Mengembalikan semua target yang tersedia untuk ruang kerja ini yang difilter menurut Nama target dan ID Penyedia. Jika nama target diteruskan, satu objek Target akan dikembalikan. Jika tidak, objek target dikembalikan, secara opsional difilter oleh ID Penyedia.
list_jobs

Mengembalikan daftar pekerjaan yang memenuhi kriteria filter opsional (terbatas).
list_jobs_paginated
list_session_jobs

Mendapatkan semua pekerjaan yang terkait dengan sesi.
list_session_jobs_paginated

Mendapatkan semua pekerjaan yang terkait dengan sesi.
list_sessions

Dapatkan daftar sesi di ruang kerja yang diberikan.
list_sessions_paginated

Dapatkan daftar sesi di ruang kerja yang diberikan.
list_top_level_items

Dapatkan daftar item tingkat atas untuk ruang kerja yang diberikan, yang dapat berupa Pekerjaan mandiri (Pekerjaan yang tidak terkait dengan Sesi) atau Sesi (yang dapat berisi Pekerjaan).
list_top_level_items_paginated
open_session

Membuka/membuat sesi di ruang kerja yang diberikan.
refresh_session

Memperbarui detail sesi dengan informasi terbaru dari ruang kerja.
submit_job

Mengirimkan pekerjaan yang akan diproses di Ruang Kerja.

append_user_agent

Tambahkan nilai baru ke UserAgent Ruang Kerja. Nilai ditambahkan menggunakan tanda hubung.

append_user_agent(value: str) -> None

Parameter

Nama Deskripsi
value
Diperlukan

Nilai UserAgent untuk ditambahkan, misalnya "azure-quantum-plugin<>"

cancel_job

Meminta Ruang Kerja untuk membatalkan eksekusi pekerjaan.

cancel_job(job: Job) -> Job

Parameter

Nama Deskripsi
job
Diperlukan

Tugas untuk membatalkan.

Mengembalikan

Jenis Deskripsi
Job

Azure Quantum Job yang diminta untuk dibatalkan, dengan status yang diperbarui.

close 

close() -> None

close_session

Menutup sesi di ruang kerja yang diberikan jika sesi tidak dalam status terminal. Jika tidak, cukup refresh detail sesi.

close_session(session: Session) -> None

Parameter

Nama Deskripsi
session
Diperlukan

Sesi yang akan ditutup.

from_connection_string

Membuat klien Azure Quantum Workspace baru dari string koneksi.

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

Parameter

Nama Deskripsi
connection_string
Diperlukan

String koneksi yang valid, biasanya diperoleh dari Quantum Workspace -> Operations -> Access Keys blade di Portal Microsoft Azure.

Mengembalikan

Jenis Deskripsi
Workspace

Klien Azure Quantum Workspace baru.

get_container_uri

Dapatkan URI kontainer berdasarkan ID pekerjaan atau nama kontainer. Membuat kontainer baru jika belum ada.

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

Parameter

Nama Deskripsi
job_id

ID Pekerjaan, default ke Tidak Ada.

Nilai default: None
container_name

Nama kontainer, default ke None.

Nilai default: None
container_name_format

Format nama kontainer, default ke "job-{job_id}".

Nilai default: job-{job_id}

Mengembalikan

Jenis Deskripsi
str

Kontainer URI.

get_job

Mengembalikan pekerjaan yang sesuai dengan id yang diberikan.

get_job(job_id: str) -> Job

Parameter

Nama Deskripsi
job_id
Diperlukan

Id pekerjaan untuk diambil.

Mengembalikan

Jenis Deskripsi
Job

Pekerjaan Azure Quantum.

get_quotas

Dapatkan daftar kuota untuk ruang kerja yang diberikan. Setiap kuota direpresentasikan sebagai kamus, yang berisi properti untuk kuota tersebut.

Properti Kuota Umum adalah:

  • "dimensi": Dimensi tempat kuota diterapkan.
  • "cakupan": Cakupan tempat kuota diterapkan.
  • "provider_id": Penyedia tempat kuota diterapkan.
  • "pemanfaatan": Pemanfaatan kuota saat ini.
  • "limit": Batas kuota.
  • "period": Periode kuota diterapkan.
get_quotas() -> List[Dict[str, Any]]

Mengembalikan

Jenis Deskripsi
List[Dict[str, Any]

Kuota ruang kerja.

get_session

Mendapatkan sesi dari ruang kerja.

get_session(session_id: str) -> Session

Parameter

Nama Deskripsi
session_id
Diperlukan

Id sesi yang akan diambil.

Mengembalikan

Jenis Deskripsi
Session

Sesi Azure Quantum

get_targets

Mengembalikan semua target yang tersedia untuk ruang kerja ini yang difilter menurut Nama target dan ID Penyedia. Jika nama target diteruskan, satu objek Target akan dikembalikan. Jika tidak, objek target dikembalikan, secara opsional difilter oleh ID Penyedia.

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

Parameter

Nama Deskripsi
name

Nama target opsional untuk difilter, default ke Tidak Ada.

Nilai default: None
provider_id

Id penyedia opsional untuk memfilter menurut, default ke Tidak Ada.

Nilai default: None

Mengembalikan

Jenis Deskripsi
Union[Target, Iterable[Target]]

Target Azure Quantum tunggal atau Target yang dapat diulang/daftar.

list_jobs

Mengembalikan daftar pekerjaan yang memenuhi kriteria filter opsional (terbatas).

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]

Parameter

Nama Deskripsi
name_match

Ekspresi Reguler Opsional untuk pencocokan nama pekerjaan. Default untuk Tidak Ada.

Nilai default: None
status

Filter opsional menurut status pekerjaan. Default untuk Tidak Ada.

Nilai default: None
created_after

Filter opsional menurut pekerjaan yang dibuat setelah waktu tertentu. Default untuk Tidak Ada.

Nilai default: None
job_type
Nilai default: None
provider
Nilai default: None
target
Nilai default: None
created_before
Nilai default: None
orderby_property
Nilai default: None
is_asc
Nilai default: True

Mengembalikan

Jenis Deskripsi
List[Job]

Pekerjaan yang cocok dengan kriteria pencarian.

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]

Parameter Kata Kunci-Saja

Nama Deskripsi
name_match
Nilai default: None
job_type
Nilai default: None
provider
Nilai default: None
target
Nilai default: None
status
Nilai default: None
created_after
Nilai default: None
created_before
Nilai default: None
skip
Nilai default: 0
top
Nilai default: 100
orderby_property
Nilai default: None
is_asc
Nilai default: True

list_session_jobs

Mendapatkan semua pekerjaan yang terkait dengan sesi.

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]

Parameter

Nama Deskripsi
session_id
Diperlukan

Id sesi.
name_match
Nilai default: None
status
Nilai default: None
orderby_property
Nilai default: None
is_asc
Nilai default: True

Mengembalikan

Jenis Deskripsi
List[Job]

Daftar semua pekerjaan yang terkait dengan sesi.

list_session_jobs_paginated

Mendapatkan semua pekerjaan yang terkait dengan sesi.

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]

Parameter

Nama Deskripsi
session_id
Diperlukan

Id sesi.

Parameter Kata Kunci-Saja

Nama Deskripsi
session_id
Diperlukan
name_match
Nilai default: None
status
Nilai default: None
skip
Nilai default: 0
top
Nilai default: 100
orderby_property
Nilai default: None
is_asc
Nilai default: True

Mengembalikan

Jenis Deskripsi
List[Job]

Daftar semua pekerjaan yang terkait dengan sesi.

list_sessions

Dapatkan daftar sesi di ruang kerja yang diberikan.

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]

Parameter

Nama Deskripsi
provider
Nilai default: None
target
Nilai default: None
status
Nilai default: None
created_after
Nilai default: None
created_before
Nilai default: None
orderby_property
Nilai default: None
is_asc
Nilai default: True

Mengembalikan

Jenis Deskripsi
List[Session]

Daftar Sesi Ruang Kerja.

list_sessions_paginated

Dapatkan daftar sesi di ruang kerja yang diberikan.

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]

Parameter Kata Kunci-Saja

Nama Deskripsi
provider
Nilai default: None
target
Nilai default: None
status
Nilai default: None
created_after
Nilai default: None
created_before
Nilai default: None
skip
Nilai default: 0
top
Nilai default: 100
orderby_property
Nilai default: None
is_asc
Nilai default: True

Mengembalikan

Jenis Deskripsi
List[Session]

Daftar Sesi Ruang Kerja.

list_top_level_items

Dapatkan daftar item tingkat atas untuk ruang kerja yang diberikan, yang dapat berupa Pekerjaan mandiri (Pekerjaan yang tidak terkait dengan Sesi) atau Sesi (yang dapat berisi Pekerjaan).

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]

Parameter

Nama Deskripsi
name_match
Nilai default: None
item_type
Nilai default: None
job_type
Nilai default: None
provider
Nilai default: None
target
Nilai default: None
status
Nilai default: None
created_after
Nilai default: None
created_before
Nilai default: None
orderby_property
Nilai default: None
is_asc
Nilai default: True

Mengembalikan

Jenis Deskripsi
List[Union[Job, Session]]

Daftar Pekerjaan atau Sesi tingkat atas Ruang Kerja.

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]

Parameter Kata Kunci-Saja

Nama Deskripsi
name_match
Nilai default: None
item_type
Nilai default: None
job_type
Nilai default: None
provider
Nilai default: None
target
Nilai default: None
status
Nilai default: None
created_after
Nilai default: None
created_before
Nilai default: None
skip
Nilai default: 0
top
Nilai default: 100
orderby_property
Nilai default: None
is_asc
Nilai default: True

open_session

Membuka/membuat sesi di ruang kerja yang diberikan.

open_session(session: Session) -> None

Parameter

Nama Deskripsi
session
Diperlukan

Sesi yang akan dibuka/dibuat.

Mengembalikan

Jenis Deskripsi
Session

Sesi Azure Quantum baru yang terbuka.

refresh_session

Memperbarui detail sesi dengan informasi terbaru dari ruang kerja.

refresh_session(session: Session) -> None

Parameter

Nama Deskripsi
session
Diperlukan

Sesi yang akan disegarkan.

submit_job

Mengirimkan pekerjaan yang akan diproses di Ruang Kerja.

submit_job(job: Job) -> Job

Parameter

Nama Deskripsi
job
Diperlukan

Tugas untuk dikirimkan.

Mengembalikan

Jenis Deskripsi
Job

Azure Quantum Job yang dikirimkan, dengan status yang diperbarui.

Atribut

credential

Mengembalikan Kredensial yang digunakan untuk menyambungkan ke Ruang Kerja Quantum.

Mengembalikan

Jenis Deskripsi
Any

Kredensial Azure SDK dari Azure.Identity.

location

Mengembalikan lokasi Azure dari Ruang Kerja Quantum.

Mengembalikan

Jenis Deskripsi
str

Nama lokasi Azure.

name

Mengembalikan Nama Ruang Kerja Quantum.

Mengembalikan

Jenis Deskripsi
str

Nama Ruang Kerja Azure Quantum.

resource_group

Mengembalikan Grup Sumber Daya Azure dari Ruang Kerja Quantum.

Mengembalikan

Jenis Deskripsi
str

Nama Grup Sumber Daya Azure.

storage

Mengembalikan nama akun Azure Storage yang terkait dengan Ruang Kerja Quantum.

Mengembalikan

Jenis Deskripsi
str

Nama akun Azure Storage.

subscription_id

Mengembalikan ID Langganan Azure dari Ruang Kerja Quantum.

Mengembalikan

Jenis Deskripsi
str

ID Langganan Azure.

user_agent

Mengembalikan string UserAgent Ruang Kerja yang dikirim ke layanan melalui header UserAgent.

Mengembalikan

Jenis Deskripsi
str

String Agen Pengguna.