Microsoft.Quantum (preview:2025-01-01)

2025/05/08 • 11 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Quantum/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_CheckNameAvailability (new)
Description :  Check the availability of the resource name for the given location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{location}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
body:
{
Description: The CheckAvailability request ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Offerings_List (new)
Description :  Returns the list of all provider offerings available for the given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/offerings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationName:
{
Description: Location. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ProviderDescription items on this page ,
Required: True ,
}
[
{
id:
{
Description: Unique provider's id. ,
Required: False ,
}
string ,
name:
{
Description: Provider's display name. ,
Required: False ,
}
string ,
properties:
{
Description: Provider properties. ,
Required: False ,
}
{
description:
{
Description: A description about this provider. ,
Required: False ,
}
string ,
providerType:
{
Description: Provider type. ,
Required: False ,
}
string ,
company:
{
Description: Company name. ,
Required: False ,
}
string ,
defaultEndpoint:
{
Description: Provider's default endpoint. ,
Required: False ,
}
string ,
aad:
{
Description: Azure Active Directory info. ,
Required: False ,
}
{
applicationId:
{
Description: Provider's application id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Provider's tenant id. ,
Required: False ,
}
string ,
}
,
managedApplication:
{
Description: Provider's Managed-Application info ,
Required: False ,
}
{
publisherId:
{
Description: Provider's publisher id. ,
Required: False ,
}
string ,
offerId:
{
Description: Provider's offer id. ,
Required: False ,
}
string ,
}
,
targets:
{
Description: The list of targets available from this provider. ,
Required: False ,
}
[
{
id:
{
Description: Unique target id. ,
Required: False ,
}
string ,
name:
{
Description: Display name of this target. ,
Required: False ,
}
string ,
description:
{
Description: A description about this target. ,
Required: False ,
}
string ,
acceptedDataFormats:
{
Description: List of data formats accepted by this target. ,
Required: False ,
}
[
string ,
]
,
acceptedContentEncodings:
{
Description: List of content encodings accepted by this target. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
skus:
{
Description: The list of skus available from this provider. ,
Required: False ,
}
[
{
id:
{
Description: Unique sku id. ,
Required: False ,
}
string ,
name:
{
Description: Display name of this sku. ,
Required: False ,
}
string ,
version:
{
Description: Display name of this sku. ,
Required: False ,
}
string ,
description:
{
Description: Description about this sku. ,
Required: False ,
}
string ,
restrictedAccessUri:
{
Description: Uri to subscribe to the restricted access sku. ,
Required: False ,
}
string ,
autoAdd:
{
Description: Flag to indicate whether the sku should be automatically added during workspace creation. ,
Required: False ,
}
boolean ,
targets:
{
Description: The list of targets available for this sku. ,
Required: False ,
}
[
string ,
]
,
quotaDimensions:
{
Description: The list of quota dimensions for this sku. ,
Required: False ,
}
[
{
id:
{
Description: Unique id of this dimension. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of this quota dimension. ,
Required: False ,
}
string ,
period:
{
Description: The reset period of this quota dimension. ,
Required: False ,
}
string ,
quota:
{
Description: The max limit of this dimension. ,
Format: float ,
Required: False ,
}
number ,
name:
{
Description: The display name of this quota dimension. ,
Required: False ,
}
string ,
description:
{
Description: A description about this quota dimension. ,
Required: False ,
}
string ,
unit:
{
Description: The standard unit of measurement used for this quota dimension. ,
Required: False ,
}
string ,
unitPlural:
{
Description: The standard unit of measurement used for this quota dimension in plural form. ,
Required: False ,
}
string ,
}
,
]
,
pricingDetails:
{
Description: The list of pricing details for the sku. ,
Required: False ,
}
[
{
id:
{
Description: Unique id for this pricing information. ,
Required: False ,
}
string ,
value:
{
Description: The unit cost of this sku. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
quotaDimensions:
{
Description: The list of quota dimensions from the provider. ,
Required: False ,
}
[
{
id:
{
Description: Unique id of this dimension. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of this quota dimension. ,
Required: False ,
}
string ,
period:
{
Description: The reset period of this quota dimension. ,
Required: False ,
}
string ,
quota:
{
Description: The max limit of this dimension. ,
Format: float ,
Required: False ,
}
number ,
name:
{
Description: The display name of this quota dimension. ,
Required: False ,
}
string ,
description:
{
Description: A description about this quota dimension. ,
Required: False ,
}
string ,
unit:
{
Description: The standard unit of measurement used for this quota dimension. ,
Required: False ,
}
string ,
unitPlural:
{
Description: The standard unit of measurement used for this quota dimension in plural form. ,
Required: False ,
}
string ,
}
,
]
,
pricingDimensions:
{
Description: The list of pricing dimensions from the provider. ,
Required: False ,
}
[
{
id:
{
Description: Unique id of this pricing dimension. ,
Required: False ,
}
string ,
name:
{
Description: The display name of this pricing dimension. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListBySubscription (new)
Description :  Gets the list of Workspaces within a Subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Quantum/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The QuantumWorkspace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListByResourceGroup (new)
Description :  Gets the list of Workspaces within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The QuantumWorkspace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Get (new)
Description :  Returns the Workspace resource associated with the given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the quantum workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_CreateOrUpdate (new)
Description :  Creates or updates a Workspace resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the quantum workspace resource. ,
Required: True ,
}
string ,
resource:
{
Description: Workspace details. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The resource proxy definition object for Quantum Workspace. ,
}
{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_UpdateTags (new)
Description :  Updates an existing Workspace's tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the quantum workspace resource. ,
Required: True ,
}
string ,
properties:
{
Description: Parameters supplied to update tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Delete (new)
Description :  Deletes a Workspace resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the quantum workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListKeys (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the quantum workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
primaryKey:
{
Description: The quantum workspace primary api key. ,
Required: False ,
}
{
createdAt:
{
Description: The creation time of the api key. ,
Format: date-time ,
Required: False ,
}
string ,
key:
{
Description: The Api key. ,
Required: False ,
}
string ,
}
,
secondaryKey:
{
Description: The quantum workspace secondary api key. ,
Required: False ,
}
{
createdAt:
{
Description: The creation time of the api key. ,
Format: date-time ,
Required: False ,
}
string ,
key:
{
Description: The Api key. ,
Required: False ,
}
string ,
}
,
primaryConnectionString:
{
Description: The connection string of the primary api key. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: The connection string of the secondary api key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_RegenerateKeys (new)
Description :  Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/regenerateKey
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the quantum workspace resource. ,
Required: True ,
}
string ,
body:
{
Description: Which key to regenerate: primary or secondary. ,
Required: True ,
}
{
keys:
{
Description: A list of api key names. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}