Workspace Clase

Representa un área de trabajo de Azure Quantum.

Al crear un objeto Workspace, los autores de llamadas tienen varias opciones para identificar el área de trabajo de Azure Quantum (en orden de prioridad):

especifique un identificador de recurso válido; o
especifique un identificador de suscripción válido, un grupo de recursos y un nombre del área de trabajo; o
especifique un nombre de área de trabajo válido.

También puede usar una cadena de conexión para especificar los parámetros de conexión a un área de trabajo de Azure Quantum mediante una llamada a from_connection_string.

Si el área de trabajo de Azure Quantum no tiene almacenamiento vinculado, el autor de la llamada también debe pasar una cadena de conexión válida de la cuenta de almacenamiento de Azure.

Constructor

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

Nombre	Description
subscription_id	Identificador de suscripción de Azure. Se omite si se especifica resource_id. Valor predeterminado: None
resource_group	Nombre del grupo de recursos de Azure. Se omite si se especifica resource_id. Valor predeterminado: None
name	Nombre del área de trabajo de Azure Quantum. Se omite si se especifica resource_id. Valor predeterminado: None
storage	Cadena de conexión de la cuenta de almacenamiento de Azure. Solo es necesario si el área de trabajo de Azure Quantum especificada no tiene almacenamiento vinculado. Valor predeterminado: None
resource_id	Identificador de recurso del área de trabajo de Azure Quantum. Valor predeterminado: None
location	Región de Azure donde se aprovisiona el área de trabajo de Azure Quantum. Esto se puede especificar como un nombre de región como "Este de EE. UU." o un nombre de ubicación como "eastus". Valor predeterminado: None
credential	Credencial que se va a usar para conectarse a los servicios de Azure. Normalmente, uno de los tipos de credenciales de Azure.Identity. El valor predeterminado es "DefaultAzureCredential", que intentará varias formas de autenticación. Valor predeterminado: None
user_agent	Agregue el valor especificado como prefijo al encabezado de User-Agent HTTP al comunicarse con el servicio Azure Quantum. Valor predeterminado: None

Métodos

append_user_agent	Anexe un nuevo valor a UserAgent del área de trabajo. Los valores se anexan mediante un guión.
cancel_job	Solicita al área de trabajo que cancele la ejecución de un trabajo.
close
close_session	Cierra una sesión en el área de trabajo especificada si la sesión no está en estado de terminal. De lo contrario, solo actualiza los detalles de la sesión.
from_connection_string	Crea un nuevo cliente del área de trabajo de Azure Quantum a partir de una cadena de conexión.
get_container_uri	Obtenga el URI del contenedor en función del identificador de trabajo o el nombre del contenedor. Crea un nuevo contenedor si aún no existe.
get_job	Devuelve el trabajo correspondiente al identificador especificado.
get_quotas	Obtenga una lista de cuotas para el área de trabajo especificada. Cada cuota se representa como un diccionario, que contiene las propiedades de esa cuota. Las propiedades de cuota comunes son: "dimension": dimensión a la que se aplica la cuota. "scope": el ámbito al que se aplica la cuota. "provider_id": proveedor al que se aplica la cuota. "uso": el uso actual de la cuota. "limit": el límite de la cuota. "period": período al que se aplica la cuota.
get_session	Obtiene una sesión del área de trabajo.
get_targets	Devuelve todos los destinos disponibles para este área de trabajo filtradas por el nombre de destino y el identificador de proveedor. Si se pasa el nombre de destino, se devolverá un solo objeto Target. De lo contrario, devuelve una lista o iterable de objetos target, opcionalmente filtrados por el identificador de proveedor.
list_jobs	Devuelve la lista de trabajos que cumplen los criterios de filtro opcionales (limitados).
list_jobs_paginated
list_session_jobs	Obtiene todos los trabajos asociados a una sesión.
list_session_jobs_paginated	Obtiene todos los trabajos asociados a una sesión.
list_sessions	Obtenga la lista de sesiones en el área de trabajo especificada.
list_sessions_paginated	Obtenga la lista de sesiones en el área de trabajo especificada.
list_top_level_items	Obtenga una lista de elementos de nivel superior para el área de trabajo determinada, que puede ser trabajos independientes (trabajos no asociados a una sesión) o sesiones (que pueden contener trabajos).
list_top_level_items_paginated
open_session	Abre o crea una sesión en el área de trabajo especificada.
refresh_session	Actualiza los detalles de la sesión con la información más reciente del área de trabajo.
submit_job	Envía un trabajo que se va a procesar en el área de trabajo.

append_user_agent

Anexe un nuevo valor a UserAgent del área de trabajo. Los valores se anexan mediante un guión.

append_user_agent(value: str) -> None

Parámetros

Nombre	Description
value Requerido	Valor de UserAgent que se va a agregar, por ejemplo, "azure-quantum-plugin<>"

cancel_job

Solicita al área de trabajo que cancele la ejecución de un trabajo.

cancel_job(job: Job) -> Job

Parámetros

