@azure/arm-workspaces 0.2.0 → 1.0.0

package/src/models/index.ts

@@ -1,446 +1,237 @@
 /*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for
- * license information.
+ * 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.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
-import * as msRest from "@azure/ms-rest-js";
+import * as coreClient from "@azure/core-client";
 
-export { BaseResource, CloudError };
+/** An array of operations supported by the resource provider. */
+export interface OperationListResult {
+  /** List of AML Studio operations supported by the AML Studio resource provider. */
+  value?: Operation[];
+}
 
+/** Azure Machine Learning Studio REST API operation */
+export interface Operation {
+  /** Operation name: {provider}/{resource}/{operation} */
+  name?: string;
+  /** Display name of operation */
+  display?: OperationDisplay;
+}
 
-/**
- * @interface
- * An interface representing ErrorResponse.
- * The error response send when an operation fails.
- *
- */
+/** Display name of operation */
+export interface OperationDisplay {
+  /** The resource provider name: Microsoft.MachineLearning */
+  provider?: string;
+  /** The resource on which the operation is performed. */
+  resource?: string;
+  /** The operation that users can perform. */
+  operation?: string;
+  /** The description for the operation. */
+  description?: string;
+}
+
+/** The error response send when an operation fails. */
 export interface ErrorResponse {
-  /**
-   * @member {string} code error code
-   */
+  /** error code */
   code: string;
-  /**
-   * @member {string} message error message
-   */
+  /** error message */
   message: string;
 }
 
