Workspace Clase

Representa un área de trabajo de Azure Quantum.

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

1. especifique una ubicación y un identificador de recurso válidos; O
2. especifique una ubicación válida, un identificador de suscripción, un grupo de recursos y un nombre de área de trabajo.

También puede usar un 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 cuenta de almacenamiento de Azure válida cadena de conexión.

Herencia

builtins.object

Workspace

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	El identificador de la suscripción de Azure. Se omite si se especifica resource_id. valor predeterminado: None
resource_group	El 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	La cuenta de almacenamiento de Azure cadena de conexión. 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. Puede especificarse 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 http User-Agent al comunicarse con el servicio Azure Quantum. valor predeterminado: None

Métodos

append_user_agent	Anexe un nuevo valor al 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_session	Cierra una sesión en el área de trabajo especificada si la sesión no está en estado terminal. De lo contrario, solo actualiza los detalles de la sesión.
from_connection_string	Crea un nuevo cliente de Área de trabajo de Azure Quantum a partir de un 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 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": ámbito al que se aplica la cuota. "provider_id": proveedor al que se aplica la cuota. "uso": el uso actual de la cuota. "limit": 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 esta área de trabajo filtradas por nombre de destino e identificador de proveedor. Si se pasa el nombre de destino, se devolverá un único objeto Target . De lo contrario, devuelve una lista o iterable de objetos Target , filtrado opcionalmente por el identificador de proveedor.
list_jobs	Devuelve la lista de trabajos que cumplen los criterios de filtro opcionales (limitados).
list_session_jobs	Obtiene todos los trabajos asociados a una sesión.
list_sessions	Obtenga la lista de sesiones del área de trabajo especificada.
list_top_level_items	Obtenga una lista de elementos de nivel superior para el área de trabajo especificada, que puede ser trabajos independientes (trabajos no asociados a una sesión) o sesiones (que pueden contener trabajos).
open_session	Abre o crea una sesión en el área de trabajo especificada.
refresh_session	Novedades 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 al 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-"

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ó cancelar, con un estado actualizado.

close_session

Cierra una sesión en el área de trabajo especificada si la sesión no está en estado 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 de Área de trabajo de Azure Quantum a partir de un 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, normalmente obtenida de la hoja Quantum Workspace -> Operations - Access Keys (Áreas de trabajo cuánticas: operaciones:> 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 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 Ninguno. 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": ámbito al que se aplica la cuota.
• "provider_id": proveedor al que se aplica la cuota.
• "uso": el uso actual de la cuota.
• "limit": 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 esta área de trabajo filtradas por nombre de destino e identificador de proveedor. Si se pasa el nombre de destino, se devolverá un único objeto Target . De lo contrario, devuelve una lista o iterable de objetos Target , filtrado opcionalmente por el identificador de proveedor.

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

Parámetros

Nombre	Description
name	El nombre de destino opcional para filtrar de forma predeterminada es Ninguno. valor predeterminado: None
provider_id	Id. de proveedor opcional para filtrar de forma predeterminada en Ninguno. valor predeterminado: None

Devoluciones

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

list_jobs

Devuelve la lista de trabajos que cumplen los criterios de filtro opcionales (limitados).

list_jobs(name_match: str | None = None, status: JobStatus | None = None, created_after: datetime | None = None) -> 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 que se crearon después de la hora especificada. El valor predeterminado es Ninguno. valor predeterminado: None

Devoluciones

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

list_session_jobs

Obtiene todos los trabajos asociados a una sesión.

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

Parámetros

Nombre	Description
session_id Requerido	Identificador de la sesión.

Devoluciones

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

list_sessions

Obtenga la lista de sesiones del área de trabajo especificada.

list_sessions() -> List[Session]

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 especificada, que puede ser trabajos independientes (trabajos no asociados a una sesión) o sesiones (que pueden contener trabajos).

list_top_level_items() -> List[Job | Session]

Devoluciones

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

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	Nueva sesión abierta de Azure Quantum.

refresh_session

Novedades 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 que se envió, 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 asociada 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.