Nombre	Description
job Requerido	Trabajo que se va a cancelar.

Devoluciones

Tipo	Description
Job	Trabajo de Azure Quantum que se solicitó que se cancele, con un estado actualizado.

close

close() -> None

close_session

Cierra una sesión en el área de trabajo especificada si la sesión no está en estado de terminal. De lo contrario, solo actualiza los detalles de la sesión.

close_session(session: Session) -> None

Parámetros

Nombre	Description
session Requerido	Sesión que se va a cerrar.

from_connection_string

Crea un nuevo cliente del área de trabajo de Azure Quantum a partir de una cadena de conexión.

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

Parámetros

Nombre	Description
connection_string Requerido	Una cadena de conexión válida, que normalmente se obtiene de la hoja Área de trabajo cuántica ( Operaciones de>> claves de acceso en Azure Portal.

Devoluciones

Tipo	Description
Workspace	Nuevo cliente del área de trabajo de Azure Quantum.

get_container_uri

Obtenga el URI del contenedor en función del identificador de trabajo o el nombre del contenedor. Crea un nuevo contenedor si aún no existe.

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

Parámetros

Nombre	Description
job_id	Id. de trabajo, el valor predeterminado es Ninguno. Valor predeterminado: None
container_name	Nombre del contenedor, el valor predeterminado es None. Valor predeterminado: None
container_name_format	Formato de nombre de contenedor, el valor predeterminado es "job-{job_id}". Valor predeterminado: job-{job_id}

Devoluciones

Tipo	Description
str	URI del contenedor.

get_job

Devuelve el trabajo correspondiente al identificador especificado.

get_job(job_id: str) -> Job

Parámetros

Nombre	Description
job_id Requerido	Identificador de un trabajo que se va a capturar.

Devoluciones

Tipo	Description
Job	Trabajo de Azure Quantum.

get_quotas

Obtenga una lista de cuotas para el área de trabajo especificada. Cada cuota se representa como un diccionario, que contiene las propiedades de esa cuota.

Las propiedades de cuota comunes son:

"dimension": dimensión a la que se aplica la cuota.
"scope": el ámbito al que se aplica la cuota.
"provider_id": proveedor al que se aplica la cuota.
"uso": el uso actual de la cuota.
"limit": el límite de la cuota.
"period": período al que se aplica la cuota.

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

Devoluciones

Tipo	Description
List[Dict[str, Any]	Cuotas del área de trabajo.

get_session

Obtiene una sesión del área de trabajo.

get_session(session_id: str) -> Session

Parámetros

Nombre	Description
session_id Requerido	Identificador de la sesión que se va a recuperar.

Devoluciones

Tipo	Description
Session	Sesión de Azure Quantum

get_targets

Devuelve todos los destinos disponibles para este área de trabajo filtradas por el nombre de destino y el identificador de proveedor. Si se pasa el nombre de destino, se devolverá un solo objeto Target. De lo contrario, devuelve una lista o iterable de objetos target, opcionalmente filtrados por el identificador de proveedor.

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

Parámetros

Nombre	Description
name	Nombre de destino opcional para filtrar de forma predeterminada Ninguno. Valor predeterminado: None
provider_id	Identificador de proveedor opcional para filtrar de forma predeterminada Ninguno. Valor predeterminado: None

Devoluciones

Tipo	Description
Union[Target, Iterable[Target]]	Un único destino de Azure Quantum o una lista iterable o de destinos.

list_jobs

Devuelve la lista de trabajos que cumplen los criterios de filtro opcionales (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

Nombre	Description
name_match	Expresión regular opcional para la coincidencia de nombres de trabajo. El valor predeterminado es Ninguno. Valor predeterminado: None
status	Filtro opcional por estado del trabajo. El valor predeterminado es Ninguno. Valor predeterminado: None
created_after	Filtro opcional por trabajos creados después del tiempo especificado. El valor predeterminado es Ninguno. Valor predeterminado: None
job_type	Valor predeterminado: None
provider	Valor predeterminado: None
target	Valor predeterminado: None
created_before	Valor predeterminado: None
orderby_property	Valor predeterminado: None
is_asc	Valor predeterminado: True

Devoluciones

Tipo	Description
List[Job]	Trabajos que coincidieron con los criterios de búsqueda.

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 de palabra clave únicamente

Nombre	Description
name_match	Valor predeterminado: None
job_type	Valor predeterminado: None
provider	Valor predeterminado: None
target	Valor predeterminado: None
status	Valor predeterminado: None
created_after	Valor predeterminado: None
created_before	Valor predeterminado: None
skip	Valor predeterminado: 0
top	Valor predeterminado: 100
orderby_property	Valor predeterminado: None
is_asc	Valor predeterminado: True

list_session_jobs

Obtiene todos los trabajos asociados a una sesión.

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

Nombre	Description
session_id Requerido	Identificador de la sesión.
name_match	Valor predeterminado: None
status	Valor predeterminado: None
orderby_property	Valor predeterminado: None
is_asc	Valor predeterminado: True

Devoluciones

Tipo	Description
List[Job]	Lista de todos los trabajos asociados a una sesión.

list_session_jobs_paginated

Obtiene todos los trabajos asociados a una sesión.

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

Nombre	Description
session_id Requerido	Identificador de la sesión.

Parámetros de palabra clave únicamente

Nombre	Description
session_id Requerido
name_match	Valor predeterminado: None
status	Valor predeterminado: None
skip	Valor predeterminado: 0
top	Valor predeterminado: 100
orderby_property	Valor predeterminado: None
is_asc	Valor predeterminado: True

Devoluciones

Tipo	Description
List[Job]	Lista de todos los trabajos asociados a una sesión.

list_sessions

Obtenga la lista de sesiones en el área de trabajo especificada.

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

Nombre	Description
provider	Valor predeterminado: None
target	Valor predeterminado: None
status	Valor predeterminado: None
created_after	Valor predeterminado: None
created_before	Valor predeterminado: None
orderby_property	Valor predeterminado: None
is_asc	Valor predeterminado: True

Devoluciones

Tipo	Description
List[Session]	Lista de sesiones del área de trabajo.

list_sessions_paginated

Obtenga la lista de sesiones en el área de trabajo especificada.

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 de palabra clave únicamente

Nombre	Description
provider	Valor predeterminado: None
target	Valor predeterminado: None
status	Valor predeterminado: None
created_after	Valor predeterminado: None
created_before	Valor predeterminado: None
skip	Valor predeterminado: 0
top	Valor predeterminado: 100
orderby_property	Valor predeterminado: None
is_asc	Valor predeterminado: True

Devoluciones

Tipo	Description
List[Session]	Lista de sesiones del área de trabajo.

list_top_level_items

Obtenga una lista de elementos de nivel superior para el área de trabajo determinada, que puede ser trabajos independientes (trabajos no asociados a una sesión) o sesiones (que pueden contener trabajos).

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

Nombre	Description
name_match	Valor predeterminado: None
item_type	Valor predeterminado: None
job_type	Valor predeterminado: None
provider	Valor predeterminado: None
target	Valor predeterminado: None
status	Valor predeterminado: None
created_after	Valor predeterminado: None
created_before	Valor predeterminado: None
orderby_property	Valor predeterminado: None
is_asc	Valor predeterminado: True

Devoluciones

Tipo	Description
List[Union[Job, Session]]	Lista de trabajos o sesiones de nivel superior del área de trabajo.

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 de palabra clave únicamente

Nombre	Description
name_match	Valor predeterminado: None
item_type	Valor predeterminado: None
job_type	Valor predeterminado: None
provider	Valor predeterminado: None
target	Valor predeterminado: None
status	Valor predeterminado: None
created_after	Valor predeterminado: None
created_before	Valor predeterminado: None
skip	Valor predeterminado: 0
top	Valor predeterminado: 100
orderby_property	Valor predeterminado: None
is_asc	Valor predeterminado: True

open_session

Abre o crea una sesión en el área de trabajo especificada.

open_session(session: Session) -> None

Parámetros

Nombre	Description
session Requerido	Sesión que se va a abrir o crear.

Devoluciones

Tipo	Description
Session	Una nueva sesión de Azure Quantum abierta.

refresh_session

Actualiza los detalles de la sesión con la información más reciente del área de trabajo.

refresh_session(session: Session) -> None

Parámetros

Nombre	Description
session Requerido	Sesión que se va a actualizar.

submit_job

Envía un trabajo que se va a procesar en el área de trabajo.

submit_job(job: Job) -> Job

Parámetros

Nombre	Description
job Requerido	Trabajo que se va a enviar.

Devoluciones

Tipo	Description
Job	Trabajo de Azure Quantum enviado, con un estado actualizado.

Atributos

credential

Devuelve la credencial usada para conectarse al área de trabajo de Quantum.

Devoluciones

Tipo	Description
Any	Credenciales del SDK de Azure de Azure.Identity.

location

Devuelve la ubicación de Azure del área de trabajo de Quantum.

Devoluciones

Tipo	Description
str	Nombre de la ubicación de Azure.

name

Devuelve el nombre del área de trabajo de Quantum.

Devoluciones

Tipo	Description
str	Nombre del área de trabajo de Azure Quantum.

resource_group

Devuelve el grupo de recursos de Azure del área de trabajo de Quantum.

Devoluciones

Tipo	Description
str	Nombre del grupo de recursos de Azure.

storage

Devuelve el nombre de la cuenta de Azure Storage asociado al área de trabajo de Quantum.

Devoluciones

Tipo	Description
str	Nombre de la cuenta de Azure Storage.

subscription_id

Devuelve el identificador de suscripción de Azure del área de trabajo de Quantum.

Devoluciones

Tipo	Description
str	Identificador de suscripción de Azure.

user_agent

Devuelve la cadena UserAgent del área de trabajo que se envía al servicio a través del encabezado UserAgent.

Devoluciones

Tipo	Description
str	Cadena del Agente de usuario.