Workspace Класс

Представляет рабочую область Azure Quantum.

При создании объекта Workspace вызывающие объекты имеют два варианта идентификации рабочей области Azure Quantum (в порядке приоритета):

1. укажите допустимое расположение и идентификатор ресурса; Или
2. укажите допустимое расположение, идентификатор подписки, группу ресурсов и имя рабочей области.

Вы также можете использовать строка подключения для указания параметров подключения к рабочей области Azure Quantum, вызвав .from_connection_string

Если в рабочей области 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. Игнорируется, если указан 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, в котором подготовлена рабочая область Azure Quantum. Это может быть имя региона, например "Восточная часть США", или имя расположения, например "eastus". значение по умолчанию: None
credential	Учетные данные, используемые для подключения к службам Azure. Обычно это один из типов учетных данных из Azure.Identity. По умолчанию используется значение DefaultAzureCredential, которое будет пытаться использовать несколько форм проверки подлинности. значение по умолчанию: None
user_agent	Добавьте указанное значение в качестве префикса в заголовок HTTP User-Agent при взаимодействии со службой Azure Quantum. значение по умолчанию: None

Методы

append_user_agent	Добавьте новое значение в userAgent рабочей области. Значения добавляются с помощью дефиса.
cancel_job	Запрашивает рабочую область для отмены выполнения задания.
close_session	Закрывает сеанс в заданной рабочей области, если сеанс не находится в состоянии терминала. В противном случае просто обновляет сведения о сеансе.
from_connection_string	Создает клиент Azure Quantum Workspace из строка подключения.
get_container_uri	Получите URI контейнера на основе идентификатора задания или имени контейнера. Создает новый контейнер, если он еще не существует.
get_job	Возвращает задание, соответствующее заданному идентификатору.
get_quotas	Получение списка квот для заданной рабочей области. Каждая квота представлена в виде словаря, содержащего свойства для этой квоты. Общие свойства квоты: "dimension": измерение, к которому применяется квота. "область": область, к которому применяется квота. "provider_id": поставщик, к которому применяется квота. "использование": текущее использование квоты. "limit": ограничение квоты. "period": период, к которому применяется квота.
get_session	Получает сеанс из рабочей области.
get_targets	Возвращает все доступные целевые объекты для этой рабочей области, отфильтрованные по имени целевого объекта и идентификатору поставщика. Если имя целевого объекта передано, возвращается один объект 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

Параметры

Имя	Описание
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 Workspace из строка подключения.

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

Параметры

Имя	Описание
connection_string Обязательно	Допустимая строка подключения, обычно полученная из колонки Quantum Workspace — Operations — Access Keys (Рабочая область Quantum —> операции —> ключи доступа) на портале Azure.

Возвращаемое значение

Тип	Описание
Workspace	Новый клиент Рабочей области Azure Quantum.

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

Параметры

Имя	Описание
job_id	Идентификатор задания по умолчанию — Нет. значение по умолчанию: None
container_name	Имя контейнера, по умолчанию — Нет. значение по умолчанию: None
container_name_format	Формат имени контейнера по умолчанию — "job-{job_id}". значение по умолчанию: job-{job_id}

Возвращаемое значение

Тип	Описание
str	URI контейнера.

get_job

Возвращает задание, соответствующее заданному идентификатору.

get_job(job_id: str) -> Job

Параметры

Имя	Описание
job_id Обязательно	Идентификатор задания для получения.

Возвращаемое значение

Тип	Описание
Job	Задание Azure Quantum.

get_quotas

Получение списка квот для заданной рабочей области. Каждая квота представлена в виде словаря, содержащего свойства для этой квоты.

Общие свойства квоты:

• "dimension": измерение, к которому применяется квота.
• "область": область, к которому применяется квота.
• "provider_id": поставщик, к которому применяется квота.
• "использование": текущее использование квоты.
• "limit": ограничение квоты.
• "period": период, к которому применяется квота.

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

Возвращаемое значение

Тип	Описание
List[Dict[str, Any]	Квоты рабочей области.

get_session

Получает сеанс из рабочей области.

get_session(session_id: str) -> Session

Параметры

Имя	Описание
session_id Обязательно	Идентификатор извлекаемого сеанса.

Возвращаемое значение

Тип	Описание
Session	Сеанс Azure Quantum

get_targets

Возвращает все доступные целевые объекты для этой рабочей области, отфильтрованные по имени целевого объекта и идентификатору поставщика. Если имя целевого объекта передано, возвращается один объект Target . В противном случае он возвращает итерируемый или список целевых объектов, при необходимости отфильтрованный по идентификатору поставщика.

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

Параметры

Имя	Описание
name	Необязательное имя целевого объекта для фильтрации, по умолчанию — Нет. значение по умолчанию: None
provider_id	Необязательный идентификатор поставщика для фильтрации. Значение по умолчанию — Нет. значение по умолчанию: None

Возвращаемое значение

Тип	Описание
Union[Target, Iterable[Target]]	Один целевой объект Azure Quantum или итерируемый или список целевых объектов.

list_jobs

Возвращает список заданий, соответствующих необязательным (ограниченным) критериям фильтра.

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

Параметры

Имя	Описание
name_match	Необязательное регулярное выражение для сопоставления имени задания. Значение по умолчанию — Нет. значение по умолчанию: None
status	Необязательный фильтр по состоянию задания. Значение по умолчанию — Нет. значение по умолчанию: None
created_after	Необязательный фильтр по заданиям, созданным после заданного времени. Значение по умолчанию — Нет. значение по умолчанию: None

Возвращаемое значение

Тип	Описание
List[Job]	Задания, соответствующие условиям поиска.

list_session_jobs

Возвращает все задания, связанные с сеансом.

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

Параметры

Имя	Описание
session_id Обязательно	Идентификатор сеанса.

Возвращаемое значение

Тип	Описание
List[Job]	Список всех заданий, связанных с сеансом.

list_sessions

Получение списка сеансов в заданной рабочей области.

list_sessions() -> List[Session]

Возвращаемое значение

Тип	Описание
List[Session]	Список сеансов рабочей области.

list_top_level_items

Получение списка элементов верхнего уровня для заданной рабочей области, которые могут быть автономными заданиями (заданиями, не связанными с сеансом) или сеансами (которые могут содержать задания).

list_top_level_items() -> List[Job | Session]

Возвращаемое значение

Тип	Описание
List[Union[Job, Session]]	Список заданий или сеансов верхнего уровня рабочей области.

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 SDK из Azure.Identity.

location

Возвращает расположение Рабочей области Quantum в Azure.

Возвращаемое значение

Тип	Описание
str	Имя расположения Azure.

name

Возвращает имя рабочей области Quantum.

Возвращаемое значение

Тип	Описание
str	Имя рабочей области Azure Quantum.

resource_group

Возвращает группу ресурсов Azure рабочей области Quantum.

Возвращаемое значение

Тип	Описание
str	Имя группы ресурсов Azure.

storage

Возвращает имя учетной записи хранения Azure, связанной с рабочей областью Quantum.

Возвращаемое значение

Тип	Описание
str	Имя учетной записи хранения Azure.

subscription_id

Возвращает идентификатор подписки Azure для рабочей области Quantum.

Возвращаемое значение

Тип	Описание
str	Идентификатор подписки Azure.

user_agent

Возвращает строку UserAgent рабочей области, которая отправляется в службу через заголовок UserAgent.

Возвращаемое значение

Тип	Описание
str	Строка агента пользователя.