diff --git a/lib/services/edgegatewayManagement/lib/dataBoxEdgeManagementClient.d.ts b/lib/services/edgegatewayManagement/lib/dataBoxEdgeManagementClient.d.ts index d1de5568b7..69f7437cdd 100644 --- a/lib/services/edgegatewayManagement/lib/dataBoxEdgeManagementClient.d.ts +++ b/lib/services/edgegatewayManagement/lib/dataBoxEdgeManagementClient.d.ts @@ -60,6 +60,7 @@ export default class DataBoxEdgeManagementClient extends AzureServiceClient { devices: operations.Devices; alerts: operations.Alerts; bandwidthSchedules: operations.BandwidthSchedules; + jobs: operations.Jobs; operationsStatus: operations.OperationsStatus; orders: operations.Orders; roles: operations.Roles; diff --git a/lib/services/edgegatewayManagement/lib/dataBoxEdgeManagementClient.js b/lib/services/edgegatewayManagement/lib/dataBoxEdgeManagementClient.js index 56f95154c8..c779a3b218 100644 --- a/lib/services/edgegatewayManagement/lib/dataBoxEdgeManagementClient.js +++ b/lib/services/edgegatewayManagement/lib/dataBoxEdgeManagementClient.js @@ -50,7 +50,7 @@ class DataBoxEdgeManagementClient extends ServiceClient { super(credentials, options); - this.apiVersion = '2018-07-01'; + this.apiVersion = '2019-03-01'; this.acceptLanguage = 'en-US'; this.longRunningOperationRetryTimeout = 30; this.generateClientRequestId = true; @@ -76,6 +76,7 @@ class DataBoxEdgeManagementClient extends ServiceClient { this.devices = new operations.Devices(this); this.alerts = new operations.Alerts(this); this.bandwidthSchedules = new operations.BandwidthSchedules(this); + this.jobs = new operations.Jobs(this); this.operationsStatus = new operations.OperationsStatus(this); this.orders = new operations.Orders(this); this.roles = new operations.Roles(this); diff --git a/lib/services/edgegatewayManagement/lib/models/aRMBaseModel.js b/lib/services/edgegatewayManagement/lib/models/aRMBaseModel.js index 5c7c4084fa..b180d2f1a6 100644 --- a/lib/services/edgegatewayManagement/lib/models/aRMBaseModel.js +++ b/lib/services/edgegatewayManagement/lib/models/aRMBaseModel.js @@ -21,7 +21,7 @@ class ARMBaseModel extends models['BaseResource'] { /** * Create a ARMBaseModel. * @property {string} [id] The path ID that uniquely identifies the object. - * @property {string} [name] The name of the object. + * @property {string} [name] The object name. * @property {string} [type] The hierarchical type of the object. */ constructor() { diff --git a/lib/services/edgegatewayManagement/lib/models/address.js b/lib/services/edgegatewayManagement/lib/models/address.js index 16ea8facc9..fc921f8401 100644 --- a/lib/services/edgegatewayManagement/lib/models/address.js +++ b/lib/services/edgegatewayManagement/lib/models/address.js @@ -18,8 +18,8 @@ class Address { /** * Create a Address. * @property {string} addressLine1 The address line1. - * @property {string} addressLine2 The address line2. - * @property {string} addressLine3 The address line3. + * @property {string} [addressLine2] The address line2. + * @property {string} [addressLine3] The address line3. * @property {string} postalCode The postal code. * @property {string} city The city name. * @property {string} state The state name. @@ -50,14 +50,14 @@ class Address { } }, addressLine2: { - required: true, + required: false, serializedName: 'addressLine2', type: { name: 'String' } }, addressLine3: { - required: true, + required: false, serializedName: 'addressLine3', type: { name: 'String' diff --git a/lib/services/edgegatewayManagement/lib/models/alert.js b/lib/services/edgegatewayManagement/lib/models/alert.js index f37a53606b..096a786664 100644 --- a/lib/services/edgegatewayManagement/lib/models/alert.js +++ b/lib/services/edgegatewayManagement/lib/models/alert.js @@ -20,20 +20,17 @@ const models = require('./index'); class Alert extends models['ARMBaseModel'] { /** * Create a Alert. - * @property {string} [title] Title of the alert. - * @property {string} [alertType] Type of the alert. - * @property {date} [appearedAtDateTime] UTC time at which the alert - * appeared. - * @property {string} [recommendation] Recommendation for acting on the - * alert. + * @property {string} [title] Alert title. + * @property {string} [alertType] Alert type. + * @property {date} [appearedAtDateTime] UTC time when the alert appeared. + * @property {string} [recommendation] Alert recommendation. * @property {string} [severity] Severity of the alert. Possible values * include: 'Informational', 'Warning', 'Critical' * @property {object} [errorDetails] Error details of the alert. * @property {string} [errorDetails.errorCode] Error code. * @property {string} [errorDetails.errorMessage] Error Message. * @property {number} [errorDetails.occurrences] Number of occurrences. - * @property {object} [detailedInformation] Detailed information about the - * alert. + * @property {object} [detailedInformation] Alert details. */ constructor() { super(); diff --git a/lib/services/edgegatewayManagement/lib/models/alertList.js b/lib/services/edgegatewayManagement/lib/models/alertList.js index e480cca06b..cb7bd8b09c 100644 --- a/lib/services/edgegatewayManagement/lib/models/alertList.js +++ b/lib/services/edgegatewayManagement/lib/models/alertList.js @@ -11,7 +11,7 @@ 'use strict'; /** - * Collection of Alerts. + * Collection of alerts. */ class AlertList extends Array { /** diff --git a/lib/services/edgegatewayManagement/lib/models/asymmetricEncryptedSecret.js b/lib/services/edgegatewayManagement/lib/models/asymmetricEncryptedSecret.js index b884481173..f9c465b5c6 100644 --- a/lib/services/edgegatewayManagement/lib/models/asymmetricEncryptedSecret.js +++ b/lib/services/edgegatewayManagement/lib/models/asymmetricEncryptedSecret.js @@ -18,8 +18,8 @@ class AsymmetricEncryptedSecret { /** * Create a AsymmetricEncryptedSecret. * @property {string} value The value of the secret. - * @property {string} [encryptionCertThumbprint] Thumbprint certificate that - * was used to encrypt "Value". If the value in unencrypted, it will be null. + * @property {string} [encryptionCertThumbprint] Thumbprint certificate used + * to encrypt \"Value\". If the value is unencrypted, it will be null. * @property {string} encryptionAlgorithm The algorithm used to encrypt * "Value". Possible values include: 'None', 'AES256', 'RSAES_PKCS1_v_1_5' */ diff --git a/lib/services/edgegatewayManagement/lib/models/authentication.js b/lib/services/edgegatewayManagement/lib/models/authentication.js index e309d3659b..68211ddd14 100644 --- a/lib/services/edgegatewayManagement/lib/models/authentication.js +++ b/lib/services/edgegatewayManagement/lib/models/authentication.js @@ -19,13 +19,13 @@ class Authentication { * Create a Authentication. * @property {object} [symmetricKey] Symmetric key for authentication. * @property {object} [symmetricKey.connectionString] Connection string based - * on symmetric key. + * on the symmetric key. * @property {string} [symmetricKey.connectionString.value] The value of the * secret. * @property {string} * [symmetricKey.connectionString.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it + * will be null. * @property {string} [symmetricKey.connectionString.encryptionAlgorithm] The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' diff --git a/lib/services/edgegatewayManagement/lib/models/azureContainerInfo.js b/lib/services/edgegatewayManagement/lib/models/azureContainerInfo.js index 074812b056..a207600b8f 100644 --- a/lib/services/edgegatewayManagement/lib/models/azureContainerInfo.js +++ b/lib/services/edgegatewayManagement/lib/models/azureContainerInfo.js @@ -17,10 +17,10 @@ class AzureContainerInfo { /** * Create a AzureContainerInfo. - * @property {string} storageAccountCredentialId ID of the Storage account - * credential to be used for accessing storage. + * @property {string} storageAccountCredentialId ID of the storage account + * credential used to access storage. * @property {string} containerName Container name (Based on the data format - * specified, represents the name of Azure file/ Page blob / Block blob). + * specified, this represents the name of Azure Files/Page blob/Block blob). * @property {string} dataFormat Storage format used for the file represented * by the share. Possible values include: 'BlockBlob', 'PageBlob', * 'AzureFile' diff --git a/lib/services/edgegatewayManagement/lib/models/clientAccessRight.js b/lib/services/edgegatewayManagement/lib/models/clientAccessRight.js index e18f3af100..e8e9942261 100644 --- a/lib/services/edgegatewayManagement/lib/models/clientAccessRight.js +++ b/lib/services/edgegatewayManagement/lib/models/clientAccessRight.js @@ -11,14 +11,14 @@ 'use strict'; /** - * The mapping between a particular client ip and the type of access client has + * The mapping between a particular client IP and the type of access client has * on the NFS share. * */ class ClientAccessRight { /** * Create a ClientAccessRight. - * @property {string} client Ip of the client. + * @property {string} client IP of the client. * @property {string} accessPermission Type of access to be allowed for the * client. Possible values include: 'NoAccess', 'ReadOnly', 'ReadWrite' */ diff --git a/lib/services/edgegatewayManagement/lib/models/contactDetails.js b/lib/services/edgegatewayManagement/lib/models/contactDetails.js index 38dcfb47d2..83a27c3004 100644 --- a/lib/services/edgegatewayManagement/lib/models/contactDetails.js +++ b/lib/services/edgegatewayManagement/lib/models/contactDetails.js @@ -17,10 +17,10 @@ class ContactDetails { /** * Create a ContactDetails. - * @property {string} contactPerson Gets or sets the contact person. - * @property {string} companyName Gets or sets the name of the company. - * @property {string} phone Gets or sets the phone number. - * @property {array} emailList Gets or sets the email list. + * @property {string} contactPerson The contact person name. + * @property {string} companyName The name of the company. + * @property {string} phone The phone number. + * @property {array} emailList The email list. */ constructor() { } diff --git a/lib/services/edgegatewayManagement/lib/models/dataBoxEdgeDevice.js b/lib/services/edgegatewayManagement/lib/models/dataBoxEdgeDevice.js index 5d2a04ceba..f6c606ea0b 100644 --- a/lib/services/edgegatewayManagement/lib/models/dataBoxEdgeDevice.js +++ b/lib/services/edgegatewayManagement/lib/models/dataBoxEdgeDevice.js @@ -20,20 +20,19 @@ const models = require('./index'); class DataBoxEdgeDevice extends models['ARMBaseModel'] { /** * Create a DataBoxEdgeDevice. - * @property {string} location The location of the device. This will be one - * of the supported and registered Azure Geo Regions (e.g. West US, East US, - * Southeast Asia, etc.). The geo region of a device cannot be changed once - * it is created, but if an identical geo region is specified on update the - * request will succeed. + * @property {string} location The location of the device. This is a + * supported and registered Azure geographical region (for example, West US, + * East US, or Southeast Asia). The geographical region of a device cannot be + * changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * @property {object} [tags] The list of tags that describe the device. These - * tags can be used in viewing and grouping this device (across resource - * groups). - * @property {object} [sku] The sku type. - * @property {string} [sku.name] Sku name. Possible values include: + * tags can be used to view and group this device (across resource groups). + * @property {object} [sku] The SKU type. + * @property {string} [sku.name] SKU name. Possible values include: * 'Gateway', 'Edge' * @property {string} [sku.tier] The SKU tier. This is based on the SKU name. * Possible values include: 'Standard' - * @property {string} [etag] The etag of the devices. + * @property {string} [etag] The etag for the devices. * @property {string} [dataBoxEdgeDeviceStatus] The status of the Data Box * Edge/Gateway device. Possible values include: 'ReadyToSetup', 'Online', * 'Offline', 'NeedsAttention', 'Disconnected', 'PartiallyDisconnected' diff --git a/lib/services/edgegatewayManagement/lib/models/dataBoxEdgeDeviceExtendedInfo.js b/lib/services/edgegatewayManagement/lib/models/dataBoxEdgeDeviceExtendedInfo.js index fda9f23159..a32eaeb4ca 100644 --- a/lib/services/edgegatewayManagement/lib/models/dataBoxEdgeDeviceExtendedInfo.js +++ b/lib/services/edgegatewayManagement/lib/models/dataBoxEdgeDeviceExtendedInfo.js @@ -26,7 +26,7 @@ class DataBoxEdgeDeviceExtendedInfo extends models['ARMBaseModel'] { * that was used to encrypt the Channel Integrity Key (CIK). * @property {string} [encryptionKey] The Channel Integrity Key (CIK) of the * device. - * @property {string} [resourceKey] The Resource Id of the Resource. + * @property {string} [resourceKey] The Resource ID of the Resource. */ constructor() { super(); diff --git a/lib/services/edgegatewayManagement/lib/models/fileEventTrigger.js b/lib/services/edgegatewayManagement/lib/models/fileEventTrigger.js index 11f6f7f914..1caa43df76 100644 --- a/lib/services/edgegatewayManagement/lib/models/fileEventTrigger.js +++ b/lib/services/edgegatewayManagement/lib/models/fileEventTrigger.js @@ -20,14 +20,14 @@ const models = require('./index'); class FileEventTrigger extends models['Trigger'] { /** * Create a FileEventTrigger. - * @property {object} [sourceInfo] File event source details. + * @property {object} sourceInfo File event source details. * @property {string} [sourceInfo.shareId] File share ID. - * @property {object} [sinkInfo] Role Sink info. + * @property {object} sinkInfo Role sink info. * @property {string} [sinkInfo.roleId] Compute role ID. - * @property {string} [customContextTag] Custom context tag, typically used - * to co-relate the trigger against its usage. Eg. If a PeriodicTimer trigger - * may be intended for certain specific IOT modules in device, the tag can be - * the name/image url of the module. + * @property {string} [customContextTag] A custom context tag typically used + * to correlate the trigger against its usage. For example, if a periodic + * timer trigger is intended for certain specific IoT modules in the device, + * the tag can be the name or the image URL of the module. */ constructor() { super(); @@ -85,7 +85,7 @@ class FileEventTrigger extends models['Trigger'] { } }, sourceInfo: { - required: false, + required: true, serializedName: 'properties.sourceInfo', type: { name: 'Composite', @@ -93,7 +93,7 @@ class FileEventTrigger extends models['Trigger'] { } }, sinkInfo: { - required: false, + required: true, serializedName: 'properties.sinkInfo', type: { name: 'Composite', diff --git a/lib/services/edgegatewayManagement/lib/models/index.d.ts b/lib/services/edgegatewayManagement/lib/models/index.d.ts index edccc59d1c..f80613b12b 100644 --- a/lib/services/edgegatewayManagement/lib/models/index.d.ts +++ b/lib/services/edgegatewayManagement/lib/models/index.d.ts @@ -26,11 +26,11 @@ export interface Address { /** * The address line2. */ - addressLine2: string; + addressLine2?: string; /** * The address line3. */ - addressLine3: string; + addressLine3?: string; /** * The postal code. */ @@ -76,7 +76,7 @@ export interface ARMBaseModel extends BaseResource { */ readonly id?: string; /** - * The name of the object. + * The object name. */ readonly name?: string; /** @@ -90,19 +90,19 @@ export interface ARMBaseModel extends BaseResource { */ export interface Alert extends ARMBaseModel { /** - * Title of the alert. + * Alert title. */ readonly title?: string; /** - * Type of the alert. + * Alert type. */ readonly alertType?: string; /** - * UTC time at which the alert appeared. + * UTC time when the alert appeared. */ readonly appearedAtDateTime?: Date; /** - * Recommendation for acting on the alert. + * Alert recommendation. */ readonly recommendation?: string; /** @@ -114,7 +114,7 @@ export interface Alert extends ARMBaseModel { */ readonly errorDetails?: AlertErrorDetails; /** - * Detailed information about the alert. + * Alert details. */ readonly detailedInformation?: { [propertyName: string]: string }; } @@ -128,8 +128,8 @@ export interface AsymmetricEncryptedSecret { */ value: string; /** - * Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will - * be null. + * Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be + * null. */ encryptionCertThumbprint?: string; /** @@ -140,11 +140,11 @@ export interface AsymmetricEncryptedSecret { } /** - * Symmetric Key for authentication. + * Symmetric key for authentication. */ export interface SymmetricKey { /** - * Connection string based on symmetric key. + * Connection string based on the symmetric key. */ connectionString?: AsymmetricEncryptedSecret; } @@ -164,12 +164,12 @@ export interface Authentication { */ export interface AzureContainerInfo { /** - * ID of the Storage account credential to be used for accessing storage. + * ID of the storage account credential used to access storage. */ storageAccountCredentialId: string; /** - * Container name (Based on the data format specified, represents the name of Azure file/ Page - * blob / Block blob). + * Container name (Based on the data format specified, this represents the name of Azure + * Files/Page blob/Block blob). */ containerName: string; /** @@ -202,11 +202,11 @@ export interface BandwidthSchedule extends ARMBaseModel { } /** - * The mapping between a particular client ip and the type of access client has on the NFS share. + * The mapping between a particular client IP and the type of access client has on the NFS share. */ export interface ClientAccessRight { /** - * Ip of the client. + * IP of the client. */ client: string; /** @@ -221,19 +221,19 @@ export interface ClientAccessRight { */ export interface ContactDetails { /** - * Gets or sets the contact person. + * The contact person name. */ contactPerson: string; /** - * Gets or sets the name of the company. + * The name of the company. */ companyName: string; /** - * Gets or sets the phone number. + * The phone number. */ phone: string; /** - * Gets or sets the email list. + * The email list. */ emailList: string[]; } @@ -243,7 +243,7 @@ export interface ContactDetails { */ export interface Sku { /** - * Sku name. Possible values include: 'Gateway', 'Edge' + * SKU name. Possible values include: 'Gateway', 'Edge' */ name?: string; /** @@ -257,23 +257,23 @@ export interface Sku { */ export interface DataBoxEdgeDevice extends ARMBaseModel { /** - * The location of the device. This will be one of the supported and registered Azure Geo Regions - * (e.g. West US, East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update the request will - * succeed. + * The location of the device. This is a supported and registered Azure geographical region (for + * example, West US, East US, or Southeast Asia). The geographical region of a device cannot be + * changed once it is created, but if an identical geographical region is specified on update, + * the request will succeed. */ location: string; /** - * The list of tags that describe the device. These tags can be used in viewing and grouping this + * The list of tags that describe the device. These tags can be used to view and group this * device (across resource groups). */ tags?: { [propertyName: string]: string }; /** - * The sku type. + * The SKU type. */ sku?: Sku; /** - * The etag of the devices. + * The etag for the devices. */ etag?: string; /** @@ -348,7 +348,7 @@ export interface DataBoxEdgeDeviceExtendedInfo extends ARMBaseModel { */ encryptionKey?: string; /** - * The Resource Id of the Resource. + * The Resource ID of the Resource. */ readonly resourceKey?: string; } @@ -400,29 +400,29 @@ export interface FileEventTrigger extends Trigger { /** * File event source details. */ - sourceInfo?: FileSourceInfo; + sourceInfo: FileSourceInfo; /** - * Role Sink info. + * Role sink info. */ - sinkInfo?: RoleSinkInfo; + sinkInfo: RoleSinkInfo; /** - * Custom context tag, typically used to co-relate the trigger against its usage. Eg. If a - * PeriodicTimer trigger may be intended for certain specific IOT modules in device, the tag can - * be the name/image url of the module. + * A custom context tag typically used to correlate the trigger against its usage. For example, + * if a periodic timer trigger is intended for certain specific IoT modules in the device, the + * tag can be the name or the image URL of the module. */ customContextTag?: string; } /** - * Metadata of IoT device/IoT edge device to be configured. + * Metadata of IoT device/IoT Edge device to be configured. */ export interface IoTDeviceInfo { /** - * Id of the IoT device/edge device. + * ID of the IoT device/edge device. */ deviceId: string; /** - * Host name for IoT hub which is associated to the device. + * Host name for the IoT hub associated to the device. */ ioTHostHub: string; /** @@ -436,7 +436,7 @@ export interface IoTDeviceInfo { */ export interface MountPointMap { /** - * ID of the share which is mounted to role VM. + * ID of the share mounted to the role VM. */ shareId: string; /** @@ -468,7 +468,7 @@ export interface Role extends ARMBaseModel { */ export interface IoTRole extends Role { /** - * Host OS which IoT role support. Possible values include: 'Windows', 'Linux' + * Host OS supported by the IoT role. Possible values include: 'Windows', 'Linux' */ hostPlatform: string; /** @@ -538,13 +538,13 @@ export interface JobErrorItem { */ readonly code?: string; /** - * The message intended to describe the error in detail. + * The message that describes the error in detail. */ readonly message?: string; } /** - * The job error information containing List of JobErrorItem. + * The job error information containing the list of job errors. */ export interface JobErrorDetails { /** @@ -556,7 +556,7 @@ export interface JobErrorDetails { */ readonly code?: string; /** - * The message intended to describe the error in detail. + * The message that describes the error in detail. */ readonly message?: string; } @@ -593,11 +593,11 @@ export interface UpdateDownloadProgress { } /** - * Details about the progress during installation of updates. + * Progress details during installation of updates. */ export interface UpdateInstallProgress { /** - * Percentage of completion. + * Percentage completed. */ readonly percentComplete?: number; /** @@ -632,19 +632,19 @@ export interface Job { */ readonly status?: string; /** - * The UTC datetime at which the job was started. + * The UTC date and time at which the job started. */ readonly startTime?: Date; /** - * The UTC datetime at which the job completed. + * The UTC date and time at which the job completed. */ readonly endTime?: Date; /** - * The percentage of the job that is already complete. + * The percentage of the job that is complete. */ readonly percentComplete?: number; /** - * The Error details. + * The error details. */ readonly error?: JobErrorDetails; /** @@ -672,16 +672,16 @@ export interface Job { */ readonly totalRefreshErrors?: number; /** - * Local Share/Remote Container relative path to the error manifest file of the refresh. + * Local share/remote container relative path to the error manifest file of the refresh. */ readonly errorManifestFile?: string; /** - * ARM id of the Share on which the Refresh operation was done. + * ARM ID of the share that was refreshed. */ readonly shareId?: string; /** - * If only subfolders need to be refreshed, then the sub folder path inside the share. Empty - * otherwise. + * If only subfolders need to be refreshed, then the subfolder path inside the share. (The path + * is empty if there are no subfolders.) */ folder?: string; } @@ -735,7 +735,7 @@ export interface MetricSpecificationV1 { */ dimensions?: MetricDimensionV1[]; /** - * set true to fill the gaps with zero. + * Set true to fill the gaps with zero. */ fillGapWithZero?: boolean; /** @@ -791,7 +791,7 @@ export interface NetworkAdapter { */ readonly nodeId?: string; /** - * Network Adapter Name. + * Network adapter name. */ readonly networkAdapterName?: string; /** @@ -799,11 +799,11 @@ export interface NetworkAdapter { */ readonly label?: string; /** - * MAC Address. + * MAC address. */ readonly macAddress?: string; /** - * Link Speed. + * Link speed. */ readonly linkSpeed?: number; /** @@ -811,12 +811,12 @@ export interface NetworkAdapter { */ readonly status?: string; /** - * Value indicating whether this adapter is RDMA Capable. Possible values include: 'Incapable', + * Value indicating whether this adapter is RDMA capable. Possible values include: 'Incapable', * 'Capable' */ rdmaStatus?: string; /** - * Value indicating whether this adapter has DHCP Enabled. Possible values include: 'Disabled', + * Value indicating whether this adapter has DHCP enabled. Possible values include: 'Disabled', * 'Enabled' */ dhcpStatus?: string; @@ -833,13 +833,13 @@ export interface NetworkAdapter { */ readonly ipv6LinkLocalAddress?: string; /** - * The list DNS Servers of the device. + * The list of DNS Servers of the device. */ readonly dnsServers?: string[]; } /** - * The NetworkSettings of a device. + * The network settings of a device. */ export interface NetworkSettings extends ARMBaseModel { /** @@ -889,7 +889,7 @@ export interface Operation { */ name?: string; /** - * Properties to displayed for the operation. + * Properties displayed for the operation. */ display?: OperationDisplay; /** @@ -907,9 +907,9 @@ export interface Operation { */ export interface OrderStatus { /** - * Status of the order pertaining to the allowed StatusTypes. Possible values include: - * 'Untracked', 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', - * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', 'ReturnInitiated', + * Status of the order as per the allowed status types. Possible values include: 'Untracked', + * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', 'Arriving', + * 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', 'ReturnInitiated', * 'AwaitingReturnShipment', 'ShippedBack', 'CollectedAtMicrosoft' */ status: string; @@ -952,15 +952,15 @@ export interface Order extends ARMBaseModel { /** * The contact details. */ - contactInformation?: ContactDetails; + contactInformation: ContactDetails; /** * The shipping address. */ - shippingAddress?: Address; + shippingAddress: Address; /** - * Current status of the Order. + * Current status of the order. */ - changeStatusTo?: OrderStatus; + currentStatus?: OrderStatus; /** * List of status changes in the order. */ @@ -970,13 +970,13 @@ export interface Order extends ARMBaseModel { */ readonly serialNumber?: string; /** - * Tracking information related to the packages being delivered to the customer whether original - * or replacement devices. + * Tracking information for the package delivered to the customer whether it has an original or a + * replacement device. */ readonly deliveryTrackingInfo?: TrackingInfo[]; /** - * Tracking information related to the package being returned from the customer whether original - * or replacement devices. + * Tracking information for the package returned from the customer whether it has an original or + * a replacement device. */ readonly returnTrackingInfo?: TrackingInfo[]; } @@ -986,17 +986,17 @@ export interface Order extends ARMBaseModel { */ export interface PeriodicTimerSourceInfo { /** - * Time time [UTC] of the day, from which the trigger will be valid. Schedule will be computed - * with reference to the time specified. + * The time of the day that results in a valid trigger. Schedule is computed with reference to + * the time specified. */ startTime: Date; /** - * Periodic frequency at which timer event needs to be raised. Supports Daily, Hourly, Minutes + * Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, * and seconds. */ schedule: string; /** - * Topic with which periodic events needs to be published to IOT device. + * Topic where periodic events are published to IoT device. */ topic?: string; } @@ -1008,15 +1008,15 @@ export interface PeriodicTimerEventTrigger extends Trigger { /** * Periodic timer details. */ - sourceInfo?: PeriodicTimerSourceInfo; + sourceInfo: PeriodicTimerSourceInfo; /** - * Role Sink info. + * Role Sink information. */ - sinkInfo?: RoleSinkInfo; + sinkInfo: RoleSinkInfo; /** - * Custom context tag, typically used to co-relate the trigger against its usage. Eg. If a - * PeriodicTimer trigger may be intended for certain specific IOT modules in device, the tag can - * be the name/image url of the module. + * A custom context tag typically used to correlate the trigger against its usage. For example, + * if a periodic timer trigger is intended for certain specific IoT modules in the device, the + * tag can be the name or the image URL of the module. */ customContextTag?: string; } @@ -1026,24 +1026,23 @@ export interface PeriodicTimerEventTrigger extends Trigger { */ export interface RefreshDetails { /** - * If a RefreshShare job is currently inprogress on this share - this field indicates the ArmId - * of that job. Empty otherwise. + * If a refresh share job is currently in progress on this share, this field indicates the ARM + * resource ID of that job. The field is empty if no job is in progress. */ inProgressRefreshJobId?: string; /** - * Indicates the job completed time of the last refresh job on this particular share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular share, if any.This + * could be a failed job or a successful job. */ lastCompletedRefreshJobTimeInUTC?: Date; /** * Indicates the relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. */ errorManifestFile?: string; /** - * Indicates the id of the last refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * Indicates the id of the last refresh job on this particular share,if any. This could be a + * failed job or a successful job. */ lastJob?: string; } @@ -1054,18 +1053,18 @@ export interface RefreshDetails { export interface SecuritySettings extends ARMBaseModel { /** * Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to - * log into the local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special characters. + * sign into the local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and special characters. */ deviceAdminPassword: AsymmetricEncryptedSecret; } /** - * The mapping between a particular user and the type of access they have on the SMB share. + * The mapping between a particular user and the access type on the SMB share. */ export interface UserAccessRight { /** - * Id of the user (already existing in the device). + * User ID (already existing in the device). */ userId: string; /** @@ -1099,11 +1098,11 @@ export interface Share extends ARMBaseModel { */ accessProtocol: string; /** - * Mapping of Users and corresponding access rights on the share (mandatory for SMB protocol). + * Mapping of users and corresponding access rights on the share (required for SMB protocol). */ userAccessRights?: UserAccessRight[]; /** - * List of IP addresses and corresponding access rights on the share(mandatory for NFS protocol). + * List of IP addresses and corresponding access rights on the share(required for NFS protocol). */ clientAccessRights?: ClientAccessRight[]; /** @@ -1126,7 +1125,7 @@ export interface Share extends ARMBaseModel { */ export interface ShareAccessRight { /** - * Id of the share. + * The share ID. */ shareId: string; /** @@ -1145,7 +1144,7 @@ export interface StorageAccountCredential extends ARMBaseModel { */ alias: string; /** - * UserName for the storage account. + * Username for the storage account. */ userName?: string; /** @@ -1153,8 +1152,8 @@ export interface StorageAccountCredential extends ARMBaseModel { */ accountKey?: AsymmetricEncryptedSecret; /** - * ConnectionString for the storage account. This needs to be specified if UserName/AccountKey - * are not specified. + * Connection string for the storage account. Use this string if username and account key are not + * specified. */ connectionString?: string; /** @@ -1178,11 +1177,11 @@ export interface StorageAccountCredential extends ARMBaseModel { */ export interface UpdateSummary extends ARMBaseModel { /** - * The current version of the device, of format: 1.2.17312.13. + * The current version of the device in format: 1.2.17312.13.", */ deviceVersionNumber?: string; /** - * The current version of the device represented in text format. + * The current version of the device in text format. */ friendlyDeviceVersionName?: string; /** @@ -1202,8 +1201,7 @@ export interface UpdateSummary extends ARMBaseModel { */ readonly lastCompletedInstallJobDateTime?: Date; /** - * Count of updates that are available for the current device version as per the last scan on the - * device. + * The number of updates available for the current device version as per the last device scan. */ readonly totalNumberOfUpdatesAvailable?: number; /** @@ -1215,8 +1213,8 @@ export interface UpdateSummary extends ARMBaseModel { */ readonly totalNumberOfUpdatesPendingInstall?: number; /** - * Indicates if updates are available and at least one of the update items detected needs a - * reboot. Possible values include: 'NeverReboots', 'RequiresReboot', 'RequestReboot' + * Indicates if updates are available and at least one of the updates needs a reboot. Possible + * values include: 'NeverReboots', 'RequiresReboot', 'RequestReboot' */ readonly rebootBehavior?: string; /** @@ -1224,11 +1222,11 @@ export interface UpdateSummary extends ARMBaseModel { */ readonly ongoingUpdateOperation?: string; /** - * The Job ID of the download job if a download is in progress. + * The job ID of the download job in progress. */ readonly inProgressDownloadJobId?: string; /** - * The Job ID of the install job if an install is in progress. + * The job ID of the install job in progress. */ readonly inProgressInstallJobId?: string; /** @@ -1240,7 +1238,7 @@ export interface UpdateSummary extends ARMBaseModel { */ readonly inProgressInstallJobStartedDateTime?: Date; /** - * The list of update titles which are available for install. + * The list of updates available for install. */ readonly updateTitles?: string[]; /** @@ -1250,7 +1248,7 @@ export interface UpdateSummary extends ARMBaseModel { } /** - * The Upload certificate request. + * The upload certificate request. */ export interface UploadCertificateRequest { /** @@ -1268,11 +1266,11 @@ export interface UploadCertificateRequest { */ export interface UploadCertificateResponse { /** - * Specifies the Authentication type. Possible values include: 'Invalid', 'AzureActiveDirectory' + * Specifies authentication type. Possible values include: 'Invalid', 'AzureActiveDirectory' */ authType?: string; /** - * The resource ID of the edge device. + * The resource ID of the Data Box Edge/Gateway device. */ resourceId: string; /** @@ -1288,21 +1286,21 @@ export interface UploadCertificateResponse { */ servicePrincipalClientId: string; /** - * Azure Active Directory service principal Object ID. + * Azure Active Directory service principal object ID. */ servicePrincipalObjectId: string; /** - * The Azure Management Endpoint Audience. + * The azure management endpoint audience. */ azureManagementEndpointAudience: string; } /** - * Represents a user who has access to one or more shares on the Edge storage device. + * Represents a user who has access to one or more shares on the Data Box Edge/Gateway device. */ export interface User extends ARMBaseModel { /** - * The details of the password specified for the user. + * The password details. */ encryptedPassword?: AsymmetricEncryptedSecret; /** @@ -1313,7 +1311,7 @@ export interface User extends ARMBaseModel { } /** - * Class for set of operations used for discovery of available provider operations. + * The list of operations used for the discovery of available provider operations. */ export interface OperationsList extends Array { /** @@ -1333,7 +1331,7 @@ export interface DataBoxEdgeDeviceList extends Array { } /** - * Collection of Alerts. + * Collection of alerts. */ export interface AlertList extends Array { /** @@ -1363,7 +1361,7 @@ export interface OrderList extends Array { } /** - * Collection of all role on the data box edge device. + * Collection of all the roles on the Data Box Edge device. */ export interface RoleList extends Array { /** @@ -1373,7 +1371,7 @@ export interface RoleList extends Array { } /** - * Collection of all shares on the Data Box Edge/Gateway device. + * Collection of all the shares on the Data Box Edge/Gateway device. */ export interface ShareList extends Array { /** @@ -1383,7 +1381,7 @@ export interface ShareList extends Array { } /** - * The collection of storage account credential entities. + * The collection of storage account credentials. */ export interface StorageAccountCredentialList extends Array { /** diff --git a/lib/services/edgegatewayManagement/lib/models/ioTDeviceInfo.js b/lib/services/edgegatewayManagement/lib/models/ioTDeviceInfo.js index 96e8f37459..70a7e21443 100644 --- a/lib/services/edgegatewayManagement/lib/models/ioTDeviceInfo.js +++ b/lib/services/edgegatewayManagement/lib/models/ioTDeviceInfo.js @@ -11,25 +11,25 @@ 'use strict'; /** - * Metadata of IoT device/IoT edge device to be configured. + * Metadata of IoT device/IoT Edge device to be configured. * */ class IoTDeviceInfo { /** * Create a IoTDeviceInfo. - * @property {string} deviceId Id of the IoT device/edge device. - * @property {string} ioTHostHub Host name for IoT hub which is associated to - * the device. + * @property {string} deviceId ID of the IoT device/edge device. + * @property {string} ioTHostHub Host name for the IoT hub associated to the + * device. * @property {object} [authentication] IoT device authentication info. * @property {object} [authentication.symmetricKey] Symmetric key for * authentication. * @property {object} [authentication.symmetricKey.connectionString] - * Connection string based on symmetric key. + * Connection string based on the symmetric key. * @property {string} [authentication.symmetricKey.connectionString.value] * The value of the secret. * @property {string} * [authentication.symmetricKey.connectionString.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * @property {string} * [authentication.symmetricKey.connectionString.encryptionAlgorithm] The diff --git a/lib/services/edgegatewayManagement/lib/models/ioTRole.js b/lib/services/edgegatewayManagement/lib/models/ioTRole.js index b3412b3af2..dfd595b261 100644 --- a/lib/services/edgegatewayManagement/lib/models/ioTRole.js +++ b/lib/services/edgegatewayManagement/lib/models/ioTRole.js @@ -20,27 +20,27 @@ const models = require('./index'); class IoTRole extends models['Role'] { /** * Create a IoTRole. - * @property {string} hostPlatform Host OS which IoT role support. Possible - * values include: 'Windows', 'Linux' + * @property {string} hostPlatform Host OS supported by the IoT role. + * Possible values include: 'Windows', 'Linux' * @property {object} ioTDeviceDetails IoT device metadata to which data box * edge device needs to be connected. - * @property {string} [ioTDeviceDetails.deviceId] Id of the IoT device/edge + * @property {string} [ioTDeviceDetails.deviceId] ID of the IoT device/edge * device. - * @property {string} [ioTDeviceDetails.ioTHostHub] Host name for IoT hub - * which is associated to the device. + * @property {string} [ioTDeviceDetails.ioTHostHub] Host name for the IoT hub + * associated to the device. * @property {object} [ioTDeviceDetails.authentication] IoT device * authentication info. * @property {object} [ioTDeviceDetails.authentication.symmetricKey] * Symmetric key for authentication. * @property {object} * [ioTDeviceDetails.authentication.symmetricKey.connectionString] Connection - * string based on symmetric key. + * string based on the symmetric key. * @property {string} * [ioTDeviceDetails.authentication.symmetricKey.connectionString.value] The * value of the secret. * @property {string} * [ioTDeviceDetails.authentication.symmetricKey.connectionString.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * @property {string} * [ioTDeviceDetails.authentication.symmetricKey.connectionString.encryptionAlgorithm] @@ -48,23 +48,23 @@ class IoTRole extends models['Role'] { * 'AES256', 'RSAES_PKCS1_v_1_5' * @property {object} ioTEdgeDeviceDetails IoT edge device to which the IoT * role needs to be configured. - * @property {string} [ioTEdgeDeviceDetails.deviceId] Id of the IoT + * @property {string} [ioTEdgeDeviceDetails.deviceId] ID of the IoT * device/edge device. - * @property {string} [ioTEdgeDeviceDetails.ioTHostHub] Host name for IoT hub - * which is associated to the device. + * @property {string} [ioTEdgeDeviceDetails.ioTHostHub] Host name for the IoT + * hub associated to the device. * @property {object} [ioTEdgeDeviceDetails.authentication] IoT device * authentication info. * @property {object} [ioTEdgeDeviceDetails.authentication.symmetricKey] * Symmetric key for authentication. * @property {object} * [ioTEdgeDeviceDetails.authentication.symmetricKey.connectionString] - * Connection string based on symmetric key. + * Connection string based on the symmetric key. * @property {string} * [ioTEdgeDeviceDetails.authentication.symmetricKey.connectionString.value] * The value of the secret. * @property {string} * [ioTEdgeDeviceDetails.authentication.symmetricKey.connectionString.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * @property {string} * [ioTEdgeDeviceDetails.authentication.symmetricKey.connectionString.encryptionAlgorithm] diff --git a/lib/services/edgegatewayManagement/lib/models/job.js b/lib/services/edgegatewayManagement/lib/models/job.js index f2dfe70505..0c0c0390f7 100644 --- a/lib/services/edgegatewayManagement/lib/models/job.js +++ b/lib/services/edgegatewayManagement/lib/models/job.js @@ -23,16 +23,17 @@ class Job { * @property {string} [status] The current status of the job. Possible values * include: 'Invalid', 'Running', 'Succeeded', 'Failed', 'Canceled', * 'Paused', 'Scheduled' - * @property {date} [startTime] The UTC datetime at which the job was + * @property {date} [startTime] The UTC date and time at which the job * started. - * @property {date} [endTime] The UTC datetime at which the job completed. + * @property {date} [endTime] The UTC date and time at which the job + * completed. * @property {number} [percentComplete] The percentage of the job that is - * already complete. - * @property {object} [error] The Error details. + * complete. + * @property {object} [error] The error details. * @property {array} [error.errorDetails] The error details. * @property {string} [error.code] The code intended for programmatic access. - * @property {string} [error.message] The message intended to describe the - * error in detail. + * @property {string} [error.message] The message that describes the error in + * detail. * @property {string} [jobType] The type of the job. Possible values include: * 'Invalid', 'ScanForUpdates', 'DownloadUpdates', 'InstallUpdates', * 'RefreshShare' @@ -57,20 +58,19 @@ class Job { * @property {number} [downloadProgress.numberOfUpdatesDownloaded] Number of * updates downloaded. * @property {object} [installProgress] The install progress. - * @property {number} [installProgress.percentComplete] Percentage of - * completion. + * @property {number} [installProgress.percentComplete] Percentage completed. * @property {number} [installProgress.numberOfUpdatesToInstall] Number of * updates to install. * @property {number} [installProgress.numberOfUpdatesInstalled] Number of * updates installed. * @property {number} [totalRefreshErrors] Total number of errors encountered * during the refresh process. - * @property {string} [errorManifestFile] Local Share/Remote Container + * @property {string} [errorManifestFile] Local share/remote container * relative path to the error manifest file of the refresh. - * @property {string} [shareId] ARM id of the Share on which the Refresh - * operation was done. + * @property {string} [shareId] ARM ID of the share that was refreshed. * @property {string} [folder] If only subfolders need to be refreshed, then - * the sub folder path inside the share. Empty otherwise. + * the subfolder path inside the share. (The path is empty if there are no + * subfolders.) */ constructor() { } diff --git a/lib/services/edgegatewayManagement/lib/models/jobErrorDetails.js b/lib/services/edgegatewayManagement/lib/models/jobErrorDetails.js index 64ba3db016..5dca0f7f94 100644 --- a/lib/services/edgegatewayManagement/lib/models/jobErrorDetails.js +++ b/lib/services/edgegatewayManagement/lib/models/jobErrorDetails.js @@ -11,7 +11,7 @@ 'use strict'; /** - * The job error information containing List of JobErrorItem. + * The job error information containing the list of job errors. * */ class JobErrorDetails { @@ -19,7 +19,7 @@ class JobErrorDetails { * Create a JobErrorDetails. * @property {array} [errorDetails] The error details. * @property {string} [code] The code intended for programmatic access. - * @property {string} [message] The message intended to describe the error in + * @property {string} [message] The message that describes the error in * detail. */ constructor() { diff --git a/lib/services/edgegatewayManagement/lib/models/jobErrorItem.js b/lib/services/edgegatewayManagement/lib/models/jobErrorItem.js index c0481a76e1..53847bafb2 100644 --- a/lib/services/edgegatewayManagement/lib/models/jobErrorItem.js +++ b/lib/services/edgegatewayManagement/lib/models/jobErrorItem.js @@ -19,7 +19,7 @@ class JobErrorItem { * Create a JobErrorItem. * @property {array} [recommendations] The recommended actions. * @property {string} [code] The code intended for programmatic access. - * @property {string} [message] The message intended to describe the error in + * @property {string} [message] The message that describes the error in * detail. */ constructor() { diff --git a/lib/services/edgegatewayManagement/lib/models/metricSpecificationV1.js b/lib/services/edgegatewayManagement/lib/models/metricSpecificationV1.js index 22108d73b1..e04fed5a38 100644 --- a/lib/services/edgegatewayManagement/lib/models/metricSpecificationV1.js +++ b/lib/services/edgegatewayManagement/lib/models/metricSpecificationV1.js @@ -29,7 +29,7 @@ class MetricSpecificationV1 { * 'Total', 'Count' * @property {array} [dimensions] Metric dimensions, other than default * dimension which is resource. - * @property {boolean} [fillGapWithZero] set true to fill the gaps with zero. + * @property {boolean} [fillGapWithZero] Set true to fill the gaps with zero. * @property {string} [category] Metric category. Possible values include: * 'Capacity', 'Transaction' * @property {string} [resourceIdDimensionNameOverride] Resource name diff --git a/lib/services/edgegatewayManagement/lib/models/mountPointMap.js b/lib/services/edgegatewayManagement/lib/models/mountPointMap.js index 6f6455461b..b46ad97578 100644 --- a/lib/services/edgegatewayManagement/lib/models/mountPointMap.js +++ b/lib/services/edgegatewayManagement/lib/models/mountPointMap.js @@ -17,7 +17,7 @@ class MountPointMap { /** * Create a MountPointMap. - * @property {string} shareId ID of the share which is mounted to role VM. + * @property {string} shareId ID of the share mounted to the role VM. * @property {string} [roleId] ID of the role to which share is mounted. * @property {string} [mountPoint] Mount point for the share. * @property {string} [roleType] Role type. Possible values include: 'IOT', diff --git a/lib/services/edgegatewayManagement/lib/models/networkAdapter.js b/lib/services/edgegatewayManagement/lib/models/networkAdapter.js index 0b3f88ec29..1217e77218 100644 --- a/lib/services/edgegatewayManagement/lib/models/networkAdapter.js +++ b/lib/services/edgegatewayManagement/lib/models/networkAdapter.js @@ -24,16 +24,16 @@ class NetworkAdapter { * @property {number} [adapterPosition.port] The port. * @property {number} [index] Logical index of the adapter. * @property {string} [nodeId] Node ID of the network adapter. - * @property {string} [networkAdapterName] Network Adapter Name. + * @property {string} [networkAdapterName] Network adapter name. * @property {string} [label] Hardware label for the adapter. - * @property {string} [macAddress] MAC Address. - * @property {number} [linkSpeed] Link Speed. + * @property {string} [macAddress] MAC address. + * @property {number} [linkSpeed] Link speed. * @property {string} [status] Value indicating whether this adapter is * valid. Possible values include: 'Inactive', 'Active' * @property {string} [rdmaStatus] Value indicating whether this adapter is - * RDMA Capable. Possible values include: 'Incapable', 'Capable' + * RDMA capable. Possible values include: 'Incapable', 'Capable' * @property {string} [dhcpStatus] Value indicating whether this adapter has - * DHCP Enabled. Possible values include: 'Disabled', 'Enabled' + * DHCP enabled. Possible values include: 'Disabled', 'Enabled' * @property {object} [ipv4Configuration] The IPv4 configuration of the * network adapter. * @property {string} [ipv4Configuration.ipAddress] The IPv4 address of the @@ -51,7 +51,7 @@ class NetworkAdapter { * @property {string} [ipv6Configuration.gateway] The IPv6 gateway of the * network adapter. * @property {string} [ipv6LinkLocalAddress] The IPv6 local address. - * @property {array} [dnsServers] The list DNS Servers of the device. + * @property {array} [dnsServers] The list of DNS Servers of the device. */ constructor() { } diff --git a/lib/services/edgegatewayManagement/lib/models/networkSettings.js b/lib/services/edgegatewayManagement/lib/models/networkSettings.js index 4f77bdc8a0..08ccd1123b 100644 --- a/lib/services/edgegatewayManagement/lib/models/networkSettings.js +++ b/lib/services/edgegatewayManagement/lib/models/networkSettings.js @@ -13,7 +13,7 @@ const models = require('./index'); /** - * The NetworkSettings of a device. + * The network settings of a device. * * @extends models['ARMBaseModel'] */ diff --git a/lib/services/edgegatewayManagement/lib/models/operation.js b/lib/services/edgegatewayManagement/lib/models/operation.js index 63aa4d6f61..dccd24bb79 100644 --- a/lib/services/edgegatewayManagement/lib/models/operation.js +++ b/lib/services/edgegatewayManagement/lib/models/operation.js @@ -18,7 +18,7 @@ class Operation { /** * Create a Operation. * @property {string} [name] Name of the operation. - * @property {object} [display] Properties to displayed for the operation. + * @property {object} [display] Properties displayed for the operation. * @property {string} [display.provider] Provider name. * @property {string} [display.resource] The type of resource in which the * operation is performed. diff --git a/lib/services/edgegatewayManagement/lib/models/operationsList.js b/lib/services/edgegatewayManagement/lib/models/operationsList.js index 2f2d6a870c..53cc65d9b7 100644 --- a/lib/services/edgegatewayManagement/lib/models/operationsList.js +++ b/lib/services/edgegatewayManagement/lib/models/operationsList.js @@ -11,7 +11,7 @@ 'use strict'; /** - * Class for set of operations used for discovery of available provider + * The list of operations used for the discovery of available provider * operations. */ class OperationsList extends Array { diff --git a/lib/services/edgegatewayManagement/lib/models/order.js b/lib/services/edgegatewayManagement/lib/models/order.js index a5873c0352..6aa4a6a419 100644 --- a/lib/services/edgegatewayManagement/lib/models/order.js +++ b/lib/services/edgegatewayManagement/lib/models/order.js @@ -20,16 +20,14 @@ const models = require('./index'); class Order extends models['ARMBaseModel'] { /** * Create a Order. - * @property {object} [contactInformation] The contact details. - * @property {string} [contactInformation.contactPerson] Gets or sets the - * contact person. - * @property {string} [contactInformation.companyName] Gets or sets the name - * of the company. - * @property {string} [contactInformation.phone] Gets or sets the phone - * number. - * @property {array} [contactInformation.emailList] Gets or sets the email - * list. - * @property {object} [shippingAddress] The shipping address. + * @property {object} contactInformation The contact details. + * @property {string} [contactInformation.contactPerson] The contact person + * name. + * @property {string} [contactInformation.companyName] The name of the + * company. + * @property {string} [contactInformation.phone] The phone number. + * @property {array} [contactInformation.emailList] The email list. + * @property {object} shippingAddress The shipping address. * @property {string} [shippingAddress.addressLine1] The address line1. * @property {string} [shippingAddress.addressLine2] The address line2. * @property {string} [shippingAddress.addressLine3] The address line3. @@ -37,24 +35,24 @@ class Order extends models['ARMBaseModel'] { * @property {string} [shippingAddress.city] The city name. * @property {string} [shippingAddress.state] The state name. * @property {string} [shippingAddress.country] The country name. - * @property {object} [changeStatusTo] Current status of the Order. - * @property {string} [changeStatusTo.status] Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @property {object} [currentStatus] Current status of the order. + * @property {string} [currentStatus.status] Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', * 'Shipped', 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', * 'Declined', 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' - * @property {date} [changeStatusTo.updateDateTime] Time of status update. - * @property {string} [changeStatusTo.comments] Comments related to this + * @property {date} [currentStatus.updateDateTime] Time of status update. + * @property {string} [currentStatus.comments] Comments related to this * status change. * @property {array} [orderHistory] List of status changes in the order. * @property {string} [serialNumber] Serial number of the device. - * @property {array} [deliveryTrackingInfo] Tracking information related to - * the packages being delivered to the customer whether original or - * replacement devices. - * @property {array} [returnTrackingInfo] Tracking information related to the - * package being returned from the customer whether original or replacement - * devices. + * @property {array} [deliveryTrackingInfo] Tracking information for the + * package delivered to the customer whether it has an original or a + * replacement device. + * @property {array} [returnTrackingInfo] Tracking information for the + * package returned from the customer whether it has an original or a + * replacement device. */ constructor() { super(); @@ -99,7 +97,7 @@ class Order extends models['ARMBaseModel'] { } }, contactInformation: { - required: false, + required: true, serializedName: 'properties.contactInformation', type: { name: 'Composite', @@ -107,16 +105,16 @@ class Order extends models['ARMBaseModel'] { } }, shippingAddress: { - required: false, + required: true, serializedName: 'properties.shippingAddress', type: { name: 'Composite', className: 'Address' } }, - changeStatusTo: { + currentStatus: { required: false, - serializedName: 'properties.changeStatusTo', + serializedName: 'properties.currentStatus', type: { name: 'Composite', className: 'OrderStatus' diff --git a/lib/services/edgegatewayManagement/lib/models/orderStatus.js b/lib/services/edgegatewayManagement/lib/models/orderStatus.js index ce1ca33156..79c08b50b2 100644 --- a/lib/services/edgegatewayManagement/lib/models/orderStatus.js +++ b/lib/services/edgegatewayManagement/lib/models/orderStatus.js @@ -17,8 +17,8 @@ class OrderStatus { /** * Create a OrderStatus. - * @property {string} status Status of the order pertaining to the allowed - * StatusTypes. Possible values include: 'Untracked', 'AwaitingFulfilment', + * @property {string} status Status of the order as per the allowed status + * types. Possible values include: 'Untracked', 'AwaitingFulfilment', * 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', 'Arriving', * 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', diff --git a/lib/services/edgegatewayManagement/lib/models/periodicTimerEventTrigger.js b/lib/services/edgegatewayManagement/lib/models/periodicTimerEventTrigger.js index 2708ae66e2..75e4ec4d83 100644 --- a/lib/services/edgegatewayManagement/lib/models/periodicTimerEventTrigger.js +++ b/lib/services/edgegatewayManagement/lib/models/periodicTimerEventTrigger.js @@ -20,20 +20,20 @@ const models = require('./index'); class PeriodicTimerEventTrigger extends models['Trigger'] { /** * Create a PeriodicTimerEventTrigger. - * @property {object} [sourceInfo] Periodic timer details. - * @property {date} [sourceInfo.startTime] Time time [UTC] of the day, from - * which the trigger will be valid. Schedule will be computed with reference - * to the time specified. + * @property {object} sourceInfo Periodic timer details. + * @property {date} [sourceInfo.startTime] The time of the day that results + * in a valid trigger. Schedule is computed with reference to the time + * specified. * @property {string} [sourceInfo.schedule] Periodic frequency at which timer - * event needs to be raised. Supports Daily, Hourly, Minutes and seconds. - * @property {string} [sourceInfo.topic] Topic with which periodic events - * needs to be published to IOT device. - * @property {object} [sinkInfo] Role Sink info. + * event needs to be raised. Supports daily, hourly, minutes, and seconds. + * @property {string} [sourceInfo.topic] Topic where periodic events are + * published to IoT device. + * @property {object} sinkInfo Role Sink information. * @property {string} [sinkInfo.roleId] Compute role ID. - * @property {string} [customContextTag] Custom context tag, typically used - * to co-relate the trigger against its usage. Eg. If a PeriodicTimer trigger - * may be intended for certain specific IOT modules in device, the tag can be - * the name/image url of the module. + * @property {string} [customContextTag] A custom context tag typically used + * to correlate the trigger against its usage. For example, if a periodic + * timer trigger is intended for certain specific IoT modules in the device, + * the tag can be the name or the image URL of the module. */ constructor() { super(); @@ -91,7 +91,7 @@ class PeriodicTimerEventTrigger extends models['Trigger'] { } }, sourceInfo: { - required: false, + required: true, serializedName: 'properties.sourceInfo', type: { name: 'Composite', @@ -99,7 +99,7 @@ class PeriodicTimerEventTrigger extends models['Trigger'] { } }, sinkInfo: { - required: false, + required: true, serializedName: 'properties.sinkInfo', type: { name: 'Composite', diff --git a/lib/services/edgegatewayManagement/lib/models/periodicTimerSourceInfo.js b/lib/services/edgegatewayManagement/lib/models/periodicTimerSourceInfo.js index 278ef88098..4801b03fa8 100644 --- a/lib/services/edgegatewayManagement/lib/models/periodicTimerSourceInfo.js +++ b/lib/services/edgegatewayManagement/lib/models/periodicTimerSourceInfo.js @@ -17,13 +17,12 @@ class PeriodicTimerSourceInfo { /** * Create a PeriodicTimerSourceInfo. - * @property {date} startTime Time time [UTC] of the day, from which the - * trigger will be valid. Schedule will be computed with reference to the - * time specified. + * @property {date} startTime The time of the day that results in a valid + * trigger. Schedule is computed with reference to the time specified. * @property {string} schedule Periodic frequency at which timer event needs - * to be raised. Supports Daily, Hourly, Minutes and seconds. - * @property {string} [topic] Topic with which periodic events needs to be - * published to IOT device. + * to be raised. Supports daily, hourly, minutes, and seconds. + * @property {string} [topic] Topic where periodic events are published to + * IoT device. */ constructor() { } diff --git a/lib/services/edgegatewayManagement/lib/models/refreshDetails.js b/lib/services/edgegatewayManagement/lib/models/refreshDetails.js index 726a3c7208..1130b5fbf2 100644 --- a/lib/services/edgegatewayManagement/lib/models/refreshDetails.js +++ b/lib/services/edgegatewayManagement/lib/models/refreshDetails.js @@ -17,18 +17,18 @@ class RefreshDetails { /** * Create a RefreshDetails. - * @property {string} [inProgressRefreshJobId] If a RefreshShare job is - * currently inprogress on this share - this field indicates the ArmId of - * that job. Empty otherwise. - * @property {date} [lastCompletedRefreshJobTimeInUTC] Indicates the job - * completed time of the last refresh job on this particular share, if any. - * This could be a failed job or a successful job. + * @property {string} [inProgressRefreshJobId] If a refresh share job is + * currently in progress on this share, this field indicates the ARM resource + * ID of that job. The field is empty if no job is in progress. + * @property {date} [lastCompletedRefreshJobTimeInUTC] Indicates the + * completed time for the last refresh job on this particular share, if + * any.This could be a failed job or a successful job. * @property {string} [errorManifestFile] Indicates the relative path of the - * error xml for the last refresh job on this particular share, if any. - * This could be a failed job or a successful job. + * error xml for the last refresh job on this particular share, if any. This + * could be a failed job or a successful job. * @property {string} [lastJob] Indicates the id of the last refresh job on - * this particular share,if any. - * This could be a failed job or a successful job. + * this particular share,if any. This could be a failed job or a successful + * job. */ constructor() { } diff --git a/lib/services/edgegatewayManagement/lib/models/roleList.js b/lib/services/edgegatewayManagement/lib/models/roleList.js index f0e6faf593..4c0acbc636 100644 --- a/lib/services/edgegatewayManagement/lib/models/roleList.js +++ b/lib/services/edgegatewayManagement/lib/models/roleList.js @@ -11,7 +11,7 @@ 'use strict'; /** - * Collection of all role on the data box edge device. + * Collection of all the roles on the Data Box Edge device. */ class RoleList extends Array { /** diff --git a/lib/services/edgegatewayManagement/lib/models/securitySettings.js b/lib/services/edgegatewayManagement/lib/models/securitySettings.js index eb96186917..af63f820a6 100644 --- a/lib/services/edgegatewayManagement/lib/models/securitySettings.js +++ b/lib/services/edgegatewayManagement/lib/models/securitySettings.js @@ -21,13 +21,13 @@ class SecuritySettings extends models['ARMBaseModel'] { /** * Create a SecuritySettings. * @property {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 * characters that are a combination of uppercase, lowercase, numeric, and * special characters. * @property {string} [deviceAdminPassword.value] The value of the secret. * @property {string} [deviceAdminPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * @property {string} [deviceAdminPassword.encryptionAlgorithm] The algorithm * used to encrypt "Value". Possible values include: 'None', 'AES256', diff --git a/lib/services/edgegatewayManagement/lib/models/share.js b/lib/services/edgegatewayManagement/lib/models/share.js index 8dc4ce144c..d561aeba4d 100644 --- a/lib/services/edgegatewayManagement/lib/models/share.js +++ b/lib/services/edgegatewayManagement/lib/models/share.js @@ -28,35 +28,33 @@ class Share extends models['ARMBaseModel'] { * @property {object} [azureContainerInfo] Azure container mapping for the * share. * @property {string} [azureContainerInfo.storageAccountCredentialId] ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * @property {string} [azureContainerInfo.containerName] Container name - * (Based on the data format specified, represents the name of Azure file/ - * Page blob / Block blob). + * (Based on the data format specified, this represents the name of Azure + * Files/Page blob/Block blob). * @property {string} [azureContainerInfo.dataFormat] Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', * 'PageBlob', 'AzureFile' * @property {string} accessProtocol Access protocol to be used by the share. * Possible values include: 'SMB', 'NFS' - * @property {array} [userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @property {array} [userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * @property {array} [clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * @property {object} [refreshDetails] Details of the refresh job on this * share. - * @property {string} [refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @property {string} [refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * @property {date} [refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this - * particular share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * @property {string} [refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * @property {string} [refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or + * a successful job. * @property {array} [shareMappings] Share mount point to the role. * @property {string} [dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' diff --git a/lib/services/edgegatewayManagement/lib/models/shareAccessRight.js b/lib/services/edgegatewayManagement/lib/models/shareAccessRight.js index a5a346983b..a3f14d751c 100644 --- a/lib/services/edgegatewayManagement/lib/models/shareAccessRight.js +++ b/lib/services/edgegatewayManagement/lib/models/shareAccessRight.js @@ -18,7 +18,7 @@ class ShareAccessRight { /** * Create a ShareAccessRight. - * @property {string} shareId Id of the share. + * @property {string} shareId The share ID. * @property {string} accessType Type of access to be allowed on the share * for this user. Possible values include: 'Change', 'Read', 'Custom' */ diff --git a/lib/services/edgegatewayManagement/lib/models/shareList.js b/lib/services/edgegatewayManagement/lib/models/shareList.js index 540488dde9..25326cb69a 100644 --- a/lib/services/edgegatewayManagement/lib/models/shareList.js +++ b/lib/services/edgegatewayManagement/lib/models/shareList.js @@ -11,7 +11,7 @@ 'use strict'; /** - * Collection of all shares on the Data Box Edge/Gateway device. + * Collection of all the shares on the Data Box Edge/Gateway device. */ class ShareList extends Array { /** diff --git a/lib/services/edgegatewayManagement/lib/models/sku.js b/lib/services/edgegatewayManagement/lib/models/sku.js index 20bc99542b..2aa1067e9a 100644 --- a/lib/services/edgegatewayManagement/lib/models/sku.js +++ b/lib/services/edgegatewayManagement/lib/models/sku.js @@ -17,7 +17,7 @@ class Sku { /** * Create a Sku. - * @property {string} [name] Sku name. Possible values include: 'Gateway', + * @property {string} [name] SKU name. Possible values include: 'Gateway', * 'Edge' * @property {string} [tier] The SKU tier. This is based on the SKU name. * Possible values include: 'Standard' diff --git a/lib/services/edgegatewayManagement/lib/models/storageAccountCredential.js b/lib/services/edgegatewayManagement/lib/models/storageAccountCredential.js index 51ceb49d87..98fd86c99a 100644 --- a/lib/services/edgegatewayManagement/lib/models/storageAccountCredential.js +++ b/lib/services/edgegatewayManagement/lib/models/storageAccountCredential.js @@ -21,18 +21,17 @@ class StorageAccountCredential extends models['ARMBaseModel'] { /** * Create a StorageAccountCredential. * @property {string} alias Alias for the storage account. - * @property {string} [userName] UserName for the storage account. + * @property {string} [userName] Username for the storage account. * @property {object} [accountKey] Encrypted storage key. * @property {string} [accountKey.value] The value of the secret. * @property {string} [accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it + * will be null. * @property {string} [accountKey.encryptionAlgorithm] The algorithm used to * encrypt "Value". Possible values include: 'None', 'AES256', * 'RSAES_PKCS1_v_1_5' - * @property {string} [connectionString] ConnectionString for the storage - * account. This needs to be specified if UserName/AccountKey are not - * specified. + * @property {string} [connectionString] Connection string for the storage + * account. Use this string if username and account key are not specified. * @property {string} sslStatus Signifies whether SSL needs to be enabled or * not. Possible values include: 'Enabled', 'Disabled' * @property {string} [blobDomainName] Blob end point for private clouds. diff --git a/lib/services/edgegatewayManagement/lib/models/storageAccountCredentialList.js b/lib/services/edgegatewayManagement/lib/models/storageAccountCredentialList.js index dec3b6acd6..74a85147ef 100644 --- a/lib/services/edgegatewayManagement/lib/models/storageAccountCredentialList.js +++ b/lib/services/edgegatewayManagement/lib/models/storageAccountCredentialList.js @@ -11,7 +11,7 @@ 'use strict'; /** - * The collection of storage account credential entities. + * The collection of storage account credentials. */ class StorageAccountCredentialList extends Array { /** diff --git a/lib/services/edgegatewayManagement/lib/models/symmetricKey.js b/lib/services/edgegatewayManagement/lib/models/symmetricKey.js index cfc79707cc..766976a8b3 100644 --- a/lib/services/edgegatewayManagement/lib/models/symmetricKey.js +++ b/lib/services/edgegatewayManagement/lib/models/symmetricKey.js @@ -11,18 +11,18 @@ 'use strict'; /** - * Symmetric Key for authentication. + * Symmetric key for authentication. * */ class SymmetricKey { /** * Create a SymmetricKey. - * @property {object} [connectionString] Connection string based on symmetric - * key. + * @property {object} [connectionString] Connection string based on the + * symmetric key. * @property {string} [connectionString.value] The value of the secret. * @property {string} [connectionString.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it + * will be null. * @property {string} [connectionString.encryptionAlgorithm] The algorithm * used to encrypt "Value". Possible values include: 'None', 'AES256', * 'RSAES_PKCS1_v_1_5' diff --git a/lib/services/edgegatewayManagement/lib/models/updateInstallProgress.js b/lib/services/edgegatewayManagement/lib/models/updateInstallProgress.js index f16e879adb..e4e77cb375 100644 --- a/lib/services/edgegatewayManagement/lib/models/updateInstallProgress.js +++ b/lib/services/edgegatewayManagement/lib/models/updateInstallProgress.js @@ -11,13 +11,13 @@ 'use strict'; /** - * Details about the progress during installation of updates. + * Progress details during installation of updates. * */ class UpdateInstallProgress { /** * Create a UpdateInstallProgress. - * @property {number} [percentComplete] Percentage of completion. + * @property {number} [percentComplete] Percentage completed. * @property {number} [numberOfUpdatesToInstall] Number of updates to * install. * @property {number} [numberOfUpdatesInstalled] Number of updates installed. diff --git a/lib/services/edgegatewayManagement/lib/models/updateSummary.js b/lib/services/edgegatewayManagement/lib/models/updateSummary.js index d682f76097..c5c0bc71a1 100644 --- a/lib/services/edgegatewayManagement/lib/models/updateSummary.js +++ b/lib/services/edgegatewayManagement/lib/models/updateSummary.js @@ -20,10 +20,10 @@ const models = require('./index'); class UpdateSummary extends models['ARMBaseModel'] { /** * Create a UpdateSummary. - * @property {string} [deviceVersionNumber] The current version of the - * device, of format: 1.2.17312.13. + * @property {string} [deviceVersionNumber] The current version of the device + * in format: 1.2.17312.13.", * @property {string} [friendlyDeviceVersionName] The current version of the - * device represented in text format. + * device in text format. * @property {date} [deviceLastScannedDateTime] The last time when a scan was * done on the device. * @property {date} [lastCompletedScanJobDateTime] The time when the last @@ -32,28 +32,27 @@ class UpdateSummary extends models['ARMBaseModel'] { * Download job was completed (success/cancelled/failed) on the appliance. * @property {date} [lastCompletedInstallJobDateTime] The time when the last * Install job was completed (success/cancelled/failed) on the appliance. - * @property {number} [totalNumberOfUpdatesAvailable] Count of updates that - * are available for the current device version as per the last scan on the - * device. + * @property {number} [totalNumberOfUpdatesAvailable] The number of updates + * available for the current device version as per the last device scan. * @property {number} [totalNumberOfUpdatesPendingDownload] The total number * of items pending download. * @property {number} [totalNumberOfUpdatesPendingInstall] The total number * of items pending install. * @property {string} [rebootBehavior] Indicates if updates are available and - * at least one of the update items detected needs a reboot. Possible values - * include: 'NeverReboots', 'RequiresReboot', 'RequestReboot' + * at least one of the updates needs a reboot. Possible values include: + * 'NeverReboots', 'RequiresReboot', 'RequestReboot' * @property {string} [ongoingUpdateOperation] The current update operation. * Possible values include: 'None', 'Scan', 'Download', 'Install' - * @property {string} [inProgressDownloadJobId] The Job ID of the download - * job if a download is in progress. - * @property {string} [inProgressInstallJobId] The Job ID of the install job - * if an install is in progress. + * @property {string} [inProgressDownloadJobId] The job ID of the download + * job in progress. + * @property {string} [inProgressInstallJobId] The job ID of the install job + * in progress. * @property {date} [inProgressDownloadJobStartedDateTime] The time when the * currently running download (if any) started. * @property {date} [inProgressInstallJobStartedDateTime] The time when the * currently running install (if any) started. - * @property {array} [updateTitles] The list of update titles which are - * available for install. + * @property {array} [updateTitles] The list of updates available for + * install. * @property {number} [totalUpdateSizeInBytes] The total size of updates * available for download in bytes. */ diff --git a/lib/services/edgegatewayManagement/lib/models/uploadCertificateRequest.js b/lib/services/edgegatewayManagement/lib/models/uploadCertificateRequest.js index 8077ddba45..8105205e6e 100644 --- a/lib/services/edgegatewayManagement/lib/models/uploadCertificateRequest.js +++ b/lib/services/edgegatewayManagement/lib/models/uploadCertificateRequest.js @@ -11,7 +11,7 @@ 'use strict'; /** - * The Upload certificate request. + * The upload certificate request. * */ class UploadCertificateRequest { diff --git a/lib/services/edgegatewayManagement/lib/models/uploadCertificateResponse.js b/lib/services/edgegatewayManagement/lib/models/uploadCertificateResponse.js index abdbbe2f8f..3d2d598422 100644 --- a/lib/services/edgegatewayManagement/lib/models/uploadCertificateResponse.js +++ b/lib/services/edgegatewayManagement/lib/models/uploadCertificateResponse.js @@ -17,17 +17,18 @@ class UploadCertificateResponse { /** * Create a UploadCertificateResponse. - * @property {string} [authType] Specifies the Authentication type. Possible + * @property {string} [authType] Specifies authentication type. Possible * values include: 'Invalid', 'AzureActiveDirectory' - * @property {string} resourceId The resource ID of the edge device. + * @property {string} resourceId The resource ID of the Data Box Edge/Gateway + * device. * @property {string} aadAuthority Azure Active Directory tenant authority. * @property {string} aadTenantId Azure Active Directory tenant ID. * @property {string} servicePrincipalClientId Azure Active Directory service * principal client ID. * @property {string} servicePrincipalObjectId Azure Active Directory service - * principal Object ID. - * @property {string} azureManagementEndpointAudience The Azure Management - * Endpoint Audience. + * principal object ID. + * @property {string} azureManagementEndpointAudience The azure management + * endpoint audience. */ constructor() { } diff --git a/lib/services/edgegatewayManagement/lib/models/user.js b/lib/services/edgegatewayManagement/lib/models/user.js index 8bbe264479..27068186ae 100644 --- a/lib/services/edgegatewayManagement/lib/models/user.js +++ b/lib/services/edgegatewayManagement/lib/models/user.js @@ -13,20 +13,19 @@ const models = require('./index'); /** - * Represents a user who has access to one or more shares on the Edge storage - * device. + * Represents a user who has access to one or more shares on the Data Box + * Edge/Gateway device. * * @extends models['ARMBaseModel'] */ class User extends models['ARMBaseModel'] { /** * Create a User. - * @property {object} [encryptedPassword] The details of the password - * specified for the user. + * @property {object} [encryptedPassword] The password details. * @property {string} [encryptedPassword.value] The value of the secret. * @property {string} [encryptedPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it + * will be null. * @property {string} [encryptedPassword.encryptionAlgorithm] The algorithm * used to encrypt "Value". Possible values include: 'None', 'AES256', * 'RSAES_PKCS1_v_1_5' diff --git a/lib/services/edgegatewayManagement/lib/models/userAccessRight.js b/lib/services/edgegatewayManagement/lib/models/userAccessRight.js index fb726772b0..0ad6385aa7 100644 --- a/lib/services/edgegatewayManagement/lib/models/userAccessRight.js +++ b/lib/services/edgegatewayManagement/lib/models/userAccessRight.js @@ -11,14 +11,13 @@ 'use strict'; /** - * The mapping between a particular user and the type of access they have on - * the SMB share. + * The mapping between a particular user and the access type on the SMB share. * */ class UserAccessRight { /** * Create a UserAccessRight. - * @property {string} userId Id of the user (already existing in the device). + * @property {string} userId User ID (already existing in the device). * @property {string} accessType Type of access to be allowed for the user. * Possible values include: 'Change', 'Read', 'Custom' */ diff --git a/lib/services/edgegatewayManagement/lib/operations/alerts.js b/lib/services/edgegatewayManagement/lib/operations/alerts.js index 8ccd2c97e2..69af435cf4 100644 --- a/lib/services/edgegatewayManagement/lib/operations/alerts.js +++ b/lib/services/edgegatewayManagement/lib/operations/alerts.js @@ -15,7 +15,7 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -160,11 +160,11 @@ function _listByDataBoxEdgeDevice(deviceName, resourceGroupName, options, callba } /** - * @summary Returns an alert by name. + * @summary Gets an alert by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the alert which needs to be retrieved. + * @param {string} name The alert name. * * @param {string} resourceGroupName The resource group name. * @@ -311,7 +311,7 @@ function _get(deviceName, name, resourceGroupName, options, callback) { } /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -451,7 +451,7 @@ class Alerts { } /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -483,7 +483,7 @@ class Alerts { } /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -537,11 +537,11 @@ class Alerts { } /** - * @summary Returns an alert by name. + * @summary Gets an alert by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the alert which needs to be retrieved. + * @param {string} name The alert name. * * @param {string} resourceGroupName The resource group name. * @@ -571,11 +571,11 @@ class Alerts { } /** - * @summary Returns an alert by name. + * @summary Gets an alert by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the alert which needs to be retrieved. + * @param {string} name The alert name. * * @param {string} resourceGroupName The resource group name. * @@ -627,7 +627,7 @@ class Alerts { } /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -658,7 +658,7 @@ class Alerts { } /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. diff --git a/lib/services/edgegatewayManagement/lib/operations/bandwidthSchedules.js b/lib/services/edgegatewayManagement/lib/operations/bandwidthSchedules.js index e181236efe..e53ed0cf50 100644 --- a/lib/services/edgegatewayManagement/lib/operations/bandwidthSchedules.js +++ b/lib/services/edgegatewayManagement/lib/operations/bandwidthSchedules.js @@ -15,7 +15,7 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -161,7 +161,7 @@ function _listByDataBoxEdgeDevice(deviceName, resourceGroupName, options, callba } /** - * Returns the properties of the specified bandwidth schedule name. + * Gets the properties of the specified bandwidth schedule. * * @param {string} deviceName The device name. * @@ -782,7 +782,7 @@ function _beginDeleteMethod(deviceName, name, resourceGroupName, options, callba } /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -927,7 +927,7 @@ class BandwidthSchedules { } /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -959,7 +959,7 @@ class BandwidthSchedules { } /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1014,7 +1014,7 @@ class BandwidthSchedules { } /** - * Returns the properties of the specified bandwidth schedule name. + * Gets the properties of the specified bandwidth schedule. * * @param {string} deviceName The device name. * @@ -1048,7 +1048,7 @@ class BandwidthSchedules { } /** - * Returns the properties of the specified bandwidth schedule name. + * Gets the properties of the specified bandwidth schedule. * * @param {string} deviceName The device name. * @@ -1510,7 +1510,7 @@ class BandwidthSchedules { } /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1541,7 +1541,7 @@ class BandwidthSchedules { } /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. diff --git a/lib/services/edgegatewayManagement/lib/operations/devices.js b/lib/services/edgegatewayManagement/lib/operations/devices.js index 32ed4f34ef..8bc032b3b4 100644 --- a/lib/services/edgegatewayManagement/lib/operations/devices.js +++ b/lib/services/edgegatewayManagement/lib/operations/devices.js @@ -15,7 +15,7 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {object} [options] Optional Parameters. * @@ -159,7 +159,7 @@ function _listBySubscription(options, callback) { } /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} resourceGroupName The resource group name. * @@ -309,7 +309,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { } /** - * Returns the properties of the data box edge/gateway device. + * Gets the properties of the data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -462,24 +462,24 @@ function _get(deviceName, resourceGroupName, options, callback) { * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -631,7 +631,7 @@ function _deleteMethod(deviceName, resourceGroupName, options, callback) { } /** - * Updates data box edge/gateway device. + * Modifies a Data Box Edge/Gateway resource. * * @param {string} deviceName The device name. * @@ -807,7 +807,7 @@ function _update(deviceName, resourceGroupName, options, callback) { /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -869,11 +869,12 @@ function _downloadUpdates(deviceName, resourceGroupName, options, callback) { } /** - * Creates or updates the extended info of the data box edge/gateway device. + * Creates or updates the additional information of a the data box edge/gateway + * device. * * @param {string} deviceName The device name. * - * @param {object} parameters The device extended information. + * @param {object} parameters The additional information. * * @param {string} parameters.integrityKey The Channel Integrity Key (CIK) of * the device. @@ -1043,8 +1044,7 @@ function _createOrUpdateExtendedInfo(deviceName, parameters, resourceGroupName, } /** - * Returns the extended information of the specified data box edge/gateway - * device. + * Gets additional information for the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1253,7 +1253,7 @@ function _installUpdates(deviceName, resourceGroupName, options, callback) { } /** - * Returns the network settings of the specified data box edge/gateway device. + * Gets the network settings of the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1469,16 +1469,16 @@ function _scanForUpdates(deviceName, resourceGroupName, options, callback) { * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -1540,9 +1540,9 @@ function _createOrUpdateSecuritySettings(deviceName, resourceGroupName, deviceAd } /** - * @summary Returns information about the availability of updates as per the - * last scan done on the device. It also returns information about any ongoing - * download or install jobs on the device. + * @summary Gets information about the availability of updates based on the + * last scan of the device. It also gets information about any ongoing download + * or install jobs on the device. * * @param {string} deviceName The device name. * @@ -1872,24 +1872,24 @@ function _uploadCertificate(deviceName, resourceGroupName, certificate, options, * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -2190,7 +2190,7 @@ function _beginDeleteMethod(deviceName, resourceGroupName, options, callback) { } /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -2578,16 +2578,16 @@ function _beginScanForUpdates(deviceName, resourceGroupName, options, callback) * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -2740,7 +2740,7 @@ function _beginCreateOrUpdateSecuritySettings(deviceName, resourceGroupName, dev } /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -2867,7 +2867,7 @@ function _listBySubscriptionNext(nextPageLink, options, callback) { } /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -3027,7 +3027,7 @@ class Devices { } /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {object} [options] Optional Parameters. * @@ -3059,7 +3059,7 @@ class Devices { } /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {object} [options] Optional Parameters. * @@ -3113,7 +3113,7 @@ class Devices { } /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} resourceGroupName The resource group name. * @@ -3147,7 +3147,7 @@ class Devices { } /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} resourceGroupName The resource group name. * @@ -3203,7 +3203,7 @@ class Devices { } /** - * Returns the properties of the data box edge/gateway device. + * Gets the properties of the data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -3235,7 +3235,7 @@ class Devices { } /** - * Returns the properties of the data box edge/gateway device. + * Gets the properties of the data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -3296,24 +3296,24 @@ class Devices { * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -3364,24 +3364,24 @@ class Devices { * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -3532,7 +3532,7 @@ class Devices { } /** - * Updates data box edge/gateway device. + * Modifies a Data Box Edge/Gateway resource. * * @param {string} deviceName The device name. * @@ -3567,7 +3567,7 @@ class Devices { } /** - * Updates data box edge/gateway device. + * Modifies a Data Box Edge/Gateway resource. * * @param {string} deviceName The device name. * @@ -3624,7 +3624,7 @@ class Devices { } /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -3656,7 +3656,7 @@ class Devices { } /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -3709,11 +3709,12 @@ class Devices { } /** - * Creates or updates the extended info of the data box edge/gateway device. + * Creates or updates the additional information of a the data box edge/gateway + * device. * * @param {string} deviceName The device name. * - * @param {object} parameters The device extended information. + * @param {object} parameters The additional information. * * @param {string} parameters.integrityKey The Channel Integrity Key (CIK) of * the device. @@ -3752,11 +3753,12 @@ class Devices { } /** - * Creates or updates the extended info of the data box edge/gateway device. + * Creates or updates the additional information of a the data box edge/gateway + * device. * * @param {string} deviceName The device name. * - * @param {object} parameters The device extended information. + * @param {object} parameters The additional information. * * @param {string} parameters.integrityKey The Channel Integrity Key (CIK) of * the device. @@ -3818,8 +3820,7 @@ class Devices { } /** - * Returns the extended information of the specified data box edge/gateway - * device. + * Gets additional information for the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -3851,8 +3852,7 @@ class Devices { } /** - * Returns the extended information of the specified data box edge/gateway - * device. + * Gets additional information for the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -3992,7 +3992,7 @@ class Devices { } /** - * Returns the network settings of the specified data box edge/gateway device. + * Gets the network settings of the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -4024,7 +4024,7 @@ class Devices { } /** - * Returns the network settings of the specified data box edge/gateway device. + * Gets the network settings of the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -4170,16 +4170,16 @@ class Devices { * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -4218,16 +4218,16 @@ class Devices { * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -4280,9 +4280,9 @@ class Devices { } /** - * @summary Returns information about the availability of updates as per the - * last scan done on the device. It also returns information about any ongoing - * download or install jobs on the device. + * @summary Gets information about the availability of updates based on the + * last scan of the device. It also gets information about any ongoing download + * or install jobs on the device. * * @param {string} deviceName The device name. * @@ -4314,9 +4314,9 @@ class Devices { } /** - * @summary Returns information about the availability of updates as per the - * last scan done on the device. It also returns information about any ongoing - * download or install jobs on the device. + * @summary Gets information about the availability of updates based on the + * last scan of the device. It also gets information about any ongoing download + * or install jobs on the device. * * @param {string} deviceName The device name. * @@ -4474,24 +4474,24 @@ class Devices { * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -4542,24 +4542,24 @@ class Devices { * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -4710,7 +4710,7 @@ class Devices { } /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -4742,7 +4742,7 @@ class Devices { } /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -4972,16 +4972,16 @@ class Devices { * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -5020,16 +5020,16 @@ class Devices { * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -5082,7 +5082,7 @@ class Devices { } /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -5113,7 +5113,7 @@ class Devices { } /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -5166,7 +5166,7 @@ class Devices { } /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -5197,7 +5197,7 @@ class Devices { } /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. diff --git a/lib/services/edgegatewayManagement/lib/operations/index.d.ts b/lib/services/edgegatewayManagement/lib/operations/index.d.ts index d6b0f2ec6b..12ef1995a2 100644 --- a/lib/services/edgegatewayManagement/lib/operations/index.d.ts +++ b/lib/services/edgegatewayManagement/lib/operations/index.d.ts @@ -22,7 +22,7 @@ export interface Operations { /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {object} [options] Optional Parameters. * @@ -38,7 +38,7 @@ export interface Operations { listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {object} [options] Optional Parameters. * @@ -73,7 +73,7 @@ export interface Operations { /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -92,7 +92,7 @@ export interface Operations { listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -139,7 +139,7 @@ export interface Devices { /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {object} [options] Optional Parameters. * @@ -159,7 +159,7 @@ export interface Devices { listBySubscriptionWithHttpOperationResponse(options?: { expand? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {object} [options] Optional Parameters. * @@ -198,7 +198,7 @@ export interface Devices { /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} resourceGroupName The resource group name. * @@ -220,7 +220,7 @@ export interface Devices { listByResourceGroupWithHttpOperationResponse(resourceGroupName: string, options?: { expand? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} resourceGroupName The resource group name. * @@ -261,7 +261,7 @@ export interface Devices { /** - * Returns the properties of the data box edge/gateway device. + * Gets the properties of the data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -281,7 +281,7 @@ export interface Devices { getWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Returns the properties of the data box edge/gateway device. + * Gets the properties of the data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -327,24 +327,24 @@ export interface Devices { * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -383,24 +383,24 @@ export interface Devices { * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -509,7 +509,7 @@ export interface Devices { /** - * Updates data box edge/gateway device. + * Modifies a Data Box Edge/Gateway resource. * * @param {string} deviceName The device name. * @@ -532,7 +532,7 @@ export interface Devices { updateWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { tags? : { [propertyName: string]: string }, customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Updates data box edge/gateway device. + * Modifies a Data Box Edge/Gateway resource. * * @param {string} deviceName The device name. * @@ -574,7 +574,7 @@ export interface Devices { /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -594,7 +594,7 @@ export interface Devices { downloadUpdatesWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -632,11 +632,12 @@ export interface Devices { /** - * Creates or updates the extended info of the data box edge/gateway device. + * Creates or updates the additional information of a the data box edge/gateway + * device. * * @param {string} deviceName The device name. * - * @param {object} parameters The device extended information. + * @param {object} parameters The additional information. * * @param {string} parameters.integrityKey The Channel Integrity Key (CIK) of * the device. @@ -663,11 +664,12 @@ export interface Devices { createOrUpdateExtendedInfoWithHttpOperationResponse(deviceName: string, parameters: models.DataBoxEdgeDeviceExtendedInfo, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Creates or updates the extended info of the data box edge/gateway device. + * Creates or updates the additional information of a the data box edge/gateway + * device. * * @param {string} deviceName The device name. * - * @param {object} parameters The device extended information. + * @param {object} parameters The additional information. * * @param {string} parameters.integrityKey The Channel Integrity Key (CIK) of * the device. @@ -714,8 +716,7 @@ export interface Devices { /** - * Returns the extended information of the specified data box edge/gateway - * device. + * Gets additional information for the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -735,8 +736,7 @@ export interface Devices { getExtendedInformationWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Returns the extended information of the specified data box edge/gateway - * device. + * Gets additional information for the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -834,7 +834,7 @@ export interface Devices { /** - * Returns the network settings of the specified data box edge/gateway device. + * Gets the network settings of the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -854,7 +854,7 @@ export interface Devices { getNetworkSettingsWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Returns the network settings of the specified data box edge/gateway device. + * Gets the network settings of the specified data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -958,16 +958,16 @@ export interface Devices { * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -994,16 +994,16 @@ export interface Devices { * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -1041,9 +1041,9 @@ export interface Devices { /** - * @summary Returns information about the availability of updates as per the - * last scan done on the device. It also returns information about any ongoing - * download or install jobs on the device. + * @summary Gets information about the availability of updates based on the + * last scan of the device. It also gets information about any ongoing download + * or install jobs on the device. * * @param {string} deviceName The device name. * @@ -1063,9 +1063,9 @@ export interface Devices { getUpdateSummaryWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Returns information about the availability of updates as per the - * last scan done on the device. It also returns information about any ongoing - * download or install jobs on the device. + * @summary Gets information about the availability of updates based on the + * last scan of the device. It also gets information about any ongoing download + * or install jobs on the device. * * @param {string} deviceName The device name. * @@ -1181,24 +1181,24 @@ export interface Devices { * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -1237,24 +1237,24 @@ export interface Devices { * @param {object} dataBoxEdgeDevice The resource object. * * @param {string} dataBoxEdgeDevice.location The location of the device. This - * will be one of the supported and registered Azure Geo Regions (e.g. West US, - * East US, Southeast Asia, etc.). The geo region of a device cannot be changed - * once it is created, but if an identical geo region is specified on update - * the request will succeed. + * is a supported and registered Azure geographical region (for example, West + * US, East US, or Southeast Asia). The geographical region of a device cannot + * be changed once it is created, but if an identical geographical region is + * specified on update, the request will succeed. * * @param {object} [dataBoxEdgeDevice.tags] The list of tags that describe the - * device. These tags can be used in viewing and grouping this device (across + * device. These tags can be used to view and group this device (across * resource groups). * - * @param {object} [dataBoxEdgeDevice.sku] The sku type. + * @param {object} [dataBoxEdgeDevice.sku] The SKU type. * - * @param {string} [dataBoxEdgeDevice.sku.name] Sku name. Possible values + * @param {string} [dataBoxEdgeDevice.sku.name] SKU name. Possible values * include: 'Gateway', 'Edge' * * @param {string} [dataBoxEdgeDevice.sku.tier] The SKU tier. This is based on * the SKU name. Possible values include: 'Standard' * - * @param {string} [dataBoxEdgeDevice.etag] The etag of the devices. + * @param {string} [dataBoxEdgeDevice.etag] The etag for the devices. * * @param {string} [dataBoxEdgeDevice.dataBoxEdgeDeviceStatus] The status of * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', @@ -1363,7 +1363,7 @@ export interface Devices { /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1383,7 +1383,7 @@ export interface Devices { beginDownloadUpdatesWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Downloads the updates on the data box edge/gateway device. + * @summary Downloads the updates on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1544,16 +1544,16 @@ export interface Devices { * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -1580,16 +1580,16 @@ export interface Devices { * @param {string} resourceGroupName The resource group name. * * @param {object} deviceAdminPassword Device administrator password as an - * encrypted string (encrypted using RSA PKCS #1) is used to log into the - * local web UI of the device. Actual password could have at least 8 characters - * that are a combination of uppercase, lowercase, numeric, and special - * characters. + * encrypted string (encrypted using RSA PKCS #1) is used to sign into the + * local web UI of the device. The Actual password should have at least 8 + * characters that are a combination of uppercase, lowercase, numeric, and + * special characters. * * @param {string} deviceAdminPassword.value The value of the secret. * * @param {string} [deviceAdminPassword.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} deviceAdminPassword.encryptionAlgorithm The algorithm used * to encrypt "Value". Possible values include: 'None', 'AES256', @@ -1627,7 +1627,7 @@ export interface Devices { /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1646,7 +1646,7 @@ export interface Devices { listBySubscriptionNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Retrieves all data box edge/gateway devices in a subscription. + * Gets all the data box edge/gateway devices in a subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1684,7 +1684,7 @@ export interface Devices { /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1703,7 +1703,7 @@ export interface Devices { listByResourceGroupNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Retrieves all data box edge/gateway devices in a resource group. + * Gets all the data box edge/gateway devices in a resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1750,7 +1750,7 @@ export interface Alerts { /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1770,7 +1770,7 @@ export interface Alerts { listByDataBoxEdgeDeviceWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1809,11 +1809,11 @@ export interface Alerts { /** - * @summary Returns an alert by name. + * @summary Gets an alert by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the alert which needs to be retrieved. + * @param {string} name The alert name. * * @param {string} resourceGroupName The resource group name. * @@ -1831,11 +1831,11 @@ export interface Alerts { getWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Returns an alert by name. + * @summary Gets an alert by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the alert which needs to be retrieved. + * @param {string} name The alert name. * * @param {string} resourceGroupName The resource group name. * @@ -1872,7 +1872,7 @@ export interface Alerts { /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1891,7 +1891,7 @@ export interface Alerts { listByDataBoxEdgeDeviceNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Retrieves all the alerts for a data box edge/gateway device. + * Gets all the alerts for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1938,7 +1938,7 @@ export interface BandwidthSchedules { /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1958,7 +1958,7 @@ export interface BandwidthSchedules { listByDataBoxEdgeDeviceWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1998,7 +1998,7 @@ export interface BandwidthSchedules { /** - * Returns the properties of the specified bandwidth schedule name. + * Gets the properties of the specified bandwidth schedule. * * @param {string} deviceName The device name. * @@ -2020,7 +2020,7 @@ export interface BandwidthSchedules { getWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Returns the properties of the specified bandwidth schedule name. + * Gets the properties of the specified bandwidth schedule. * * @param {string} deviceName The device name. * @@ -2359,7 +2359,7 @@ export interface BandwidthSchedules { /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -2378,7 +2378,7 @@ export interface BandwidthSchedules { listByDataBoxEdgeDeviceNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Returns all the bandwidth Schedules for a data box edge/gateway device. + * Gets all the bandwidth schedules for a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -2416,6 +2416,80 @@ export interface BandwidthSchedules { listByDataBoxEdgeDeviceNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; } +/** + * @class + * Jobs + * __NOTE__: An instance of this class is automatically created for an + * instance of the DataBoxEdgeManagementClient. + */ +export interface Jobs { + + + /** + * @summary Gets the details of a specified job on a data box edge/gateway + * device. + * + * @param {string} deviceName The device name. + * + * @param {string} name The job name. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @returns {Promise} A promise is returned + * + * @resolve {HttpOperationResponse} - The deserialized result object. + * + * @reject {Error|ServiceError} - The error object. + */ + getWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Gets the details of a specified job on a data box edge/gateway + * device. + * + * @param {string} deviceName The device name. + * + * @param {string} name The job name. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @param {ServiceCallback} [optionalCallback] - The optional callback. + * + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. + * + * {Promise} A promise is returned. + * + * @resolve {Job} - The deserialized result object. + * + * @reject {Error|ServiceError} - The error object. + * + * {ServiceCallback} optionalCallback(err, result, request, response) + * + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * + * {Job} [result] - The deserialized result object if an error did not occur. + * See {@link Job} for more information. + * + * {WebResource} [request] - The HTTP Request object if an error did not occur. + * + * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. + */ + get(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(deviceName: string, name: string, resourceGroupName: string, callback: ServiceCallback): void; + get(deviceName: string, name: string, resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + /** * @class * OperationsStatus @@ -2426,8 +2500,8 @@ export interface OperationsStatus { /** - * @summary Returns the job details of the specified job on a data box - * edge/gateway device. + * @summary Gets the details of a specified job on a data box edge/gateway + * device. * * @param {string} deviceName The device name. * @@ -2449,8 +2523,8 @@ export interface OperationsStatus { getWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Returns the job details of the specified job on a data box - * edge/gateway device. + * @summary Gets the details of a specified job on a data box edge/gateway + * device. * * @param {string} deviceName The device name. * @@ -2500,9 +2574,9 @@ export interface Orders { /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -2520,9 +2594,9 @@ export interface Orders { listByDataBoxEdgeDeviceWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -2559,9 +2633,9 @@ export interface Orders { /** - * @summary Get a specific order by name. + * @summary Gets a specific order by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -2579,9 +2653,9 @@ export interface Orders { getWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Get a specific order by name. + * @summary Gets a specific order by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -2620,32 +2694,29 @@ export interface Orders { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -2655,16 +2726,16 @@ export interface Orders { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -2685,32 +2756,29 @@ export interface Orders { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -2720,16 +2788,16 @@ export interface Orders { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -2769,7 +2837,7 @@ export interface Orders { /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -2789,7 +2857,7 @@ export interface Orders { /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -2827,32 +2895,29 @@ export interface Orders { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -2862,16 +2927,16 @@ export interface Orders { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -2892,32 +2957,29 @@ export interface Orders { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -2927,16 +2989,16 @@ export interface Orders { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -2976,7 +3038,7 @@ export interface Orders { /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -2996,7 +3058,7 @@ export interface Orders { /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -3032,7 +3094,7 @@ export interface Orders { /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -3051,7 +3113,7 @@ export interface Orders { listByDataBoxEdgeDeviceNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -3100,7 +3162,7 @@ export interface Roles { /** * Lists all the roles configured in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -3120,7 +3182,7 @@ export interface Roles { /** * Lists all the roles configured in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -3157,11 +3219,11 @@ export interface Roles { /** - * Get a specific role by name. + * Gets a specific role by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of role to be fetched. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -3179,11 +3241,11 @@ export interface Roles { getWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Get a specific role by name. + * Gets a specific role by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of role to be fetched. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -3222,12 +3284,11 @@ export interface Roles { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -3249,12 +3310,11 @@ export interface Roles { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -3293,11 +3353,11 @@ export interface Roles { /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -3315,11 +3375,11 @@ export interface Roles { deleteMethodWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -3357,12 +3417,11 @@ export interface Roles { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -3384,12 +3443,11 @@ export interface Roles { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -3428,11 +3486,11 @@ export interface Roles { /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -3450,11 +3508,11 @@ export interface Roles { beginDeleteMethodWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -3558,7 +3616,7 @@ export interface Shares { /** * @summary Lists all the shares in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -3578,7 +3636,7 @@ export interface Shares { /** * @summary Lists all the shares in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -3615,11 +3673,11 @@ export interface Shares { /** - * @summary Returns a particular share by name. + * @summary Gets a share by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -3637,11 +3695,11 @@ export interface Shares { getWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Returns a particular share by name. + * @summary Gets a share by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -3678,13 +3736,13 @@ export interface Shares { /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -3698,11 +3756,11 @@ export interface Shares { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -3711,32 +3769,30 @@ export interface Shares { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -3757,13 +3813,13 @@ export interface Shares { createOrUpdateWithHttpOperationResponse(deviceName: string, name: string, share: models.Share, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -3777,11 +3833,11 @@ export interface Shares { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -3790,32 +3846,30 @@ export interface Shares { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -3857,9 +3911,9 @@ export interface Shares { /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -3879,9 +3933,9 @@ export interface Shares { /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -3917,12 +3971,11 @@ export interface Shares { /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -3940,12 +3993,11 @@ export interface Shares { refreshWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -3981,13 +4033,13 @@ export interface Shares { /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -4001,11 +4053,11 @@ export interface Shares { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -4014,32 +4066,30 @@ export interface Shares { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -4060,13 +4110,13 @@ export interface Shares { beginCreateOrUpdateWithHttpOperationResponse(deviceName: string, name: string, share: models.Share, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -4080,11 +4130,11 @@ export interface Shares { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -4093,32 +4143,30 @@ export interface Shares { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -4160,9 +4208,9 @@ export interface Shares { /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -4182,9 +4230,9 @@ export interface Shares { /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -4220,12 +4268,11 @@ export interface Shares { /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -4243,12 +4290,11 @@ export interface Shares { beginRefreshWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -4353,7 +4399,7 @@ export interface StorageAccountCredentials { * @summary Gets all the storage account credentials in a data box edge/gateway * device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -4374,7 +4420,7 @@ export interface StorageAccountCredentials { * @summary Gets all the storage account credentials in a data box edge/gateway * device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -4414,9 +4460,9 @@ export interface StorageAccountCredentials { /** * Gets the properties of the specified storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential to be fetched. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -4436,9 +4482,9 @@ export interface StorageAccountCredentials { /** * Gets the properties of the specified storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential to be fetched. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -4478,17 +4524,16 @@ export interface StorageAccountCredentials { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -4498,15 +4543,15 @@ export interface StorageAccountCredentials { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -4537,17 +4582,16 @@ export interface StorageAccountCredentials { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -4557,15 +4601,15 @@ export interface StorageAccountCredentials { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -4616,9 +4660,9 @@ export interface StorageAccountCredentials { /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -4638,9 +4682,9 @@ export interface StorageAccountCredentials { /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -4678,17 +4722,16 @@ export interface StorageAccountCredentials { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -4698,15 +4741,15 @@ export interface StorageAccountCredentials { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -4737,17 +4780,16 @@ export interface StorageAccountCredentials { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -4757,15 +4799,15 @@ export interface StorageAccountCredentials { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -4816,9 +4858,9 @@ export interface StorageAccountCredentials { /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -4838,9 +4880,9 @@ export interface StorageAccountCredentials { /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -4945,9 +4987,9 @@ export interface Triggers { /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -4965,9 +5007,9 @@ export interface Triggers { listByDataBoxEdgeDeviceWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -5006,9 +5048,9 @@ export interface Triggers { /** * Get a specific trigger by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of trigger to be fetched. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -5028,9 +5070,9 @@ export interface Triggers { /** * Get a specific trigger by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of trigger to be fetched. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -5067,14 +5109,13 @@ export interface Triggers { /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -5094,14 +5135,13 @@ export interface Triggers { createOrUpdateWithHttpOperationResponse(deviceName: string, name: string, trigger: models.Trigger, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -5142,9 +5182,9 @@ export interface Triggers { /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -5164,9 +5204,9 @@ export interface Triggers { /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -5202,14 +5242,13 @@ export interface Triggers { /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -5229,14 +5268,13 @@ export interface Triggers { beginCreateOrUpdateWithHttpOperationResponse(deviceName: string, name: string, trigger: models.Trigger, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -5277,9 +5315,9 @@ export interface Triggers { /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -5299,9 +5337,9 @@ export interface Triggers { /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -5337,7 +5375,7 @@ export interface Triggers { /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -5356,7 +5394,7 @@ export interface Triggers { listByDataBoxEdgeDeviceNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -5403,7 +5441,7 @@ export interface Users { /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -5423,7 +5461,7 @@ export interface Users { listByDataBoxEdgeDeviceWithHttpOperationResponse(deviceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -5462,11 +5500,11 @@ export interface Users { /** - * Returns the properties of the specified user. + * Gets the properties of the specified user. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be retrieved. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -5484,11 +5522,11 @@ export interface Users { getWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Returns the properties of the specified user. + * Gets the properties of the specified user. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be retrieved. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -5525,24 +5563,23 @@ export interface Users { /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -5564,24 +5601,23 @@ export interface Users { createOrUpdateWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { encryptedPassword? : models.AsymmetricEncryptedSecret, shareAccessRights? : models.ShareAccessRight[], customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -5626,7 +5662,7 @@ export interface Users { * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -5648,7 +5684,7 @@ export interface Users { * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -5684,24 +5720,23 @@ export interface Users { /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -5723,24 +5758,23 @@ export interface Users { beginCreateOrUpdateWithHttpOperationResponse(deviceName: string, name: string, resourceGroupName: string, options?: { encryptedPassword? : models.AsymmetricEncryptedSecret, shareAccessRights? : models.ShareAccessRight[], customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -5785,7 +5819,7 @@ export interface Users { * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -5807,7 +5841,7 @@ export interface Users { * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -5843,7 +5877,7 @@ export interface Users { /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -5862,7 +5896,7 @@ export interface Users { listByDataBoxEdgeDeviceNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. diff --git a/lib/services/edgegatewayManagement/lib/operations/index.js b/lib/services/edgegatewayManagement/lib/operations/index.js index db5e505f00..6095fab8e3 100644 --- a/lib/services/edgegatewayManagement/lib/operations/index.js +++ b/lib/services/edgegatewayManagement/lib/operations/index.js @@ -18,6 +18,7 @@ exports.Operations = require('./operations'); exports.Devices = require('./devices'); exports.Alerts = require('./alerts'); exports.BandwidthSchedules = require('./bandwidthSchedules'); +exports.Jobs = require('./jobs'); exports.OperationsStatus = require('./operationsStatus'); exports.Orders = require('./orders'); exports.Roles = require('./roles'); diff --git a/lib/services/edgegatewayManagement/lib/operations/jobs.js b/lib/services/edgegatewayManagement/lib/operations/jobs.js new file mode 100644 index 0000000000..d3a30d16e9 --- /dev/null +++ b/lib/services/edgegatewayManagement/lib/operations/jobs.js @@ -0,0 +1,274 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * 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. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * @summary Gets the details of a specified job on a data box edge/gateway + * device. + * + * @param {string} deviceName The device name. + * + * @param {string} name The job name. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @param {function} callback - The callback. + * + * @returns {function} callback(err, result, request, response) + * + * {Error} err - The Error object if an error occurred, null otherwise. + * + * {object} [result] - The deserialized result object if an error did not occur. + * See {@link Job} for more information. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ +function _get(deviceName, name, resourceGroupName, options, callback) { + /* jshint validthis: true */ + let client = this.client; + if(!callback && typeof options === 'function') { + callback = options; + options = null; + } + if (!callback) { + throw new Error('callback cannot be null.'); + } + // Validate + try { + if (deviceName === null || deviceName === undefined || typeof deviceName.valueOf() !== 'string') { + throw new Error('deviceName cannot be null or undefined and it must be of type string.'); + } + if (name === null || name === undefined || typeof name.valueOf() !== 'string') { + throw new Error('name cannot be null or undefined and it must be of type string.'); + } + if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { + throw new Error('this.client.subscriptionId cannot be null or undefined and it must be of type string.'); + } + if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { + throw new Error('resourceGroupName cannot be null or undefined and it must be of type string.'); + } + if (this.client.apiVersion === null || this.client.apiVersion === undefined || typeof this.client.apiVersion.valueOf() !== 'string') { + throw new Error('this.client.apiVersion cannot be null or undefined and it must be of type string.'); + } + if (this.client.acceptLanguage !== null && this.client.acceptLanguage !== undefined && typeof this.client.acceptLanguage.valueOf() !== 'string') { + throw new Error('this.client.acceptLanguage must be of type string.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}'; + requestUrl = requestUrl.replace('{deviceName}', encodeURIComponent(deviceName)); + requestUrl = requestUrl.replace('{name}', encodeURIComponent(name)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + let queryParameters = []; + queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); + if (queryParameters.length > 0) { + requestUrl += '?' + queryParameters.join('&'); + } + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + if (this.client.generateClientRequestId) { + httpRequest.headers['x-ms-client-request-id'] = msRestAzure.generateUuid(); + } + if (this.client.acceptLanguage !== undefined && this.client.acceptLanguage !== null) { + httpRequest.headers['accept-language'] = this.client.acceptLanguage; + } + if(options) { + for(let headerName in options['customHeaders']) { + if (options['customHeaders'].hasOwnProperty(headerName)) { + httpRequest.headers[headerName] = options['customHeaders'][headerName]; + } + } + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200) { + let error = new Error(responseBody); + error.statusCode = response.statusCode; + error.request = msRest.stripRequest(httpRequest); + error.response = msRest.stripResponse(response); + if (responseBody === '') responseBody = null; + let parsedErrorResponse; + try { + parsedErrorResponse = JSON.parse(responseBody); + if (parsedErrorResponse) { + if (parsedErrorResponse.error) parsedErrorResponse = parsedErrorResponse.error; + if (parsedErrorResponse.code) error.code = parsedErrorResponse.code; + if (parsedErrorResponse.message) error.message = parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['CloudError']().mapper(); + error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); + } + } catch (defaultError) { + error.message = `Error "${defaultError.message}" occurred in deserializing the responseBody ` + + `- "${responseBody}" for the default response.`; + return callback(error); + } + return callback(error); + } + // Create Result + let result = null; + if (responseBody === '') responseBody = null; + // Deserialize Response + if (statusCode === 200) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Job']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError.request = msRest.stripRequest(httpRequest); + deserializationError.response = msRest.stripResponse(response); + return callback(deserializationError); + } + } + + return callback(null, result, httpRequest, response); + }); +} + +/** Class representing a Jobs. */ +class Jobs { + /** + * Create a Jobs. + * @param {DataBoxEdgeManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._get = _get; + } + + /** + * @summary Gets the details of a specified job on a data box edge/gateway + * device. + * + * @param {string} deviceName The device name. + * + * @param {string} name The job name. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @returns {Promise} A promise is returned + * + * @resolve {HttpOperationResponse} - The deserialized result object. + * + * @reject {Error} - The error object. + */ + getWithHttpOperationResponse(deviceName, name, resourceGroupName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._get(deviceName, name, resourceGroupName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * @summary Gets the details of a specified job on a data box edge/gateway + * device. + * + * @param {string} deviceName The device name. + * + * @param {string} name The job name. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @param {function} [optionalCallback] - The optional callback. + * + * @returns {function|Promise} If a callback was passed as the last parameter + * then it returns the callback else returns a Promise. + * + * {Promise} A promise is returned + * + * @resolve {Job} - The deserialized result object. + * + * @reject {Error} - The error object. + * + * {function} optionalCallback(err, result, request, response) + * + * {Error} err - The Error object if an error occurred, null otherwise. + * + * {object} [result] - The deserialized result object if an error did not occur. + * See {@link Job} for more information. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + get(deviceName, name, resourceGroupName, options, optionalCallback) { + let client = this.client; + let self = this; + if (!optionalCallback && typeof options === 'function') { + optionalCallback = options; + options = null; + } + if (!optionalCallback) { + return new Promise((resolve, reject) => { + self._get(deviceName, name, resourceGroupName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._get(deviceName, name, resourceGroupName, options, optionalCallback); + } + } + +} + +module.exports = Jobs; diff --git a/lib/services/edgegatewayManagement/lib/operations/operations.js b/lib/services/edgegatewayManagement/lib/operations/operations.js index 8976860479..ad8105de99 100644 --- a/lib/services/edgegatewayManagement/lib/operations/operations.js +++ b/lib/services/edgegatewayManagement/lib/operations/operations.js @@ -15,7 +15,7 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {object} [options] Optional Parameters. * @@ -144,7 +144,7 @@ function _list(options, callback) { } /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -283,7 +283,7 @@ class Operations { } /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {object} [options] Optional Parameters. * @@ -311,7 +311,7 @@ class Operations { } /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {object} [options] Optional Parameters. * @@ -361,7 +361,7 @@ class Operations { } /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -392,7 +392,7 @@ class Operations { } /** - * @summary Lists all the operations supported. + * @summary List all the supported operations. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. diff --git a/lib/services/edgegatewayManagement/lib/operations/operationsStatus.js b/lib/services/edgegatewayManagement/lib/operations/operationsStatus.js index 3560b89d43..f3b946ca84 100644 --- a/lib/services/edgegatewayManagement/lib/operations/operationsStatus.js +++ b/lib/services/edgegatewayManagement/lib/operations/operationsStatus.js @@ -15,8 +15,8 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * @summary Returns the job details of the specified job on a data box - * edge/gateway device. + * @summary Gets the details of a specified job on a data box edge/gateway + * device. * * @param {string} deviceName The device name. * @@ -178,8 +178,8 @@ class OperationsStatus { } /** - * @summary Returns the job details of the specified job on a data box - * edge/gateway device. + * @summary Gets the details of a specified job on a data box edge/gateway + * device. * * @param {string} deviceName The device name. * @@ -213,8 +213,8 @@ class OperationsStatus { } /** - * @summary Returns the job details of the specified job on a data box - * edge/gateway device. + * @summary Gets the details of a specified job on a data box edge/gateway + * device. * * @param {string} deviceName The device name. * diff --git a/lib/services/edgegatewayManagement/lib/operations/orders.js b/lib/services/edgegatewayManagement/lib/operations/orders.js index fad37d82ae..c2f6b7ddad 100644 --- a/lib/services/edgegatewayManagement/lib/operations/orders.js +++ b/lib/services/edgegatewayManagement/lib/operations/orders.js @@ -15,9 +15,9 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -160,9 +160,9 @@ function _listByDataBoxEdgeDevice(deviceName, resourceGroupName, options, callba } /** - * @summary Get a specific order by name. + * @summary Gets a specific order by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -308,32 +308,29 @@ function _get(deviceName, resourceGroupName, options, callback) { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -343,16 +340,16 @@ function _get(deviceName, resourceGroupName, options, callback) { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -431,7 +428,7 @@ function _createOrUpdate(deviceName, order, resourceGroupName, options, callback /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -493,32 +490,29 @@ function _deleteMethod(deviceName, resourceGroupName, options, callback) { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -528,16 +522,16 @@ function _deleteMethod(deviceName, resourceGroupName, options, callback) { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -700,7 +694,7 @@ function _beginCreateOrUpdate(deviceName, order, resourceGroupName, options, cal /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -825,7 +819,7 @@ function _beginDeleteMethod(deviceName, resourceGroupName, options, callback) { } /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -969,9 +963,9 @@ class Orders { } /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1001,9 +995,9 @@ class Orders { } /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1055,9 +1049,9 @@ class Orders { } /** - * @summary Get a specific order by name. + * @summary Gets a specific order by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1087,9 +1081,9 @@ class Orders { } /** - * @summary Get a specific order by name. + * @summary Gets a specific order by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1143,32 +1137,29 @@ class Orders { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -1178,16 +1169,16 @@ class Orders { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -1220,32 +1211,29 @@ class Orders { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -1255,16 +1243,16 @@ class Orders { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -1319,7 +1307,7 @@ class Orders { /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1351,7 +1339,7 @@ class Orders { /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1404,32 +1392,29 @@ class Orders { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -1439,16 +1424,16 @@ class Orders { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -1481,32 +1466,29 @@ class Orders { /** * @summary Creates or updates an order. * - * @param {string} deviceName Name of the edge device for which order needs to - * be added or updated. + * @param {string} deviceName The order details of a device. * - * @param {object} order Order to be added. + * @param {object} order The order to be created or updated. * - * @param {object} [order.contactInformation] The contact details. + * @param {object} order.contactInformation The contact details. * - * @param {string} order.contactInformation.contactPerson Gets or sets the - * contact person. + * @param {string} order.contactInformation.contactPerson The contact person + * name. * - * @param {string} order.contactInformation.companyName Gets or sets the name - * of the company. + * @param {string} order.contactInformation.companyName The name of the + * company. * - * @param {string} order.contactInformation.phone Gets or sets the phone - * number. + * @param {string} order.contactInformation.phone The phone number. * - * @param {array} order.contactInformation.emailList Gets or sets the email - * list. + * @param {array} order.contactInformation.emailList The email list. * - * @param {object} [order.shippingAddress] The shipping address. + * @param {object} order.shippingAddress The shipping address. * * @param {string} order.shippingAddress.addressLine1 The address line1. * - * @param {string} order.shippingAddress.addressLine2 The address line2. + * @param {string} [order.shippingAddress.addressLine2] The address line2. * - * @param {string} order.shippingAddress.addressLine3 The address line3. + * @param {string} [order.shippingAddress.addressLine3] The address line3. * * @param {string} order.shippingAddress.postalCode The postal code. * @@ -1516,16 +1498,16 @@ class Orders { * * @param {string} order.shippingAddress.country The country name. * - * @param {object} [order.changeStatusTo] Current status of the Order. + * @param {object} [order.currentStatus] Current status of the order. * - * @param {string} order.changeStatusTo.status Status of the order pertaining - * to the allowed StatusTypes. Possible values include: 'Untracked', + * @param {string} order.currentStatus.status Status of the order as per the + * allowed status types. Possible values include: 'Untracked', * 'AwaitingFulfilment', 'AwaitingPreparation', 'AwaitingShipment', 'Shipped', * 'Arriving', 'Delivered', 'ReplacementRequested', 'LostDevice', 'Declined', * 'ReturnInitiated', 'AwaitingReturnShipment', 'ShippedBack', * 'CollectedAtMicrosoft' * - * @param {string} [order.changeStatusTo.comments] Comments related to this + * @param {string} [order.currentStatus.comments] Comments related to this * status change. * * @param {string} resourceGroupName The resource group name. @@ -1580,7 +1562,7 @@ class Orders { /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1612,7 +1594,7 @@ class Orders { /** * @summary Deletes the order related to the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1663,7 +1645,7 @@ class Orders { } /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1694,7 +1676,7 @@ class Orders { } /** - * @summary List all the orders related to the device. + * @summary Lists all the orders related to a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. diff --git a/lib/services/edgegatewayManagement/lib/operations/roles.js b/lib/services/edgegatewayManagement/lib/operations/roles.js index 5e9232ef22..6a88d6cf27 100644 --- a/lib/services/edgegatewayManagement/lib/operations/roles.js +++ b/lib/services/edgegatewayManagement/lib/operations/roles.js @@ -17,7 +17,7 @@ const WebResource = msRest.WebResource; /** * Lists all the roles configured in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -160,11 +160,11 @@ function _listByDataBoxEdgeDevice(deviceName, resourceGroupName, options, callba } /** - * Get a specific role by name. + * Gets a specific role by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of role to be fetched. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -314,12 +314,11 @@ function _get(deviceName, name, resourceGroupName, options, callback) { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -397,11 +396,11 @@ function _createOrUpdate(deviceName, name, role, resourceGroupName, options, cal /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -463,12 +462,11 @@ function _deleteMethod(deviceName, name, resourceGroupName, options, callback) { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -634,11 +632,11 @@ function _beginCreateOrUpdate(deviceName, name, role, resourceGroupName, options } /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -913,7 +911,7 @@ class Roles { /** * Lists all the roles configured in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -945,7 +943,7 @@ class Roles { /** * Lists all the roles configured in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -997,11 +995,11 @@ class Roles { } /** - * Get a specific role by name. + * Gets a specific role by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of role to be fetched. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -1031,11 +1029,11 @@ class Roles { } /** - * Get a specific role by name. + * Gets a specific role by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of role to be fetched. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -1089,12 +1087,11 @@ class Roles { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -1128,12 +1125,11 @@ class Roles { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -1187,11 +1183,11 @@ class Roles { } /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -1221,11 +1217,11 @@ class Roles { } /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -1278,12 +1274,11 @@ class Roles { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -1317,12 +1312,11 @@ class Roles { /** * Create or update a role. * - * @param {string} deviceName Name of the device in which the role needs to be - * added or updated. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role to be updated. + * @param {string} name The role name. * - * @param {object} role Role to be added. + * @param {object} role The role properties. * * @param {string} role.kind Polymorphic Discriminator * @@ -1376,11 +1370,11 @@ class Roles { } /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * @@ -1410,11 +1404,11 @@ class Roles { } /** - * Deletes the role on the gateway device. + * Deletes the role on the data box edge device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the role which needs to be deleted. + * @param {string} name The role name. * * @param {string} resourceGroupName The resource group name. * diff --git a/lib/services/edgegatewayManagement/lib/operations/shares.js b/lib/services/edgegatewayManagement/lib/operations/shares.js index 6eec4d7604..1232bd26dd 100644 --- a/lib/services/edgegatewayManagement/lib/operations/shares.js +++ b/lib/services/edgegatewayManagement/lib/operations/shares.js @@ -17,7 +17,7 @@ const WebResource = msRest.WebResource; /** * @summary Lists all the shares in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -160,11 +160,11 @@ function _listByDataBoxEdgeDevice(deviceName, resourceGroupName, options, callba } /** - * @summary Returns a particular share by name. + * @summary Gets a share by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -312,13 +312,13 @@ function _get(deviceName, name, resourceGroupName, options, callback) { /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -332,11 +332,11 @@ function _get(deviceName, name, resourceGroupName, options, callback) { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -345,32 +345,30 @@ function _get(deviceName, name, resourceGroupName, options, callback) { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -451,9 +449,9 @@ function _createOrUpdate(deviceName, name, share, resourceGroupName, options, ca /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -514,12 +512,11 @@ function _deleteMethod(deviceName, name, resourceGroupName, options, callback) { /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -579,13 +576,13 @@ function _refresh(deviceName, name, resourceGroupName, options, callback) { } /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -599,11 +596,11 @@ function _refresh(deviceName, name, resourceGroupName, options, callback) { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -612,32 +609,30 @@ function _refresh(deviceName, name, resourceGroupName, options, callback) { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -806,9 +801,9 @@ function _beginCreateOrUpdate(deviceName, name, share, resourceGroupName, option /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -937,12 +932,11 @@ function _beginDeleteMethod(deviceName, name, resourceGroupName, options, callba } /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -1219,7 +1213,7 @@ class Shares { /** * @summary Lists all the shares in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1251,7 +1245,7 @@ class Shares { /** * @summary Lists all the shares in a data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1303,11 +1297,11 @@ class Shares { } /** - * @summary Returns a particular share by name. + * @summary Gets a share by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -1337,11 +1331,11 @@ class Shares { } /** - * @summary Returns a particular share by name. + * @summary Gets a share by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -1393,13 +1387,13 @@ class Shares { } /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -1413,11 +1407,11 @@ class Shares { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -1426,32 +1420,30 @@ class Shares { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -1484,13 +1476,13 @@ class Shares { } /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -1504,11 +1496,11 @@ class Shares { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -1517,32 +1509,30 @@ class Shares { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -1599,9 +1589,9 @@ class Shares { /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -1633,9 +1623,9 @@ class Shares { /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -1686,12 +1676,11 @@ class Shares { } /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -1721,12 +1710,11 @@ class Shares { } /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -1777,13 +1765,13 @@ class Shares { } /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -1797,11 +1785,11 @@ class Shares { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -1810,32 +1798,30 @@ class Shares { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -1868,13 +1854,13 @@ class Shares { } /** - * @summary Creates a new share or update an existing share on the device. + * @summary Creates a new share or updates an existing share on the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be added/updated. + * @param {string} name The share name. * - * @param {object} share The share object containing the share details. + * @param {object} share The share properties. * * @param {string} [share.description] Description for the share. * @@ -1888,11 +1874,11 @@ class Shares { * share. * * @param {string} share.azureContainerInfo.storageAccountCredentialId ID of - * the Storage account credential to be used for accessing storage. + * the storage account credential used to access storage. * * @param {string} share.azureContainerInfo.containerName Container name (Based - * on the data format specified, represents the name of Azure file/ Page blob / - * Block blob). + * on the data format specified, this represents the name of Azure Files/Page + * blob/Block blob). * * @param {string} share.azureContainerInfo.dataFormat Storage format used for * the file represented by the share. Possible values include: 'BlockBlob', @@ -1901,32 +1887,30 @@ class Shares { * @param {string} share.accessProtocol Access protocol to be used by the * share. Possible values include: 'SMB', 'NFS' * - * @param {array} [share.userAccessRights] Mapping of Users and corresponding - * access rights on the share (mandatory for SMB protocol). + * @param {array} [share.userAccessRights] Mapping of users and corresponding + * access rights on the share (required for SMB protocol). * * @param {array} [share.clientAccessRights] List of IP addresses and - * corresponding access rights on the share(mandatory for NFS protocol). + * corresponding access rights on the share(required for NFS protocol). * * @param {object} [share.refreshDetails] Details of the refresh job on this * share. * - * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a - * RefreshShare job is currently inprogress on this share - this field - * indicates the ArmId of that job. Empty otherwise. + * @param {string} [share.refreshDetails.inProgressRefreshJobId] If a refresh + * share job is currently in progress on this share, this field indicates the + * ARM resource ID of that job. The field is empty if no job is in progress. * * @param {date} [share.refreshDetails.lastCompletedRefreshJobTimeInUTC] - * Indicates the job completed time of the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * Indicates the completed time for the last refresh job on this particular + * share, if any.This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.errorManifestFile] Indicates the * relative path of the error xml for the last refresh job on this particular - * share, if any. - * This could be a failed job or a successful job. + * share, if any. This could be a failed job or a successful job. * * @param {string} [share.refreshDetails.lastJob] Indicates the id of the last - * refresh job on this particular share,if any. - * This could be a failed job or a successful job. + * refresh job on this particular share,if any. This could be a failed job or a + * successful job. * * @param {string} [share.dataPolicy] Data policy of the share. Possible values * include: 'Cloud', 'Local' @@ -1983,9 +1967,9 @@ class Shares { /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -2017,9 +2001,9 @@ class Shares { /** * Deletes the share on the data box edge/gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share which needs to be deleted. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -2070,12 +2054,11 @@ class Shares { } /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * @@ -2105,12 +2088,11 @@ class Shares { } /** - * @summary Triggers a manual refresh of the share metadata with the actual - * cloud storage account. + * @summary Refreshes the share metadata with the data from the cloud. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the share. + * @param {string} name The share name. * * @param {string} resourceGroupName The resource group name. * diff --git a/lib/services/edgegatewayManagement/lib/operations/storageAccountCredentials.js b/lib/services/edgegatewayManagement/lib/operations/storageAccountCredentials.js index 991db54dc1..f0c00ee404 100644 --- a/lib/services/edgegatewayManagement/lib/operations/storageAccountCredentials.js +++ b/lib/services/edgegatewayManagement/lib/operations/storageAccountCredentials.js @@ -18,7 +18,7 @@ const WebResource = msRest.WebResource; * @summary Gets all the storage account credentials in a data box edge/gateway * device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -164,9 +164,9 @@ function _listByDataBoxEdgeDevice(deviceName, resourceGroupName, options, callba /** * Gets the properties of the specified storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential to be fetched. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -317,17 +317,16 @@ function _get(deviceName, name, resourceGroupName, options, callback) { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -337,15 +336,15 @@ function _get(deviceName, name, resourceGroupName, options, callback) { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -435,9 +434,9 @@ function _createOrUpdate(deviceName, name, storageAccountCredential, resourceGro /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -499,17 +498,16 @@ function _deleteMethod(deviceName, name, resourceGroupName, options, callback) { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -519,15 +517,15 @@ function _deleteMethod(deviceName, name, resourceGroupName, options, callback) { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -705,9 +703,9 @@ function _beginCreateOrUpdate(deviceName, name, storageAccountCredential, resour /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -985,7 +983,7 @@ class StorageAccountCredentials { * @summary Gets all the storage account credentials in a data box edge/gateway * device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1018,7 +1016,7 @@ class StorageAccountCredentials { * @summary Gets all the storage account credentials in a data box edge/gateway * device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -1073,9 +1071,9 @@ class StorageAccountCredentials { /** * Gets the properties of the specified storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential to be fetched. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -1107,9 +1105,9 @@ class StorageAccountCredentials { /** * Gets the properties of the specified storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential to be fetched. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -1164,17 +1162,16 @@ class StorageAccountCredentials { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -1184,15 +1181,15 @@ class StorageAccountCredentials { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -1235,17 +1232,16 @@ class StorageAccountCredentials { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -1255,15 +1251,15 @@ class StorageAccountCredentials { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -1329,9 +1325,9 @@ class StorageAccountCredentials { /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -1363,9 +1359,9 @@ class StorageAccountCredentials { /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -1418,17 +1414,16 @@ class StorageAccountCredentials { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -1438,15 +1433,15 @@ class StorageAccountCredentials { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -1489,17 +1484,16 @@ class StorageAccountCredentials { /** * Creates or updates the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} name The storage account credential name. * - * @param {object} storageAccountCredential The storage account credential to - * be added or updated. + * @param {object} storageAccountCredential The storage account credential. * * @param {string} storageAccountCredential.alias Alias for the storage * account. * - * @param {string} [storageAccountCredential.userName] UserName for the storage + * @param {string} [storageAccountCredential.userName] Username for the storage * account. * * @param {object} [storageAccountCredential.accountKey] Encrypted storage key. @@ -1509,15 +1503,15 @@ class StorageAccountCredentials { * * @param {string} * [storageAccountCredential.accountKey.encryptionCertThumbprint] Thumbprint - * certificate that was used to encrypt "Value". If the value in unencrypted, - * it will be null. + * certificate used to encrypt \"Value\". If the value is unencrypted, it will + * be null. * * @param {string} storageAccountCredential.accountKey.encryptionAlgorithm The * algorithm used to encrypt "Value". Possible values include: 'None', * 'AES256', 'RSAES_PKCS1_v_1_5' * - * @param {string} [storageAccountCredential.connectionString] ConnectionString - * for the storage account. This needs to be specified if UserName/AccountKey + * @param {string} [storageAccountCredential.connectionString] Connection + * string for the storage account. Use this string if username and account key * are not specified. * * @param {string} storageAccountCredential.sslStatus Signifies whether SSL @@ -1583,9 +1577,9 @@ class StorageAccountCredentials { /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * @@ -1617,9 +1611,9 @@ class StorageAccountCredentials { /** * Deletes the storage account credential. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the storage account credential. + * @param {string} name The storage account credential name. * * @param {string} resourceGroupName The resource group name. * diff --git a/lib/services/edgegatewayManagement/lib/operations/triggers.js b/lib/services/edgegatewayManagement/lib/operations/triggers.js index f19f0cd531..c3b3d2df67 100644 --- a/lib/services/edgegatewayManagement/lib/operations/triggers.js +++ b/lib/services/edgegatewayManagement/lib/operations/triggers.js @@ -15,9 +15,9 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -162,9 +162,9 @@ function _listByDataBoxEdgeDevice(deviceName, resourceGroupName, options, callba /** * Get a specific trigger by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of trigger to be fetched. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -312,14 +312,13 @@ function _get(deviceName, name, resourceGroupName, options, callback) { /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -399,9 +398,9 @@ function _createOrUpdate(deviceName, name, trigger, resourceGroupName, options, /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -461,14 +460,13 @@ function _deleteMethod(deviceName, name, resourceGroupName, options, callback) { } /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -636,9 +634,9 @@ function _beginCreateOrUpdate(deviceName, name, trigger, resourceGroupName, opti /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -767,7 +765,7 @@ function _beginDeleteMethod(deviceName, name, resourceGroupName, options, callba } /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -911,9 +909,9 @@ class Triggers { } /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -943,9 +941,9 @@ class Triggers { } /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * * @param {string} resourceGroupName The resource group name. * @@ -999,9 +997,9 @@ class Triggers { /** * Get a specific trigger by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of trigger to be fetched. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -1033,9 +1031,9 @@ class Triggers { /** * Get a specific trigger by name. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of trigger to be fetched. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -1087,14 +1085,13 @@ class Triggers { } /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -1126,14 +1123,13 @@ class Triggers { } /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -1189,9 +1185,9 @@ class Triggers { /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -1223,9 +1219,9 @@ class Triggers { /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -1276,14 +1272,13 @@ class Triggers { } /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -1315,14 +1310,13 @@ class Triggers { } /** - * Create or update a trigger. + * Creates or updates a trigger. * - * @param {string} deviceName Name of the edge device in which trigger needs to - * be added or updated. + * @param {string} deviceName Creates or updates a trigger * - * @param {string} name Name of trigger to be added or updated. + * @param {string} name The trigger name. * - * @param {object} trigger Trigger to be added. + * @param {object} trigger The trigger. * * @param {string} trigger.kind Polymorphic Discriminator * @@ -1378,9 +1372,9 @@ class Triggers { /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -1412,9 +1406,9 @@ class Triggers { /** * Deletes the trigger on the gateway device. * - * @param {string} deviceName Name of the device. + * @param {string} deviceName The device name. * - * @param {string} name Name of the trigger which needs to be deleted. + * @param {string} name The trigger name. * * @param {string} resourceGroupName The resource group name. * @@ -1465,7 +1459,7 @@ class Triggers { } /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1496,7 +1490,7 @@ class Triggers { } /** - * List all the triggers configured in the device. + * Lists all the triggers configured in the device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. diff --git a/lib/services/edgegatewayManagement/lib/operations/users.js b/lib/services/edgegatewayManagement/lib/operations/users.js index 7d770ce2ba..a192a37155 100644 --- a/lib/services/edgegatewayManagement/lib/operations/users.js +++ b/lib/services/edgegatewayManagement/lib/operations/users.js @@ -15,7 +15,7 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -160,11 +160,11 @@ function _listByDataBoxEdgeDevice(deviceName, resourceGroupName, options, callba } /** - * Returns the properties of the specified user. + * Gets the properties of the specified user. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be retrieved. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -312,24 +312,23 @@ function _get(deviceName, name, resourceGroupName, options, callback) { /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -413,7 +412,7 @@ function _createOrUpdate(deviceName, name, resourceGroupName, options, callback) * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -473,24 +472,23 @@ function _deleteMethod(deviceName, name, resourceGroupName, options, callback) { } /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -671,7 +669,7 @@ function _beginCreateOrUpdate(deviceName, name, resourceGroupName, options, call * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -800,7 +798,7 @@ function _beginDeleteMethod(deviceName, name, resourceGroupName, options, callba } /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -944,7 +942,7 @@ class Users { } /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -976,7 +974,7 @@ class Users { } /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} deviceName The device name. * @@ -1030,11 +1028,11 @@ class Users { } /** - * Returns the properties of the specified user. + * Gets the properties of the specified user. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be retrieved. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -1064,11 +1062,11 @@ class Users { } /** - * Returns the properties of the specified user. + * Gets the properties of the specified user. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be retrieved. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -1120,24 +1118,23 @@ class Users { } /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -1171,24 +1168,23 @@ class Users { } /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -1248,7 +1244,7 @@ class Users { * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -1282,7 +1278,7 @@ class Users { * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -1333,24 +1329,23 @@ class Users { } /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -1384,24 +1379,23 @@ class Users { } /** - * Create a new user or update an existing user's information on a data box + * Creates a new user or updates an existing user's information on a data box * edge/gateway device. * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be added/updated. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.encryptedPassword] The details of the password - * specified for the user. + * @param {object} [options.encryptedPassword] The password details. * * @param {string} options.encryptedPassword.value The value of the secret. * * @param {string} [options.encryptedPassword.encryptionCertThumbprint] - * Thumbprint certificate that was used to encrypt "Value". If the value in + * Thumbprint certificate used to encrypt \"Value\". If the value is * unencrypted, it will be null. * * @param {string} options.encryptedPassword.encryptionAlgorithm The algorithm @@ -1461,7 +1455,7 @@ class Users { * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -1495,7 +1489,7 @@ class Users { * * @param {string} deviceName The device name. * - * @param {string} name The name of the user who needs to be deleted. + * @param {string} name The user name. * * @param {string} resourceGroupName The resource group name. * @@ -1546,7 +1540,7 @@ class Users { } /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1577,7 +1571,7 @@ class Users { } /** - * Returns all the users registered in a data box edge/gateway device. + * Gets all the users registered on a data box edge/gateway device. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation.