@azure/arm-quantum 1.0.0-alpha.20240312.1 → 1.0.0-beta.2

package/src/operationsInterfaces/workspace.ts

@@ -9,7 +9,11 @@
 import {
   CheckNameAvailabilityParameters,
   WorkspaceCheckNameAvailabilityOptionalParams,
-  WorkspaceCheckNameAvailabilityResponse
+  WorkspaceCheckNameAvailabilityResponse,
+  WorkspaceListKeysOptionalParams,
+  WorkspaceListKeysResponse,
+  APIKeys,
+  WorkspaceRegenerateKeysOptionalParams,
 } from "../models";
 
 /** Interface representing a Workspace. */
@@ -23,6 +27,33 @@ export interface Workspace {
   checkNameAvailability(
     locationName: string,
     checkNameAvailabilityParameters: CheckNameAvailabilityParameters,
-    options?: WorkspaceCheckNameAvailabilityOptionalParams
+    options?: WorkspaceCheckNameAvailabilityOptionalParams,
   ): Promise<WorkspaceCheckNameAvailabilityResponse>;
+  /**
+   * 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.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the quantum workspace resource.
+   * @param options The options parameters.
+   */
+  listKeys(
+    resourceGroupName: string,
+    workspaceName: string,
+    options?: WorkspaceListKeysOptionalParams,
+  ): Promise<WorkspaceListKeysResponse>;
+  /**
+   * Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop
+   * working immediately.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the quantum workspace resource.
+   * @param keySpecification Which key to regenerate:  primary or secondary.
+   * @param options The options parameters.
+   */
+  regenerateKeys(
+    resourceGroupName: string,
+    workspaceName: string,
+    keySpecification: APIKeys,
+    options?: WorkspaceRegenerateKeysOptionalParams,
+  ): Promise<void>;
 }

package/src/operationsInterfaces/workspaces.ts

