AzureQuantumProvider Class

Class for interfacing with the Azure Quantum service using Qiskit quantum circuits.

Inheritance

qiskit.providers.provider.ProviderV1

AzureQuantumProvider

Constructor

AzureQuantumProvider(workspace: Workspace | None = None, **kwargs)

Parameters

Name	Description
workspace	Workspace Azure Quantum workspace. If missing it will create a new Workspace passing kwargs to the constructor. Defaults to None. default value: None

Methods

backends	Return a list of backends matching the specified filtering.
get_backend	Return a single backend matching the specified filtering.
get_job	Returns the Job instance associated with the given id.
get_workspace	Return Azure Quantum Workspace

backends

Return a list of backends matching the specified filtering.

backends(name=None, **kwargs)

Parameters

Name	Description
name	str name of the backend. default value: None
**kwargs Required	dict used for filtering.

Returns

Type	Description
List[<xref:azure.quantum.qiskit.backends.AzureBackendBase>]	a list of Backends that match the filtering criteria.

get_backend

Return a single backend matching the specified filtering.

get_backend(name=None, **kwargs) -> AzureBackendBase

Parameters

Name	Description
name	str name of the backend. default value: None
**kwargs Required	dict used for filtering.

Returns

Type	Description
<xref:azure.quantum.qiskit.backends.AzureBackendBase>	a backend matching the filtering.

Exceptions

Type	Description
QiskitBackendNotFoundError	if no backend could be found or more than one backend matches the filtering criteria.

get_job

Returns the Job instance associated with the given id.

get_job(job_id) -> AzureQuantumJob

Parameters

Name	Description
job_id Required	str Id of the Job to return.

Returns

Type	Description
AzureQuantumJob	Job instance.

get_workspace

Return Azure Quantum Workspace

get_workspace() -> Workspace