Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 2.86 KB

optimization-workspace.md

File metadata and controls

94 lines (70 loc) · 2.86 KB
Raw
author description ms.author ms.date ms.service ms.subservice ms.topic title uid
george-moussa
Reference for azure.quantum.Workspace
georgenm
02/01/2021
azure-quantum
optimization
reference
Azure Quantum Workspace
microsoft.quantum.optimization.workspace

Quantum Workspace

from azure.quantum import Workspace

Constructor

To create a Workspace object, you must supply the following arguments in order to connect. If you have not already created a workspace, follow the steps in Creating an Azure Quantum workspace guide using the following values:

  • subscription_id: The subscription ID where the workspace is deployed.
  • resource_group: The name of the resource group where the workspace is deployed.
  • name: The name of the workspace.
  • location: The location where the workspace is deployed, for example West US, with either the create or show commands.
  • credential: (Optional) The credential to use to connect to the Azure Quantum and Storage services. Normally one of the credential types from Azure.Identity. Defaults to DefaultAzureCredential, which will attempt multiple forms of authentication.

You can find these values by viewing your Azure Quantum Workspace details through the Azure portal.

In case you have not specified any credentials, the first time you run a method which interacts with the Azure service, a window might prompt in your default browser asking for your credentials.

workspace = Workspace (
    subscription_id = "",  # Add your subscription_id
    resource_group = "",   # Add your resource_group
    name = ""              # Add your workspace name
    location= ""           # Add the workspace location, for example, westus
)

Workspace.get_job

Retrieves information about a job.

from azure.quantum import Workspace

workspace = Workspace(...)
job = workspace.get_job("285cfcb4-6822-11ea-a05f-2a16a847b8a3")
print(job.details.status)

> Succeeded

Workspace.list_jobs

Returns the list of existing jobs in the workspace.

from azure.quantum import Workspace

workspace = Workspace(...)
jobs = workspace.list_jobs()
for job in jobs:
    print(job.id, job.details.status)

> 08ea8792-68f2-11ea-acc5-2a16a847b8a3 Succeeded
> 0ab1863a-68f2-11ea-82b3-2a16a847b8a3 Succeeded
> 0c5c507e-68f2-11ea-ba75-2a16a847b8a3 Cancelled
> f0c8de58-68f1-11ea-a565-2a16a847b8a3 Executing

Workspace.cancel_job

Cancels a job that was previously submitted.

from azure.quantum import Workspace

workspace = Workspace(...)
job = workspace.get_job("285cfcb4-6822-11ea-a05f-2a16a847b8a3")

workspace.cancel_job(job)
print(job.details.status)

> Succeeded