@@ -19,7 +19,7 @@ import {
   TagsObject,
   WorkspacesUpdateTagsOptionalParams,
   WorkspacesUpdateTagsResponse,
-  WorkspacesDeleteOptionalParams
+  WorkspacesDeleteOptionalParams,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -30,31 +30,31 @@ export interface Workspaces {
    * @param options The options parameters.
    */
   listBySubscription(
-    options?: WorkspacesListBySubscriptionOptionalParams
+    options?: WorkspacesListBySubscriptionOptionalParams,
   ): PagedAsyncIterableIterator<QuantumWorkspace>;
   /**
    * Gets the list of Workspaces within a resource group.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param options The options parameters.
    */
   listByResourceGroup(
     resourceGroupName: string,
-    options?: WorkspacesListByResourceGroupOptionalParams
+    options?: WorkspacesListByResourceGroupOptionalParams,
   ): PagedAsyncIterableIterator<QuantumWorkspace>;
   /**
    * Returns the Workspace resource associated with the given name.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param workspaceName The name of the quantum workspace resource.
    * @param options The options parameters.
    */
   get(
     resourceGroupName: string,
     workspaceName: string,
-    options?: WorkspacesGetOptionalParams
+    options?: WorkspacesGetOptionalParams,
   ): Promise<WorkspacesGetResponse>;
   /**
    * Creates or updates a workspace resource.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param workspaceName The name of the quantum workspace resource.
    * @param quantumWorkspace Workspace details.
    * @param options The options parameters.
@@ -63,7 +63,7 @@ export interface Workspaces {
     resourceGroupName: string,
     workspaceName: string,
     quantumWorkspace: QuantumWorkspace,
-    options?: WorkspacesCreateOrUpdateOptionalParams
+    options?: WorkspacesCreateOrUpdateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<WorkspacesCreateOrUpdateResponse>,
@@ -72,7 +72,7 @@ export interface Workspaces {
   >;
   /**
    * Creates or updates a workspace resource.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param workspaceName The name of the quantum workspace resource.
    * @param quantumWorkspace Workspace details.
    * @param options The options parameters.
@@ -81,11 +81,11 @@ export interface Workspaces {
     resourceGroupName: string,
     workspaceName: string,
     quantumWorkspace: QuantumWorkspace,
-    options?: WorkspacesCreateOrUpdateOptionalParams
+    options?: WorkspacesCreateOrUpdateOptionalParams,
   ): Promise<WorkspacesCreateOrUpdateResponse>;
   /**
    * Updates an existing workspace's tags.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param workspaceName The name of the quantum workspace resource.
    * @param workspaceTags Parameters supplied to update tags.
    * @param options The options parameters.
@@ -94,28 +94,28 @@ export interface Workspaces {
     resourceGroupName: string,
     workspaceName: string,
     workspaceTags: TagsObject,
-    options?: WorkspacesUpdateTagsOptionalParams
+    options?: WorkspacesUpdateTagsOptionalParams,
   ): Promise<WorkspacesUpdateTagsResponse>;
   /**
    * Deletes a Workspace resource.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param workspaceName The name of the quantum workspace resource.
    * @param options The options parameters.
    */
   beginDelete(
     resourceGroupName: string,
     workspaceName: string,
-    options?: WorkspacesDeleteOptionalParams
+    options?: WorkspacesDeleteOptionalParams,
   ): Promise<SimplePollerLike<OperationState<void>, void>>;
   /**
    * Deletes a Workspace resource.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param workspaceName The name of the quantum workspace resource.
    * @param options The options parameters.
    */
   beginDeleteAndWait(
     resourceGroupName: string,
     workspaceName: string,
-    options?: WorkspacesDeleteOptionalParams
+    options?: WorkspacesDeleteOptionalParams,
   ): Promise<void>;
 }

package/src/pagingHelper.ts

@@ -28,7 +28,7 @@ export function getContinuationToken(page: unknown): string | undefined {
 
 export function setContinuationToken(
   page: unknown,
-  continuationToken: string | undefined
+  continuationToken: string | undefined,
 ): void {
   if (typeof page !== "object" || page === null || !continuationToken) {
     return;

package/types/arm-quantum.d.ts

@@ -4,6 +4,23 @@ import { OperationState } from '@azure/core-lro';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { SimplePollerLike } from '@azure/core-lro';
 
+/** Azure quantum workspace Api key details. */
+export declare interface ApiKey {
+    /** The creation time of the api key. */
+    createdAt?: Date;
+    /**
+     * The Api key.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly key?: string;
+}
+
+/** List of api keys to be generated. */
+export declare interface APIKeys {
+    /** A list of api key names. */
+    keys?: KeyType_2[];
+}
+
 export declare class AzureQuantumManagementClient extends coreClient.ServiceClient {
     $host: string;
     apiVersion: string;
@@ -11,7 +28,7 @@ export declare class AzureQuantumManagementClient extends coreClient.ServiceClie
     /**
      * Initializes a new instance of the AzureQuantumManagementClient class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
-     * @param subscriptionId The Azure subscription ID.
+     * @param subscriptionId The ID of the target subscription. The value must be an UUID.
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureQuantumManagementClientOptionalParams);
@@ -124,6 +141,17 @@ export declare interface ErrorResponse {
  */
 export declare function getContinuationToken(page: unknown): string | undefined;
 
+/**
+ * Defines values for KeyType. \
+ * {@link 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**
+ */
+declare type KeyType_2 = string;
+export { KeyType_2 as KeyType }
+
 /** Known values of {@link CreatedByType} that the service accepts. */
 export declare enum KnownCreatedByType {
     /** User */
@@ -136,6 +164,14 @@ export declare enum KnownCreatedByType {
     Key = "Key"
 }
 
+/** Known values of {@link KeyType} that the service accepts. */
+export declare enum KnownKeyType {
+    /** Primary */
+    Primary = "Primary",
+    /** Secondary */
+    Secondary = "Secondary"
+}
+
 /** Known values of {@link ProvisioningStatus} that the service accepts. */
 export declare enum KnownProvisioningStatus {
     /** Succeeded */
@@ -186,6 +222,26 @@ export declare enum KnownUsableStatus {
     Partial = "Partial"
 }
 
+/** Result of list Api keys and connection strings. */
+export declare interface ListKeysResult {
+    /** Indicator of enablement of the Quantum workspace Api keys. */
+    apiKeyEnabled?: boolean;
+    /** The quantum workspace primary api key. */
+    primaryKey?: ApiKey;
+    /** The quantum workspace secondary api key. */
+    secondaryKey?: ApiKey;
+    /**
+     * The connection string of the primary api key.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly primaryConnectionString?: string;
+    /**
+     * The connection string of the secondary api key.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly secondaryConnectionString?: string;
+}
+
 /** Interface representing a Offerings. */
 export declare interface Offerings {
     /**
@@ -312,7 +368,7 @@ export declare interface ProviderDescription {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly name?: string;
-    /** A list of provider-specific properties. */
+    /** Provider properties. */
     properties?: ProviderProperties;
 }
 
@@ -396,32 +452,10 @@ export declare type ProvisioningStatus = string;
 
 /** The resource proxy definition object for quantum workspace. */
 export declare interface QuantumWorkspace extends TrackedResource {
+    /** Gets or sets the properties. Define quantum workspace's specific properties. */
+    properties?: WorkspaceResourceProperties;
     /** Managed Identity information. */
     identity?: QuantumWorkspaceIdentity;
-    /**
-     * System metadata
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly systemData?: SystemData;
-    /** List of Providers selected for this Workspace */
-    providers?: Provider[];
-    /**
-     * Whether the current workspace is ready to accept Jobs.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly usable?: UsableStatus;
-    /**
-     * Provisioning status field
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly provisioningState?: ProvisioningStatus;
-    /** ARM Resource Id of the storage account associated with this workspace. */
-    storageAccount?: string;
-    /**
-     * The URI of the workspace endpoint.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly endpointUri?: string;
 }
 
 /** Managed Identity information. */
@@ -463,7 +497,7 @@ export declare interface QuotaDimension {
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export declare interface Resource {
     /**
-     * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+     * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly id?: string;
@@ -477,6 +511,11 @@ export declare interface Resource {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly type?: string;
+    /**
+     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
 }
 
 /**
@@ -593,6 +632,24 @@ export declare interface Workspace {
      * @param options The options parameters.
      */
     checkNameAvailability(locationName: string, checkNameAvailabilityParameters: CheckNameAvailabilityParameters, options?: WorkspaceCheckNameAvailabilityOptionalParams): Promise<WorkspaceCheckNameAvailabilityResponse>;
+    /**
+     * 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.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workspaceName The name of the quantum workspace resource.
+     * @param options The options parameters.
+     */
+    listKeys(resourceGroupName: string, workspaceName: string, options?: WorkspaceListKeysOptionalParams): Promise<WorkspaceListKeysResponse>;
+    /**
+     * Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop
+     * working immediately.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workspaceName The name of the quantum workspace resource.
+     * @param keySpecification Which key to regenerate:  primary or secondary.
+     * @param options The options parameters.
+     */
+    regenerateKeys(resourceGroupName: string, workspaceName: string, keySpecification: APIKeys, options?: WorkspaceRegenerateKeysOptionalParams): Promise<void>;
 }
 
 /** Optional parameters. */
@@ -602,6 +659,13 @@ export declare interface WorkspaceCheckNameAvailabilityOptionalParams extends co
 /** Contains response data for the checkNameAvailability operation. */
 export declare type WorkspaceCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
 
+/** Optional parameters. */
+export declare interface WorkspaceListKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listKeys operation. */
+export declare type WorkspaceListKeysResponse = ListKeysResult;
+
 /** The response of a list Workspaces operation. */
 export declare interface WorkspaceListResult {
     /** Result of a list Workspaces operation. */
@@ -610,6 +674,35 @@ export declare interface WorkspaceListResult {
     nextLink?: string;
 }
 
+/** Optional parameters. */
+export declare interface WorkspaceRegenerateKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Properties of a Workspace */
+export declare interface WorkspaceResourceProperties {
+    /** List of Providers selected for this Workspace */
+    providers?: Provider[];
+    /**
+     * Whether the current workspace is ready to accept Jobs.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly usable?: UsableStatus;
+    /**
+     * Provisioning status field
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningStatus;
+    /** ARM Resource Id of the storage account associated with this workspace. */
+    storageAccount?: string;
+    /**
+     * The URI of the workspace endpoint.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly endpointUri?: string;
+    /** Indicator of enablement of the Quantum workspace Api keys. */
+    apiKeyEnabled?: boolean;
+}
+
 /** Interface representing a Workspaces. */
 export declare interface Workspaces {
     /**
@@ -619,20 +712,20 @@ export declare interface Workspaces {
     listBySubscription(options?: WorkspacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<QuantumWorkspace>;
     /**
      * Gets the list of Workspaces within a resource group.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param options The options parameters.
      */
     listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<QuantumWorkspace>;
     /**
      * Returns the Workspace resource associated with the given name.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param workspaceName The name of the quantum workspace resource.
      * @param options The options parameters.
      */
     get(resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams): Promise<WorkspacesGetResponse>;
     /**
      * Creates or updates a workspace resource.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param workspaceName The name of the quantum workspace resource.
      * @param quantumWorkspace Workspace details.
      * @param options The options parameters.
@@ -640,7 +733,7 @@ export declare interface Workspaces {
     beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, quantumWorkspace: QuantumWorkspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspacesCreateOrUpdateResponse>, WorkspacesCreateOrUpdateResponse>>;
     /**
      * Creates or updates a workspace resource.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param workspaceName The name of the quantum workspace resource.
      * @param quantumWorkspace Workspace details.
      * @param options The options parameters.
@@ -648,7 +741,7 @@ export declare interface Workspaces {
     beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, quantumWorkspace: QuantumWorkspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<WorkspacesCreateOrUpdateResponse>;
     /**
      * Updates an existing workspace's tags.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param workspaceName The name of the quantum workspace resource.
      * @param workspaceTags Parameters supplied to update tags.
      * @param options The options parameters.
@@ -656,14 +749,14 @@ export declare interface Workspaces {
     updateTags(resourceGroupName: string, workspaceName: string, workspaceTags: TagsObject, options?: WorkspacesUpdateTagsOptionalParams): Promise<WorkspacesUpdateTagsResponse>;
     /**
      * Deletes a Workspace resource.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param workspaceName The name of the quantum workspace resource.
      * @param options The options parameters.
      */
     beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes a Workspace resource.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param workspaceName The name of the quantum workspace resource.
      * @param options The options parameters.
      */

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.3"
+      "packageVersion": "7.43.0"
     }
   ]
 }