Workspace Classe

Representa um workspace do Azure Quantum.

Ao criar um objeto workspace, os chamadores têm várias opções para identificar o workspace Azure Quantum (em ordem de precedência):

especificar uma ID de recurso válida; Ou
especificar uma ID de assinatura válida, um grupo de recursos e um nome de workspace; Ou
especifique um nome de workspace válido.

Você também pode usar uma cadeia de conexão para especificar os parâmetros de conexão para um Workspace do Azure Quantum chamando from_connection_string.

Se o workspace do Azure Quantum não tiver armazenamento vinculado, o chamador também deverá passar uma cadeia de conexão de conta de armazenamento válida do Azure.

Construtor

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)

Parâmetros

Nome	Description
subscription_id	A ID da assinatura do Azure. Ignorado se resource_id for especificado. Valor padrão: None
resource_group	O nome do grupo de recursos do Azure. Ignorado se resource_id for especificado. Valor padrão: None
name	O nome do workspace do Azure Quantum. Ignorado se resource_id for especificado. Valor padrão: None
storage	A cadeia de conexão da conta de armazenamento do Azure. Necessário somente se o workspace do Azure Quantum especificado não tiver armazenamento vinculado. Valor padrão: None
resource_id	A ID do recurso do workspace do Azure Quantum. Valor padrão: None
location	A região do Azure em que o workspace do Azure Quantum é provisionado. Isso pode ser especificado como um nome de região, como "Leste dos EUA" ou um nome de local, como "eastus". Valor padrão: None
credential	A credencial a ser usada para se conectar aos serviços do Azure. Normalmente, um dos tipos de credencial do Azure.Identity. O padrão é "DefaultAzureCredential", que tentará várias formas de autenticação. Valor padrão: None
user_agent	Adicione o valor especificado como um prefixo ao cabeçalho http User-Agent ao se comunicar com o serviço do Azure Quantum. Valor padrão: None

Métodos

append_user_agent	Acrescente um novo valor ao UserAgent do Workspace. Os valores são acrescentados usando um traço.
cancel_job	Solicita que o Workspace cancele a execução de um trabalho.
close
close_session	Fecha uma sessão no workspace fornecido se a sessão não estiver em um estado terminal. Caso contrário, basta atualizar os detalhes da sessão.
from_connection_string	Cria um novo cliente do Workspace do Azure Quantum a partir de uma cadeia de conexão.
get_container_uri	Obtenha o URI do contêiner com base na ID do trabalho ou no nome do contêiner. Criará um novo contêiner se ele ainda não existir.
get_job	Retorna o trabalho correspondente à ID fornecida.
get_quotas	Obtenha uma lista de cotas para o workspace fornecido. Cada cota é representada como um dicionário, contendo as propriedades dessa cota. As propriedades comuns de Cota são: "dimensão": a dimensão à qual a cota é aplicada. "escopo": o escopo ao qual a cota é aplicada. "provider_id": o provedor ao qual a cota é aplicada. "utilização": a utilização atual da cota. "limit": o limite da cota. "period": o período ao qual a cota é aplicada.
get_session	Obtém uma sessão do workspace.
get_targets	Retorna todos os destinos disponíveis para esse workspace filtrado pelo nome de destino e pela ID do provedor. Se o nome de destino for passado, um único objeto Target será retornado. Caso contrário, ele retornará uma iterável/lista de objetos de de destino , opcionalmente filtrados pela ID do Provedor.
list_jobs	Retorna a lista de trabalhos que atendem aos critérios de filtro opcionais (limitados).
list_jobs_paginated
list_session_jobs	Obtém todos os trabalhos associados a uma sessão.
list_session_jobs_paginated	Obtém todos os trabalhos associados a uma sessão.
list_sessions	Obtenha a lista de sessões no workspace fornecido.
list_sessions_paginated	Obtenha a lista de sessões no workspace fornecido.
list_top_level_items	Obtenha uma lista de itens de nível superior para o workspace fornecido, que pode ser trabalhos autônomos (trabalhos não associados a uma sessão) ou sessões (que podem conter Trabalhos).
list_top_level_items_paginated
open_session	Abre/cria uma sessão no workspace fornecido.
refresh_session	Atualiza os detalhes da sessão com as informações mais recentes do workspace.
submit_job	Envia um trabalho a ser processado no Workspace.

append_user_agent

Acrescente um novo valor ao UserAgent do Workspace. Os valores são acrescentados usando um traço.

append_user_agent(value: str) -> None

Parâmetros

Nome	Description
value Obrigatório	Valor UserAgent a ser adicionado, por exemplo, "azure-quantum-plugin<>"

cancel_job

Solicita que o Workspace cancele a execução de um trabalho.

cancel_job(job: Job) -> Job

