Workspace 클래스

참조

Azure Quantum 작업 영역을 나타냅니다.

Workspace 개체를 만들 때 호출자에게는 Azure Quantum 작업 영역을 식별하기 위한 두 가지 옵션이 있습니다(우선 순위순).

유효한 위치 및 리소스 ID를 지정합니다. 또는
올바른 위치, 구독 ID, 리소스 그룹 및 작업 영역 이름을 지정합니다.

연결 문자열 사용하여 를 호출from_connection_string하여 Azure Quantum 작업 영역에 대한 연결 매개 변수를 지정할 수도 있습니다.

Azure Quantum 작업 영역에 연결된 스토리지가 없는 경우 호출자는 유효한 Azure Storage 계정 연결 문자열 전달해야 합니다.

상속: 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)

매개 변수

Name	Description
subscription_id	Azure 구독 ID입니다. resource_id 지정되면 무시됩니다. 기본값: None
resource_group	Azure 리소스 그룹 이름입니다. resource_id 지정되면 무시됩니다. 기본값: None
name	Azure Quantum 작업 영역 이름입니다. resource_id 지정되면 무시됩니다. 기본값: None
storage	Azure Storage 계정 연결 문자열. 지정된 Azure Quantum 작업 영역에 연결된 스토리지가 없는 경우에만 필요합니다. 기본값: None
resource_id	Azure Quantum 작업 영역의 리소스 ID입니다. 기본값: None
location	Azure Quantum 작업 영역이 프로비전되는 Azure 지역입니다. "미국 동부"와 같은 지역 이름 또는 "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 작업 영역 클라이언트를 만듭니다.
get_container_uri	작업 ID 또는 컨테이너 이름을 기반으로 컨테이너 URI를 가져옵니다. 아직 없는 경우 새 컨테이너를 만듭니다.
get_job	지정된 ID에 해당하는 작업을 반환합니다.
get_quotas	지정된 작업 영역에 대한 할당량 목록을 가져옵니다. 각 할당량은 해당 할당량에 대한 속성을 포함하는 사전으로 표시됩니다. 일반적인 할당량 속성은 다음과 같습니다. "dimension": 할당량이 적용되는 차원입니다. "scope": 할당량이 적용되는 scope. "provider_id": 할당량이 적용되는 공급자입니다. "사용률": 할당량의 현재 사용률입니다. "limit": 할당량의 제한입니다. "period": 할당량이 적용되는 기간입니다.
get_session	작업 영역에서 세션을 가져옵니다.
get_targets	대상 이름 및 공급자 ID로 필터링된 이 작업 영역에 대해 사용 가능한 모든 대상을 반환합니다. 대상 이름이 전달되면 단일 Target 개체가 반환됩니다. 그렇지 않으면 선택적으로 공급자 ID로 필터링된 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

매개 변수

Name	Description
value 필수	추가할 UserAgent 값(예: "azure-quantum-")

cancel_job

작업 영역에 작업 실행을 취소하도록 요청합니다.

cancel_job(job: Job) -> Job

매개 변수

Name	Description
job 필수	취소할 작업입니다.

반환

형식	Description
Job	업데이트된 상태 사용하여 취소하도록 요청된 Azure Quantum 작업

close_session

세션이 터미널 상태가 아닌 경우 지정된 작업 영역에서 세션을 닫습니다. 그렇지 않으면 세션 세부 정보만 새로 고칩니다.

close_session(session: Session) -> None

매개 변수

Name	Description
session 필수	닫을 세션입니다.

from_connection_string

연결 문자열 새 Azure Quantum 작업 영역 클라이언트를 만듭니다.

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

매개 변수

Name	Description
connection_string 필수	일반적으로 Azure Portal의 Quantum 작업 영역 - 작업 ->> 액세스 키 블레이드에서 가져온 유효한 연결 문자열.

반환

형식	Description
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

매개 변수

Name	Description
job_id	작업 ID, 기본값은 없음입니다. 기본값: None
container_name	컨테이너 이름, 기본값은 없음입니다. 기본값: None
container_name_format	컨테이너 이름 형식은 기본적으로 "job-{job_id}"입니다. 기본값: job-{job_id}

반환

형식	Description
str	컨테이너 URI.

get_job

지정된 ID에 해당하는 작업을 반환합니다.

get_job(job_id: str) -> Job

매개 변수

Name	Description
job_id 필수	가져올 작업의 ID입니다.

반환

형식	Description
Job	Azure Quantum 작업.

get_quotas

지정된 작업 영역에 대한 할당량 목록을 가져옵니다. 각 할당량은 해당 할당량에 대한 속성을 포함하는 사전으로 표시됩니다.

