Skip to content
This repository has been archived by the owner on May 5, 2023. It is now read-only.

[AutoPR batchai/resource-manager] typo: batchai/resource-manager/Microsoft.BatchAI/BatchAI #4172

Merged
merged 1 commit into from
Nov 24, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions lib/services/batchaiManagement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,23 @@ uid: azure-arm-batchai
summary: *content

---
# Microsoft Azure SDK for Node.js - BatchAIManagementClient
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - BatchAIManagementClient
This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

## Features
### Features


## How to Install
### How to Install

```bash
npm install azure-arm-batchai
```

## How to use
### How to use

### Authentication, client creation and list operations as an example.
#### Authentication, client creation and list operations as an example.

```javascript
const msRestAzure = require("ms-rest-azure");
Expand All @@ -35,6 +36,6 @@ msRestAzure.interactiveLogin().then((creds) => {
console.dir(err, {depth: null, colors: true});
});

## Related projects
### Related projects

- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@
class AppInsightsReference {
/**
* Create a AppInsightsReference.
* @member {object} component Component ID. Azure Application Insights
* @property {object} component Component ID. Azure Application Insights
* component resource ID.
* @member {string} [component.id] The ID of the resource
* @member {string} [instrumentationKey] Instrumentation Key. Value of the
* @property {string} [component.id] The ID of the resource
* @property {string} [instrumentationKey] Instrumentation Key. Value of the
* Azure Application Insights instrumentation key.
* @member {object} [instrumentationKeySecretReference] Instrumentation key
* @property {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] Fully
* qualified resource indentifier of the Key Vault.
* @member {string} [instrumentationKeySecretReference.sourceVault.id] The ID
* of the resource
* @member {string} [instrumentationKeySecretReference.secretUrl] The URL
* @property {object} [instrumentationKeySecretReference.sourceVault] Fully
* qualified resource identifier of the Key Vault.
* @property {string} [instrumentationKeySecretReference.sourceVault.id] The
* ID of the resource
* @property {string} [instrumentationKeySecretReference.secretUrl] The URL
* referencing a secret in the Key Vault.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@
class AutoScaleSettings {
/**
* Create a AutoScaleSettings.
* @member {number} minimumNodeCount Minimum node count. The minimum number
* @property {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
* @property {number} maximumNodeCount Maximum node count. The maximum number
* of compute nodes the cluster can have.
* @member {number} [initialNodeCount] Initial node count. The number of
* @property {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 .
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,30 @@
class AzureBlobFileSystemReference {
/**
* Create a AzureBlobFileSystemReference.
* @member {string} accountName Account name. Name of the Azure storage
* @property {string} accountName Account name. Name of the Azure storage
* account.
* @member {string} containerName Container name. Name of the Azure Blob
* @property {string} containerName Container name. Name of the Azure Blob
* Storage container to mount on the cluster.
* @member {object} credentials Credentials. Information about the Azure
* @property {object} credentials Credentials. Information about the Azure
* storage credentials.
* @member {string} [credentials.accountKey] Storage account key. One of
* @property {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.sourceVault] Fully
* qualified resource indentifier of the Key Vault.
* @member {string} [credentials.accountKeySecretReference.sourceVault.id]
* @property {object} [credentials.accountKeySecretReference] Information
* about KeyVault secret storing the storage account key. One of accountKey
* or accountKeySecretReference must be specified.
* @property {object} [credentials.accountKeySecretReference.sourceVault]
* Fully qualified resource identifier of the Key Vault.
* @property {string} [credentials.accountKeySecretReference.sourceVault.id]
* The ID of the resource
* @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
* @property {string} [credentials.accountKeySecretReference.secretUrl] The
* URL referencing a secret in the Key Vault.
* @property {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.
* @property {string} [mountOptions] Mount options. Mount options for
* mounting blobfuse file system.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,33 @@
class AzureFileShareReference {
/**
* Create a AzureFileShareReference.
* @member {string} accountName Account name. Name of the Azure storage
* @property {string} accountName Account name. Name of the Azure storage
* account.
* @member {string} azureFileUrl Azure File URL. URL to access the Azure
* @property {string} azureFileUrl Azure File URL. URL to access the Azure
* File.
* @member {object} credentials Credentials. Information about the Azure
* @property {object} credentials Credentials. Information about the Azure
* storage credentials.
* @member {string} [credentials.accountKey] Storage account key. One of
* @property {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.sourceVault] Fully
* qualified resource indentifier of the Key Vault.
* @member {string} [credentials.accountKeySecretReference.sourceVault.id]
* @property {object} [credentials.accountKeySecretReference] Information
* about KeyVault secret storing the storage account key. One of accountKey
* or accountKeySecretReference must be specified.
* @property {object} [credentials.accountKeySecretReference.sourceVault]
* Fully qualified resource identifier of the Key Vault.
* @property {string} [credentials.accountKeySecretReference.sourceVault.id]
* The ID of the resource
* @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] 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' .
* @property {string} [credentials.accountKeySecretReference.secretUrl] The
* URL referencing a secret in the Key Vault.
* @property {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.
* @property {string} [fileMode] File mode. File mode for files on the
* mounted file share. Default value: 0777. Default value: '0777' .
* @property {string} [directoryMode] Directory mode. File mode for
* directories on the mounted file share. Default value: 0777. Default value:
* '0777' .
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@
class AzureStorageCredentialsInfo {
/**
* Create a AzureStorageCredentialsInfo.
* @member {string} [accountKey] Account key. Storage account key. One of
* @property {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] The URL referencing
* a secret in the Key Vault.
* @property {object} [accountKeySecretReference] Account key secret
* reference. Information about KeyVault secret storing the storage account
* key. One of accountKey or accountKeySecretReference must be specified.
* @property {object} [accountKeySecretReference.sourceVault] Fully qualified
* resource identifier of the Key Vault.
* @property {string} [accountKeySecretReference.sourceVault.id] The ID of
* the resource
* @property {string} [accountKeySecretReference.secretUrl] The URL
* referencing a secret in the Key Vault.
*/
constructor() {
}
Expand Down
8 changes: 4 additions & 4 deletions lib/services/batchaiManagement/lib/models/batchAIError.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
class BatchAIError {
/**
* Create a BatchAIError.
* @member {string} [code] An identifier of the error. Codes are invariant
* @property {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.
* @member {array} [details] A list of additional details about the error.
* @property {string} [message] A message describing the error, intended to
* be suitable for display in a user interface.
* @property {array} [details] A list of additional details about the error.
*/
constructor() {
}
Expand Down
16 changes: 8 additions & 8 deletions lib/services/batchaiManagement/lib/models/cNTKsettings.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@
class CNTKsettings {
/**
* Create a CNTKsettings.
* @member {string} [languageType] Language type. The language to use for
* @property {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] Config file path. Specifies the path of
* the BrainScript config file. This property can be specified only if the
* @property {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
* @property {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
* @property {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
* @property {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
* @property {number} [processCount] Process count. Number of processes to
* launch for the job execution. The default value for this property is equal
* to nodeCount property
*/
Expand Down
10 changes: 5 additions & 5 deletions lib/services/batchaiManagement/lib/models/caffe2Settings.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
class Caffe2Settings {
/**
* Create a Caffe2Settings.
* @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
* @property {string} pythonScriptFilePath Python script file path. The
* python script to execute.
* @property {string} [pythonInterpreterPath] Python interpreter path. The
* path to the Python interpreter.
* @property {string} [commandLineArgs] Command line arguments. Command line
* arguments that need to be passed to the python script.
*/
constructor() {
Expand Down
12 changes: 6 additions & 6 deletions lib/services/batchaiManagement/lib/models/caffeSettings.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@
class CaffeSettings {
/**
* Create a CaffeSettings.
* @member {string} [configFilePath] Config file path. Path of the config
* @property {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
* @property {string} [pythonScriptFilePath] Python script file path. Python
* script to execute. This property cannot be specified if configFilePath is
* specified.
* @member {string} [pythonInterpreterPath] Python interpreter path. The path
* to the Python interpreter. The property can be specified only if the
* @property {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
* @property {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
* @property {number} [processCount] Process count. Number of processes to
* launch for the job execution. The default value for this property is equal
* to nodeCount property
*/
Expand Down
12 changes: 6 additions & 6 deletions lib/services/batchaiManagement/lib/models/chainerSettings.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
class ChainerSettings {
/**
* Create a ChainerSettings.
* @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
* @property {string} pythonScriptFilePath Python script file path. The
* python script to execute.
* @property {string} [pythonInterpreterPath] Python interpreter path. The
* path to the Python interpreter.
* @property {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
* @property {number} [processCount] Process count. Number of processes to
* launch for the job execution. The default value for this property is equal
* to nodeCount property
*/
Expand Down
Loading