Parâmetros

Nome	Description
job Obrigatório	Trabalho a ser cancelado.

Retornos

Tipo	Description
Job	Trabalho do Azure Quantum que foi solicitado a ser cancelado, com um status atualizado.

close

close() -> None

close_session

Fecha uma sessão no workspace fornecido se a sessão não estiver em um estado terminal. Caso contrário, basta atualizar os detalhes da sessão.

close_session(session: Session) -> None

Parâmetros

Nome	Description
session Obrigatório	A sessão a ser fechada.

from_connection_string

Cria um novo cliente do Workspace do Azure Quantum a partir de uma cadeia de conexão.

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

Parâmetros

Nome	Description
connection_string Obrigatório	Uma cadeia de conexão válida, geralmente obtida da folha Quantum Workspace – operações de> -> teclas de acesso no Portal do Azure.

Retornos

Tipo	Description
Workspace	Novo cliente do Workspace do Azure Quantum.

get_container_uri

Obtenha o URI do contêiner com base na ID do trabalho ou no nome do contêiner. Criará um novo contêiner se ele ainda não existir.

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

Parâmetros

Nome	Description
job_id	ID do trabalho, o padrão é None. Valor padrão: None
container_name	Nome do contêiner, o padrão é None. Valor padrão: None
container_name_format	Formato de nome de contêiner, padrão como "job-{job_id}". Valor padrão: job-{job_id}

Retornos

Tipo	Description
str	URI do contêiner.

get_job

Retorna o trabalho correspondente à ID fornecida.

get_job(job_id: str) -> Job

Parâmetros

Nome	Description
job_id Obrigatório	Id de um trabalho a ser buscado.

Retornos

Tipo	Description
Job	Trabalho do Azure Quantum.

get_quotas

Obtenha uma lista de cotas para o workspace fornecido. Cada cota é representada como um dicionário, contendo as propriedades dessa cota.

As propriedades comuns de Cota são:

"dimensão": a dimensão à qual a cota é aplicada.
"escopo": o escopo ao qual a cota é aplicada.
"provider_id": o provedor ao qual a cota é aplicada.
"utilização": a utilização atual da cota.
"limit": o limite da cota.
"period": o período ao qual a cota é aplicada.

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

Retornos

Tipo	Description
List[Dict[str, Any]	Cotas de workspace.

get_session

Obtém uma sessão do workspace.

get_session(session_id: str) -> Session

Parâmetros

Nome	Description
session_id Obrigatório	A ID da sessão a ser recuperada.

Retornos

Tipo	Description
Session	Sessão do Azure Quantum

get_targets

Retorna todos os destinos disponíveis para esse workspace filtrado pelo nome de destino e pela ID do provedor. Se o nome de destino for passado, um único objeto Target será retornado. Caso contrário, ele retornará uma iterável/lista de objetos de de destino , opcionalmente filtrados pela ID do Provedor.

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

Parâmetros

Nome	Description
name	O nome de destino opcional pelo qual filtrar, o padrão é None. Valor padrão: None
provider_id	A ID do provedor opcional a ser filtrada, o padrão é None. Valor padrão: None

Retornos

Tipo	Description
Union[Target, Iterable[Target]]	Um único destino do Azure Quantum ou uma iterável/lista de destinos.

list_jobs

Retorna a lista de trabalhos que atendem aos critérios de filtro opcionais (limitados).

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]

Parâmetros

Nome	Description
name_match	Expressão regular opcional para correspondência de nome de trabalho. O padrão é None. Valor padrão: None
status	Filtro opcional por status do trabalho. O padrão é None. Valor padrão: None
created_after	Filtro opcional por trabalhos que foram criados após o horário determinado. O padrão é None. Valor padrão: None
job_type	Valor padrão: None
provider	Valor padrão: None
target	Valor padrão: None
created_before	Valor padrão: None
orderby_property	Valor padrão: None
is_asc	Valor padrão: True

Retornos

Tipo	Description
List[Job]	Trabalhos que corresponderam aos critérios de pesquisa.

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]

Parâmetros somente de palavra-chave

Nome	Description
name_match	Valor padrão: None
job_type	Valor padrão: None
provider	Valor padrão: None
target	Valor padrão: None
status	Valor padrão: None
created_after	Valor padrão: None
created_before	Valor padrão: None
skip	Valor padrão: 0
top	Valor padrão: 100
orderby_property	Valor padrão: None
is_asc	Valor padrão: True

list_session_jobs

Obtém todos os trabalhos associados a uma sessão.

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]

Parâmetros

Nome	Description
session_id Obrigatório	A ID da sessão.
name_match	Valor padrão: None
status	Valor padrão: None
orderby_property	Valor padrão: None
is_asc	Valor padrão: True

Retornos

