[AutoPR batchai/resource-manager] BatchAI. Remove API for list clusters and fileservers

lib/services/batchaiManagement/lib/batchAIManagementClient.d.ts

@@ -58,11 +58,11 @@ export default class BatchAIManagementClient extends AzureServiceClient {
   // Operation groups
   operations: operations.Operations;
   usages: operations.Usages;
-  clusters: operations.Clusters;
-  fileServers: operations.FileServers;
   workspaces: operations.Workspaces;
   experiments: operations.Experiments;
   jobs: operations.Jobs;
+  fileServers: operations.FileServers;
+  clusters: operations.Clusters;
 }
 
 export { BatchAIManagementClient, models as BatchAIManagementModels };

lib/services/batchaiManagement/lib/batchAIManagementClient.js

@@ -74,11 +74,11 @@ class BatchAIManagementClient extends ServiceClient {
     }
     this.operations = new operations.Operations(this);
     this.usages = new operations.Usages(this);
-    this.clusters = new operations.Clusters(this);
-    this.fileServers = new operations.FileServers(this);
     this.workspaces = new operations.Workspaces(this);
     this.experiments = new operations.Experiments(this);
     this.jobs = new operations.Jobs(this);
+    this.fileServers = new operations.FileServers(this);
+    this.clusters = new operations.Clusters(this);
     this.models = models;
     msRest.addSerializationMixin(this);
   }

lib/services/batchaiManagement/lib/models/appInsightsReference.js

