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

package/review/arm-quantum.api.md

@@ -10,6 +10,17 @@ import { OperationState } from '@azure/core-lro';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { SimplePollerLike } from '@azure/core-lro';
 
+// @public
+export interface ApiKey {
+    createdAt?: Date;
+    readonly key?: string;
+}
+
+// @public
+export interface APIKeys {
+    keys?: KeyType_2[];
+}
+
 // @public (undocumented)
 export class AzureQuantumManagementClient extends coreClient.ServiceClient {
     // (undocumented)
@@ -75,6 +86,10 @@ export interface ErrorResponse {
 // @public
 export function getContinuationToken(page: unknown): string | undefined;
 
+// @public
+type KeyType_2 = string;
+export { KeyType_2 as KeyType }
+
 // @public
 export enum KnownCreatedByType {
     Application = "Application",
@@ -83,6 +98,12 @@ export enum KnownCreatedByType {
     User = "User"
 }
 
+// @public
+export enum KnownKeyType {
+    Primary = "Primary",
+    Secondary = "Secondary"
+}
+
 // @public
 export enum KnownProvisioningStatus {
     Failed = "Failed",
@@ -116,6 +137,15 @@ export enum KnownUsableStatus {
     Yes = "Yes"
 }
 
+// @public
+export interface ListKeysResult {
+    apiKeyEnabled?: boolean;
+    readonly primaryConnectionString?: string;
+    primaryKey?: ApiKey;
+    readonly secondaryConnectionString?: string;
+    secondaryKey?: ApiKey;
+}
+
 // @public
 export interface Offerings {
     list(locationName: string, options?: OfferingsListOptionalParams): PagedAsyncIterableIterator<ProviderDescription>;
@@ -241,13 +271,8 @@ export type ProvisioningStatus = string;
 
 // @public
 export interface QuantumWorkspace extends TrackedResource {
-    readonly endpointUri?: string;
     identity?: QuantumWorkspaceIdentity;
-    providers?: Provider[];
-    readonly provisioningState?: ProvisioningStatus;
-    storageAccount?: string;
-    readonly systemData?: SystemData;
-    readonly usable?: UsableStatus;
+    properties?: WorkspaceResourceProperties;
 }
 
 // @public
@@ -273,6 +298,7 @@ export interface QuotaDimension {
 export interface Resource {
     readonly id?: string;
     readonly name?: string;
+    readonly systemData?: SystemData;
     readonly type?: string;
 }
 
@@ -335,6 +361,8 @@ export type UsableStatus = string;
 // @public
 export interface Workspace {
     checkNameAvailability(locationName: string, checkNameAvailabilityParameters: CheckNameAvailabilityParameters, options?: WorkspaceCheckNameAvailabilityOptionalParams): Promise<WorkspaceCheckNameAvailabilityResponse>;
+    listKeys(resourceGroupName: string, workspaceName: string, options?: WorkspaceListKeysOptionalParams): Promise<WorkspaceListKeysResponse>;
+    regenerateKeys(resourceGroupName: string, workspaceName: string, keySpecification: APIKeys, options?: WorkspaceRegenerateKeysOptionalParams): Promise<void>;
 }
 
 // @public
@@ -344,12 +372,33 @@ export interface WorkspaceCheckNameAvailabilityOptionalParams extends coreClient
 // @public
 export type WorkspaceCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
 
+// @public
+export interface WorkspaceListKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WorkspaceListKeysResponse = ListKeysResult;
+
 // @public
 export interface WorkspaceListResult {
     nextLink?: string;
     value?: QuantumWorkspace[];
 }
 
+// @public
+export interface WorkspaceRegenerateKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface WorkspaceResourceProperties {
+    apiKeyEnabled?: boolean;
+    readonly endpointUri?: string;
+    providers?: Provider[];
+    readonly provisioningState?: ProvisioningStatus;
+    storageAccount?: string;
+    readonly usable?: UsableStatus;
+}
+
 // @public
 export interface Workspaces {
     beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, quantumWorkspace: QuantumWorkspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspacesCreateOrUpdateResponse>, WorkspacesCreateOrUpdateResponse>>;

package/src/azureQuantumManagementClient.ts

@@ -11,20 +11,20 @@ import * as coreRestPipeline from "@azure/core-rest-pipeline";
 import {
   PipelineRequest,
   PipelineResponse,
-  SendRequest
+  SendRequest,
 } from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import {
   WorkspacesImpl,
   OfferingsImpl,
   OperationsImpl,
-  WorkspaceImpl
+  WorkspaceImpl,
 } from "./operations";
 import {
   Workspaces,
   Offerings,
   Operations,
-  Workspace
+  Workspace,
 } from "./operationsInterfaces";
 import { AzureQuantumManagementClientOptionalParams } from "./models";
 
@@ -36,13 +36,13 @@ export class AzureQuantumManagementClient extends coreClient.ServiceClient {
   /**
    * 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
+    options?: AzureQuantumManagementClientOptionalParams,
   ) {
     if (credentials === undefined) {
       throw new Error("'credentials' cannot be null");
@@ -57,7 +57,7 @@ export class AzureQuantumManagementClient extends coreClient.ServiceClient {
     }
     const defaults: AzureQuantumManagementClientOptionalParams = {
       requestContentType: "application/json; charset=utf-8",
-      credential: credentials
+      credential: credentials,
     };
 
     const packageDetails = `azsdk-js-arm-quantum/1.0.0-beta.2`;
@@ -70,20 +70,21 @@ export class AzureQuantumManagementClient extends coreClient.ServiceClient {
       ...defaults,
       ...options,
       userAgentOptions: {
-        userAgentPrefix
+        userAgentPrefix,
       },
       endpoint:
-        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com",
     };
     super(optionsWithDefaults);
 
     let bearerTokenAuthenticationPolicyFound: boolean = false;
     if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
-      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] =
+        options.pipeline.getOrderedPolicies();
       bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
         (pipelinePolicy) =>
           pipelinePolicy.name ===
-          coreRestPipeline.bearerTokenAuthenticationPolicyName
+          coreRestPipeline.bearerTokenAuthenticationPolicyName,
       );
     }
     if (
@@ -93,7 +94,7 @@ export class AzureQuantumManagementClient extends coreClient.ServiceClient {
       !bearerTokenAuthenticationPolicyFound
     ) {
       this.pipeline.removePolicy({
-        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName,
       });
       this.pipeline.addPolicy(
         coreRestPipeline.bearerTokenAuthenticationPolicy({
@@ -103,9 +104,9 @@ export class AzureQuantumManagementClient extends coreClient.ServiceClient {
             `${optionsWithDefaults.endpoint}/.default`,
           challengeCallbacks: {
             authorizeRequestOnChallenge:
-              coreClient.authorizeRequestOnClaimChallenge
-          }
-        })
+              coreClient.authorizeRequestOnClaimChallenge,
+          },
+        }),
       );
     }
     // Parameter assignments
@@ -113,7 +114,7 @@ export class AzureQuantumManagementClient extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2022-01-10-preview";
+    this.apiVersion = options.apiVersion || "2023-11-13-preview";
     this.workspaces = new WorkspacesImpl(this);
     this.offerings = new OfferingsImpl(this);
     this.operations = new OperationsImpl(this);
@@ -130,7 +131,7 @@ export class AzureQuantumManagementClient extends coreClient.ServiceClient {
       name: "CustomApiVersionPolicy",
       async sendRequest(
         request: PipelineRequest,
-        next: SendRequest
+        next: SendRequest,
       ): Promise<PipelineResponse> {
         const param = request.url.split("?");
         if (param.length > 1) {
@@ -144,7 +145,7 @@ export class AzureQuantumManagementClient extends coreClient.ServiceClient {
           request.url = param[0] + "?" + newParams.join("&");
         }
         return next(request);
-      }
+      },
     };
     this.pipeline.addPolicy(apiVersionPolicy);
   }

package/src/lroImpl.ts

@@ -28,15 +28,15 @@ export function createLroSpec<T>(inputs: {
     sendInitialRequest: () => sendOperationFn(args, spec),
     sendPollRequest: (
       path: string,
-      options?: { abortSignal?: AbortSignalLike }
+      options?: { abortSignal?: AbortSignalLike },
     ) => {
       const { requestBody, ...restSpec } = spec;
       return sendOperationFn(args, {
         ...restSpec,
         httpMethod: "GET",
         path,
-        abortSignal: options?.abortSignal
+        abortSignal: options?.abortSignal,
       });
-    }
+    },
   };
 }

package/src/models/index.ts

@@ -8,6 +8,31 @@
 
 import * as coreClient from "@azure/core-client";
 
+/** Properties of a Workspace */
+export 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;
+}
+
 /** Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs. */
 export interface Provider {
   /** Unique id of this provider. */
@@ -40,26 +65,10 @@ export interface QuantumWorkspaceIdentity {
   type?: ResourceIdentityType;
 }
 
-/** Metadata pertaining to creation and last modification of the resource. */
-export interface SystemData {
-  /** The identity that created the resource. */
-  createdBy?: string;
-  /** The type of identity that created the resource. */
-  createdByType?: CreatedByType;
-  /** The timestamp of resource creation (UTC). */
-  createdAt?: Date;
-  /** The identity that last modified the resource. */
-  lastModifiedBy?: string;
-  /** The type of identity that last modified the resource. */
-  lastModifiedByType?: CreatedByType;
-  /** The timestamp of resource last modification (UTC) */
-  lastModifiedAt?: Date;
-}
-
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export 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;
@@ -73,6 +82,27 @@ export 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;
+}
+
+/** Metadata pertaining to creation and last modification of the resource. */
+export interface SystemData {
+  /** The identity that created the resource. */
+  createdBy?: string;
+  /** The type of identity that created the resource. */
+  createdByType?: CreatedByType;
+  /** The timestamp of resource creation (UTC). */
+  createdAt?: Date;
+  /** The identity that last modified the resource. */
+  lastModifiedBy?: string;
+  /** The type of identity that last modified the resource. */
+  lastModifiedByType?: CreatedByType;
+  /** The timestamp of resource last modification (UTC) */
+  lastModifiedAt?: Date;
 }
 
 /** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
@@ -155,7 +185,7 @@ export 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;
 }
 
@@ -346,6 +376,43 @@ export interface CheckNameAvailabilityResult {
   readonly message?: string;
 }
 
+/** Result of list Api keys and connection strings. */
+export 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;
+}
+
+/** Azure quantum workspace Api key details. */
+export 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 interface APIKeys {
+  /** A list of api key names. */
+  keys?: KeyType[];
+}
+
 /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
 export interface TrackedResource extends Resource {
   /** Resource tags. */
@@ -356,32 +423,10 @@ export interface TrackedResource extends Resource {
 
 /** The resource proxy definition object for quantum workspace. */
 export 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;
 }
 
 /** Known values of {@link Status} that the service accepts. */
@@ -397,7 +442,7 @@ export enum KnownStatus {
   /** Deleted */
   Deleted = "Deleted",
   /** Failed */
-  Failed = "Failed"
+  Failed = "Failed",
 }
 
 /**
@@ -421,7 +466,7 @@ export enum KnownUsableStatus {
   /** No */
   No = "No",
   /** Partial */
-  Partial = "Partial"
+  Partial = "Partial",
 }
 
 /**
@@ -448,7 +493,7 @@ export enum KnownProvisioningStatus {
   /** ProviderProvisioning */
   ProviderProvisioning = "ProviderProvisioning",
   /** Failed */
-  Failed = "Failed"
+  Failed = "Failed",
 }
 
 /**
@@ -470,7 +515,7 @@ export enum KnownResourceIdentityType {
   /** SystemAssigned */
   SystemAssigned = "SystemAssigned",
   /** None */
-  None = "None"
+  None = "None",
 }
 
 /**
@@ -492,7 +537,7 @@ export enum KnownCreatedByType {
   /** ManagedIdentity */
   ManagedIdentity = "ManagedIdentity",
   /** Key */
-  Key = "Key"
+  Key = "Key",
 }
 
 /**
@@ -507,6 +552,24 @@ export enum KnownCreatedByType {
  */
 export type CreatedByType = string;
 
+/** Known values of {@link KeyType} that the service accepts. */
+export enum KnownKeyType {
+  /** Primary */
+  Primary = "Primary",
+  /** Secondary */
+  Secondary = "Secondary",
+}
+
+/**
+ * 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**
+ */
+export type KeyType = string;
+
 /** Optional parameters. */
 export interface WorkspacesGetOptionalParams
   extends coreClient.OperationOptions {}
@@ -603,7 +666,19 @@ export interface WorkspaceCheckNameAvailabilityOptionalParams
   extends coreClient.OperationOptions {}
 
 /** Contains response data for the checkNameAvailability operation. */
-export type WorkspaceCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
+export type WorkspaceCheckNameAvailabilityResponse =
+  CheckNameAvailabilityResult;
+
+/** Optional parameters. */
+export interface WorkspaceListKeysOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listKeys operation. */
+export type WorkspaceListKeysResponse = ListKeysResult;
+
+/** Optional parameters. */
+export interface WorkspaceRegenerateKeysOptionalParams
+  extends coreClient.OperationOptions {}
 
 /** Optional parameters. */
 export interface AzureQuantumManagementClientOptionalParams