Workspace interface

  • Reference
Package:
@azure/arm-quantum

Interface representing a Workspace.

Methods

checkNameAvailability(string, CheckNameAvailabilityParameters, WorkspaceCheckNameAvailabilityOptionalParams)

Check the availability of the resource name.
listKeys(string, string, WorkspaceListKeysOptionalParams)

Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.
regenerateKeys(string, string, APIKeys, WorkspaceRegenerateKeysOptionalParams)

Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately.

Method Details

checkNameAvailability(string, CheckNameAvailabilityParameters, WorkspaceCheckNameAvailabilityOptionalParams)

Check the availability of the resource name.

function checkNameAvailability(locationName: string, checkNameAvailabilityParameters: CheckNameAvailabilityParameters, options?: WorkspaceCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>

Parameters

locationName

string

Location.

checkNameAvailabilityParameters
CheckNameAvailabilityParameters

The name and type of the resource.

options
WorkspaceCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResult>

listKeys(string, string, WorkspaceListKeysOptionalParams)

Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.

function listKeys(resourceGroupName: string, workspaceName: string, options?: WorkspaceListKeysOptionalParams): Promise<ListKeysResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the quantum workspace resource.

options
WorkspaceListKeysOptionalParams

The options parameters.

Returns

Promise<ListKeysResult>

regenerateKeys(string, string, APIKeys, WorkspaceRegenerateKeysOptionalParams)

Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately.

function regenerateKeys(resourceGroupName: string, workspaceName: string, keySpecification: APIKeys, options?: WorkspaceRegenerateKeysOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the quantum workspace resource.

keySpecification
APIKeys

Which key to regenerate: primary or secondary.

options
WorkspaceRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<void>