@@ -13,27 +13,27 @@
 const models = require('./index');
 
 /**
- * Specifies Azure Application Insights information for performance counters
- * reporting.
+ * Azure Application Insights information for performance counters reporting.
  *
  */
 class AppInsightsReference {
   /**
    * Create a AppInsightsReference.
-   * @member {object} component Specifies the Azure Application Insights
-   * component resource id.
+   * @member {object} component Component ID. Azure Application Insights
+   * component resource ID.
    * @member {string} [component.id] The ID of the resource
-   * @member {string} [instrumentationKey] Value of the Azure Application
-   * Insights instrumentation key.
-   * @member {object} [instrumentationKeySecretReference] Specifies a KeyVault
-   * Secret containing Azure Application Insights instrumentation key.
-   * Specifies KeyVault Store and Secret which contains Azure Application
-   * Insights instrumentation key. One of instumentationKey or
+   * @member {string} [instrumentationKey] Instrumentation Key. Value of the
+   * Azure Application Insights instrumentation key.
+   * @member {object} [instrumentationKeySecretReference] Instrumentation key
+   * KeyVault Secret reference. KeyVault Store and Secret which contains Azure
+   * Application Insights instrumentation key. One of instrumentationKey or
    * instrumentationKeySecretReference must be specified.
-   * @member {object} [instrumentationKeySecretReference.sourceVault]
+   * @member {object} [instrumentationKeySecretReference.sourceVault] Fully
+   * qualified resource indentifier of the Key Vault.
    * @member {string} [instrumentationKeySecretReference.sourceVault.id] The ID
    * of the resource
-   * @member {string} [instrumentationKeySecretReference.secretUrl]
+   * @member {string} [instrumentationKeySecretReference.secretUrl] The URL
+   * referencing a secret in the Key Vault.
    */
   constructor() {
   }

lib/services/batchaiManagement/lib/models/autoScaleSettings.js

@@ -11,21 +11,23 @@
 'use strict';
 
 /**
- * The system automatically scales the cluster up and down (within
- * minimumNodeCount and maximumNodeCount) based on the pending and running jobs
- * on the cluster.
+ * Auto-scale settings for the cluster. The system automatically scales the
+ * cluster up and down (within minimumNodeCount and maximumNodeCount) based on
+ * the number of queued and running jobs assigned to the cluster.
  *
  */
 class AutoScaleSettings {
   /**
    * Create a AutoScaleSettings.
-   * @member {number} minimumNodeCount Specifies the minimum number of compute
-   * nodes the cluster can have.
-   * @member {number} maximumNodeCount Specifies the maximum number of compute
-   * nodes the cluster can have.
-   * @member {number} [initialNodeCount] Specifies the number of compute nodes
-   * to allocate on cluster creation. Note that this value is used only during
-   * cluster creation.  Default value: 0 .
+   * @member {number} minimumNodeCount Minimum node count. The minimum number
+   * of compute nodes the Batch AI service will try to allocate for the
+   * cluster. Note, the actual number of nodes can be less than the specified
+   * value if the subscription has not enough quota to fulfill the request.
+   * @member {number} maximumNodeCount Maximum node count. The maximum number
+   * of compute nodes the cluster can have.
+   * @member {number} [initialNodeCount] Initial node count. The number of
+   * compute nodes to allocate on cluster creation. Note that this value is
+   * used only during cluster creation. Default: 0. Default value: 0 .
    */
   constructor() {
   }

lib/services/batchaiManagement/lib/models/azureBlobFileSystemReference.js

@@ -13,35 +13,36 @@
 const models = require('./index');
 
 /**
- * Provides required information, for the service to be able to mount Azure
- * Blob Storage container on the cluster nodes.
+ * Azure Blob Storage Container mounting configuration.
  *
  */
 class AzureBlobFileSystemReference {
   /**
    * Create a AzureBlobFileSystemReference.
-   * @member {string} accountName Name of the Azure Blob Storage account.
-   * @member {string} containerName Name of the Azure Blob Storage container to
-   * mount on the cluster.
-   * @member {object} credentials Information of the Azure Blob Storage account
-   * credentials.
-   * @member {string} [credentials.accountKey] One of accountKey or
+   * @member {string} accountName Account name. Name of the Azure storage
+   * account.
+   * @member {string} containerName Container name. Name of the Azure Blob
+   * Storage container to mount on the cluster.
+   * @member {object} credentials Credentials. Information about the Azure
+   * storage credentials.
+   * @member {string} [credentials.accountKey] Storage account key. One of
+   * accountKey or accountKeySecretReference must be specified.
+   * @member {object} [credentials.accountKeySecretReference] Information about
+   * KeyVault secret storing the storage account key. One of accountKey or
    * accountKeySecretReference must be specified.
-   * @member {object} [credentials.accountKeySecretReference] Users can store
-   * their secrets in Azure KeyVault and pass it to the Batch AI Service to
-   * integrate with KeyVault. One of accountKey or accountKeySecretReference
-   * must be specified.
-   * @member {object} [credentials.accountKeySecretReference.sourceVault]
+   * @member {object} [credentials.accountKeySecretReference.sourceVault] Fully
+   * qualified resource indentifier of the Key Vault.
    * @member {string} [credentials.accountKeySecretReference.sourceVault.id]
    * The ID of the resource
-   * @member {string} [credentials.accountKeySecretReference.secretUrl]
-   * @member {string} relativeMountPath Specifies the relative path on the
-   * compute node where the Azure Blob file system will be mounted. Note that
-   * all cluster level blob file systems will be mounted under
-   * $AZ_BATCHAI_MOUNT_ROOT location and all job level blob file systems will
-   * be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
-   * @member {string} [mountOptions] Specifies the various mount options that
-   * can be used to configure Blob file system.
+   * @member {string} [credentials.accountKeySecretReference.secretUrl] The URL
+   * referencing a secret in the Key Vault.
+   * @member {string} relativeMountPath Relative mount path. The relative path
+   * on the compute node where the Azure File container will be mounted. Note
+   * that all cluster level containers will be mounted under
+   * $AZ_BATCHAI_MOUNT_ROOT location and all job level containers will be
+   * mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
+   * @member {string} [mountOptions] Mount options. Mount options for mounting
+   * blobfuse file system.
    */
   constructor() {
   }

lib/services/batchaiManagement/lib/models/azureFileShareReference.js

@@ -13,34 +13,38 @@
 const models = require('./index');
 
 /**
- * Details of the Azure File Share to mount on the cluster.
+ * Azure File Share mounting configuration.
  *
  */
 class AzureFileShareReference {
   /**
    * Create a AzureFileShareReference.
-   * @member {string} accountName Name of the storage account.
-   * @member {string} azureFileUrl URL to access the Azure File.
-   * @member {object} credentials Information of the Azure File credentials.
-   * @member {string} [credentials.accountKey] One of accountKey or
+   * @member {string} accountName Account name. Name of the Azure storage
+   * account.
+   * @member {string} azureFileUrl Azure File URL. URL to access the Azure
+   * File.
+   * @member {object} credentials Credentials. Information about the Azure
+   * storage credentials.
+   * @member {string} [credentials.accountKey] Storage account key. One of
+   * accountKey or accountKeySecretReference must be specified.
+   * @member {object} [credentials.accountKeySecretReference] Information about
+   * KeyVault secret storing the storage account key. One of accountKey or
    * accountKeySecretReference must be specified.
-   * @member {object} [credentials.accountKeySecretReference] Users can store
-   * their secrets in Azure KeyVault and pass it to the Batch AI Service to
-   * integrate with KeyVault. One of accountKey or accountKeySecretReference
-   * must be specified.
-   * @member {object} [credentials.accountKeySecretReference.sourceVault]
+   * @member {object} [credentials.accountKeySecretReference.sourceVault] Fully
+   * qualified resource indentifier of the Key Vault.
    * @member {string} [credentials.accountKeySecretReference.sourceVault.id]
    * The ID of the resource
-   * @member {string} [credentials.accountKeySecretReference.secretUrl]
-   * @member {string} relativeMountPath Specifies the relative path on the
-   * compute node where the Azure file share will be mounted. Note that all
-   * cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT
+   * @member {string} [credentials.accountKeySecretReference.secretUrl] The URL
+   * referencing a secret in the Key Vault.
+   * @member {string} relativeMountPath Relative mount path. The relative path
+   * on the compute node where the Azure File share will be mounted. Note that
+   * all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT
    * location and all job level file shares will be mounted under
    * $AZ_BATCHAI_JOB_MOUNT_ROOT.
-   * @member {string} [fileMode] Specifies the file mode. Default value is
-   * 0777. Valid only if OS is linux. Default value: '0777' .
-   * @member {string} [directoryMode] Specifies the directory Mode. Default
-   * value is 0777. Valid only if OS is linux. Default value: '0777' .
+   * @member {string} [fileMode] File mode. File mode for files on the mounted
+   * file share. Default value: 0777. Default value: '0777' .
+   * @member {string} [directoryMode] Directory mode. File mode for directories
+   * on the mounted file share. Default value: 0777. Default value: '0777' .
    */
   constructor() {
   }

lib/services/batchaiManagement/lib/models/azureStorageCredentialsInfo.js

@@ -13,23 +13,23 @@
 const models = require('./index');
 
 /**
- * Credentials to access Azure File Share.
+ * Azure storage account credentials.
  *
  */
 class AzureStorageCredentialsInfo {
   /**
    * Create a AzureStorageCredentialsInfo.
-   * @member {string} [accountKey] Storage account key. One of accountKey or
-   * accountKeySecretReference must be specified.
-   * @member {object} [accountKeySecretReference] Specifies the location of the
-   * storage account key, which is a Key Vault Secret. Users can store their
-   * secrets in Azure KeyVault and pass it to the Batch AI Service to integrate
-   * with KeyVault. One of accountKey or accountKeySecretReference must be
-   * specified.
-   * @member {object} [accountKeySecretReference.sourceVault]
+   * @member {string} [accountKey] Account key. Storage account key. One of
+   * accountKey or accountKeySecretReference must be specified.
+   * @member {object} [accountKeySecretReference] Account key secret reference.
+   * Information about KeyVault secret storing the storage account key. One of
+   * accountKey or accountKeySecretReference must be specified.
+   * @member {object} [accountKeySecretReference.sourceVault] Fully qualified
+   * resource indentifier of the Key Vault.
    * @member {string} [accountKeySecretReference.sourceVault.id] The ID of the
    * resource
-   * @member {string} [accountKeySecretReference.secretUrl]
+   * @member {string} [accountKeySecretReference.secretUrl] The URL referencing
+   * a secret in the Key Vault.
    */
   constructor() {
   }

lib/services/batchaiManagement/lib/models/batchAIError.js

@@ -19,7 +19,7 @@ const models = require('./index');
 class BatchAIError {
   /**
    * Create a BatchAIError.
-   * @member {string} [code] An identifier for the error. Codes are invariant
+   * @member {string} [code] An identifier of the error. Codes are invariant
    * and are intended to be consumed programmatically.
    * @member {string} [message] A message describing the error, intended to be
    * suitable for display in a user interface.

lib/services/batchaiManagement/lib/models/cNTKsettings.js

@@ -11,27 +11,29 @@
 'use strict';
 
 /**
- * Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.
+ * CNTK (aka Microsoft Cognitive Toolkit) job settings.
  *
  */
 class CNTKsettings {
   /**
    * Create a CNTKsettings.
-   * @member {string} [languageType] Specifies the language type to use for
+   * @member {string} [languageType] Language type. The language to use for
    * launching CNTK (aka Microsoft Cognitive Toolkit) job. Valid values are
    * 'BrainScript' or 'Python'.
-   * @member {string} [configFilePath] Specifies the path of the config file.
-   * This property can be specified only if the languageType is 'BrainScript'.
-   * @member {string} [pythonScriptFilePath] The path and file name of the
-   * python script to execute the job. This property can be specified only if
-   * the languageType is 'Python'.
-   * @member {string} [pythonInterpreterPath] The path to python interpreter.
-   * This property can be specified only if the languageType is 'Python'.
-   * @member {string} [commandLineArgs] Command line arguments that needs to be
-   * passed to the python script or CNTK.exe.
-   * @member {number} [processCount] Number of processes parameter that is
-   * passed to MPI runtime. The default value for this property is equal to
-   * nodeCount property
+   * @member {string} [configFilePath] Config file path. Specifies the path of
+   * the BrainScript config file. This property can be specified only if the
+   * languageType is 'BrainScript'.
+   * @member {string} [pythonScriptFilePath] Python script file path. Python
+   * script to execute. This property can be specified only if the languageType
+   * is 'Python'.
+   * @member {string} [pythonInterpreterPath] Python interpreter path. The path
+   * to the Python interpreter. This property can be specified only if the
+   * languageType is 'Python'.
+   * @member {string} [commandLineArgs] Command line arguments. Command line
+   * arguments that need to be passed to the python script or cntk executable.
+   * @member {number} [processCount] Process count. Number of processes to
+   * launch for the job execution. The default value for this property is equal
+   * to nodeCount property
    */
   constructor() {
   }

lib/services/batchaiManagement/lib/models/caffe2Settings.js

@@ -11,17 +11,18 @@
 'use strict';
 
 /**
- * Specifies the settings for Caffe2 job.
+ * Caffe2 job settings.
  *
  */
 class Caffe2Settings {
   /**
    * Create a Caffe2Settings.
-   * @member {string} pythonScriptFilePath The path and file name of the python
-   * script to execute the job.
-   * @member {string} [pythonInterpreterPath] The path to python interpreter.
-   * @member {string} [commandLineArgs] Command line arguments that needs to be
-   * passed to the python script.
+   * @member {string} pythonScriptFilePath Python script file path. The python
+   * script to execute.
+   * @member {string} [pythonInterpreterPath] Python interpreter path. The path
+   * to the Python interpreter.
+   * @member {string} [commandLineArgs] Command line arguments. Command line
+   * arguments that need to be passed to the python script.
    */
   constructor() {
   }

lib/services/batchaiManagement/lib/models/caffeSettings.js

@@ -11,25 +11,26 @@
 'use strict';
 
 /**
- * Specifies the settings for Caffe job.
+ * Caffe job settings.
  *
  */
 class CaffeSettings {
   /**
    * Create a CaffeSettings.
-   * @member {string} [configFilePath] Specifies the path of the config file.
-   * This property cannot be specified if pythonScriptFilePath is specified.
-   * @member {string} [pythonScriptFilePath] The path and file name of the
-   * python script to execute the job. This property cannot be specified if
-   * configFilePath is specified.
-   * @member {string} [pythonInterpreterPath] The path to python interpreter.
-   * This property can be specified only if the pythonScriptFilePath is
+   * @member {string} [configFilePath] Config file path. Path of the config
+   * file for the job. This property cannot be specified if
+   * pythonScriptFilePath is specified.
+   * @member {string} [pythonScriptFilePath] Python script file path. Python
+   * script to execute. This property cannot be specified if configFilePath is
    * specified.
-   * @member {string} [commandLineArgs] Command line arguments that needs to be
-   * passed to the Caffe job.
-   * @member {number} [processCount] Number of processes parameter that is
-   * passed to MPI runtime. The default value for this property is equal to
-   * nodeCount property
+   * @member {string} [pythonInterpreterPath] Python interpreter path. The path
+   * to the Python interpreter. The property can be specified only if the
+   * pythonScriptFilePath is specified.
+   * @member {string} [commandLineArgs] Command line arguments. Command line
+   * arguments that need to be passed to the Caffe job.
+   * @member {number} [processCount] Process count. Number of processes to
+   * launch for the job execution. The default value for this property is equal
+   * to nodeCount property
    */
   constructor() {
   }

lib/services/batchaiManagement/lib/models/chainerSettings.js

@@ -11,20 +11,21 @@
 'use strict';
 
 /**
- * Specifies the settings for Chainer job.
+ * Chainer job settings.
  *
  */
 class ChainerSettings {
   /**
    * Create a ChainerSettings.
-   * @member {string} pythonScriptFilePath The path and file name of the python
-   * script to execute the job.
-   * @member {string} [pythonInterpreterPath] The path to python interpreter.
-   * @member {string} [commandLineArgs] Command line arguments that needs to be
-   * passed to the python script.
-   * @member {number} [processCount] Number of processes parameter that is
-   * passed to MPI runtime. The default value for this property is equal to
-   * nodeCount property
+   * @member {string} pythonScriptFilePath Python script file path. The python
+   * script to execute.
+   * @member {string} [pythonInterpreterPath] Python interpreter path. The path
+   * to the Python interpreter.
+   * @member {string} [commandLineArgs] Command line arguments. Command line
+   * arguments that need to be passed to the python script.
+   * @member {number} [processCount] Process count. Number of processes to
+   * launch for the job execution. The default value for this property is equal
+   * to nodeCount property
    */
   constructor() {
   }