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

package/src/models/parameters.ts

@@ -9,12 +9,13 @@
 import {
   OperationParameter,
   OperationURLParameter,
-  OperationQueryParameter
+  OperationQueryParameter,
 } from "@azure/core-client";
 import {
   QuantumWorkspace as QuantumWorkspaceMapper,
   TagsObject as TagsObjectMapper,
-  CheckNameAvailabilityParameters as CheckNameAvailabilityParametersMapper
+  CheckNameAvailabilityParameters as CheckNameAvailabilityParametersMapper,
+  APIKeys as APIKeysMapper,
 } from "../models/mappers";
 
 export const accept: OperationParameter = {
@@ -24,9 +25,9 @@ export const accept: OperationParameter = {
     isConstant: true,
     serializedName: "Accept",
     type: {
-      name: "String"
-    }
-  }
+      name: "String",
+    },
+  },
 };
 
 export const $host: OperationURLParameter = {
@@ -35,33 +36,37 @@ export const $host: OperationURLParameter = {
     serializedName: "$host",
     required: true,
     type: {
-      name: "String"
-    }
+      name: "String",
+    },
   },
-  skipEncoding: true
+  skipEncoding: true,
 };
 
 export const resourceGroupName: OperationURLParameter = {
   parameterPath: "resourceGroupName",
   mapper: {
+    constraints: {
+      MaxLength: 90,
+      MinLength: 1,
+    },
     serializedName: "resourceGroupName",
     required: true,
     type: {
-      name: "String"
-    }
-  }
+      name: "String",
+    },
+  },
 };
 
 export const apiVersion: OperationQueryParameter = {
   parameterPath: "apiVersion",
   mapper: {
-    defaultValue: "2022-01-10-preview",
+    defaultValue: "2023-11-13-preview",
     isConstant: true,
     serializedName: "api-version",
     type: {
-      name: "String"
-    }
-  }
+      name: "String",
+    },
+  },
 };
 
 export const subscriptionId: OperationURLParameter = {
@@ -70,20 +75,23 @@ export const subscriptionId: OperationURLParameter = {
     serializedName: "subscriptionId",
     required: true,
     type: {
-      name: "String"
-    }
-  }
+      name: "Uuid",
+    },
+  },
 };
 
 export const workspaceName: OperationURLParameter = {
   parameterPath: "workspaceName",
   mapper: {
+    constraints: {
+      Pattern: new RegExp("^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$"),
+    },
     serializedName: "workspaceName",
     required: true,
     type: {
-      name: "String"
-    }
-  }
+      name: "String",
+    },
+  },
 };
 
 export const contentType: OperationParameter = {
@@ -93,19 +101,19 @@ export const contentType: OperationParameter = {
     isConstant: true,
     serializedName: "Content-Type",
     type: {
-      name: "String"
-    }
-  }
+      name: "String",
+    },
+  },
 };
 
 export const quantumWorkspace: OperationParameter = {
   parameterPath: "quantumWorkspace",
-  mapper: QuantumWorkspaceMapper
+  mapper: QuantumWorkspaceMapper,
 };
 
 export const workspaceTags: OperationParameter = {
   parameterPath: "workspaceTags",
-  mapper: TagsObjectMapper
+  mapper: TagsObjectMapper,
 };
 
 export const nextLink: OperationURLParameter = {
@@ -114,10 +122,10 @@ export const nextLink: OperationURLParameter = {
     serializedName: "nextLink",
     required: true,
     type: {
-      name: "String"
-    }
+      name: "String",
+    },
   },
-  skipEncoding: true
+  skipEncoding: true,
 };
 
 export const locationName: OperationURLParameter = {
@@ -126,12 +134,17 @@ export const locationName: OperationURLParameter = {
     serializedName: "locationName",
     required: true,
     type: {
-      name: "String"
-    }
-  }
+      name: "String",
+    },
+  },
 };
 
 export const checkNameAvailabilityParameters: OperationParameter = {
   parameterPath: "checkNameAvailabilityParameters",
-  mapper: CheckNameAvailabilityParametersMapper
+  mapper: CheckNameAvailabilityParametersMapper,
+};
+
+export const keySpecification: OperationParameter = {
+  parameterPath: "keySpecification",
+  mapper: APIKeysMapper,
 };

package/src/operations/offerings.ts

