@azure/arm-quantum 1.0.0-beta.1 → 1.0.0-beta.2

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