diff --git a/lib/services/containerinstanceManagement/README.md b/lib/services/containerinstanceManagement/README.md index 62ef791bc7..a4a65aa24a 100644 --- a/lib/services/containerinstanceManagement/README.md +++ b/lib/services/containerinstanceManagement/README.md @@ -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"); @@ -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) diff --git a/lib/services/containerinstanceManagement/lib/models/azureFileVolume.js b/lib/services/containerinstanceManagement/lib/models/azureFileVolume.js index d80dbd8404..1d3dcb2162 100644 --- a/lib/services/containerinstanceManagement/lib/models/azureFileVolume.js +++ b/lib/services/containerinstanceManagement/lib/models/azureFileVolume.js @@ -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() { diff --git a/lib/services/containerinstanceManagement/lib/models/container.js b/lib/services/containerinstanceManagement/lib/models/container.js index a618edb2d8..b65b053820 100644 --- a/lib/services/containerinstanceManagement/lib/models/container.js +++ b/lib/services/containerinstanceManagement/lib/models/container.js @@ -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() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerExec.js b/lib/services/containerinstanceManagement/lib/models/containerExec.js index dbc3a1b3fa..c945813d22 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerExec.js +++ b/lib/services/containerinstanceManagement/lib/models/containerExec.js @@ -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() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerExecRequest.js b/lib/services/containerinstanceManagement/lib/models/containerExecRequest.js index 650bbcea1b..8be7252033 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerExecRequest.js +++ b/lib/services/containerinstanceManagement/lib/models/containerExecRequest.js @@ -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() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerExecRequestTerminalSize.js b/lib/services/containerinstanceManagement/lib/models/containerExecRequestTerminalSize.js index 3e0750867e..707cbf424a 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerExecRequestTerminalSize.js +++ b/lib/services/containerinstanceManagement/lib/models/containerExecRequestTerminalSize.js @@ -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() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerExecResponse.js b/lib/services/containerinstanceManagement/lib/models/containerExecResponse.js index 59ab75a459..9f133c9585 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerExecResponse.js +++ b/lib/services/containerinstanceManagement/lib/models/containerExecResponse.js @@ -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() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerGroup.js b/lib/services/containerinstanceManagement/lib/models/containerGroup.js index fb2a37e401..d2c01e6a06 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerGroup.js +++ b/lib/services/containerinstanceManagement/lib/models/containerGroup.js @@ -20,77 +20,79 @@ const models = require('./index'); class ContainerGroup extends models['Resource'] { /** * Create a ContainerGroup. - * @member {object} [identity] The identity of the container group, if + * @property {object} [identity] The identity of the container group, if * configured. - * @member {string} [identity.principalId] The principal id of the container - * group identity. This property will only be provided for a system assigned - * identity. - * @member {string} [identity.tenantId] The tenant id associated with the + * @property {string} [identity.principalId] The principal id of the + * container group identity. This property will only be provided for a system + * assigned identity. + * @property {string} [identity.tenantId] The tenant id associated with the * container group. This property will only be provided for a system assigned * identity. - * @member {string} [identity.type] The type of identity used for the + * @property {string} [identity.type] The type of identity used for the * container group. The type 'SystemAssigned, UserAssigned' includes both an * implicitly created identity and a set of user assigned identities. The * type 'None' will remove any identities from the container group. Possible * values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, * UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user + * @property {object} [identity.userAssignedIdentities] The list of user * identities associated with the container group. The user identity * dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * container group. This only appears in the response. - * @member {array} containers The containers within the container group. - * @member {array} [imageRegistryCredentials] The image registry credentials - * by which the container group is created from. - * @member {string} [restartPolicy] Restart policy for all containers within - * the container group. + * @property {array} containers The containers within the container group. + * @property {array} [imageRegistryCredentials] The image registry + * credentials by which the container group is created from. + * @property {string} [restartPolicy] Restart policy for all containers + * within the container group. * - `Always` Always restart * - `OnFailure` Restart on failure * - `Never` Never restart * . Possible values include: 'Always', 'OnFailure', 'Never' - * @member {object} [ipAddress] The IP address type of the container group. - * @member {array} [ipAddress.ports] The list of ports exposed on the + * @property {object} [ipAddress] The IP address type of the container group. + * @property {array} [ipAddress.ports] The list of ports exposed on the * container group. - * @member {string} [ipAddress.type] Specifies if the IP is exposed to the + * @property {string} [ipAddress.type] Specifies if the IP is exposed to the * public internet or private VNET. Possible values include: 'Public', * 'Private' - * @member {string} [ipAddress.ip] The IP exposed to the public internet. - * @member {string} [ipAddress.dnsNameLabel] The Dns name label for the IP. - * @member {string} [ipAddress.fqdn] The FQDN for the IP. - * @member {string} osType The operating system type required by the + * @property {string} [ipAddress.ip] The IP exposed to the public internet. + * @property {string} [ipAddress.dnsNameLabel] The Dns name label for the IP. + * @property {string} [ipAddress.fqdn] The FQDN for the IP. + * @property {string} osType The operating system type required by the * containers in the container group. Possible values include: 'Windows', * 'Linux' - * @member {array} [volumes] The list of volumes that can be mounted by + * @property {array} [volumes] The list of volumes that can be mounted by * containers in this container group. - * @member {object} [instanceView] The instance view of the container group. - * Only valid in response. - * @member {array} [instanceView.events] The events of this container group. - * @member {string} [instanceView.state] The state of the container group. - * Only valid in response. - * @member {object} [diagnostics] The diagnostic information for a container + * @property {object} [instanceView] The instance view of the container + * group. Only valid in response. + * @property {array} [instanceView.events] The events of this container * group. - * @member {object} [diagnostics.logAnalytics] Container group log analytics - * information. - * @member {string} [diagnostics.logAnalytics.workspaceId] The workspace id - * for log analytics - * @member {string} [diagnostics.logAnalytics.workspaceKey] The workspace key + * @property {string} [instanceView.state] The state of the container group. + * Only valid in response. + * @property {object} [diagnostics] The diagnostic information for a + * container group. + * @property {object} [diagnostics.logAnalytics] Container group log + * analytics information. + * @property {string} [diagnostics.logAnalytics.workspaceId] The workspace id * for log analytics - * @member {string} [diagnostics.logAnalytics.logType] The log type to be + * @property {string} [diagnostics.logAnalytics.workspaceKey] The workspace + * key for log analytics + * @property {string} [diagnostics.logAnalytics.logType] The log type to be * used. Possible values include: 'ContainerInsights', * 'ContainerInstanceLogs' - * @member {object} [diagnostics.logAnalytics.metadata] Metadata for log + * @property {object} [diagnostics.logAnalytics.metadata] Metadata for log * analytics. - * @member {object} [networkProfile] The network profile information for a + * @property {object} [networkProfile] The network profile information for a * container group. - * @member {string} [networkProfile.id] The identifier for a network profile. - * @member {object} [dnsConfig] The DNS config information for a container + * @property {string} [networkProfile.id] The identifier for a network + * profile. + * @property {object} [dnsConfig] The DNS config information for a container * group. - * @member {array} [dnsConfig.nameServers] The DNS servers for the container - * group. - * @member {string} [dnsConfig.searchDomains] The DNS search domains for + * @property {array} [dnsConfig.nameServers] The DNS servers for the + * container group. + * @property {string} [dnsConfig.searchDomains] The DNS search domains for * hostname lookup in the container group. - * @member {string} [dnsConfig.options] The DNS options for the container + * @property {string} [dnsConfig.options] The DNS options for the container * group. */ constructor() { diff --git a/lib/services/containerinstanceManagement/lib/models/containerGroupDiagnostics.js b/lib/services/containerinstanceManagement/lib/models/containerGroupDiagnostics.js index e91000a941..cbfda17a0d 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerGroupDiagnostics.js +++ b/lib/services/containerinstanceManagement/lib/models/containerGroupDiagnostics.js @@ -17,14 +17,15 @@ class ContainerGroupDiagnostics { /** * Create a ContainerGroupDiagnostics. - * @member {object} [logAnalytics] Container group log analytics information. - * @member {string} [logAnalytics.workspaceId] The workspace id for log + * @property {object} [logAnalytics] Container group log analytics + * information. + * @property {string} [logAnalytics.workspaceId] The workspace id for log * analytics - * @member {string} [logAnalytics.workspaceKey] The workspace key for log + * @property {string} [logAnalytics.workspaceKey] The workspace key for log * analytics - * @member {string} [logAnalytics.logType] The log type to be used. Possible - * values include: 'ContainerInsights', 'ContainerInstanceLogs' - * @member {object} [logAnalytics.metadata] Metadata for log analytics. + * @property {string} [logAnalytics.logType] The log type to be used. + * Possible values include: 'ContainerInsights', 'ContainerInstanceLogs' + * @property {object} [logAnalytics.metadata] Metadata for log analytics. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerGroupIdentity.js b/lib/services/containerinstanceManagement/lib/models/containerGroupIdentity.js index db2e110156..a9fa5a0b73 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerGroupIdentity.js +++ b/lib/services/containerinstanceManagement/lib/models/containerGroupIdentity.js @@ -17,18 +17,18 @@ class ContainerGroupIdentity { /** * Create a ContainerGroupIdentity. - * @member {string} [principalId] The principal id of the container group + * @property {string} [principalId] The principal id of the container group * identity. This property will only be provided for a system assigned * identity. - * @member {string} [tenantId] The tenant id associated with the container + * @property {string} [tenantId] The tenant id associated with the container * group. This property will only be provided for a system assigned identity. - * @member {string} [type] The type of identity used for the container group. - * The type 'SystemAssigned, UserAssigned' includes both an implicitly + * @property {string} [type] The type of identity used for the container + * group. The type 'SystemAssigned, UserAssigned' includes both an implicitly * created identity and a set of user assigned identities. The type 'None' * will remove any identities from the container group. Possible values * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', * 'None' - * @member {object} [userAssignedIdentities] The list of user identities + * @property {object} [userAssignedIdentities] The list of user identities * associated with the container group. The user identity dictionary key * references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. diff --git a/lib/services/containerinstanceManagement/lib/models/containerGroupIdentityUserAssignedIdentitiesValue.js b/lib/services/containerinstanceManagement/lib/models/containerGroupIdentityUserAssignedIdentitiesValue.js index f4f545661b..e8f5f7c50b 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerGroupIdentityUserAssignedIdentitiesValue.js +++ b/lib/services/containerinstanceManagement/lib/models/containerGroupIdentityUserAssignedIdentitiesValue.js @@ -16,8 +16,9 @@ class ContainerGroupIdentityUserAssignedIdentitiesValue { /** * Create a ContainerGroupIdentityUserAssignedIdentitiesValue. - * @member {string} [principalId] The principal id of user assigned identity. - * @member {string} [clientId] The client id of user assigned identity. + * @property {string} [principalId] The principal id of user assigned + * identity. + * @property {string} [clientId] The client id of user assigned identity. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerGroupListResult.js b/lib/services/containerinstanceManagement/lib/models/containerGroupListResult.js index 9ee4a5810b..3b72d73e43 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerGroupListResult.js +++ b/lib/services/containerinstanceManagement/lib/models/containerGroupListResult.js @@ -17,7 +17,7 @@ class ContainerGroupListResult extends Array { /** * Create a ContainerGroupListResult. - * @member {string} [nextLink] The URI to fetch the next page of container + * @property {string} [nextLink] The URI to fetch the next page of container * groups. */ constructor() { diff --git a/lib/services/containerinstanceManagement/lib/models/containerGroupNetworkProfile.js b/lib/services/containerinstanceManagement/lib/models/containerGroupNetworkProfile.js index 0998021e7d..c927e74c91 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerGroupNetworkProfile.js +++ b/lib/services/containerinstanceManagement/lib/models/containerGroupNetworkProfile.js @@ -17,7 +17,7 @@ class ContainerGroupNetworkProfile { /** * Create a ContainerGroupNetworkProfile. - * @member {string} id The identifier for a network profile. + * @property {string} id The identifier for a network profile. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerGroupPropertiesInstanceView.js b/lib/services/containerinstanceManagement/lib/models/containerGroupPropertiesInstanceView.js index c377de44e0..4ae029e136 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerGroupPropertiesInstanceView.js +++ b/lib/services/containerinstanceManagement/lib/models/containerGroupPropertiesInstanceView.js @@ -17,8 +17,8 @@ class ContainerGroupPropertiesInstanceView { /** * Create a ContainerGroupPropertiesInstanceView. - * @member {array} [events] The events of this container group. - * @member {string} [state] The state of the container group. Only valid in + * @property {array} [events] The events of this container group. + * @property {string} [state] The state of the container group. Only valid in * response. */ constructor() { diff --git a/lib/services/containerinstanceManagement/lib/models/containerHttpGet.js b/lib/services/containerinstanceManagement/lib/models/containerHttpGet.js index e0f3619d8f..07ad7ee59c 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerHttpGet.js +++ b/lib/services/containerinstanceManagement/lib/models/containerHttpGet.js @@ -17,9 +17,9 @@ class ContainerHttpGet { /** * Create a ContainerHttpGet. - * @member {string} [path] The path to probe. - * @member {number} port The port number to probe. - * @member {string} [scheme] The scheme. Possible values include: 'http', + * @property {string} [path] The path to probe. + * @property {number} port The port number to probe. + * @property {string} [scheme] The scheme. Possible values include: 'http', * 'https' */ constructor() { diff --git a/lib/services/containerinstanceManagement/lib/models/containerPort.js b/lib/services/containerinstanceManagement/lib/models/containerPort.js index 3106ae3267..dd8be9492f 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerPort.js +++ b/lib/services/containerinstanceManagement/lib/models/containerPort.js @@ -17,9 +17,10 @@ class ContainerPort { /** * Create a ContainerPort. - * @member {string} [protocol] The protocol associated with the port. + * @property {string} [protocol] The protocol associated with the port. * Possible values include: 'TCP', 'UDP' - * @member {number} port The port number exposed within the container group. + * @property {number} port The port number exposed within the container + * group. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerProbe.js b/lib/services/containerinstanceManagement/lib/models/containerProbe.js index 84f63fe3ba..38e44d652f 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerProbe.js +++ b/lib/services/containerinstanceManagement/lib/models/containerProbe.js @@ -17,19 +17,19 @@ class ContainerProbe { /** * Create a ContainerProbe. - * @member {object} [exec] The execution command to probe - * @member {array} [exec.command] The commands to execute within the + * @property {object} [exec] The execution command to probe + * @property {array} [exec.command] The commands to execute within the * container. - * @member {object} [httpGet] The Http Get settings to probe - * @member {string} [httpGet.path] The path to probe. - * @member {number} [httpGet.port] The port number to probe. - * @member {string} [httpGet.scheme] The scheme. Possible values include: + * @property {object} [httpGet] The Http Get settings to probe + * @property {string} [httpGet.path] The path to probe. + * @property {number} [httpGet.port] The port number to probe. + * @property {string} [httpGet.scheme] The scheme. Possible values include: * 'http', 'https' - * @member {number} [initialDelaySeconds] The initial delay seconds. - * @member {number} [periodSeconds] The period seconds. - * @member {number} [failureThreshold] The failure threshold. - * @member {number} [successThreshold] The success threshold. - * @member {number} [timeoutSeconds] The timeout seconds. + * @property {number} [initialDelaySeconds] The initial delay seconds. + * @property {number} [periodSeconds] The period seconds. + * @property {number} [failureThreshold] The failure threshold. + * @property {number} [successThreshold] The success threshold. + * @property {number} [timeoutSeconds] The timeout seconds. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerPropertiesInstanceView.js b/lib/services/containerinstanceManagement/lib/models/containerPropertiesInstanceView.js index 8365cacc4e..6337ce502e 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerPropertiesInstanceView.js +++ b/lib/services/containerinstanceManagement/lib/models/containerPropertiesInstanceView.js @@ -17,30 +17,31 @@ class ContainerPropertiesInstanceView { /** * Create a ContainerPropertiesInstanceView. - * @member {number} [restartCount] The number of times that the container + * @property {number} [restartCount] The number of times that the container * instance has been restarted. - * @member {object} [currentState] Current container instance state. - * @member {string} [currentState.state] The state of the container instance. - * @member {date} [currentState.startTime] The date-time when the container - * instance state started. - * @member {number} [currentState.exitCode] The container instance exit codes - * correspond to those from the `docker run` command. - * @member {date} [currentState.finishTime] The date-time when the container - * instance state finished. - * @member {string} [currentState.detailStatus] The human-readable status of - * the container instance state. - * @member {object} [previousState] Previous container instance state. - * @member {string} [previousState.state] The state of the container + * @property {object} [currentState] Current container instance state. + * @property {string} [currentState.state] The state of the container * instance. - * @member {date} [previousState.startTime] The date-time when the container + * @property {date} [currentState.startTime] The date-time when the container * instance state started. - * @member {number} [previousState.exitCode] The container instance exit + * @property {number} [currentState.exitCode] The container instance exit + * codes correspond to those from the `docker run` command. + * @property {date} [currentState.finishTime] The date-time when the + * container instance state finished. + * @property {string} [currentState.detailStatus] The human-readable status + * of the container instance state. + * @property {object} [previousState] Previous container instance state. + * @property {string} [previousState.state] The state of the container + * instance. + * @property {date} [previousState.startTime] The date-time when the + * container instance state started. + * @property {number} [previousState.exitCode] The container instance exit * codes correspond to those from the `docker run` command. - * @member {date} [previousState.finishTime] The date-time when the container - * instance state finished. - * @member {string} [previousState.detailStatus] The human-readable status of - * the container instance state. - * @member {array} [events] The events of the container instance. + * @property {date} [previousState.finishTime] The date-time when the + * container instance state finished. + * @property {string} [previousState.detailStatus] The human-readable status + * of the container instance state. + * @property {array} [events] The events of the container instance. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/containerState.js b/lib/services/containerinstanceManagement/lib/models/containerState.js index aacd154f32..42aef350c9 100644 --- a/lib/services/containerinstanceManagement/lib/models/containerState.js +++ b/lib/services/containerinstanceManagement/lib/models/containerState.js @@ -17,15 +17,15 @@ class ContainerState { /** * Create a ContainerState. - * @member {string} [state] The state of the container instance. - * @member {date} [startTime] The date-time when the container instance state - * started. - * @member {number} [exitCode] The container instance exit codes correspond + * @property {string} [state] The state of the container instance. + * @property {date} [startTime] The date-time when the container instance + * state started. + * @property {number} [exitCode] The container instance exit codes correspond * to those from the `docker run` command. - * @member {date} [finishTime] The date-time when the container instance + * @property {date} [finishTime] The date-time when the container instance * state finished. - * @member {string} [detailStatus] The human-readable status of the container - * instance state. + * @property {string} [detailStatus] The human-readable status of the + * container instance state. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/dnsConfiguration.js b/lib/services/containerinstanceManagement/lib/models/dnsConfiguration.js index dead49bd8b..bc3ce708b1 100644 --- a/lib/services/containerinstanceManagement/lib/models/dnsConfiguration.js +++ b/lib/services/containerinstanceManagement/lib/models/dnsConfiguration.js @@ -17,10 +17,10 @@ class DnsConfiguration { /** * Create a DnsConfiguration. - * @member {array} nameServers The DNS servers for the container group. - * @member {string} [searchDomains] The DNS search domains for hostname + * @property {array} nameServers The DNS servers for the container group. + * @property {string} [searchDomains] The DNS search domains for hostname * lookup in the container group. - * @member {string} [options] The DNS options for the container group. + * @property {string} [options] The DNS options for the container group. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/environmentVariable.js b/lib/services/containerinstanceManagement/lib/models/environmentVariable.js index d6f65b5536..3958886410 100644 --- a/lib/services/containerinstanceManagement/lib/models/environmentVariable.js +++ b/lib/services/containerinstanceManagement/lib/models/environmentVariable.js @@ -17,9 +17,9 @@ class EnvironmentVariable { /** * Create a EnvironmentVariable. - * @member {string} name The name of the environment variable. - * @member {string} [value] The value of the environment variable. - * @member {string} [secureValue] The value of the secure environment + * @property {string} name The name of the environment variable. + * @property {string} [value] The value of the environment variable. + * @property {string} [secureValue] The value of the secure environment * variable. */ constructor() { diff --git a/lib/services/containerinstanceManagement/lib/models/event.js b/lib/services/containerinstanceManagement/lib/models/event.js index 1657cb79d7..d64d3f8915 100644 --- a/lib/services/containerinstanceManagement/lib/models/event.js +++ b/lib/services/containerinstanceManagement/lib/models/event.js @@ -17,13 +17,13 @@ class Event { /** * Create a Event. - * @member {number} [count] The count of the event. - * @member {date} [firstTimestamp] The date-time of the earliest logged + * @property {number} [count] The count of the event. + * @property {date} [firstTimestamp] The date-time of the earliest logged * event. - * @member {date} [lastTimestamp] The date-time of the latest logged event. - * @member {string} [name] The event name. - * @member {string} [message] The event message. - * @member {string} [type] The event type. + * @property {date} [lastTimestamp] The date-time of the latest logged event. + * @property {string} [name] The event name. + * @property {string} [message] The event message. + * @property {string} [type] The event type. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/gitRepoVolume.js b/lib/services/containerinstanceManagement/lib/models/gitRepoVolume.js index 10e6161824..3bbc71fc73 100644 --- a/lib/services/containerinstanceManagement/lib/models/gitRepoVolume.js +++ b/lib/services/containerinstanceManagement/lib/models/gitRepoVolume.js @@ -17,12 +17,12 @@ class GitRepoVolume { /** * Create a GitRepoVolume. - * @member {string} [directory] Target directory name. Must not contain or + * @property {string} [directory] Target directory name. Must not contain or * start with '..'. If '.' is supplied, the volume directory will be the git * repository. Otherwise, if specified, the volume will contain the git * repository in the subdirectory with the given name. - * @member {string} repository Repository URL - * @member {string} [revision] Commit hash for the specified revision. + * @property {string} repository Repository URL + * @property {string} [revision] Commit hash for the specified revision. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/gpuResource.js b/lib/services/containerinstanceManagement/lib/models/gpuResource.js index 904310ed6e..7eb8d7c539 100644 --- a/lib/services/containerinstanceManagement/lib/models/gpuResource.js +++ b/lib/services/containerinstanceManagement/lib/models/gpuResource.js @@ -17,9 +17,9 @@ class GpuResource { /** * Create a GpuResource. - * @member {number} count The count of the GPU resource. - * @member {string} sku The SKU of the GPU resource. Possible values include: - * 'K80', 'P100', 'V100' + * @property {number} count The count of the GPU resource. + * @property {string} sku The SKU of the GPU resource. Possible values + * include: 'K80', 'P100', 'V100' */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/imageRegistryCredential.js b/lib/services/containerinstanceManagement/lib/models/imageRegistryCredential.js index ca8f89a9c4..3a9691c6df 100644 --- a/lib/services/containerinstanceManagement/lib/models/imageRegistryCredential.js +++ b/lib/services/containerinstanceManagement/lib/models/imageRegistryCredential.js @@ -17,10 +17,10 @@ class ImageRegistryCredential { /** * Create a ImageRegistryCredential. - * @member {string} server The Docker image registry server without a + * @property {string} server The Docker image registry server without a * protocol such as "http" and "https". - * @member {string} username The username for the private registry. - * @member {string} [password] The password for the private registry. + * @property {string} username The username for the private registry. + * @property {string} [password] The password for the private registry. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/index.d.ts b/lib/services/containerinstanceManagement/lib/models/index.d.ts index 3087f97bc0..5219bf0622 100644 --- a/lib/services/containerinstanceManagement/lib/models/index.d.ts +++ b/lib/services/containerinstanceManagement/lib/models/index.d.ts @@ -1,939 +1,802 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * 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 } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the ContainerPort class. - * @constructor * The port exposed on the container instance. - * - * @member {string} [protocol] The protocol associated with the port. Possible - * values include: 'TCP', 'UDP' - * @member {number} port The port number exposed within the container group. */ export interface ContainerPort { + /** + * The protocol associated with the port. Possible values include: 'TCP', 'UDP' + */ protocol?: string; + /** + * The port number exposed within the container group. + */ port: number; } /** - * @class - * Initializes a new instance of the EnvironmentVariable class. - * @constructor * The environment variable to set within the container instance. - * - * @member {string} name The name of the environment variable. - * @member {string} [value] The value of the environment variable. - * @member {string} [secureValue] The value of the secure environment variable. */ export interface EnvironmentVariable { + /** + * The name of the environment variable. + */ name: string; + /** + * The value of the environment variable. + */ value?: string; + /** + * The value of the secure environment variable. + */ secureValue?: string; } /** - * @class - * Initializes a new instance of the ContainerState class. - * @constructor * The container instance state. - * - * @member {string} [state] The state of the container instance. - * @member {date} [startTime] The date-time when the container instance state - * started. - * @member {number} [exitCode] The container instance exit codes correspond to - * those from the `docker run` command. - * @member {date} [finishTime] The date-time when the container instance state - * finished. - * @member {string} [detailStatus] The human-readable status of the container - * instance state. */ export interface ContainerState { + /** + * The state of the container instance. + */ state?: string; + /** + * The date-time when the container instance state started. + */ startTime?: Date; + /** + * The container instance exit codes correspond to those from the `docker run` command. + */ exitCode?: number; + /** + * The date-time when the container instance state finished. + */ finishTime?: Date; + /** + * The human-readable status of the container instance state. + */ detailStatus?: string; } /** - * @class - * Initializes a new instance of the Event class. - * @constructor * A container group or container instance event. - * - * @member {number} [count] The count of the event. - * @member {date} [firstTimestamp] The date-time of the earliest logged event. - * @member {date} [lastTimestamp] The date-time of the latest logged event. - * @member {string} [name] The event name. - * @member {string} [message] The event message. - * @member {string} [type] The event type. */ export interface Event { + /** + * The count of the event. + */ count?: number; + /** + * The date-time of the earliest logged event. + */ firstTimestamp?: Date; + /** + * The date-time of the latest logged event. + */ lastTimestamp?: Date; + /** + * The event name. + */ name?: string; + /** + * The event message. + */ message?: string; + /** + * The event type. + */ type?: string; } /** - * @class - * Initializes a new instance of the ContainerPropertiesInstanceView class. - * @constructor * The instance view of the container instance. Only valid in response. - * - * @member {number} [restartCount] The number of times that the container - * instance has been restarted. - * @member {object} [currentState] Current container instance state. - * @member {string} [currentState.state] The state of the container instance. - * @member {date} [currentState.startTime] The date-time when the container - * instance state started. - * @member {number} [currentState.exitCode] The container instance exit codes - * correspond to those from the `docker run` command. - * @member {date} [currentState.finishTime] The date-time when the container - * instance state finished. - * @member {string} [currentState.detailStatus] The human-readable status of - * the container instance state. - * @member {object} [previousState] Previous container instance state. - * @member {string} [previousState.state] The state of the container instance. - * @member {date} [previousState.startTime] The date-time when the container - * instance state started. - * @member {number} [previousState.exitCode] The container instance exit codes - * correspond to those from the `docker run` command. - * @member {date} [previousState.finishTime] The date-time when the container - * instance state finished. - * @member {string} [previousState.detailStatus] The human-readable status of - * the container instance state. - * @member {array} [events] The events of the container instance. */ export interface ContainerPropertiesInstanceView { + /** + * The number of times that the container instance has been restarted. + */ readonly restartCount?: number; + /** + * Current container instance state. + */ readonly currentState?: ContainerState; + /** + * Previous container instance state. + */ readonly previousState?: ContainerState; + /** + * The events of the container instance. + */ readonly events?: Event[]; } /** - * @class - * Initializes a new instance of the GpuResource class. - * @constructor * The GPU resource. - * - * @member {number} count The count of the GPU resource. - * @member {string} sku The SKU of the GPU resource. Possible values include: - * 'K80', 'P100', 'V100' */ export interface GpuResource { + /** + * The count of the GPU resource. + */ count: number; + /** + * The SKU of the GPU resource. Possible values include: 'K80', 'P100', 'V100' + */ sku: string; } /** - * @class - * Initializes a new instance of the ResourceRequests class. - * @constructor * The resource requests. - * - * @member {number} memoryInGB The memory request in GB of this container - * instance. - * @member {number} cpu The CPU request of this container instance. - * @member {object} [gpu] The GPU request of this container instance. - * @member {number} [gpu.count] The count of the GPU resource. - * @member {string} [gpu.sku] The SKU of the GPU resource. Possible values - * include: 'K80', 'P100', 'V100' */ export interface ResourceRequests { + /** + * The memory request in GB of this container instance. + */ memoryInGB: number; + /** + * The CPU request of this container instance. + */ cpu: number; + /** + * The GPU request of this container instance. + */ gpu?: GpuResource; } /** - * @class - * Initializes a new instance of the ResourceLimits class. - * @constructor * The resource limits. - * - * @member {number} [memoryInGB] The memory limit in GB of this container - * instance. - * @member {number} [cpu] The CPU limit of this container instance. - * @member {object} [gpu] The GPU limit of this container instance. - * @member {number} [gpu.count] The count of the GPU resource. - * @member {string} [gpu.sku] The SKU of the GPU resource. Possible values - * include: 'K80', 'P100', 'V100' */ export interface ResourceLimits { + /** + * The memory limit in GB of this container instance. + */ memoryInGB?: number; + /** + * The CPU limit of this container instance. + */ cpu?: number; + /** + * The GPU limit of this container instance. + */ gpu?: GpuResource; } /** - * @class - * Initializes a new instance of the ResourceRequirements class. - * @constructor * The resource requirements. - * - * @member {object} requests The resource requests of this container instance. - * @member {number} [requests.memoryInGB] The memory request in GB of this - * container instance. - * @member {number} [requests.cpu] The CPU request of this container instance. - * @member {object} [requests.gpu] The GPU request of this container instance. - * @member {number} [requests.gpu.count] The count of the GPU resource. - * @member {string} [requests.gpu.sku] The SKU of the GPU resource. Possible - * values include: 'K80', 'P100', 'V100' - * @member {object} [limits] The resource limits of this container instance. - * @member {number} [limits.memoryInGB] The memory limit in GB of this - * container instance. - * @member {number} [limits.cpu] The CPU limit of this container instance. - * @member {object} [limits.gpu] The GPU limit of this container instance. - * @member {number} [limits.gpu.count] The count of the GPU resource. - * @member {string} [limits.gpu.sku] The SKU of the GPU resource. Possible - * values include: 'K80', 'P100', 'V100' */ export interface ResourceRequirements { + /** + * The resource requests of this container instance. + */ requests: ResourceRequests; + /** + * The resource limits of this container instance. + */ limits?: ResourceLimits; } /** - * @class - * Initializes a new instance of the VolumeMount class. - * @constructor * The properties of the volume mount. - * - * @member {string} name The name of the volume mount. - * @member {string} mountPath The path within the container where the volume - * should be mounted. Must not contain colon (:). - * @member {boolean} [readOnly] The flag indicating whether the volume mount is - * read-only. */ export interface VolumeMount { + /** + * The name of the volume mount. + */ name: string; + /** + * The path within the container where the volume should be mounted. Must not contain colon (:). + */ mountPath: string; + /** + * The flag indicating whether the volume mount is read-only. + */ readOnly?: boolean; } /** - * @class - * Initializes a new instance of the ContainerExec class. - * @constructor * The container execution command, for liveness or readiness probe - * - * @member {array} [command] The commands to execute within the container. */ export interface ContainerExec { + /** + * The commands to execute within the container. + */ command?: string[]; } /** - * @class - * Initializes a new instance of the ContainerHttpGet class. - * @constructor * The container Http Get settings, for liveness or readiness probe - * - * @member {string} [path] The path to probe. - * @member {number} port The port number to probe. - * @member {string} [scheme] The scheme. Possible values include: 'http', - * 'https' */ export interface ContainerHttpGet { + /** + * The path to probe. + */ path?: string; + /** + * The port number to probe. + */ port: number; + /** + * The scheme. Possible values include: 'http', 'https' + */ scheme?: string; } /** - * @class - * Initializes a new instance of the ContainerProbe class. - * @constructor * The container probe, for liveness or readiness - * - * @member {object} [exec] The execution command to probe - * @member {array} [exec.command] The commands to execute within the container. - * @member {object} [httpGet] The Http Get settings to probe - * @member {string} [httpGet.path] The path to probe. - * @member {number} [httpGet.port] The port number to probe. - * @member {string} [httpGet.scheme] The scheme. Possible values include: - * 'http', 'https' - * @member {number} [initialDelaySeconds] The initial delay seconds. - * @member {number} [periodSeconds] The period seconds. - * @member {number} [failureThreshold] The failure threshold. - * @member {number} [successThreshold] The success threshold. - * @member {number} [timeoutSeconds] The timeout seconds. */ export interface ContainerProbe { + /** + * The execution command to probe + */ exec?: ContainerExec; + /** + * The Http Get settings to probe + */ httpGet?: ContainerHttpGet; + /** + * The initial delay seconds. + */ initialDelaySeconds?: number; + /** + * The period seconds. + */ periodSeconds?: number; + /** + * The failure threshold. + */ failureThreshold?: number; + /** + * The success threshold. + */ successThreshold?: number; + /** + * The timeout seconds. + */ timeoutSeconds?: number; } /** - * @class - * Initializes a new instance of the Container class. - * @constructor * A container instance. - * - * @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 - * 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 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 - * state. - * @member {string} [instanceView.currentState.state] The state of the - * container instance. - * @member {date} [instanceView.currentState.startTime] The date-time when the - * container instance state started. - * @member {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 the - * container instance state finished. - * @member {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 - * container instance. - * @member {date} [instanceView.previousState.startTime] The date-time when the - * container instance state started. - * @member {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 - * human-readable status of the container instance state. - * @member {array} [instanceView.events] The events of the container instance. - * @member {object} resources The resource requirements of the container - * instance. - * @member {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 container - * instance. - * @member {object} [resources.requests.gpu] The GPU request of this container - * instance. - * @member {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 - * this container instance. - * @member {number} [resources.limits.cpu] The CPU limit of this container - * instance. - * @member {object} [resources.limits.gpu] The GPU limit of this container - * instance. - * @member {number} [resources.limits.gpu.count] The count of the GPU resource. - * @member {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 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 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 values - * include: 'http', 'https' - * @member {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 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 values - * include: 'http', 'https' - * @member {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. */ export interface Container { + /** + * The user-provided name of the container instance. + */ name: string; + /** + * The name of the image used to create the container instance. + */ image: string; + /** + * The commands to execute within the container instance in exec form. + */ command?: string[]; + /** + * The exposed ports on the container instance. + */ ports?: ContainerPort[]; + /** + * The environment variables to set in the container instance. + */ environmentVariables?: EnvironmentVariable[]; + /** + * The instance view of the container instance. Only valid in response. + */ readonly instanceView?: ContainerPropertiesInstanceView; + /** + * The resource requirements of the container instance. + */ resources: ResourceRequirements; + /** + * The volume mounts available to the container instance. + */ volumeMounts?: VolumeMount[]; + /** + * The liveness probe. + */ livenessProbe?: ContainerProbe; + /** + * The readiness probe. + */ readinessProbe?: ContainerProbe; } /** - * @class - * Initializes a new instance of the AzureFileVolume class. - * @constructor - * The properties of the Azure File volume. Azure File shares are mounted as - * volumes. - * - * @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 - * shared mounted as a volume is read-only. - * @member {string} storageAccountName The name of the storage account that - * contains the Azure File share. - * @member {string} [storageAccountKey] The storage account access key used to - * access the Azure File share. + * The properties of the Azure File volume. Azure File shares are mounted as volumes. */ export interface AzureFileVolume { + /** + * The name of the Azure File share to be mounted as a volume. + */ shareName: string; + /** + * The flag indicating whether the Azure File shared mounted as a volume is read-only. + */ readOnly?: boolean; + /** + * The name of the storage account that contains the Azure File share. + */ storageAccountName: string; + /** + * The storage account access key used to access the Azure File share. + */ storageAccountKey?: string; } /** - * @class - * Initializes a new instance of the GitRepoVolume class. - * @constructor * Represents a volume that is populated with the contents of a git repository - * - * @member {string} [directory] Target directory name. Must not contain or - * start with '..'. If '.' is supplied, the volume directory will be the git - * repository. Otherwise, if specified, the volume will contain the git - * repository in the subdirectory with the given name. - * @member {string} repository Repository URL - * @member {string} [revision] Commit hash for the specified revision. */ export interface GitRepoVolume { + /** + * Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume + * directory will be the git repository. Otherwise, if specified, the volume will contain the + * git repository in the subdirectory with the given name. + */ directory?: string; + /** + * Repository URL + */ repository: string; + /** + * Commit hash for the specified revision. + */ revision?: string; } /** - * @class - * Initializes a new instance of the Volume class. - * @constructor * The properties of the volume. - * - * @member {string} name The name of the volume. - * @member {object} [azureFile] The Azure File volume. - * @member {string} [azureFile.shareName] The name of the Azure File share to - * be mounted as a volume. - * @member {boolean} [azureFile.readOnly] The flag indicating whether the Azure - * File shared mounted as a volume is read-only. - * @member {string} [azureFile.storageAccountName] The name of the storage - * account that contains the Azure File share. - * @member {string} [azureFile.storageAccountKey] The storage account access - * key used to access the Azure File share. - * @member {object} [emptyDir] The empty directory volume. - * @member {object} [secret] The secret volume. - * @member {object} [gitRepo] The git repo volume. - * @member {string} [gitRepo.directory] Target directory name. Must not contain - * or start with '..'. If '.' is supplied, the volume directory will be the - * git repository. Otherwise, if specified, the volume will contain the git - * repository in the subdirectory with the given name. - * @member {string} [gitRepo.repository] Repository URL - * @member {string} [gitRepo.revision] Commit hash for the specified revision. */ export interface Volume { + /** + * The name of the volume. + */ name: string; + /** + * The Azure File volume. + */ azureFile?: AzureFileVolume; + /** + * The empty directory volume. + */ emptyDir?: any; + /** + * The secret volume. + */ secret?: { [propertyName: string]: string }; + /** + * The git repo volume. + */ gitRepo?: GitRepoVolume; } -/** - * @class - * Initializes a new instance of the ContainerGroupIdentityUserAssignedIdentitiesValue class. - * @constructor - * @member {string} [principalId] The principal id of user assigned identity. - * @member {string} [clientId] The client id of user assigned identity. - */ export interface ContainerGroupIdentityUserAssignedIdentitiesValue { + /** + * The principal id of user assigned identity. + */ readonly principalId?: string; + /** + * The client id of user assigned identity. + */ readonly clientId?: string; } /** - * @class - * Initializes a new instance of the ContainerGroupIdentity class. - * @constructor * Identity for the container group. - * - * @member {string} [principalId] The principal id of the container group - * identity. This property will only be provided for a system assigned - * identity. - * @member {string} [tenantId] The tenant id associated with the container - * group. This property will only be provided for a system assigned identity. - * @member {string} [type] The type of identity used for the container group. - * The type 'SystemAssigned, UserAssigned' includes both an implicitly created - * identity and a set of user assigned identities. The type 'None' will remove - * any identities from the container group. Possible values include: - * 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' - * @member {object} [userAssignedIdentities] The list of user identities - * associated with the container group. The user identity dictionary key - * references will be ARM resource ids in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - */ +*/ export interface ContainerGroupIdentity { + /** + * The principal id of the container group identity. This property will only be provided for a + * system assigned identity. + */ readonly principalId?: string; + /** + * The tenant id associated with the container group. This property will only be provided for a + * system assigned identity. + */ readonly tenantId?: string; + /** + * The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' + * includes both an implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the container group. Possible values include: + * 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + */ type?: string; - userAssignedIdentities?: { [propertyName: string]: ContainerGroupIdentityUserAssignedIdentitiesValue }; + /** + * The list of user identities associated with the container group. The user identity dictionary + * key references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + */ + userAssignedIdentities?: { [propertyName: string]: + ContainerGroupIdentityUserAssignedIdentitiesValue }; } /** - * @class - * Initializes a new instance of the ImageRegistryCredential class. - * @constructor * Image registry credential. - * - * @member {string} server The Docker image registry server without a protocol - * such as "http" and "https". - * @member {string} username The username for the private registry. - * @member {string} [password] The password for the private registry. - */ +*/ export interface ImageRegistryCredential { + /** + * The Docker image registry server without a protocol such as "http" and "https". + */ server: string; + /** + * The username for the private registry. + */ username: string; + /** + * The password for the private registry. + */ password?: string; } /** - * @class - * Initializes a new instance of the Port class. - * @constructor * The port exposed on the container group. - * - * @member {string} [protocol] The protocol associated with the port. Possible - * values include: 'TCP', 'UDP' - * @member {number} port The port number. - */ +*/ export interface Port { + /** + * The protocol associated with the port. Possible values include: 'TCP', 'UDP' + */ protocol?: string; + /** + * The port number. + */ port: number; } /** - * @class - * Initializes a new instance of the IpAddress class. - * @constructor * IP address for the container group. - * - * @member {array} ports The list of ports exposed on the container group. - * @member {string} type Specifies if the IP is exposed to the public internet - * or private VNET. Possible values include: 'Public', 'Private' - * @member {string} [ip] The IP exposed to the public internet. - * @member {string} [dnsNameLabel] The Dns name label for the IP. - * @member {string} [fqdn] The FQDN for the IP. - */ +*/ export interface IpAddress { + /** + * The list of ports exposed on the container group. + */ ports: Port[]; + /** + * Specifies if the IP is exposed to the public internet or private VNET. Possible values + * include: 'Public', 'Private' + */ type: string; + /** + * The IP exposed to the public internet. + */ ip?: string; + /** + * The Dns name label for the IP. + */ dnsNameLabel?: string; + /** + * The FQDN for the IP. + */ readonly fqdn?: string; } /** - * @class - * Initializes a new instance of the ContainerGroupPropertiesInstanceView class. - * @constructor * The instance view of the container group. Only valid in response. - * - * @member {array} [events] The events of this container group. - * @member {string} [state] The state of the container group. Only valid in - * response. - */ +*/ export interface ContainerGroupPropertiesInstanceView { + /** + * The events of this container group. + */ readonly events?: Event[]; + /** + * The state of the container group. Only valid in response. + */ readonly state?: string; } /** - * @class - * Initializes a new instance of the LogAnalytics class. - * @constructor * Container group log analytics information. - * - * @member {string} workspaceId The workspace id for log analytics - * @member {string} workspaceKey The workspace key for log analytics - * @member {string} [logType] The log type to be used. Possible values include: - * 'ContainerInsights', 'ContainerInstanceLogs' - * @member {object} [metadata] Metadata for log analytics. - */ +*/ export interface LogAnalytics { + /** + * The workspace id for log analytics + */ workspaceId: string; + /** + * The workspace key for log analytics + */ workspaceKey: string; + /** + * The log type to be used. Possible values include: 'ContainerInsights', 'ContainerInstanceLogs' + */ logType?: string; + /** + * Metadata for log analytics. + */ metadata?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the ContainerGroupDiagnostics class. - * @constructor * Container group diagnostic information. - * - * @member {object} [logAnalytics] Container group log analytics information. - * @member {string} [logAnalytics.workspaceId] The workspace id for log - * analytics - * @member {string} [logAnalytics.workspaceKey] The workspace key for log - * analytics - * @member {string} [logAnalytics.logType] The log type to be used. Possible - * values include: 'ContainerInsights', 'ContainerInstanceLogs' - * @member {object} [logAnalytics.metadata] Metadata for log analytics. - */ +*/ export interface ContainerGroupDiagnostics { + /** + * Container group log analytics information. + */ logAnalytics?: LogAnalytics; } /** - * @class - * Initializes a new instance of the ContainerGroupNetworkProfile class. - * @constructor * Container group network profile information. - * - * @member {string} id The identifier for a network profile. - */ +*/ export interface ContainerGroupNetworkProfile { + /** + * The identifier for a network profile. + */ id: string; } /** - * @class - * Initializes a new instance of the DnsConfiguration class. - * @constructor * DNS configuration for the container group. - * - * @member {array} nameServers The DNS servers for the container group. - * @member {string} [searchDomains] The DNS search domains for hostname lookup - * in the container group. - * @member {string} [options] The DNS options for the container group. - */ +*/ export interface DnsConfiguration { + /** + * The DNS servers for the container group. + */ nameServers: string[]; + /** + * The DNS search domains for hostname lookup in the container group. + */ searchDomains?: string; + /** + * The DNS options for the container group. + */ options?: string; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * The Resource model definition. - * - * @member {string} [id] The resource id. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} [location] The resource location. - * @member {object} [tags] The resource tags. - */ +*/ export interface Resource extends BaseResource { + /** + * The resource id. + */ readonly id?: string; + /** + * The resource name. + */ readonly name?: string; + /** + * The resource type. + */ readonly type?: string; + /** + * The resource location. + */ location?: string; + /** + * The resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the ContainerGroup class. - * @constructor * A container group. - * - * @member {object} [identity] The identity of the container group, if - * configured. - * @member {string} [identity.principalId] The principal id of the container - * group identity. This property will only be provided for a system assigned - * identity. - * @member {string} [identity.tenantId] The tenant id associated with the - * container group. This property will only be provided for a system assigned - * identity. - * @member {string} [identity.type] The type of identity used for the container - * group. The type 'SystemAssigned, UserAssigned' includes both an implicitly - * created identity and a set of user assigned identities. The type 'None' will - * remove any identities from the container group. Possible values include: - * 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user - * identities associated with the container group. The user identity dictionary - * key references will be ARM resource ids in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - * @member {string} [provisioningState] The provisioning state of the container - * group. This only appears in the response. - * @member {array} containers The containers within the container group. - * @member {array} [imageRegistryCredentials] The image registry credentials by - * which the container group is created from. - * @member {string} [restartPolicy] Restart policy for all containers within - * the container group. - * - `Always` Always restart - * - `OnFailure` Restart on failure - * - `Never` Never restart - * . Possible values include: 'Always', 'OnFailure', 'Never' - * @member {object} [ipAddress] The IP address type of the container group. - * @member {array} [ipAddress.ports] The list of ports exposed on the container - * group. - * @member {string} [ipAddress.type] Specifies if the IP is exposed to the - * public internet or private VNET. Possible values include: 'Public', - * 'Private' - * @member {string} [ipAddress.ip] The IP exposed to the public internet. - * @member {string} [ipAddress.dnsNameLabel] The Dns name label for the IP. - * @member {string} [ipAddress.fqdn] The FQDN for the IP. - * @member {string} osType The operating system type required by the containers - * in the container group. Possible values include: 'Windows', 'Linux' - * @member {array} [volumes] The list of volumes that can be mounted by - * containers in this container group. - * @member {object} [instanceView] The instance view of the container group. - * Only valid in response. - * @member {array} [instanceView.events] The events of this container group. - * @member {string} [instanceView.state] The state of the container group. Only - * valid in response. - * @member {object} [diagnostics] The diagnostic information for a container - * group. - * @member {object} [diagnostics.logAnalytics] Container group log analytics - * information. - * @member {string} [diagnostics.logAnalytics.workspaceId] The workspace id for - * log analytics - * @member {string} [diagnostics.logAnalytics.workspaceKey] The workspace key - * for log analytics - * @member {string} [diagnostics.logAnalytics.logType] The log type to be used. - * Possible values include: 'ContainerInsights', 'ContainerInstanceLogs' - * @member {object} [diagnostics.logAnalytics.metadata] Metadata for log - * analytics. - * @member {object} [networkProfile] The network profile information for a - * container group. - * @member {string} [networkProfile.id] The identifier for a network profile. - * @member {object} [dnsConfig] The DNS config information for a container - * group. - * @member {array} [dnsConfig.nameServers] The DNS servers for the container - * group. - * @member {string} [dnsConfig.searchDomains] The DNS search domains for - * hostname lookup in the container group. - * @member {string} [dnsConfig.options] The DNS options for the container - * group. - */ +*/ export interface ContainerGroup extends Resource { + /** + * The identity of the container group, if configured. + */ identity?: ContainerGroupIdentity; + /** + * The provisioning state of the container group. This only appears in the response. + */ readonly provisioningState?: string; + /** + * The containers within the container group. + */ containers: Container[]; + /** + * The image registry credentials by which the container group is created from. + */ imageRegistryCredentials?: ImageRegistryCredential[]; + /** + * Restart policy for all containers within the container group. + * - `Always` Always restart + * - `OnFailure` Restart on failure + * - `Never` Never restart + * . Possible values include: 'Always', 'OnFailure', 'Never' + */ restartPolicy?: string; + /** + * The IP address type of the container group. + */ ipAddress?: IpAddress; + /** + * The operating system type required by the containers in the container group. Possible values + * include: 'Windows', 'Linux' + */ osType: string; + /** + * The list of volumes that can be mounted by containers in this container group. + */ volumes?: Volume[]; + /** + * The instance view of the container group. Only valid in response. + */ readonly instanceView?: ContainerGroupPropertiesInstanceView; + /** + * The diagnostic information for a container group. + */ diagnostics?: ContainerGroupDiagnostics; + /** + * The network profile information for a container group. + */ networkProfile?: ContainerGroupNetworkProfile; + /** + * The DNS config information for a container group. + */ dnsConfig?: DnsConfiguration; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * The display information of the operation. - * - * @member {string} [provider] The name of the provider of the operation. - * @member {string} [resource] The name of the resource type of the operation. - * @member {string} [operation] The friendly name of the operation. - * @member {string} [description] The description of the operation. - */ +*/ export interface OperationDisplay { + /** + * The name of the provider of the operation. + */ provider?: string; + /** + * The name of the resource type of the operation. + */ resource?: string; + /** + * The friendly name of the operation. + */ operation?: string; + /** + * The description of the operation. + */ description?: string; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * An operation for Azure Container Instance service. - * - * @member {string} name The name of the operation. - * @member {object} display The display information of the operation. - * @member {string} [display.provider] The name of the provider of the - * operation. - * @member {string} [display.resource] The name of the resource type of the - * operation. - * @member {string} [display.operation] The friendly name of the operation. - * @member {string} [display.description] The description of the operation. - * @member {string} [origin] The intended executor of the operation. Possible - * values include: 'User', 'System' - */ +*/ export interface Operation { + /** + * The name of the operation. + */ name: string; + /** + * The display information of the operation. + */ display: OperationDisplay; + /** + * The intended executor of the operation. Possible values include: 'User', 'System' + */ origin?: string; } /** - * @class - * Initializes a new instance of the OperationListResult class. - * @constructor - * The operation list response that contains all operations for Azure Container - * Instance service. - * - * @member {array} [value] The list of operations. - * @member {string} [nextLink] The URI to fetch the next page of operations. - */ + * The operation list response that contains all operations for Azure Container Instance service. +*/ export interface OperationListResult { + /** + * The list of operations. + */ value?: Operation[]; + /** + * The URI to fetch the next page of operations. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the UsageName class. - * @constructor * The name object of the resource - * - * @member {string} [value] The name of the resource - * @member {string} [localizedValue] The localized name of the resource - */ +*/ export interface UsageName { + /** + * The name of the resource + */ readonly value?: string; + /** + * The localized name of the resource + */ readonly localizedValue?: string; } /** - * @class - * Initializes a new instance of the Usage class. - * @constructor * A single usage result - * - * @member {string} [unit] Unit of the usage result - * @member {number} [currentValue] The current usage of the resource - * @member {number} [limit] The maximum permitted usage of the resource. - * @member {object} [name] The name object of the resource - * @member {string} [name.value] The name of the resource - * @member {string} [name.localizedValue] The localized name of the resource - */ +*/ export interface Usage { + /** + * Unit of the usage result + */ readonly unit?: string; + /** + * The current usage of the resource + */ readonly currentValue?: number; + /** + * The maximum permitted usage of the resource. + */ readonly limit?: number; + /** + * The name object of the resource + */ readonly name?: UsageName; } /** - * @class - * Initializes a new instance of the UsageListResult class. - * @constructor * The response containing the usage data - * - * @member {array} [value] - */ +*/ export interface UsageListResult { readonly value?: Usage[]; } /** - * @class - * Initializes a new instance of the Logs class. - * @constructor * The logs. - * - * @member {string} [content] The content of the log. - */ +*/ export interface Logs { + /** + * The content of the log. + */ content?: string; } /** - * @class - * Initializes a new instance of the ContainerExecRequestTerminalSize class. - * @constructor * The size of the terminal. - * - * @member {number} [rows] The row size of the terminal - * @member {number} [cols] The column size of the terminal - */ +*/ export interface ContainerExecRequestTerminalSize { + /** + * The row size of the terminal + */ rows?: number; + /** + * The column size of the terminal + */ cols?: number; } /** - * @class - * Initializes a new instance of the ContainerExecRequest class. - * @constructor * The container exec request. - * - * @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 - */ +*/ export interface ContainerExecRequest { + /** + * The command to be executed. + */ command?: string; + /** + * The size of the terminal. + */ terminalSize?: ContainerExecRequestTerminalSize; } /** - * @class - * Initializes a new instance of the ContainerExecResponse class. - * @constructor * The information for the container exec command. - * - * @member {string} [webSocketUri] The uri for the exec websocket. - * @member {string} [password] The password to start the exec command. - */ +*/ export interface ContainerExecResponse { + /** + * The uri for the exec websocket. + */ webSocketUri?: string; + /** + * The password to start the exec command. + */ password?: string; } - /** - * @class - * Initializes a new instance of the ContainerGroupListResult class. - * @constructor - * The container group list response that contains the container group - * properties. - * - * @member {string} [nextLink] The URI to fetch the next page of container - * groups. - */ + * The container group list response that contains the container group properties. +*/ export interface ContainerGroupListResult extends Array { + /** + * The URI to fetch the next page of container groups. + */ nextLink?: string; } diff --git a/lib/services/containerinstanceManagement/lib/models/ipAddress.js b/lib/services/containerinstanceManagement/lib/models/ipAddress.js index 0ab73610e7..b653f88ef3 100644 --- a/lib/services/containerinstanceManagement/lib/models/ipAddress.js +++ b/lib/services/containerinstanceManagement/lib/models/ipAddress.js @@ -17,12 +17,12 @@ class IpAddress { /** * Create a IpAddress. - * @member {array} ports The list of ports exposed on the container group. - * @member {string} type Specifies if the IP is exposed to the public + * @property {array} ports The list of ports exposed on the container group. + * @property {string} type Specifies if the IP is exposed to the public * internet or private VNET. Possible values include: 'Public', 'Private' - * @member {string} [ip] The IP exposed to the public internet. - * @member {string} [dnsNameLabel] The Dns name label for the IP. - * @member {string} [fqdn] The FQDN for the IP. + * @property {string} [ip] The IP exposed to the public internet. + * @property {string} [dnsNameLabel] The Dns name label for the IP. + * @property {string} [fqdn] The FQDN for the IP. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/logAnalytics.js b/lib/services/containerinstanceManagement/lib/models/logAnalytics.js index f3609a5a89..5fddcd4c53 100644 --- a/lib/services/containerinstanceManagement/lib/models/logAnalytics.js +++ b/lib/services/containerinstanceManagement/lib/models/logAnalytics.js @@ -17,11 +17,11 @@ class LogAnalytics { /** * Create a LogAnalytics. - * @member {string} workspaceId The workspace id for log analytics - * @member {string} workspaceKey The workspace key for log analytics - * @member {string} [logType] The log type to be used. Possible values + * @property {string} workspaceId The workspace id for log analytics + * @property {string} workspaceKey The workspace key for log analytics + * @property {string} [logType] The log type to be used. Possible values * include: 'ContainerInsights', 'ContainerInstanceLogs' - * @member {object} [metadata] Metadata for log analytics. + * @property {object} [metadata] Metadata for log analytics. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/logs.js b/lib/services/containerinstanceManagement/lib/models/logs.js index 2362049af1..329bf281d8 100644 --- a/lib/services/containerinstanceManagement/lib/models/logs.js +++ b/lib/services/containerinstanceManagement/lib/models/logs.js @@ -17,7 +17,7 @@ class Logs { /** * Create a Logs. - * @member {string} [content] The content of the log. + * @property {string} [content] The content of the log. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/operation.js b/lib/services/containerinstanceManagement/lib/models/operation.js index aed258517a..09bfc85902 100644 --- a/lib/services/containerinstanceManagement/lib/models/operation.js +++ b/lib/services/containerinstanceManagement/lib/models/operation.js @@ -17,16 +17,16 @@ class Operation { /** * Create a Operation. - * @member {string} name The name of the operation. - * @member {object} display The display information of the operation. - * @member {string} [display.provider] The name of the provider of the + * @property {string} name The name of the operation. + * @property {object} display The display information of the operation. + * @property {string} [display.provider] The name of the provider of the * operation. - * @member {string} [display.resource] The name of the resource type of the + * @property {string} [display.resource] The name of the resource type of the * operation. - * @member {string} [display.operation] The friendly name of the operation. - * @member {string} [display.description] The description of the operation. - * @member {string} [origin] The intended executor of the operation. Possible - * values include: 'User', 'System' + * @property {string} [display.operation] The friendly name of the operation. + * @property {string} [display.description] The description of the operation. + * @property {string} [origin] The intended executor of the operation. + * Possible values include: 'User', 'System' */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/operationDisplay.js b/lib/services/containerinstanceManagement/lib/models/operationDisplay.js index 672b7cefbf..20c5ebc0d2 100644 --- a/lib/services/containerinstanceManagement/lib/models/operationDisplay.js +++ b/lib/services/containerinstanceManagement/lib/models/operationDisplay.js @@ -17,11 +17,11 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] The name of the provider of the operation. - * @member {string} [resource] The name of the resource type of the + * @property {string} [provider] The name of the provider of the operation. + * @property {string} [resource] The name of the resource type of the * operation. - * @member {string} [operation] The friendly name of the operation. - * @member {string} [description] The description of the operation. + * @property {string} [operation] The friendly name of the operation. + * @property {string} [description] The description of the operation. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/operationListResult.js b/lib/services/containerinstanceManagement/lib/models/operationListResult.js index df3c0fef3a..f7bf2e5c80 100644 --- a/lib/services/containerinstanceManagement/lib/models/operationListResult.js +++ b/lib/services/containerinstanceManagement/lib/models/operationListResult.js @@ -18,8 +18,9 @@ class OperationListResult { /** * Create a OperationListResult. - * @member {array} [value] The list of operations. - * @member {string} [nextLink] The URI to fetch the next page of operations. + * @property {array} [value] The list of operations. + * @property {string} [nextLink] The URI to fetch the next page of + * operations. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/port.js b/lib/services/containerinstanceManagement/lib/models/port.js index 75c0e283fd..5830946180 100644 --- a/lib/services/containerinstanceManagement/lib/models/port.js +++ b/lib/services/containerinstanceManagement/lib/models/port.js @@ -17,9 +17,9 @@ class Port { /** * Create a Port. - * @member {string} [protocol] The protocol associated with the port. + * @property {string} [protocol] The protocol associated with the port. * Possible values include: 'TCP', 'UDP' - * @member {number} port The port number. + * @property {number} port The port number. */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/resource.js b/lib/services/containerinstanceManagement/lib/models/resource.js index 59252c5ada..925f61e8cf 100644 --- a/lib/services/containerinstanceManagement/lib/models/resource.js +++ b/lib/services/containerinstanceManagement/lib/models/resource.js @@ -20,11 +20,11 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] The resource id. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} [location] The resource location. - * @member {object} [tags] The resource tags. + * @property {string} [id] The resource id. + * @property {string} [name] The resource name. + * @property {string} [type] The resource type. + * @property {string} [location] The resource location. + * @property {object} [tags] The resource tags. */ constructor() { super(); diff --git a/lib/services/containerinstanceManagement/lib/models/resourceLimits.js b/lib/services/containerinstanceManagement/lib/models/resourceLimits.js index 15af3b5a8a..f599e8a1d8 100644 --- a/lib/services/containerinstanceManagement/lib/models/resourceLimits.js +++ b/lib/services/containerinstanceManagement/lib/models/resourceLimits.js @@ -17,12 +17,12 @@ class ResourceLimits { /** * Create a ResourceLimits. - * @member {number} [memoryInGB] The memory limit in GB of this container + * @property {number} [memoryInGB] The memory limit in GB of this container * instance. - * @member {number} [cpu] The CPU limit of this container instance. - * @member {object} [gpu] The GPU limit of this container instance. - * @member {number} [gpu.count] The count of the GPU resource. - * @member {string} [gpu.sku] The SKU of the GPU resource. Possible values + * @property {number} [cpu] The CPU limit of this container instance. + * @property {object} [gpu] The GPU limit of this container instance. + * @property {number} [gpu.count] The count of the GPU resource. + * @property {string} [gpu.sku] The SKU of the GPU resource. Possible values * include: 'K80', 'P100', 'V100' */ constructor() { diff --git a/lib/services/containerinstanceManagement/lib/models/resourceRequests.js b/lib/services/containerinstanceManagement/lib/models/resourceRequests.js index bf7a20e906..d12ed136c3 100644 --- a/lib/services/containerinstanceManagement/lib/models/resourceRequests.js +++ b/lib/services/containerinstanceManagement/lib/models/resourceRequests.js @@ -17,12 +17,12 @@ class ResourceRequests { /** * Create a ResourceRequests. - * @member {number} memoryInGB The memory request in GB of this container + * @property {number} memoryInGB The memory request in GB of this container * instance. - * @member {number} cpu The CPU request of this container instance. - * @member {object} [gpu] The GPU request of this container instance. - * @member {number} [gpu.count] The count of the GPU resource. - * @member {string} [gpu.sku] The SKU of the GPU resource. Possible values + * @property {number} cpu The CPU request of this container instance. + * @property {object} [gpu] The GPU request of this container instance. + * @property {number} [gpu.count] The count of the GPU resource. + * @property {string} [gpu.sku] The SKU of the GPU resource. Possible values * include: 'K80', 'P100', 'V100' */ constructor() { diff --git a/lib/services/containerinstanceManagement/lib/models/resourceRequirements.js b/lib/services/containerinstanceManagement/lib/models/resourceRequirements.js index d1cde84099..3b63f3c33f 100644 --- a/lib/services/containerinstanceManagement/lib/models/resourceRequirements.js +++ b/lib/services/containerinstanceManagement/lib/models/resourceRequirements.js @@ -17,24 +17,25 @@ class ResourceRequirements { /** * Create a ResourceRequirements. - * @member {object} requests The resource requests of this container + * @property {object} requests The resource requests of this container * instance. - * @member {number} [requests.memoryInGB] The memory request in GB of this + * @property {number} [requests.memoryInGB] The memory request in GB of this * container instance. - * @member {number} [requests.cpu] The CPU request of this container + * @property {number} [requests.cpu] The CPU request of this container * instance. - * @member {object} [requests.gpu] The GPU request of this container + * @property {object} [requests.gpu] The GPU request of this container * instance. - * @member {number} [requests.gpu.count] The count of the GPU resource. - * @member {string} [requests.gpu.sku] The SKU of the GPU resource. Possible - * values include: 'K80', 'P100', 'V100' - * @member {object} [limits] The resource limits of this container instance. - * @member {number} [limits.memoryInGB] The memory limit in GB of this + * @property {number} [requests.gpu.count] The count of the GPU resource. + * @property {string} [requests.gpu.sku] The SKU of the GPU resource. + * Possible values include: 'K80', 'P100', 'V100' + * @property {object} [limits] The resource limits of this container + * instance. + * @property {number} [limits.memoryInGB] The memory limit in GB of this * container instance. - * @member {number} [limits.cpu] The CPU limit of this container instance. - * @member {object} [limits.gpu] The GPU limit of this container instance. - * @member {number} [limits.gpu.count] The count of the GPU resource. - * @member {string} [limits.gpu.sku] The SKU of the GPU resource. Possible + * @property {number} [limits.cpu] The CPU limit of this container instance. + * @property {object} [limits.gpu] The GPU limit of this container instance. + * @property {number} [limits.gpu.count] The count of the GPU resource. + * @property {string} [limits.gpu.sku] The SKU of the GPU resource. Possible * values include: 'K80', 'P100', 'V100' */ constructor() { diff --git a/lib/services/containerinstanceManagement/lib/models/usage.js b/lib/services/containerinstanceManagement/lib/models/usage.js index caa5b858fb..b9b749600f 100644 --- a/lib/services/containerinstanceManagement/lib/models/usage.js +++ b/lib/services/containerinstanceManagement/lib/models/usage.js @@ -17,12 +17,13 @@ class Usage { /** * Create a Usage. - * @member {string} [unit] Unit of the usage result - * @member {number} [currentValue] The current usage of the resource - * @member {number} [limit] The maximum permitted usage of the resource. - * @member {object} [name] The name object of the resource - * @member {string} [name.value] The name of the resource - * @member {string} [name.localizedValue] The localized name of the resource + * @property {string} [unit] Unit of the usage result + * @property {number} [currentValue] The current usage of the resource + * @property {number} [limit] The maximum permitted usage of the resource. + * @property {object} [name] The name object of the resource + * @property {string} [name.value] The name of the resource + * @property {string} [name.localizedValue] The localized name of the + * resource */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/usageListResult.js b/lib/services/containerinstanceManagement/lib/models/usageListResult.js index 4cc0008c5c..b4f1df2e65 100644 --- a/lib/services/containerinstanceManagement/lib/models/usageListResult.js +++ b/lib/services/containerinstanceManagement/lib/models/usageListResult.js @@ -17,7 +17,7 @@ class UsageListResult { /** * Create a UsageListResult. - * @member {array} [value] + * @property {array} [value] */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/usageName.js b/lib/services/containerinstanceManagement/lib/models/usageName.js index 048ce3cbff..b571b05a09 100644 --- a/lib/services/containerinstanceManagement/lib/models/usageName.js +++ b/lib/services/containerinstanceManagement/lib/models/usageName.js @@ -17,8 +17,8 @@ class UsageName { /** * Create a UsageName. - * @member {string} [value] The name of the resource - * @member {string} [localizedValue] The localized name of the resource + * @property {string} [value] The name of the resource + * @property {string} [localizedValue] The localized name of the resource */ constructor() { } diff --git a/lib/services/containerinstanceManagement/lib/models/volume.js b/lib/services/containerinstanceManagement/lib/models/volume.js index c092412d6a..4bb1a14a15 100644 --- a/lib/services/containerinstanceManagement/lib/models/volume.js +++ b/lib/services/containerinstanceManagement/lib/models/volume.js @@ -17,25 +17,25 @@ class Volume { /** * Create a Volume. - * @member {string} name The name of the volume. - * @member {object} [azureFile] The Azure File volume. - * @member {string} [azureFile.shareName] The name of the Azure File share to - * be mounted as a volume. - * @member {boolean} [azureFile.readOnly] The flag indicating whether the + * @property {string} name The name of the volume. + * @property {object} [azureFile] The Azure File volume. + * @property {string} [azureFile.shareName] The name of the Azure File share + * to be mounted as a volume. + * @property {boolean} [azureFile.readOnly] The flag indicating whether the * Azure File shared mounted as a volume is read-only. - * @member {string} [azureFile.storageAccountName] The name of the storage + * @property {string} [azureFile.storageAccountName] The name of the storage * account that contains the Azure File share. - * @member {string} [azureFile.storageAccountKey] The storage account access - * key used to access the Azure File share. - * @member {object} [emptyDir] The empty directory volume. - * @member {object} [secret] The secret volume. - * @member {object} [gitRepo] The git repo volume. - * @member {string} [gitRepo.directory] Target directory name. Must not + * @property {string} [azureFile.storageAccountKey] The storage account + * access key used to access the Azure File share. + * @property {object} [emptyDir] The empty directory volume. + * @property {object} [secret] The secret volume. + * @property {object} [gitRepo] The git repo volume. + * @property {string} [gitRepo.directory] Target directory name. Must not * contain or start with '..'. If '.' is supplied, the volume directory will * be the git repository. Otherwise, if specified, the volume will contain * the git repository in the subdirectory with the given name. - * @member {string} [gitRepo.repository] Repository URL - * @member {string} [gitRepo.revision] Commit hash for the specified + * @property {string} [gitRepo.repository] Repository URL + * @property {string} [gitRepo.revision] Commit hash for the specified * revision. */ constructor() { diff --git a/lib/services/containerinstanceManagement/lib/models/volumeMount.js b/lib/services/containerinstanceManagement/lib/models/volumeMount.js index 52203a7a45..a9b447bb88 100644 --- a/lib/services/containerinstanceManagement/lib/models/volumeMount.js +++ b/lib/services/containerinstanceManagement/lib/models/volumeMount.js @@ -17,11 +17,11 @@ class VolumeMount { /** * Create a VolumeMount. - * @member {string} name The name of the volume mount. - * @member {string} mountPath The path within the container where the volume - * should be mounted. Must not contain colon (:). - * @member {boolean} [readOnly] The flag indicating whether the volume mount - * is read-only. + * @property {string} name The name of the volume mount. + * @property {string} mountPath The path within the container where the + * volume should be mounted. Must not contain colon (:). + * @property {boolean} [readOnly] The flag indicating whether the volume + * mount is read-only. */ constructor() { }