@@ -18,7 +18,7 @@ import {
   OfferingsListNextOptionalParams,
   OfferingsListOptionalParams,
   OfferingsListResponse,
-  OfferingsListNextResponse
+  OfferingsListNextResponse,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -41,7 +41,7 @@ export class OfferingsImpl implements Offerings {
    */
   public list(
     locationName: string,
-    options?: OfferingsListOptionalParams
+    options?: OfferingsListOptionalParams,
   ): PagedAsyncIterableIterator<ProviderDescription> {
     const iter = this.listPagingAll(locationName, options);
     return {
@@ -56,14 +56,14 @@ export class OfferingsImpl implements Offerings {
           throw new Error("maxPageSize is not supported by this operation.");
         }
         return this.listPagingPage(locationName, options, settings);
-      }
+      },
     };
   }
 
   private async *listPagingPage(
     locationName: string,
     options?: OfferingsListOptionalParams,
-    settings?: PageSettings
+    settings?: PageSettings,
   ): AsyncIterableIterator<ProviderDescription[]> {
     let result: OfferingsListResponse;
     let continuationToken = settings?.continuationToken;
@@ -85,7 +85,7 @@ export class OfferingsImpl implements Offerings {
 
   private async *listPagingAll(
     locationName: string,
-    options?: OfferingsListOptionalParams
+    options?: OfferingsListOptionalParams,
   ): AsyncIterableIterator<ProviderDescription> {
     for await (const page of this.listPagingPage(locationName, options)) {
       yield* page;
@@ -99,11 +99,11 @@ export class OfferingsImpl implements Offerings {
    */
   private _list(
     locationName: string,
-    options?: OfferingsListOptionalParams
+    options?: OfferingsListOptionalParams,
   ): Promise<OfferingsListResponse> {
     return this.client.sendOperationRequest(
       { locationName, options },
-      listOperationSpec
+      listOperationSpec,
     );
   }
 
@@ -116,11 +116,11 @@ export class OfferingsImpl implements Offerings {
   private _listNext(
     locationName: string,
     nextLink: string,
-    options?: OfferingsListNextOptionalParams
+    options?: OfferingsListNextOptionalParams,
   ): Promise<OfferingsListNextResponse> {
     return this.client.sendOperationRequest(
       { locationName, nextLink, options },
-      listNextOperationSpec
+      listNextOperationSpec,
     );
   }
 }
@@ -128,43 +128,42 @@ export class OfferingsImpl implements Offerings {
 const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
 
 const listOperationSpec: coreClient.OperationSpec = {
-  path:
-    "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/offerings",
+  path: "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/offerings",
   httpMethod: "GET",
   responses: {
     200: {
-      bodyMapper: Mappers.OfferingsListResult
+      bodyMapper: Mappers.OfferingsListResult,
     },
     default: {
-      bodyMapper: Mappers.ErrorResponse
-    }
+      bodyMapper: Mappers.ErrorResponse,
+    },
   },
   queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,
-    Parameters.locationName
+    Parameters.locationName,
   ],
   headerParameters: [Parameters.accept],
-  serializer
+  serializer,
 };
 const listNextOperationSpec: coreClient.OperationSpec = {
   path: "{nextLink}",
   httpMethod: "GET",
   responses: {
     200: {
-      bodyMapper: Mappers.OfferingsListResult
+      bodyMapper: Mappers.OfferingsListResult,
     },
     default: {
-      bodyMapper: Mappers.ErrorResponse
-    }
+      bodyMapper: Mappers.ErrorResponse,
+    },
   },
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,
     Parameters.nextLink,
-    Parameters.locationName
+    Parameters.locationName,
   ],
   headerParameters: [Parameters.accept],
-  serializer
+  serializer,
 };

package/src/operations/operations.ts

@@ -18,7 +18,7 @@ import {
   OperationsListNextOptionalParams,
   OperationsListOptionalParams,
   OperationsListResponse,
-  OperationsListNextResponse
+  OperationsListNextResponse,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -39,7 +39,7 @@ export class OperationsImpl implements Operations {
    * @param options The options parameters.
    */
   public list(
-    options?: OperationsListOptionalParams
+    options?: OperationsListOptionalParams,
   ): PagedAsyncIterableIterator<Operation> {
     const iter = this.listPagingAll(options);
     return {
@@ -54,13 +54,13 @@ export class OperationsImpl implements Operations {
           throw new Error("maxPageSize is not supported by this operation.");
         }
         return this.listPagingPage(options, settings);
-      }
+      },
     };
   }
 
   private async *listPagingPage(
     options?: OperationsListOptionalParams,
-    settings?: PageSettings
+    settings?: PageSettings,
   ): AsyncIterableIterator<Operation[]> {
     let result: OperationsListResponse;
     let continuationToken = settings?.continuationToken;
@@ -81,7 +81,7 @@ export class OperationsImpl implements Operations {
   }
 
   private async *listPagingAll(
-    options?: OperationsListOptionalParams
+    options?: OperationsListOptionalParams,
   ): AsyncIterableIterator<Operation> {
     for await (const page of this.listPagingPage(options)) {
       yield* page;
@@ -93,7 +93,7 @@ export class OperationsImpl implements Operations {
    * @param options The options parameters.
    */
   private _list(
-    options?: OperationsListOptionalParams
+    options?: OperationsListOptionalParams,
   ): Promise<OperationsListResponse> {
     return this.client.sendOperationRequest({ options }, listOperationSpec);
   }
@@ -105,11 +105,11 @@ export class OperationsImpl implements Operations {
    */
   private _listNext(
     nextLink: string,
-    options?: OperationsListNextOptionalParams
+    options?: OperationsListNextOptionalParams,
   ): Promise<OperationsListNextResponse> {
     return this.client.sendOperationRequest(
       { nextLink, options },
-      listNextOperationSpec
+      listNextOperationSpec,
     );
   }
 }
@@ -121,29 +121,29 @@ const listOperationSpec: coreClient.OperationSpec = {
   httpMethod: "GET",
   responses: {
     200: {
-      bodyMapper: Mappers.OperationsList
+      bodyMapper: Mappers.OperationsList,
     },
     default: {
-      bodyMapper: Mappers.ErrorResponse
-    }
+      bodyMapper: Mappers.ErrorResponse,
+    },
   },
   queryParameters: [Parameters.apiVersion],
   urlParameters: [Parameters.$host],
   headerParameters: [Parameters.accept],
-  serializer
+  serializer,
 };
 const listNextOperationSpec: coreClient.OperationSpec = {
   path: "{nextLink}",
   httpMethod: "GET",
   responses: {
     200: {
-      bodyMapper: Mappers.OperationsList
+      bodyMapper: Mappers.OperationsList,
     },
     default: {
-      bodyMapper: Mappers.ErrorResponse
-    }
+      bodyMapper: Mappers.ErrorResponse,
+    },
   },
   urlParameters: [Parameters.$host, Parameters.nextLink],
   headerParameters: [Parameters.accept],
-  serializer
+  serializer,
 };

package/src/operations/workspace.ts

@@ -14,7 +14,11 @@ import { AzureQuantumManagementClient } from "../azureQuantumManagementClient";
 import {
   CheckNameAvailabilityParameters,
   WorkspaceCheckNameAvailabilityOptionalParams,
-  WorkspaceCheckNameAvailabilityResponse
+  WorkspaceCheckNameAvailabilityResponse,
+  WorkspaceListKeysOptionalParams,
+  WorkspaceListKeysResponse,
+  APIKeys,
+  WorkspaceRegenerateKeysOptionalParams,
 } from "../models";
 
 /** Class containing Workspace operations. */
@@ -38,11 +42,50 @@ export class WorkspaceImpl implements Workspace {
   checkNameAvailability(
     locationName: string,
     checkNameAvailabilityParameters: CheckNameAvailabilityParameters,
-    options?: WorkspaceCheckNameAvailabilityOptionalParams
+    options?: WorkspaceCheckNameAvailabilityOptionalParams,
   ): Promise<WorkspaceCheckNameAvailabilityResponse> {
     return this.client.sendOperationRequest(
       { locationName, checkNameAvailabilityParameters, options },
-      checkNameAvailabilityOperationSpec
+      checkNameAvailabilityOperationSpec,
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, workspaceName, options },
+      listKeysOperationSpec,
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, workspaceName, keySpecification, options },
+      regenerateKeysOperationSpec,
     );
   }
 }
@@ -50,25 +93,66 @@ export class WorkspaceImpl implements Workspace {
 const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
 
 const checkNameAvailabilityOperationSpec: coreClient.OperationSpec = {
-  path:
-    "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/checkNameAvailability",
+  path: "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/checkNameAvailability",
   httpMethod: "POST",
   responses: {
     200: {
-      bodyMapper: Mappers.CheckNameAvailabilityResult
+      bodyMapper: Mappers.CheckNameAvailabilityResult,
     },
     default: {
-      bodyMapper: Mappers.ErrorResponse
-    }
+      bodyMapper: Mappers.ErrorResponse,
+    },
   },
   requestBody: Parameters.checkNameAvailabilityParameters,
   queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,
-    Parameters.locationName
+    Parameters.locationName,
+  ],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer,
+};
+const listKeysOperationSpec: coreClient.OperationSpec = {
+  path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/listKeys",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ListKeysResult,
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse,
+    },
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.subscriptionId,
+    Parameters.workspaceName,
+  ],
+  headerParameters: [Parameters.accept],
+  serializer,
+};
+const regenerateKeysOperationSpec: coreClient.OperationSpec = {
+  path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/regenerateKey",
+  httpMethod: "POST",
+  responses: {
+    204: {},
+    default: {
+      bodyMapper: Mappers.ErrorResponse,
+    },
+  },
+  requestBody: Parameters.keySpecification,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.subscriptionId,
+    Parameters.workspaceName,
   ],
   headerParameters: [Parameters.accept, Parameters.contentType],
   mediaType: "json",
-  serializer
+  serializer,
 };