일반적인 할당량 속성은 다음과 같습니다.

"dimension": 할당량이 적용되는 차원입니다.
"scope": 할당량이 적용되는 scope.
"provider_id": 할당량이 적용되는 공급자입니다.
"사용률": 할당량의 현재 사용률입니다.
"limit": 할당량의 제한입니다.
"period": 할당량이 적용되는 기간입니다.

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

반환

형식	Description
List[Dict[str, Any]	작업 영역 할당량.

get_session

작업 영역에서 세션을 가져옵니다.

get_session(session_id: str) -> Session

매개 변수

Name	Description
session_id 필수	검색할 세션의 ID입니다.

반환

형식	Description
Session	Azure Quantum 세션

get_targets

대상 이름 및 공급자 ID로 필터링된 이 작업 영역에 대해 사용 가능한 모든 대상을 반환합니다. 대상 이름이 전달되면 단일 Target 개체가 반환됩니다. 그렇지 않으면 선택적으로 공급자 ID로 필터링된 Target 개체의 반복 가능/목록을 반환합니다.

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

매개 변수

Name	Description
name	필터링할 선택적 대상 이름이며, 기본적으로 없음으로 설정됩니다. 기본값: None
provider_id	필터링할 선택적 공급자 ID이며, 기본적으로 없음으로 설정됩니다. 기본값: None

반환

형식	Description
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	Description
name_match	작업 이름 일치에 대한 선택적 정규식입니다. 기본값은 없음입니다. 기본값: None
status	작업 상태 의한 선택적 필터입니다. 기본값은 없음입니다. 기본값: None
created_after	지정된 시간 후에 만들어진 작업별 선택적 필터입니다. 기본값은 없음입니다. 기본값: None

반환

형식	Description
List[Job]	검색 조건과 일치하는 작업입니다.

list_session_jobs

세션과 연결된 모든 작업을 가져옵니다.

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

매개 변수

Name	Description
session_id 필수	세션의 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

매개 변수

Name	Description
session 필수	열려고 만들 세션입니다.

반환

형식	Description
Session	새로 열려 있는 Azure Quantum 세션.

refresh_session

작업 영역의 최신 정보로 세션 세부 정보를 업데이트.

refresh_session(session: Session) -> None

매개 변수

Name	Description
session 필수	새로 고칠 세션입니다.

submit_job

작업 영역에서 처리할 작업을 제출합니다.

submit_job(job: Job) -> Job

매개 변수

Name	Description
job 필수	제출할 작업입니다.

반환

형식	Description
Job	업데이트된 상태 사용하여 제출된 Azure Quantum 작업입니다.

특성

credential

Quantum 작업 영역에 연결하는 데 사용되는 자격 증명을 반환합니다.

반환

형식	Description
Any	Azure.Identity의 Azure SDK 자격 증명.

location

Quantum 작업 영역의 Azure 위치를 반환합니다.

반환

형식	Description
str	Azure 위치 이름입니다.

name

Quantum 작업 영역의 이름을 반환합니다.

반환

형식	Description
str	Azure Quantum 작업 영역 이름입니다.

resource_group

Quantum 작업 영역의 Azure 리소스 그룹을 반환합니다.

반환

형식	Description
str	Azure 리소스 그룹 이름.

storage

Quantum 작업 영역과 연결된 Azure Storage 계정 이름을 반환합니다.

반환

형식	Description
str	Azure Storage 계정 이름입니다.

subscription_id

Quantum 작업 영역의 Azure 구독 ID를 반환합니다.

반환

형식	Description
str	Azure 구독 ID입니다.

user_agent

UserAgent 헤더를 통해 서비스로 전송되는 작업 영역의 UserAgent 문자열을 반환합니다.

반환

형식	Description
str	사용자 에이전트 문자열입니다.

Share via

Workspace 클래스

생성자

매개 변수

메서드

append_user_agent

매개 변수

cancel_job

매개 변수

반환

close_session

매개 변수

from_connection_string

매개 변수

반환

get_container_uri

매개 변수

반환

get_job

매개 변수

반환

get_quotas

반환

get_session

매개 변수

반환

get_targets

매개 변수

반환

list_jobs

매개 변수

반환

list_session_jobs

매개 변수

반환

list_sessions

반환

list_top_level_items

반환

open_session

매개 변수

반환

refresh_session

매개 변수

submit_job

매개 변수

반환

특성

credential

반환

location

반환

name

반환

resource_group

반환

storage

반환

subscription_id

반환

user_agent

반환

추가 리소스