@azure/arm-quantum package

Classes

AzureQuantumManagementClient

Interfaces

APIKeys	List of api keys to be generated.
ApiKey	Azure quantum workspace Api key details.
AzureQuantumManagementClientOptionalParams	Optional parameters.
CheckNameAvailabilityParameters	Details of check name availability request body.
CheckNameAvailabilityResult	Result of check name availability.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
ListKeysResult	Result of list Api keys and connection strings.
Offerings	Interface representing a Offerings.
OfferingsListNextOptionalParams	Optional parameters.
OfferingsListOptionalParams	Optional parameters.
OfferingsListResult	The response of a list Providers operation.
Operation	Operation provided by provider
OperationDisplay	Properties of the operation
Operations	Interface representing a Operations.
OperationsList	Lists the operations available.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PricingDetail	Detailed pricing information for an sku.
PricingDimension	Information about pricing dimension.
Provider	Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs.
ProviderDescription	Information about an offering. A provider offering is an entity that offers Targets to run Azure Quantum Jobs.
ProviderProperties	Provider properties.
ProviderPropertiesAad	Azure Active Directory info.
ProviderPropertiesManagedApplication	Provider's Managed-Application info
QuantumWorkspace	The resource proxy definition object for quantum workspace.
QuantumWorkspaceIdentity	Managed Identity information.
QuotaDimension	Information about a specific quota dimension.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
SkuDescription	Information about a specific sku.
SystemData	Metadata pertaining to creation and last modification of the resource.
TagsObject	Tags object for patch operations.
TargetDescription	Information about a Target. A target is the component that can process a specific type of Job.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
Workspace	Interface representing a Workspace.
WorkspaceCheckNameAvailabilityOptionalParams	Optional parameters.
WorkspaceListKeysOptionalParams	Optional parameters.
WorkspaceListResult	The response of a list Workspaces operation.
WorkspaceRegenerateKeysOptionalParams	Optional parameters.
WorkspaceResourceProperties	Properties of a Workspace
Workspaces	Interface representing a Workspaces.
WorkspacesCreateOrUpdateOptionalParams	Optional parameters.
WorkspacesDeleteOptionalParams	Optional parameters.
WorkspacesGetOptionalParams	Optional parameters.
WorkspacesListByResourceGroupNextOptionalParams	Optional parameters.
WorkspacesListByResourceGroupOptionalParams	Optional parameters.
WorkspacesListBySubscriptionNextOptionalParams	Optional parameters.
WorkspacesListBySubscriptionOptionalParams	Optional parameters.
WorkspacesUpdateTagsOptionalParams	Optional parameters.

Type Aliases

CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
KeyType	Defines values for KeyType. KnownKeyType can be used interchangeably with KeyType, this enum contains the known values that the service supports. Known values supported by the service Primary Secondary
OfferingsListNextResponse	Contains response data for the listNext operation.
OfferingsListResponse	Contains response data for the list operation.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
ProvisioningStatus	Defines values for ProvisioningStatus. KnownProvisioningStatus can be used interchangeably with ProvisioningStatus, this enum contains the known values that the service supports. Known values supported by the service Succeeded ProviderLaunching ProviderUpdating ProviderDeleting ProviderProvisioning Failed
ResourceIdentityType	Defines values for ResourceIdentityType. KnownResourceIdentityType can be used interchangeably with ResourceIdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned None
Status	Defines values for Status. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service Succeeded Launching Updating Deleting Deleted Failed
UsableStatus	Defines values for UsableStatus. KnownUsableStatus can be used interchangeably with UsableStatus, this enum contains the known values that the service supports. Known values supported by the service Yes No Partial
WorkspaceCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
WorkspaceListKeysResponse	Contains response data for the listKeys operation.
WorkspacesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
WorkspacesGetResponse	Contains response data for the get operation.
WorkspacesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
WorkspacesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
WorkspacesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
WorkspacesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
WorkspacesUpdateTagsResponse	Contains response data for the updateTags operation.

Enums

KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownKeyType	Known values of KeyType that the service accepts.
KnownProvisioningStatus	Known values of ProvisioningStatus that the service accepts.
KnownResourceIdentityType	Known values of ResourceIdentityType that the service accepts.
KnownStatus	Known values of Status that the service accepts.
KnownUsableStatus	Known values of UsableStatus that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.