Tipo	Description
List[Job]	Lista de todos os trabalhos associados a uma sessão.

list_session_jobs_paginated

Obtém todos os trabalhos associados a uma sessão.

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]

Parâmetros

Nome	Description
session_id Obrigatório	A ID da sessão.

Parâmetros somente de palavra-chave

Nome	Description
session_id Obrigatório
name_match	Valor padrão: None
status	Valor padrão: None
skip	Valor padrão: 0
top	Valor padrão: 100
orderby_property	Valor padrão: None
is_asc	Valor padrão: True

Retornos

Tipo	Description
List[Job]	Lista de todos os trabalhos associados a uma sessão.

list_sessions

Obtenha a lista de sessões no workspace fornecido.

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]

Parâmetros

Nome	Description
provider	Valor padrão: None
target	Valor padrão: None
status	Valor padrão: None
created_after	Valor padrão: None
created_before	Valor padrão: None
orderby_property	Valor padrão: None
is_asc	Valor padrão: True

Retornos

Tipo	Description
List[Session]	Lista de sessões de workspace.

list_sessions_paginated

Obtenha a lista de sessões no workspace fornecido.

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]

Parâmetros somente de palavra-chave

Nome	Description
provider	Valor padrão: None
target	Valor padrão: None
status	Valor padrão: None
created_after	Valor padrão: None
created_before	Valor padrão: None
skip	Valor padrão: 0
top	Valor padrão: 100
orderby_property	Valor padrão: None
is_asc	Valor padrão: True

Retornos

Tipo	Description
List[Session]	Lista de sessões de workspace.

list_top_level_items

Obtenha uma lista de itens de nível superior para o workspace fornecido, que pode ser trabalhos autônomos (trabalhos não associados a uma sessão) ou sessões (que podem conter Trabalhos).

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]

Parâmetros

Nome	Description
name_match	Valor padrão: None
item_type	Valor padrão: None
job_type	Valor padrão: None
provider	Valor padrão: None
target	Valor padrão: None
status	Valor padrão: None
created_after	Valor padrão: None
created_before	Valor padrão: None
orderby_property	Valor padrão: None
is_asc	Valor padrão: True

Retornos

Tipo	Description
List[Union[Job, Session]]	Lista de Trabalhos ou Sessões de nível superior do Workspace.

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]

Parâmetros somente de palavra-chave

Nome	Description
name_match	Valor padrão: None
item_type	Valor padrão: None
job_type	Valor padrão: None
provider	Valor padrão: None
target	Valor padrão: None
status	Valor padrão: None
created_after	Valor padrão: None
created_before	Valor padrão: None
skip	Valor padrão: 0
top	Valor padrão: 100
orderby_property	Valor padrão: None
is_asc	Valor padrão: True

open_session

Abre/cria uma sessão no workspace fornecido.

open_session(session: Session) -> None

Parâmetros

Nome	Description
session Obrigatório	A sessão a ser aberta/criada.

Retornos

Tipo	Description
Session	Uma nova sessão aberta do Azure Quantum.

refresh_session

Atualiza os detalhes da sessão com as informações mais recentes do workspace.

refresh_session(session: Session) -> None

Parâmetros

Nome	Description
session Obrigatório	A sessão a ser atualizada.

submit_job

Envia um trabalho a ser processado no Workspace.

submit_job(job: Job) -> Job

Parâmetros

Nome	Description
job Obrigatório	Trabalho a ser enviada.

Retornos

Tipo	Description
Job	Trabalho do Azure Quantum que foi enviado, com um status atualizado.

Atributos

credential

Retorna a Credencial usada para se conectar ao Espaço de Trabalho Quântico.

Retornos

Tipo	Description
Any	Credencial do SDK do Azure do Azure.Identity.

location

Retorna o local do Azure do Workspace Quantum.

Retornos

Tipo	Description
str	Nome da localização do Azure.

name

Retorna o nome do workspace quântico.

Retornos

Tipo	Description
str	Nome do Workspace do Azure Quantum.

resource_group

Retorna o Grupo de Recursos do Azure do Workspace Quantum.

Retornos

Tipo	Description
str	Nome do Grupo de Recursos do Azure.

storage

Retorna o nome da conta de Armazenamento do Azure associado ao Espaço de Trabalho Quantum.

Retornos

Tipo	Description
str	Nome da conta do Armazenamento do Azure.

subscription_id

Retorna a ID de Assinatura do Azure do Workspace Quantum.

Retornos

Tipo	Description
str	ID da Assinatura do Azure.

user_agent

Retorna a cadeia de caracteres UserAgent do Workspace que é enviada para o serviço por meio do cabeçalho UserAgent.

Retornos

Tipo	Description
str	Cadeia de caracteres do Agente de Usuário.