Workspace Classe

  • Referência

Representa um workspace do Azure Quantum.

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

  1. especifique um local válido e uma ID de recurso; Ou
  2. especifique um local válido, uma ID de assinatura, um grupo de recursos e um nome de workspace.

Você também pode usar um 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 conta de armazenamento válida do Azure cadeia de conexão.

Herança
builtins.object
Workspace

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 de 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 conta de armazenamento do Azure cadeia de conexão. 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_session

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

Cria um novo cliente do Workspace do Azure Quantum de um 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 da Cota são:

  • "dimensão": a dimensão à qual a cota é aplicada.
  • "scope": 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 por Nome de destino e 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 Target , opcionalmente filtrados pela ID do Provedor.
list_jobs

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

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

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).
open_session

Abre/cria uma sessão no workspace fornecido.
refresh_session

Atualizações 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-"

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_session

Fecha uma sessão no workspace fornecido se a sessão não estiver em um estado de 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 de um cadeia de conexão.

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

Parâmetros

Nome Description
connection_string
Obrigatório

Um cadeia de conexão válido, geralmente obtido na folha Workspace do Quantum –> Operações –> Chaves 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 é Nenhum.

valor padrão: None
container_name

Nome do contêiner, o padrão é Nenhum.

valor padrão: None
container_name_format

Formato do nome do contêiner, o padrão é "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 da Cota são:

  • "dimensão": a dimensão à qual a cota é aplicada.
  • "scope": 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 por Nome de destino e 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 Target , 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 a ser filtrado por, o padrão é None.

valor padrão: None
provider_id

A ID do provedor opcional a ser filtrada por, 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, status: JobStatus | None = None, created_after: datetime | None = None) -> List[Job]

Parâmetros

Nome Description
name_match

Expressão Regular opcional para correspondência de nome de trabalho. O padrão é Nenhum.

valor padrão: None
status

Filtro opcional por status de trabalho. O padrão é Nenhum.

valor padrão: None
created_after

Filtro opcional por trabalhos que foram criados após o horário determinado. O padrão é Nenhum.

valor padrão: None

Retornos

Tipo Description
List[Job]

Trabalhos que corresponderam aos critérios de pesquisa.

list_session_jobs

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

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

Parâmetros

Nome Description
session_id
Obrigatório

A ID da sessão.

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() -> List[Session]

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() -> List[Job | Session]

Retornos

Tipo Description
List[Union[Job, Session]]

Lista de trabalhos ou sessões de nível superior do workspace.

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ções 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 Espaço de Trabalho Quântico.

Retornos

Tipo Description
str

Nome do local do Azure.

name

Retorna o Nome do Workspace Quantum.

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 Do Quantum.

Retornos

Tipo Description
str

Nome da conta de Armazenamento do Azure.

subscription_id

Retorna a ID da Assinatura do Azure do Workspace Quantum.

Retornos

Tipo Description
str

ID de 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 do Usuário.