Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.
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/containerinstanceManagement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,23 @@ uid: azure-arm-containerinstance
summary: *content

---
# Microsoft Azure SDK for Node.js - ContainerInstanceManagementClient
**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 - ContainerInstanceManagementClient
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-containerinstance
```

## How to use
### How to use

### Authentication, client creation and list containerGroups as an example.
#### Authentication, client creation and list containerGroups 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 @@ -18,13 +18,13 @@
class AzureFileVolume {
/**
* Create a AzureFileVolume.
* @member {string} shareName The name of the Azure File share to be mounted
* as a volume.
* @member {boolean} [readOnly] The flag indicating whether the Azure File
* @property {string} shareName The name of the Azure File share to be
* mounted as a volume.
* @property {boolean} [readOnly] The flag indicating whether the Azure File
* shared mounted as a volume is read-only.
* @member {string} storageAccountName The name of the storage account that
* @property {string} storageAccountName The name of the storage account that
* contains the Azure File share.
* @member {string} [storageAccountKey] The storage account access key used
* @property {string} [storageAccountKey] The storage account access key used
* to access the Azure File share.
*/
constructor() {
Expand Down
134 changes: 68 additions & 66 deletions lib/services/containerinstanceManagement/lib/models/container.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,102 +17,104 @@
class Container {
/**
* Create a Container.
* @member {string} name The user-provided name of the container instance.
* @member {string} image The name of the image used to create the container
* instance.
* @member {array} [command] The commands to execute within the container
* @property {string} name The user-provided name of the container instance.
* @property {string} image The name of the image used to create the
* container instance.
* @property {array} [command] The commands to execute within the container
* instance in exec form.
* @member {array} [ports] The exposed ports on the container instance.
* @member {array} [environmentVariables] The environment variables to set in
* the container instance.
* @member {object} [instanceView] The instance view of the container
* @property {array} [ports] The exposed ports on the container instance.
* @property {array} [environmentVariables] The environment variables to set
* in the container instance.
* @property {object} [instanceView] The instance view of the container
* instance. Only valid in response.
* @member {number} [instanceView.restartCount] The number of times that the
* container instance has been restarted.
* @member {object} [instanceView.currentState] Current container instance
* @property {number} [instanceView.restartCount] The number of times that
* the container instance has been restarted.
* @property {object} [instanceView.currentState] Current container instance
* state.
* @member {string} [instanceView.currentState.state] The state of the
* @property {string} [instanceView.currentState.state] The state of the
* container instance.
* @member {date} [instanceView.currentState.startTime] The date-time when
* @property {date} [instanceView.currentState.startTime] The date-time when
* the container instance state started.
* @member {number} [instanceView.currentState.exitCode] The container
* @property {number} [instanceView.currentState.exitCode] The container
* instance exit codes correspond to those from the `docker run` command.
* @member {date} [instanceView.currentState.finishTime] The date-time when
* @property {date} [instanceView.currentState.finishTime] The date-time when
* the container instance state finished.
* @member {string} [instanceView.currentState.detailStatus] The
* @property {string} [instanceView.currentState.detailStatus] The
* human-readable status of the container instance state.
* @member {object} [instanceView.previousState] Previous container instance
* state.
* @member {string} [instanceView.previousState.state] The state of the
* @property {object} [instanceView.previousState] Previous container
* instance state.
* @property {string} [instanceView.previousState.state] The state of the
* container instance.
* @member {date} [instanceView.previousState.startTime] The date-time when
* @property {date} [instanceView.previousState.startTime] The date-time when
* the container instance state started.
* @member {number} [instanceView.previousState.exitCode] The container
* @property {number} [instanceView.previousState.exitCode] The container
* instance exit codes correspond to those from the `docker run` command.
* @member {date} [instanceView.previousState.finishTime] The date-time when
* the container instance state finished.
* @member {string} [instanceView.previousState.detailStatus] The
* @property {date} [instanceView.previousState.finishTime] The date-time
* when the container instance state finished.
* @property {string} [instanceView.previousState.detailStatus] The
* human-readable status of the container instance state.
* @member {array} [instanceView.events] The events of the container
* @property {array} [instanceView.events] The events of the container
* instance.
* @member {object} resources The resource requirements of the container
* @property {object} resources The resource requirements of the container
* instance.
* @member {object} [resources.requests] The resource requests of this
* @property {object} [resources.requests] The resource requests of this
* container instance.
* @member {number} [resources.requests.memoryInGB] The memory request in GB
* of this container instance.
* @member {number} [resources.requests.cpu] The CPU request of this
* @property {number} [resources.requests.memoryInGB] The memory request in
* GB of this container instance.
* @property {number} [resources.requests.cpu] The CPU request of this
* container instance.
* @member {object} [resources.requests.gpu] The GPU request of this
* @property {object} [resources.requests.gpu] The GPU request of this
* container instance.
* @member {number} [resources.requests.gpu.count] The count of the GPU
* @property {number} [resources.requests.gpu.count] The count of the GPU
* resource.
* @member {string} [resources.requests.gpu.sku] The SKU of the GPU resource.
* Possible values include: 'K80', 'P100', 'V100'
* @member {object} [resources.limits] The resource limits of this container
* instance.
* @member {number} [resources.limits.memoryInGB] The memory limit in GB of
* @property {string} [resources.requests.gpu.sku] The SKU of the GPU
* resource. Possible values include: 'K80', 'P100', 'V100'
* @property {object} [resources.limits] The resource limits of this
* container instance.
* @property {number} [resources.limits.memoryInGB] The memory limit in GB of
* this container instance.
* @member {number} [resources.limits.cpu] The CPU limit of this container
* @property {number} [resources.limits.cpu] The CPU limit of this container
* instance.
* @member {object} [resources.limits.gpu] The GPU limit of this container
* @property {object} [resources.limits.gpu] The GPU limit of this container
* instance.
* @member {number} [resources.limits.gpu.count] The count of the GPU
* @property {number} [resources.limits.gpu.count] The count of the GPU
* resource.
* @member {string} [resources.limits.gpu.sku] The SKU of the GPU resource.
* @property {string} [resources.limits.gpu.sku] The SKU of the GPU resource.
* Possible values include: 'K80', 'P100', 'V100'
* @member {array} [volumeMounts] The volume mounts available to the
* @property {array} [volumeMounts] The volume mounts available to the
* container instance.
* @member {object} [livenessProbe] The liveness probe.
* @member {object} [livenessProbe.exec] The execution command to probe
* @member {array} [livenessProbe.exec.command] The commands to execute
* @property {object} [livenessProbe] The liveness probe.
* @property {object} [livenessProbe.exec] The execution command to probe
* @property {array} [livenessProbe.exec.command] The commands to execute
* within the container.
* @member {object} [livenessProbe.httpGet] The Http Get settings to probe
* @member {string} [livenessProbe.httpGet.path] The path to probe.
* @member {number} [livenessProbe.httpGet.port] The port number to probe.
* @member {string} [livenessProbe.httpGet.scheme] The scheme. Possible
* @property {object} [livenessProbe.httpGet] The Http Get settings to probe
* @property {string} [livenessProbe.httpGet.path] The path to probe.
* @property {number} [livenessProbe.httpGet.port] The port number to probe.
* @property {string} [livenessProbe.httpGet.scheme] The scheme. Possible
* values include: 'http', 'https'
* @member {number} [livenessProbe.initialDelaySeconds] The initial delay
* @property {number} [livenessProbe.initialDelaySeconds] The initial delay
* seconds.
* @member {number} [livenessProbe.periodSeconds] The period seconds.
* @member {number} [livenessProbe.failureThreshold] The failure threshold.
* @member {number} [livenessProbe.successThreshold] The success threshold.
* @member {number} [livenessProbe.timeoutSeconds] The timeout seconds.
* @member {object} [readinessProbe] The readiness probe.
* @member {object} [readinessProbe.exec] The execution command to probe
* @member {array} [readinessProbe.exec.command] The commands to execute
* @property {number} [livenessProbe.periodSeconds] The period seconds.
* @property {number} [livenessProbe.failureThreshold] The failure threshold.
* @property {number} [livenessProbe.successThreshold] The success threshold.
* @property {number} [livenessProbe.timeoutSeconds] The timeout seconds.
* @property {object} [readinessProbe] The readiness probe.
* @property {object} [readinessProbe.exec] The execution command to probe
* @property {array} [readinessProbe.exec.command] The commands to execute
* within the container.
* @member {object} [readinessProbe.httpGet] The Http Get settings to probe
* @member {string} [readinessProbe.httpGet.path] The path to probe.
* @member {number} [readinessProbe.httpGet.port] The port number to probe.
* @member {string} [readinessProbe.httpGet.scheme] The scheme. Possible
* @property {object} [readinessProbe.httpGet] The Http Get settings to probe
* @property {string} [readinessProbe.httpGet.path] The path to probe.
* @property {number} [readinessProbe.httpGet.port] The port number to probe.
* @property {string} [readinessProbe.httpGet.scheme] The scheme. Possible
* values include: 'http', 'https'
* @member {number} [readinessProbe.initialDelaySeconds] The initial delay
* @property {number} [readinessProbe.initialDelaySeconds] The initial delay
* seconds.
* @member {number} [readinessProbe.periodSeconds] The period seconds.
* @member {number} [readinessProbe.failureThreshold] The failure threshold.
* @member {number} [readinessProbe.successThreshold] The success threshold.
* @member {number} [readinessProbe.timeoutSeconds] The timeout seconds.
* @property {number} [readinessProbe.periodSeconds] The period seconds.
* @property {number} [readinessProbe.failureThreshold] The failure
* threshold.
* @property {number} [readinessProbe.successThreshold] The success
* threshold.
* @property {number} [readinessProbe.timeoutSeconds] The timeout seconds.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class ContainerExec {
/**
* Create a ContainerExec.
* @member {array} [command] The commands to execute within the container.
* @property {array} [command] The commands to execute within the container.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
class ContainerExecRequest {
/**
* Create a ContainerExecRequest.
* @member {string} [command] The command to be executed.
* @member {object} [terminalSize] The size of the terminal.
* @member {number} [terminalSize.rows] The row size of the terminal
* @member {number} [terminalSize.cols] The column size of the terminal
* @property {string} [command] The command to be executed.
* @property {object} [terminalSize] The size of the terminal.
* @property {number} [terminalSize.rows] The row size of the terminal
* @property {number} [terminalSize.cols] The column size of the terminal
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class ContainerExecRequestTerminalSize {
/**
* Create a ContainerExecRequestTerminalSize.
* @member {number} [rows] The row size of the terminal
* @member {number} [cols] The column size of the terminal
* @property {number} [rows] The row size of the terminal
* @property {number} [cols] The column size of the terminal
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class ContainerExecResponse {
/**
* Create a ContainerExecResponse.
* @member {string} [webSocketUri] The uri for the exec websocket.
* @member {string} [password] The password to start the exec command.
* @property {string} [webSocketUri] The uri for the exec websocket.
* @property {string} [password] The password to start the exec command.
*/
constructor() {
}
Expand Down
Loading