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

package/src/models/index.ts

@@ -1,617 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-
-import * as coreClient from "@azure/core-client";
-
-/** 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. */
-  providerId?: string;
-  /** The sku associated with pricing information for this provider. */
-  providerSku?: string;
-  /** A Uri identifying the specific instance of this provider. */
-  instanceUri?: string;
-  /** The provider's marketplace application display name. */
-  applicationName?: string;
-  /** Provisioning status field */
-  provisioningState?: Status;
-  /** Id to track resource usage for the provider. */
-  resourceUsageId?: string;
-}
-
-/** Managed Identity information. */
-export interface QuantumWorkspaceIdentity {
-  /**
-   * The principal ID of resource identity.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly principalId?: string;
-  /**
-   * The tenant ID of resource.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly tenantId?: string;
-  /** The identity type. */
-  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}
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly id?: string;
-  /**
-   * The name of the resource
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly name?: string;
-  /**
-   * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly type?: string;
-}
-
-/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
-export interface ErrorResponse {
-  /** The error object. */
-  error?: ErrorDetail;
-}
-
-/** The error detail. */
-export interface ErrorDetail {
-  /**
-   * The error code.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly code?: string;
-  /**
-   * The error message.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly message?: string;
-  /**
-   * The error target.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly target?: string;
-  /**
-   * The error details.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly details?: ErrorDetail[];
-  /**
-   * The error additional info.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly additionalInfo?: ErrorAdditionalInfo[];
-}
-
-/** The resource management error additional info. */
-export interface ErrorAdditionalInfo {
-  /**
-   * The additional info type.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly type?: string;
-  /**
-   * The additional info.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly info?: Record<string, unknown>;
-}
-
-/** Tags object for patch operations. */
-export interface TagsObject {
-  /** Resource tags. */
-  tags?: { [propertyName: string]: string };
-}
-
-/** The response of a list Workspaces operation. */
-export interface WorkspaceListResult {
-  /** Result of a list Workspaces operation. */
-  value?: QuantumWorkspace[];
-  /** Link to the next set of results. Not empty if Value contains incomplete list of Workspaces. */
-  nextLink?: string;
-}
-
-/** The response of a list Providers operation. */
-export interface OfferingsListResult {
-  /** Result of a list Providers operation. */
-  value?: ProviderDescription[];
-  /** Link to the next set of results. Not empty if Value contains incomplete list of Providers. */
-  nextLink?: string;
-}
-
-/** Information about an offering. A provider offering is an entity that offers Targets to run Azure Quantum Jobs. */
-export interface ProviderDescription {
-  /** Unique provider's id. */
-  id?: string;
-  /**
-   * Provider's display name.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly name?: string;
-  /** A list of provider-specific properties. */
-  properties?: ProviderProperties;
-}
-
-/** Provider properties. */
-export interface ProviderProperties {
-  /**
-   * A description about this provider.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly description?: string;
-  /**
-   * Provider type.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly providerType?: string;
-  /**
-   * Company name.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly company?: string;
-  /**
-   * Provider's default endpoint.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly defaultEndpoint?: string;
-  /** Azure Active Directory info. */
-  aad?: ProviderPropertiesAad;
-  /** Provider's Managed-Application info */
-  managedApplication?: ProviderPropertiesManagedApplication;
-  /** The list of targets available from this provider. */
-  targets?: TargetDescription[];
-  /** The list of skus available from this provider. */
-  skus?: SkuDescription[];
-  /** The list of quota dimensions from the provider. */
-  quotaDimensions?: QuotaDimension[];
-  /** The list of pricing dimensions from the provider. */
-  pricingDimensions?: PricingDimension[];
-}
-
-/** Azure Active Directory info. */
-export interface ProviderPropertiesAad {
-  /**
-   * Provider's application id.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly applicationId?: string;
-  /**
-   * Provider's tenant id.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly tenantId?: string;
-}
-
-/** Provider's Managed-Application info */
-export interface ProviderPropertiesManagedApplication {
-  /**
-   * Provider's publisher id.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly publisherId?: string;
-  /**
-   * Provider's offer id.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly offerId?: string;
-}
-
-/** Information about a Target. A target is the component that can process a specific type of Job. */
-export interface TargetDescription {
-  /** Unique target id. */
-  id?: string;
-  /** Display name of this target. */
-  name?: string;
-  /** A description about this target. */
-  description?: string;
-  /** List of data formats accepted by this target. */
-  acceptedDataFormats?: string[];
-  /** List of content encodings accepted by this target. */
-  acceptedContentEncodings?: string[];
-}
-
-/** Information about a specific sku. */
-export interface SkuDescription {
-  /** Unique sku id. */
-  id?: string;
-  /** Display name of this sku. */
-  name?: string;
-  /** Display name of this sku. */
-  version?: string;
-  /** Description about this sku. */
-  description?: string;
-  /** Uri to subscribe to the restricted access sku. */
-  restrictedAccessUri?: string;
-  /** Flag to indicate whether the sku should be automatically added during workspace creation. */
-  autoAdd?: boolean;
-  /** The list of targets available for this sku. */
-  targets?: string[];
-  /** The list of quota dimensions for this sku. */
-  quotaDimensions?: QuotaDimension[];
-  /** The list of pricing details for the sku. */
-  pricingDetails?: PricingDetail[];
-}
-
-/** Information about a specific quota dimension. */
-export interface QuotaDimension {
-  /** Unique id of this dimension. */
-  id?: string;
-  /** The scope of this quota dimension. */
-  scope?: string;
-  /** The reset period of this quota dimension. */
-  period?: string;
-  /** The max limit of this dimension. */
-  quota?: number;
-  /** The display name of this quota dimension. */
-  name?: string;
-  /** A description about this quota dimension. */
-  description?: string;
-  /** The standard unit of measurement used for this quota dimension. */
-  unit?: string;
-  /** The standard unit of measurement used for this quota dimension in plural form. */
-  unitPlural?: string;
-}
-
-/** Detailed pricing information for an sku. */
-export interface PricingDetail {
-  /** Unique id for this pricing information. */
-  id?: string;
-  /** The unit cost of this sku. */
-  value?: string;
-}
-
-/** Information about pricing dimension. */
-export interface PricingDimension {
-  /** Unique id of this pricing dimension. */
-  id?: string;
-  /** The display name of this pricing dimension. */
-  name?: string;
-}
-
-/** Lists the operations available. */
-export interface OperationsList {
-  /** Url to follow for getting next page of operations. */
-  nextLink?: string;
-  /** Array of operations */
-  value: Operation[];
-}
-
-/** Operation provided by provider */
-export interface Operation {
-  /** Name of the operation */
-  name?: string;
-  /** Indicates whether the operation is a data action */
-  isDataAction?: boolean;
-  /** Properties of the operation */
-  display?: OperationDisplay;
-}
-
-/** Properties of the operation */
-export interface OperationDisplay {
-  /** Provider name */
-  provider?: string;
-  /** Resource name */
-  resource?: string;
-  /** Operation name */
-  operation?: string;
-  /** Description of the operation */
-  description?: string;
-}
-
-/** Details of check name availability request body. */
-export interface CheckNameAvailabilityParameters {
-  /** Name for checking availability. */
-  name?: string;
-  /** The resource type of Quantum Workspace. */
-  type?: string;
-}
-
-/** Result of check name availability. */
-export interface CheckNameAvailabilityResult {
-  /** Indicator of availability of the Quantum Workspace resource name. */
-  nameAvailable?: boolean;
-  /** The reason of unavailability. */
-  reason?: string;
-  /**
-   * The detailed info regarding the reason associated with the Namespace.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly message?: string;
-}
-
-/** 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. */
-  tags?: { [propertyName: string]: string };
-  /** The geo-location where the resource lives */
-  location: string;
-}
-
-/** The resource proxy definition object for quantum workspace. */
-export interface QuantumWorkspace extends TrackedResource {
-  /** 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. */
-export enum KnownStatus {
-  /** Succeeded */
-  Succeeded = "Succeeded",
-  /** Launching */
-  Launching = "Launching",
-  /** Updating */
-  Updating = "Updating",
-  /** Deleting */
-  Deleting = "Deleting",
-  /** Deleted */
-  Deleted = "Deleted",
-  /** Failed */
-  Failed = "Failed"
-}
-
-/**
- * Defines values for Status. \
- * {@link KnownStatus} can be used interchangeably with Status,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **Succeeded** \
- * **Launching** \
- * **Updating** \
- * **Deleting** \
- * **Deleted** \
- * **Failed**
- */
-export type Status = string;
-
-/** Known values of {@link UsableStatus} that the service accepts. */
-export enum KnownUsableStatus {
-  /** Yes */
-  Yes = "Yes",
-  /** No */
-  No = "No",
-  /** Partial */
-  Partial = "Partial"
-}
-
-/**
- * Defines values for UsableStatus. \
- * {@link KnownUsableStatus} can be used interchangeably with UsableStatus,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **Yes** \
- * **No** \
- * **Partial**
- */
-export type UsableStatus = string;
-
-/** Known values of {@link ProvisioningStatus} that the service accepts. */
-export enum KnownProvisioningStatus {
-  /** Succeeded */
-  Succeeded = "Succeeded",
-  /** ProviderLaunching */
-  ProviderLaunching = "ProviderLaunching",
-  /** ProviderUpdating */
-  ProviderUpdating = "ProviderUpdating",
-  /** ProviderDeleting */
-  ProviderDeleting = "ProviderDeleting",
-  /** ProviderProvisioning */
-  ProviderProvisioning = "ProviderProvisioning",
-  /** Failed */
-  Failed = "Failed"
-}
-
-/**
- * Defines values for ProvisioningStatus. \
- * {@link KnownProvisioningStatus} can be used interchangeably with ProvisioningStatus,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **Succeeded** \
- * **ProviderLaunching** \
- * **ProviderUpdating** \
- * **ProviderDeleting** \
- * **ProviderProvisioning** \
- * **Failed**
- */
-export type ProvisioningStatus = string;
-
-/** Known values of {@link ResourceIdentityType} that the service accepts. */
-export enum KnownResourceIdentityType {
-  /** SystemAssigned */
-  SystemAssigned = "SystemAssigned",
-  /** None */
-  None = "None"
-}
-
-/**
- * Defines values for ResourceIdentityType. \
- * {@link KnownResourceIdentityType} can be used interchangeably with ResourceIdentityType,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **SystemAssigned** \
- * **None**
- */
-export type ResourceIdentityType = string;
-
-/** Known values of {@link CreatedByType} that the service accepts. */
-export enum KnownCreatedByType {
-  /** User */
-  User = "User",
-  /** Application */
-  Application = "Application",
-  /** ManagedIdentity */
-  ManagedIdentity = "ManagedIdentity",
-  /** Key */
-  Key = "Key"
-}
-
-/**
- * Defines values for CreatedByType. \
- * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **User** \
- * **Application** \
- * **ManagedIdentity** \
- * **Key**
- */
-export type CreatedByType = string;
-
-/** Optional parameters. */
-export interface WorkspacesGetOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the get operation. */
-export type WorkspacesGetResponse = QuantumWorkspace;
-
-/** Optional parameters. */
-export interface WorkspacesCreateOrUpdateOptionalParams
-  extends coreClient.OperationOptions {
-  /** Delay to wait until next poll, in milliseconds. */
-  updateIntervalInMs?: number;
-  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
-  resumeFrom?: string;
-}
-
-/** Contains response data for the createOrUpdate operation. */
-export type WorkspacesCreateOrUpdateResponse = QuantumWorkspace;
-
-/** Optional parameters. */
-export interface WorkspacesUpdateTagsOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the updateTags operation. */
-export type WorkspacesUpdateTagsResponse = QuantumWorkspace;
-
-/** Optional parameters. */
-export interface WorkspacesDeleteOptionalParams
-  extends coreClient.OperationOptions {
-  /** Delay to wait until next poll, in milliseconds. */
-  updateIntervalInMs?: number;
-  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
-  resumeFrom?: string;
-}
-
-/** Optional parameters. */
-export interface WorkspacesListBySubscriptionOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the listBySubscription operation. */
-export type WorkspacesListBySubscriptionResponse = WorkspaceListResult;
-
-/** Optional parameters. */
-export interface WorkspacesListByResourceGroupOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the listByResourceGroup operation. */
-export type WorkspacesListByResourceGroupResponse = WorkspaceListResult;
-
-/** Optional parameters. */
-export interface WorkspacesListBySubscriptionNextOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the listBySubscriptionNext operation. */
-export type WorkspacesListBySubscriptionNextResponse = WorkspaceListResult;
-
-/** Optional parameters. */
-export interface WorkspacesListByResourceGroupNextOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the listByResourceGroupNext operation. */
-export type WorkspacesListByResourceGroupNextResponse = WorkspaceListResult;
-
-/** Optional parameters. */
-export interface OfferingsListOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the list operation. */
-export type OfferingsListResponse = OfferingsListResult;
-
-/** Optional parameters. */
-export interface OfferingsListNextOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the listNext operation. */
-export type OfferingsListNextResponse = OfferingsListResult;
-
-/** Optional parameters. */
-export interface OperationsListOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the list operation. */
-export type OperationsListResponse = OperationsList;
-
-/** Optional parameters. */
-export interface OperationsListNextOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the listNext operation. */
-export type OperationsListNextResponse = OperationsList;
-
-/** Optional parameters. */
-export interface WorkspaceCheckNameAvailabilityOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the checkNameAvailability operation. */
-export type WorkspaceCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
-
-/** Optional parameters. */
-export interface AzureQuantumManagementClientOptionalParams
-  extends coreClient.ServiceClientOptions {
-  /** server parameter */
-  $host?: string;
-  /** Api Version */
-  apiVersion?: string;
-  /** Overrides client endpoint. */
-  endpoint?: string;
-}