Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 5.75 KB

how-to-manage-quantum-workspaces-with-the-azure-cli.md

File metadata and controls

120 lines (81 loc) · 5.75 KB
author description ms.author ms.date ms.service ms.subservice ms.topic title uid
ricardo-espinoza
This guide shows you how to create and delete quantum workspaces using the Azure command line tool.
ricardoe
02/01/2021
azure-quantum
core
article
Manage quantum workspaces with the Azure CLI
microsoft.quantum.workspaces-cli

Manage quantum workspaces with the Azure CLI

In this guide, learn to create Azure Quantum workspaces and the required Resource Groups and Storage Accounts using the Azure Command-Line Interface (Azure CLI) and start running your quantum applications in Azure Quantum.

Prerequisites

In order to use the Azure Quantum service, you will need:

  • An active Azure account and subscription. For more information, see the Microsoft Learn module Create an Azure account.
  • The Azure CLI.
  • The necessary utilities to use Azure Quantum (includes the quantum extension for the Azure CLI).
  • An Azure resource group where the quantum workspace will live.
  • A storage account in the resource group to be associated with the quantum workspace. Multiple workspaces can be associated with the same account.

Environment setup

  1. Log in to Azure using your credentials.

    az login

  2. In case you have more than one subscription associated with your Azure account, specify the subscription you want to use.

    az account set -s <Your subscription ID>

  3. If this is the first time you will be creating quantum workspaces in your subscription, register the resource provider with this command:

    az provider register --namespace Microsoft.Quantum

Create an Azure Quantum workspace

In order to create a new Azure Quantum workspace, you'll need to know:

  • The location or Azure region name where the resource will live. You can use the list of regions and their resource manager codes supported by the Azure CLI tool (for example, westus).
  • The resource group associated with the new workspace. (for example, MyResourceGroup).
  • An storage account on the same resource group and subscription than the quantum workspace. It's possible to create a new storage account from the Az CLI tool. (for example, MyStorageAccount)
  • The name of the quantum workspace to create. (for example, MyQuantumWorkspace)

And then you can create it using the following command, using the previous examples:

az quantum workspace create -l westus -g MyResourceGroup -w MyQuantumWorkspace -a MyStorageAccount

By default, a new workspace will be created only containing the Microsoft Basic QIO provider. At any time, it is possible to modify a workspace in order to add or remove other providers. For this, you can use the Azure portal and edit the workspace.

Alternatively, you can create a workspace in a more advanced way and specify the providers using the CLI directly.

Specify additional providers during creation of an Azure Quantum workspace

  1. To retrieve the list of quantum providers available, you can use the following command (using westus as example location) :

    az quantum offerings list -l westus -o table

  2. Once you determine the provider and SKU to include in your workspace, you can review terms using this command, assuming MyProviderID and MySKU as example values:

    az quantum offerings show-terms -l westus -p MyProviderId -k MySKU

  3. The output of the command above includes a Boolean field accepted that shows if the terms for this provider have been accepted already or not, as well as a link to the license terms to review. If you decide to accept those terms, use the following command to record your acceptance.

    az quantum offerings accept-terms -l westus -p MyProviderId -k MySKU

  4. Once you have reviewed and accepted all terms and conditions required, you can create your workspace specifying a list of provider/SKU combinations separated by commas, as in the example below:

    az quantum workspace create -l westus -g MyResourceGroup -w MyQuantumWorkspace -a MyStorageAccount -r "MyProvider1/MySKU1, MyProvider2/MySKU2"

Delete a quantum workspace

If you know the name and resource group of a quantum workspace you want to delete, you can do it with the following command (using the same names as the example above):

az quantum workspace delete -g MyResourceGroup -w MyQuantumWorkspace

Tip

If you don't remember the exact name, you can view the entire list of quantum workspaces in your subscription using az quantum workspace list -o table.

After you delete a workspace, you will still see it listed while it's being deleted in the cloud, however, the provisioningState property of the workspace will immediately change to indicate it's being deleted. You can see this information by using the following command:

az quantum workspace show -g MyResourceGroup -w MyQuantumWorkspace

Note

In case you used the az quantum workspace set command previously to specify a default quantum workspace, then calling the command without parameters will delete (and clear) the default workspace.

az quantum workspace delete

Next steps

Now that you can created and delete workspaces, you can learn about the different targets to run quantum algorithms in Azure Quantum.