-/**
- * @interface
- * An interface representing Resource.
- * An Azure resource.
- *
- * @extends BaseResource
- */
-export interface Resource extends BaseResource {
+/** An Azure resource. */
+export interface Resource {
   /**
-   * @member {string} [id] The resource ID.
-   * **NOTE: This property will not be serialized. It can only be populated by
-   * the server.**
+   * The resource ID.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly id?: string;
   /**
-   * @member {string} [name] The name of the resource.
-   * **NOTE: This property will not be serialized. It can only be populated by
-   * the server.**
+   * The name of the resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly name?: string;
   /**
-   * @member {string} [type] The type of the resource.
-   * **NOTE: This property will not be serialized. It can only be populated by
-   * the server.**
+   * The type of the resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly type?: string;
-  /**
-   * @member {string} location The location of the resource. This cannot be
-   * changed after the resource is created.
-   */
+  /** The location of the resource. This cannot be changed after the resource is created. */
   location: string;
-  /**
-   * @member {{ [propertyName: string]: string }} [tags] The tags of the
-   * resource.
-   */
+  /** The tags of the resource. */
   tags?: { [propertyName: string]: string };
+  /** The sku of the workspace. */
+  sku?: Sku;
 }
 
-/**
- * @interface
- * An interface representing Workspace.
- * An object that represents a machine learning workspace.
- *
- * @extends Resource
- */
-export interface Workspace extends Resource {
-  /**
-   * @member {string} userStorageAccountId The fully qualified arm id of the
-   * storage account associated with this workspace.
-   */
-  userStorageAccountId: string;
-  /**
-   * @member {string} [ownerEmail] The email id of the owner for this
-   * workspace.
-   */
-  ownerEmail?: string;
-  /**
-   * @member {WorkspaceType} [workspaceType] The type of this workspace.
-   * Possible values include: 'Production', 'Free', 'Anonymous',
-   * 'PaidStandard', 'PaidPremium'
-   * **NOTE: This property will not be serialized. It can only be populated by
-   * the server.**
-   */
-  readonly workspaceType?: WorkspaceType;
-  /**
-   * @member {WorkspaceState} [workspaceState] The current state of workspace
-   * resource. Possible values include: 'Deleted', 'Enabled', 'Disabled',
-   * 'Migrated', 'Updated', 'Registered', 'Unregistered'
-   * **NOTE: This property will not be serialized. It can only be populated by
-   * the server.**
-   */
-  readonly workspaceState?: WorkspaceState;
-  /**
-   * @member {string} [workspaceId] The immutable id associated with this
-   * workspace.
-   * **NOTE: This property will not be serialized. It can only be populated by
-   * the server.**
-   */
-  readonly workspaceId?: string;
-  /**
-   * @member {string} [creationTime] The creation time for this workspace
-   * resource.
-   * **NOTE: This property will not be serialized. It can only be populated by
-   * the server.**
-   */
-  readonly creationTime?: string;
-  /**
-   * @member {string} [studioEndpoint] The regional endpoint for the machine
-   * learning studio service which hosts this workspace.
-   * **NOTE: This property will not be serialized. It can only be populated by
-   * the server.**
-   */
-  readonly studioEndpoint?: string;
-  /**
-   * @member {string} [keyVaultIdentifierId] The key vault identifier used for
-   * encrypted workspaces.
-   */
-  keyVaultIdentifierId?: string;
+/** Sku of the resource */
+export interface Sku {
+  /** Name of the sku */
+  name?: string;
+  /** Tier of the sku like Basic or Enterprise */
+  tier?: string;
 }
 
-/**
- * @interface
- * An interface representing WorkspaceUpdateParameters.
- * The parameters for updating a machine learning workspace.
- *
- */
+/** The parameters for updating a machine learning workspace. */
 export interface WorkspaceUpdateParameters {
-  /**
-   * @member {{ [propertyName: string]: string }} [tags] The resource tags for
-   * the machine learning workspace.
-   */
+  /** The resource tags for the machine learning workspace. */
   tags?: { [propertyName: string]: string };
-  /**
-   * @member {WorkspaceState} [workspaceState] The current state of workspace
-   * resource. Possible values include: 'Deleted', 'Enabled', 'Disabled',
-   * 'Migrated', 'Updated', 'Registered', 'Unregistered'
-   */
+  /** The current state of workspace resource. */
   workspaceState?: WorkspaceState;
-  /**
-   * @member {string} [keyVaultIdentifierId] The key vault identifier used for
-   * encrypted workspaces.
-   */
+  /** The key vault identifier used for encrypted workspaces. */
   keyVaultIdentifierId?: string;
+  /** The sku of the workspace. */
+  sku?: Sku;
 }
 
-/**
- * @interface
- * An interface representing WorkspaceKeysResponse.
- * Workspace authorization keys for a workspace.
- *
- */
+/** Workspace authorization keys for a workspace. */
 export interface WorkspaceKeysResponse {
-  /**
-   * @member {string} [primaryToken] Primary authorization key for this
-   * workspace.
-   */
+  /** Primary authorization key for this workspace. */
   primaryToken?: string;
-  /**
-   * @member {string} [secondaryToken] Secondary authorization key for this
-   * workspace.
-   */
+  /** Secondary authorization key for this workspace. */
   secondaryToken?: string;
 }
 
-/**
- * @interface
- * An interface representing OperationDisplay.
- * Display name of operation
- *
- */
-export interface OperationDisplay {
-  /**
-   * @member {string} [provider] The resource provider name:
-   * Microsoft.MachineLearning
-   */
-  provider?: string;
-  /**
-   * @member {string} [resource] The resource on which the operation is
-   * performed.
-   */
-  resource?: string;
-  /**
-   * @member {string} [operation] The operation that users can perform.
-   */
-  operation?: string;
-  /**
-   * @member {string} [description] The description for the operation.
-   */
-  description?: string;
-}
-
-/**
- * @interface
- * An interface representing Operation.
- * Azure Machine Learning Studio REST API operation
- *
- */
-export interface Operation {
-  /**
-   * @member {string} [name] Operation name: {provider}/{resource}/{operation}
-   */
-  name?: string;
-  /**
-   * @member {OperationDisplay} [display] Display name of operation
-   */
-  display?: OperationDisplay;
-}
-
-/**
- * @interface
- * An interface representing MachineLearningWorkspacesManagementClientOptions.
- * @extends AzureServiceClientOptions
- */
-export interface MachineLearningWorkspacesManagementClientOptions extends AzureServiceClientOptions {
-  /**
-   * @member {string} [baseUri]
-   */
-  baseUri?: string;
-}
-
-
-/**
- * @interface
- * An interface representing the OperationListResult.
- * An array of operations supported by the resource provider.
- *
- * @extends Array<Operation>
- */
-export interface OperationListResult extends Array<Operation> {
-}
-
-/**
- * @interface
- * An interface representing the WorkspaceListResult.
- * The result of a request to list machine learning workspace keys.
- *
- * @extends Array<Workspace>
- */
-export interface WorkspaceListResult extends Array<Workspace> {
-  /**
-   * @member {string} [nextLink] The URI that can be used to request the next
-   * list of machine learning workspaces.
-   */
+/** The result of a request to list machine learning workspace keys. */
+export interface WorkspaceListResult {
+  /** The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces. */
+  value?: Workspace[];
+  /** The URI that can be used to request the next list of machine learning workspaces. */
   nextLink?: string;
 }
 
-/**
- * Defines values for WorkspaceType.
- * Possible values include: 'Production', 'Free', 'Anonymous', 'PaidStandard', 'PaidPremium'
- * @readonly
- * @enum {string}
- */
-export type WorkspaceType = 'Production' | 'Free' | 'Anonymous' | 'PaidStandard' | 'PaidPremium';
-
-/**
- * Defines values for WorkspaceState.
- * Possible values include: 'Deleted', 'Enabled', 'Disabled', 'Migrated', 'Updated', 'Registered',
- * 'Unregistered'
- * @readonly
- * @enum {string}
- */
-export type WorkspaceState = 'Deleted' | 'Enabled' | 'Disabled' | 'Migrated' | 'Updated' | 'Registered' | 'Unregistered';
-
-/**
- * Contains response data for the list operation.
- */
-export type OperationsListResponse = OperationListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: OperationListResult;
-    };
-};
-
-/**
- * Contains response data for the get operation.
- */
-export type WorkspacesGetResponse = Workspace & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: Workspace;
-    };
-};
-
-/**
- * Contains response data for the createOrUpdate operation.
- */
-export type WorkspacesCreateOrUpdateResponse = Workspace & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: Workspace;
-    };
-};
-
-/**
- * Contains response data for the update operation.
- */
-export type WorkspacesUpdateResponse = Workspace & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: Workspace;
-    };
-};
-
-/**
- * Contains response data for the listWorkspaceKeys operation.
- */
-export type WorkspacesListWorkspaceKeysResponse = WorkspaceKeysResponse & {
+/** An object that represents a machine learning workspace. */
+export type Workspace = Resource & {
+  /** The fully qualified arm id of the storage account associated with this workspace. */
+  userStorageAccountId?: string;
+  /** The email id of the owner for this workspace. */
+  ownerEmail?: string;
   /**
-   * The underlying HTTP response.
+   * The type of this workspace.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: WorkspaceKeysResponse;
-    };
-};
-
-/**
- * Contains response data for the listByResourceGroup operation.
- */
-export type WorkspacesListByResourceGroupResponse = WorkspaceListResult & {
+  readonly workspaceType?: WorkspaceType;
   /**
-   * The underlying HTTP response.
+   * The current state of workspace resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: WorkspaceListResult;
-    };
-};
-
-/**
- * Contains response data for the list operation.
- */
-export type WorkspacesListResponse = WorkspaceListResult & {
+  readonly workspaceState?: WorkspaceState;
   /**
-   * The underlying HTTP response.
+   * The immutable id associated with this workspace.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: WorkspaceListResult;
-    };
-};
-
-/**
- * Contains response data for the listByResourceGroupNext operation.
- */
-export type WorkspacesListByResourceGroupNextResponse = WorkspaceListResult & {
+  readonly workspaceId?: string;
   /**
-   * The underlying HTTP response.
+   * The creation time for this workspace resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: WorkspaceListResult;
-    };
-};
-
-/**
- * Contains response data for the listNext operation.
- */
-export type WorkspacesListNextResponse = WorkspaceListResult & {
+  readonly creationTime?: string;
   /**
-   * The underlying HTTP response.
+   * The regional endpoint for the machine learning studio service which hosts this workspace.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: WorkspaceListResult;
-    };
+  readonly studioEndpoint?: string;
+  /** The key vault identifier used for encrypted workspaces. */
+  keyVaultIdentifierId?: string;
 };
+/** Defines values for WorkspaceType. */
+export type WorkspaceType =
+  | "Production"
+  | "Free"
+  | "Anonymous"
+  | "PaidStandard"
+  | "PaidPremium";
+/** Defines values for WorkspaceState. */
+export type WorkspaceState =
+  | "Deleted"
+  | "Enabled"
+  | "Disabled"
+  | "Migrated"
+  | "Updated"
+  | "Registered"
+  | "Unregistered";
+
+/** Optional parameters. */
+export interface OperationsListOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the list operation. */
+export type OperationsListResponse = OperationListResult;
+
+/** Optional parameters. */
+export interface WorkspacesGetOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the get operation. */
+export type WorkspacesGetResponse = Workspace;
+
+/** Optional parameters. */
+export interface WorkspacesCreateOrUpdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrUpdate operation. */
+export type WorkspacesCreateOrUpdateResponse = Workspace;
+
+/** Optional parameters. */
+export interface WorkspacesDeleteOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface WorkspacesUpdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the update operation. */
+export type WorkspacesUpdateResponse = Workspace;
+
+/** Optional parameters. */
+export interface WorkspacesResyncStorageKeysOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface WorkspacesListWorkspaceKeysOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listWorkspaceKeys operation. */
+export type WorkspacesListWorkspaceKeysResponse = WorkspaceKeysResponse;
+
+/** Optional parameters. */
+export interface WorkspacesListByResourceGroupOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listByResourceGroup operation. */
+export type WorkspacesListByResourceGroupResponse = WorkspaceListResult;
+
+/** Optional parameters. */
+export interface WorkspacesListOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the list operation. */
+export type WorkspacesListResponse = WorkspaceListResult;
+
+/** Optional parameters. */
+export interface WorkspacesListByResourceGroupNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export type WorkspacesListByResourceGroupNextResponse = WorkspaceListResult;
+
+/** Optional parameters. */
+export interface WorkspacesListNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNext operation. */
+export type WorkspacesListNextResponse = WorkspaceListResult;
+
+/** Optional parameters. */
+export interface MachineLearningWorkspacesManagementClientOptionalParams
+  extends coreClient.ServiceClientOptions {
+  /** server parameter */
+  $host?: string;
+  /** Api Version */
+  apiVersion?: string;
+  /** Overrides client endpoint. */
+  endpoint?: string;
+}