diff --git a/packages/@azure/arm-edgegateway/lib/models/alertsMappers.ts b/packages/@azure/arm-edgegateway/lib/models/alertsMappers.ts index 978bea78dc66..946edc4f7577 100644 --- a/packages/@azure/arm-edgegateway/lib/models/alertsMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/alertsMappers.ts @@ -1,54 +1,57 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - Address, - Alert, - AlertErrorDetails, AlertList, + Alert, ARMBaseModel, - AsymmetricEncryptedSecret, - Authentication, - AzureContainerInfo, - BandwidthSchedule, BaseResource, - ClientAccessRight, + AlertErrorDetails, CloudError, - ContactDetails, + BandwidthSchedule, DataBoxEdgeDevice, + Sku, DataBoxEdgeDeviceExtendedInfo, - FileEventTrigger, - FileSourceInfo, - IoTDeviceInfo, - IoTRole, - Ipv4Config, - Ipv6Config, - MountPointMap, + NetworkSettings, NetworkAdapter, NetworkAdapterPosition, - NetworkSettings, + Ipv4Config, + Ipv6Config, Order, + ContactDetails, + Address, OrderStatus, - PeriodicTimerEventTrigger, - PeriodicTimerSourceInfo, - RefreshDetails, + TrackingInfo, Role, - RoleSinkInfo, SecuritySettings, + AsymmetricEncryptedSecret, Share, - ShareAccessRight, - Sku, + AzureContainerInfo, + UserAccessRight, + ClientAccessRight, + RefreshDetails, + MountPointMap, StorageAccountCredential, - SymmetricKey, - TrackingInfo, Trigger, UpdateSummary, User, - UserAccessRight + ShareAccessRight, + FileEventTrigger, + FileSourceInfo, + RoleSinkInfo, + IoTRole, + IoTDeviceInfo, + Authentication, + SymmetricKey, + PeriodicTimerEventTrigger, + PeriodicTimerSourceInfo } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/bandwidthSchedulesMappers.ts b/packages/@azure/arm-edgegateway/lib/models/bandwidthSchedulesMappers.ts index 36ef672b6f4d..c8df8c4c6215 100644 --- a/packages/@azure/arm-edgegateway/lib/models/bandwidthSchedulesMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/bandwidthSchedulesMappers.ts @@ -1,54 +1,57 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - Address, - Alert, - AlertErrorDetails, - ARMBaseModel, - AsymmetricEncryptedSecret, - Authentication, - AzureContainerInfo, - BandwidthSchedule, BandwidthSchedulesList, + BandwidthSchedule, + ARMBaseModel, BaseResource, - ClientAccessRight, CloudError, - ContactDetails, + Alert, + AlertErrorDetails, DataBoxEdgeDevice, + Sku, DataBoxEdgeDeviceExtendedInfo, - FileEventTrigger, - FileSourceInfo, - IoTDeviceInfo, - IoTRole, - Ipv4Config, - Ipv6Config, - MountPointMap, + NetworkSettings, NetworkAdapter, NetworkAdapterPosition, - NetworkSettings, + Ipv4Config, + Ipv6Config, Order, + ContactDetails, + Address, OrderStatus, - PeriodicTimerEventTrigger, - PeriodicTimerSourceInfo, - RefreshDetails, + TrackingInfo, Role, - RoleSinkInfo, SecuritySettings, + AsymmetricEncryptedSecret, Share, - ShareAccessRight, - Sku, + AzureContainerInfo, + UserAccessRight, + ClientAccessRight, + RefreshDetails, + MountPointMap, StorageAccountCredential, - SymmetricKey, - TrackingInfo, Trigger, UpdateSummary, User, - UserAccessRight + ShareAccessRight, + FileEventTrigger, + FileSourceInfo, + RoleSinkInfo, + IoTRole, + IoTDeviceInfo, + Authentication, + SymmetricKey, + PeriodicTimerEventTrigger, + PeriodicTimerSourceInfo } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/devicesMappers.ts b/packages/@azure/arm-edgegateway/lib/models/devicesMappers.ts index 7a92c7deaf9b..2249bca4a5d1 100644 --- a/packages/@azure/arm-edgegateway/lib/models/devicesMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/devicesMappers.ts @@ -1,57 +1,60 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - Address, - Alert, - AlertErrorDetails, + DataBoxEdgeDeviceList, + DataBoxEdgeDevice, ARMBaseModel, - AsymmetricEncryptedSecret, - Authentication, - AzureContainerInfo, - BandwidthSchedule, BaseResource, - ClientAccessRight, + Sku, CloudError, - ContactDetails, - DataBoxEdgeDevice, - DataBoxEdgeDeviceExtendedInfo, - DataBoxEdgeDeviceList, DataBoxEdgeDevicePatch, - FileEventTrigger, - FileSourceInfo, - IoTDeviceInfo, - IoTRole, - Ipv4Config, - Ipv6Config, - MountPointMap, + DataBoxEdgeDeviceExtendedInfo, + NetworkSettings, NetworkAdapter, NetworkAdapterPosition, - NetworkSettings, + Ipv4Config, + Ipv6Config, + SecuritySettings, + AsymmetricEncryptedSecret, + UpdateSummary, + UploadCertificateRequest, + UploadCertificateResponse, + Alert, + AlertErrorDetails, + BandwidthSchedule, Order, + ContactDetails, + Address, OrderStatus, - PeriodicTimerEventTrigger, - PeriodicTimerSourceInfo, - RefreshDetails, + TrackingInfo, Role, - RoleSinkInfo, - SecuritySettings, Share, - ShareAccessRight, - Sku, + AzureContainerInfo, + UserAccessRight, + ClientAccessRight, + RefreshDetails, + MountPointMap, StorageAccountCredential, - SymmetricKey, - TrackingInfo, Trigger, - UpdateSummary, - UploadCertificateRequest, - UploadCertificateResponse, User, - UserAccessRight + ShareAccessRight, + FileEventTrigger, + FileSourceInfo, + RoleSinkInfo, + IoTRole, + IoTDeviceInfo, + Authentication, + SymmetricKey, + PeriodicTimerEventTrigger, + PeriodicTimerSourceInfo } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/index.ts b/packages/@azure/arm-edgegateway/lib/models/index.ts index 48922e7556d1..f2b3cf904ded 100644 --- a/packages/@azure/arm-edgegateway/lib/models/index.ts +++ b/packages/@azure/arm-edgegateway/lib/models/index.ts @@ -1,9 +1,11 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js"; @@ -11,393 +13,495 @@ import * as msRest from "@azure/ms-rest-js"; export { BaseResource, CloudError }; + /** + * @interface + * An interface representing Address. * The shipping address of the customer. + * */ export interface Address { /** - * The address line1. + * @member {string} addressLine1 The address line1. */ addressLine1: string; /** - * The address line2. + * @member {string} [addressLine2] The address line2. */ addressLine2?: string; /** - * The address line3. + * @member {string} [addressLine3] The address line3. */ addressLine3?: string; /** - * The postal code. + * @member {string} postalCode The postal code. */ postalCode: string; /** - * The city name. + * @member {string} city The city name. */ city: string; /** - * The state name. + * @member {string} state The state name. */ state: string; /** - * The country name. + * @member {string} country The country name. */ country: string; } /** + * @interface + * An interface representing AlertErrorDetails. * Error details for the alert. + * */ export interface AlertErrorDetails { /** - * Error code. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [errorCode] Error code. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly errorCode?: string; /** - * Error Message. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [errorMessage] Error Message. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly errorMessage?: string; /** - * Number of occurrences. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [occurrences] Number of occurrences. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly occurrences?: number; } /** + * @interface + * An interface representing ARMBaseModel. * Represents the base class for all object models. + * + * @extends BaseResource */ export interface ARMBaseModel extends BaseResource { /** - * The path ID that uniquely identifies the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [id] The path ID that uniquely identifies the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly id?: string; /** - * The object name. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [name] The object name. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: string; /** - * The hierarchical type of the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [type] The hierarchical type of the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly type?: string; } /** + * @interface + * An interface representing Alert. * Alert on the data box edge/gateway device. + * + * @extends ARMBaseModel */ export interface Alert extends ARMBaseModel { /** - * Alert title. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [title] Alert title. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly title?: string; /** - * Alert type. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [alertType] Alert type. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly alertType?: string; /** - * UTC time when the alert appeared. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [appearedAtDateTime] UTC time when the alert appeared. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly appearedAtDateTime?: Date; /** - * Alert recommendation. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [recommendation] Alert recommendation. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly recommendation?: string; /** - * Severity of the alert. Possible values include: 'Informational', 'Warning', 'Critical' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {AlertSeverity} [severity] Severity of the alert. Possible values + * include: 'Informational', 'Warning', 'Critical' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly severity?: AlertSeverity; /** - * Error details of the alert. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {AlertErrorDetails} [errorDetails] Error details of the alert. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly errorDetails?: AlertErrorDetails; /** - * Alert details. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {{ [propertyName: string]: string }} [detailedInformation] Alert + * details. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly detailedInformation?: { [propertyName: string]: string }; } /** + * @interface + * An interface representing AsymmetricEncryptedSecret. * Represent the secrets intended for encryption with asymmetric key pair. + * */ export interface AsymmetricEncryptedSecret { /** - * The value of the secret. + * @member {string} value The value of the secret. */ value: string; /** - * Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be - * null. + * @member {string} [encryptionCertThumbprint] Thumbprint certificate used to + * encrypt \"Value\". If the value is unencrypted, it will be null. */ encryptionCertThumbprint?: string; /** - * The algorithm used to encrypt "Value". Possible values include: 'None', 'AES256', + * @member {EncryptionAlgorithm} encryptionAlgorithm The algorithm used to + * encrypt "Value". Possible values include: 'None', 'AES256', * 'RSAES_PKCS1_v_1_5' */ encryptionAlgorithm: EncryptionAlgorithm; } /** + * @interface + * An interface representing SymmetricKey. * Symmetric key for authentication. + * */ export interface SymmetricKey { /** - * Connection string based on the symmetric key. + * @member {AsymmetricEncryptedSecret} [connectionString] Connection string + * based on the symmetric key. */ connectionString?: AsymmetricEncryptedSecret; } /** + * @interface + * An interface representing Authentication. * Authentication mechanism for IoT devices. + * */ export interface Authentication { /** - * Symmetric key for authentication. + * @member {SymmetricKey} [symmetricKey] Symmetric key for authentication. */ symmetricKey?: SymmetricKey; } /** + * @interface + * An interface representing AzureContainerInfo. * Azure container mapping of the endpoint. + * */ export interface AzureContainerInfo { /** - * ID of the storage account credential used to access storage. + * @member {string} storageAccountCredentialId ID of the storage account + * credential used to access storage. */ storageAccountCredentialId: string; /** - * Container name (Based on the data format specified, this represents the name of Azure - * Files/Page blob/Block blob). + * @member {string} containerName Container name (Based on the data format + * specified, this represents the name of Azure Files/Page blob/Block blob). */ containerName: string; /** - * Storage format used for the file represented by the share. Possible values include: - * 'BlockBlob', 'PageBlob', 'AzureFile' + * @member {AzureContainerDataFormat} dataFormat Storage format used for the + * file represented by the share. Possible values include: 'BlockBlob', + * 'PageBlob', 'AzureFile' */ dataFormat: AzureContainerDataFormat; } /** + * @interface + * An interface representing BandwidthSchedule. * The bandwidth schedule details. + * + * @extends ARMBaseModel */ export interface BandwidthSchedule extends ARMBaseModel { /** - * The start time of the schedule in UTC. + * @member {string} start The start time of the schedule in UTC. */ start: string; /** - * The stop time of the schedule in UTC. + * @member {string} stop The stop time of the schedule in UTC. */ stop: string; /** - * The bandwidth rate in Mbps. + * @member {number} rateInMbps The bandwidth rate in Mbps. */ rateInMbps: number; /** - * The days of the week when this schedule is applicable. + * @member {DayOfWeek[]} days The days of the week when this schedule is + * applicable. */ days: DayOfWeek[]; } /** - * The mapping between a particular client IP and the type of access client has on the NFS share. + * @interface + * An interface representing ClientAccessRight. + * 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. + * @member {string} client IP of the client. */ client: string; /** - * Type of access to be allowed for the client. Possible values include: 'NoAccess', 'ReadOnly', + * @member {ClientPermissionType} accessPermission Type of access to be + * allowed for the client. Possible values include: 'NoAccess', 'ReadOnly', * 'ReadWrite' */ accessPermission: ClientPermissionType; } /** + * @interface + * An interface representing ContactDetails. * Contains all the contact details of the customer. + * */ export interface ContactDetails { /** - * The contact person name. + * @member {string} contactPerson The contact person name. */ contactPerson: string; /** - * The name of the company. + * @member {string} companyName The name of the company. */ companyName: string; /** - * The phone number. + * @member {string} phone The phone number. */ phone: string; /** - * The email list. + * @member {string[]} emailList The email list. */ emailList: string[]; } /** + * @interface + * An interface representing Sku. * The SKU type. + * */ export interface Sku { /** - * SKU name. Possible values include: 'Gateway', 'Edge' + * @member {SkuName} [name] SKU name. Possible values include: 'Gateway', + * 'Edge' */ name?: SkuName; /** - * The SKU tier. This is based on the SKU name. Possible values include: 'Standard' + * @member {SkuTier} [tier] The SKU tier. This is based on the SKU name. + * Possible values include: 'Standard' */ tier?: SkuTier; } /** + * @interface + * An interface representing DataBoxEdgeDevice. * The Data Box Edge/Gateway device. + * + * @extends ARMBaseModel */ export interface DataBoxEdgeDevice extends ARMBaseModel { /** - * 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. + * @member {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. */ location: string; /** - * The list of tags that describe the device. These tags can be used to view and group this - * device (across resource groups). + * @member {{ [propertyName: string]: string }} [tags] 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. + * @member {Sku} [sku] The SKU type. */ sku?: Sku; /** - * The etag for the devices. + * @member {string} [etag] The etag for the devices. */ etag?: string; /** - * The status of the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', - * 'Online', 'Offline', 'NeedsAttention', 'Disconnected', 'PartiallyDisconnected' + * @member {DataBoxEdgeDeviceStatus} [dataBoxEdgeDeviceStatus] The status of + * the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', + * 'Online', 'Offline', 'NeedsAttention', 'Disconnected', + * 'PartiallyDisconnected' */ dataBoxEdgeDeviceStatus?: DataBoxEdgeDeviceStatus; /** - * The Serial Number of Data Box Edge/Gateway device. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [serialNumber] The Serial Number of Data Box Edge/Gateway + * device. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly serialNumber?: string; /** - * The Description of the Data Box Edge/Gateway device. + * @member {string} [description] The Description of the Data Box + * Edge/Gateway device. */ description?: string; /** - * The description of the Data Box Edge/Gateway device model. + * @member {string} [modelDescription] The description of the Data Box + * Edge/Gateway device model. */ modelDescription?: string; /** - * The type of the Data Box Edge/Gateway device. Possible values include: 'DataBoxEdgeDevice' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {DeviceType} [deviceType] The type of the Data Box Edge/Gateway + * device. Possible values include: 'DataBoxEdgeDevice' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly deviceType?: DeviceType; /** - * The Data Box Edge/Gateway device name. + * @member {string} [friendlyName] The Data Box Edge/Gateway device name. */ friendlyName?: string; /** - * The Data Box Edge/Gateway device culture. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [culture] The Data Box Edge/Gateway device culture. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly culture?: string; /** - * The Data Box Edge/Gateway device model. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [deviceModel] The Data Box Edge/Gateway device model. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly deviceModel?: string; /** - * The Data Box Edge/Gateway device software version. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [deviceSoftwareVersion] The Data Box Edge/Gateway device + * software version. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly deviceSoftwareVersion?: string; /** - * The Data Box Edge/Gateway device local capacity in MB. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [deviceLocalCapacity] The Data Box Edge/Gateway device + * local capacity in MB. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly deviceLocalCapacity?: number; /** - * The Data Box Edge/Gateway device timezone. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [timeZone] The Data Box Edge/Gateway device timezone. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly timeZone?: string; /** - * The device software version number of the device (eg: 1.2.18105.6). - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [deviceHcsVersion] The device software version number of + * the device (eg: 1.2.18105.6). + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly deviceHcsVersion?: string; /** - * Type of compute roles configured. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {RoleTypes[]} [configuredRoleTypes] Type of compute roles + * configured. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly configuredRoleTypes?: RoleTypes[]; } /** + * @interface + * An interface representing DataBoxEdgeDeviceExtendedInfo. * The extended Info of the Data Box Edge/Gateway device. + * + * @extends ARMBaseModel */ export interface DataBoxEdgeDeviceExtendedInfo extends ARMBaseModel { /** - * The Channel Integrity Key (CIK) of the device. - */ - integrityKey: string; - /** - * The certificate thumbprint that was used to encrypt the Channel Integrity Key (CIK). + * @member {string} [encryptionKeyThumbprint] The digital signature of + * encrypted certificate. */ encryptionKeyThumbprint?: string; /** - * The Channel Integrity Key (CIK) of the device. + * @member {string} [encryptionKey] The public part of the encryption + * certificate. Client uses this to encrypt any secret. */ encryptionKey?: string; /** - * The Resource ID of the Resource. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [resourceKey] The Resource ID of the Resource. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly resourceKey?: string; } /** + * @interface + * An interface representing DataBoxEdgeDevicePatch. * The Data Box Edge/Gateway device patch. + * */ export interface DataBoxEdgeDevicePatch { /** - * The tags attached to the Data Box Edge/Gateway resource. + * @member {{ [propertyName: string]: string }} [tags] The tags attached to + * the Data Box Edge/Gateway resource. */ tags?: { [propertyName: string]: string }; } /** + * @interface + * An interface representing FileSourceInfo. * File source details. + * */ export interface FileSourceInfo { /** - * File share ID. + * @member {string} shareId File share ID. */ shareId: string; } /** + * @interface + * An interface representing RoleSinkInfo. * Compute role against which events will be raised. + * */ export interface RoleSinkInfo { /** - * Compute role ID. + * @member {string} roleId Compute role ID. */ roleId: string; } @@ -408,108 +512,132 @@ export interface RoleSinkInfo { export type TriggerUnion = Trigger | FileEventTrigger | PeriodicTimerEventTrigger; /** + * @interface + * An interface representing Trigger. * Trigger details. + * */ export interface Trigger { /** - * Polymorphic Discriminator + * @member {string} kind Polymorphic Discriminator */ kind: "Trigger"; /** - * The path ID that uniquely identifies the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [id] The path ID that uniquely identifies the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly id?: string; /** - * The object name. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [name] The object name. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: string; /** - * The hierarchical type of the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [type] The hierarchical type of the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly type?: string; } /** + * @interface + * An interface representing FileEventTrigger. * Trigger details. + * */ export interface FileEventTrigger { /** - * Polymorphic Discriminator + * @member {string} kind Polymorphic Discriminator */ kind: "FileEvent"; /** - * The path ID that uniquely identifies the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [id] The path ID that uniquely identifies the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly id?: string; /** - * The object name. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [name] The object name. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: string; /** - * The hierarchical type of the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [type] The hierarchical type of the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly type?: string; /** - * File event source details. + * @member {FileSourceInfo} sourceInfo File event source details. */ sourceInfo: FileSourceInfo; /** - * Role sink info. + * @member {RoleSinkInfo} sinkInfo Role sink info. */ sinkInfo: RoleSinkInfo; /** - * 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 + * @member {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. */ customContextTag?: string; } /** + * @interface + * An interface representing IoTDeviceInfo. * Metadata of IoT device/IoT Edge device to be configured. + * */ export interface IoTDeviceInfo { /** - * ID of the IoT device/edge device. + * @member {string} deviceId ID of the IoT device/edge device. */ deviceId: string; /** - * Host name for the IoT hub associated to the device. + * @member {string} ioTHostHub Host name for the IoT hub associated to the + * device. */ ioTHostHub: string; /** - * IoT device authentication info. + * @member {Authentication} [authentication] IoT device authentication info. */ authentication?: Authentication; } /** + * @interface + * An interface representing MountPointMap. * The share mount point. + * */ export interface MountPointMap { /** - * ID of the share mounted to the role VM. + * @member {string} shareId ID of the share mounted to the role VM. */ shareId: string; /** - * ID of the role to which share is mounted. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [roleId] ID of the role to which share is mounted. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly roleId?: string; /** - * Mount point for the share. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [mountPoint] Mount point for the share. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly mountPoint?: string; /** - * Role type. Possible values include: 'IOT', 'ASA', 'Functions', 'Cognitive' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {RoleTypes} [roleType] Role type. Possible values include: 'IOT', + * 'ASA', 'Functions', 'Cognitive' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly roleType?: RoleTypes; } @@ -520,1190 +648,1540 @@ export interface MountPointMap { export type RoleUnion = Role | IoTRole; /** + * @interface + * An interface representing Role. * Compute role. + * */ export interface Role { /** - * Polymorphic Discriminator + * @member {string} kind Polymorphic Discriminator */ kind: "Role"; /** - * The path ID that uniquely identifies the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [id] The path ID that uniquely identifies the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly id?: string; /** - * The object name. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [name] The object name. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: string; /** - * The hierarchical type of the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [type] The hierarchical type of the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly type?: string; } /** + * @interface + * An interface representing IoTRole. * Compute role. + * */ export interface IoTRole { /** - * Polymorphic Discriminator + * @member {string} kind Polymorphic Discriminator */ kind: "IOT"; /** - * The path ID that uniquely identifies the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [id] The path ID that uniquely identifies the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly id?: string; /** - * The object name. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [name] The object name. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: string; /** - * The hierarchical type of the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [type] The hierarchical type of the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly type?: string; /** - * Host OS supported by the IoT role. Possible values include: 'Windows', 'Linux' + * @member {PlatformType} hostPlatform Host OS supported by the IoT role. + * Possible values include: 'Windows', 'Linux' */ hostPlatform: PlatformType; /** - * IoT device metadata to which data box edge device needs to be connected. + * @member {IoTDeviceInfo} ioTDeviceDetails IoT device metadata to which data + * box edge device needs to be connected. */ ioTDeviceDetails: IoTDeviceInfo; /** - * IoT edge device to which the IoT role needs to be configured. + * @member {IoTDeviceInfo} ioTEdgeDeviceDetails IoT edge device to which the + * IoT role needs to be configured. */ ioTEdgeDeviceDetails: IoTDeviceInfo; /** - * Mount points of shares in role(s). + * @member {MountPointMap[]} [shareMappings] Mount points of shares in + * role(s). */ shareMappings?: MountPointMap[]; /** - * Role status. Possible values include: 'Enabled', 'Disabled' + * @member {RoleStatus} roleStatus Role status. Possible values include: + * 'Enabled', 'Disabled' */ roleStatus: RoleStatus; } /** + * @interface + * An interface representing Ipv4Config. * Details related to the IPv4 address configuration. + * */ export interface Ipv4Config { /** - * The IPv4 address of the network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [ipAddress] The IPv4 address of the network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly ipAddress?: string; /** - * The IPv4 subnet of the network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [subnet] The IPv4 subnet of the network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly subnet?: string; /** - * The IPv4 gateway of the network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [gateway] The IPv4 gateway of the network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly gateway?: string; } /** + * @interface + * An interface representing Ipv6Config. * Details related to the IPv6 address configuration. + * */ export interface Ipv6Config { /** - * The IPv6 address of the network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [ipAddress] The IPv6 address of the network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly ipAddress?: string; /** - * The IPv6 prefix of the network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [prefixLength] The IPv6 prefix of the network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly prefixLength?: number; /** - * The IPv6 gateway of the network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [gateway] The IPv6 gateway of the network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly gateway?: string; } /** + * @interface + * An interface representing JobErrorItem. * The job error items. + * */ export interface JobErrorItem { /** - * The recommended actions. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string[]} [recommendations] The recommended actions. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly recommendations?: string[]; /** - * The code intended for programmatic access. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [code] The code intended for programmatic access. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly code?: string; /** - * The message that describes the error in detail. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [message] The message that describes the error in detail. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly message?: string; } /** + * @interface + * An interface representing JobErrorDetails. * The job error information containing the list of job errors. + * */ export interface JobErrorDetails { /** - * The error details. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {JobErrorItem[]} [errorDetails] The error details. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly errorDetails?: JobErrorItem[]; /** - * The code intended for programmatic access. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [code] The code intended for programmatic access. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly code?: string; /** - * The message that describes the error in detail. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [message] The message that describes the error in detail. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly message?: string; } /** + * @interface + * An interface representing UpdateDownloadProgress. * Details about the download progress of update. + * */ export interface UpdateDownloadProgress { /** - * The download phase. Possible values include: 'Unknown', 'Initializing', 'Downloading', - * 'Verifying' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {DownloadPhase} [downloadPhase] The download phase. Possible + * values include: 'Unknown', 'Initializing', 'Downloading', 'Verifying' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly downloadPhase?: DownloadPhase; /** - * Percentage of completion. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [percentComplete] Percentage of completion. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly percentComplete?: number; /** - * Total bytes to download. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [totalBytesToDownload] Total bytes to download. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly totalBytesToDownload?: number; /** - * Total bytes downloaded. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [totalBytesDownloaded] Total bytes downloaded. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly totalBytesDownloaded?: number; /** - * Number of updates to download. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [numberOfUpdatesToDownload] Number of updates to + * download. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly numberOfUpdatesToDownload?: number; /** - * Number of updates downloaded. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [numberOfUpdatesDownloaded] Number of updates downloaded. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly numberOfUpdatesDownloaded?: number; } /** + * @interface + * An interface representing UpdateInstallProgress. * Progress details during installation of updates. + * */ export interface UpdateInstallProgress { /** - * Percentage completed. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [percentComplete] Percentage completed. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly percentComplete?: number; /** - * Number of updates to install. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [numberOfUpdatesToInstall] Number of updates to install. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly numberOfUpdatesToInstall?: number; /** - * Number of updates installed. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [numberOfUpdatesInstalled] Number of updates installed. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly numberOfUpdatesInstalled?: number; } /** + * @interface + * An interface representing Job. * A device job. + * */ export interface Job { /** - * The path ID that uniquely identifies the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [id] The path ID that uniquely identifies the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly id?: string; /** - * The name of the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [name] The name of the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: string; /** - * The hierarchical type of the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [type] The hierarchical type of the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly type?: string; /** - * The current status of the job. Possible values include: 'Invalid', 'Running', 'Succeeded', - * 'Failed', 'Canceled', 'Paused', 'Scheduled' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {JobStatus} [status] The current status of the job. Possible + * values include: 'Invalid', 'Running', 'Succeeded', 'Failed', 'Canceled', + * 'Paused', 'Scheduled' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly status?: JobStatus; /** - * The UTC date and time at which the job started. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [startTime] The UTC date and time at which the job started. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly startTime?: Date; /** - * The UTC date and time at which the job completed. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [endTime] The UTC date and time at which the job completed. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly endTime?: Date; /** - * The percentage of the job that is complete. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [percentComplete] The percentage of the job that is + * complete. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly percentComplete?: number; /** - * The error details. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {JobErrorDetails} [error] The error details. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly error?: JobErrorDetails; /** - * The type of the job. Possible values include: 'Invalid', 'ScanForUpdates', 'DownloadUpdates', - * 'InstallUpdates', 'RefreshShare' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {JobType} [jobType] The type of the job. Possible values include: + * 'Invalid', 'ScanForUpdates', 'DownloadUpdates', 'InstallUpdates', + * 'RefreshShare' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly jobType?: JobType; /** - * Current stage of the update operation. Possible values include: 'Unknown', 'Initial', - * 'ScanStarted', 'ScanComplete', 'ScanFailed', 'DownloadStarted', 'DownloadComplete', - * 'DownloadFailed', 'InstallStarted', 'InstallComplete', 'InstallFailed', 'RebootInitiated', - * 'Success', 'Failure', 'RescanStarted', 'RescanComplete', 'RescanFailed' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {UpdateOperationStage} [currentStage] Current stage of the update + * operation. Possible values include: 'Unknown', 'Initial', 'ScanStarted', + * 'ScanComplete', 'ScanFailed', 'DownloadStarted', 'DownloadComplete', + * 'DownloadFailed', 'InstallStarted', 'InstallComplete', 'InstallFailed', + * 'RebootInitiated', 'Success', 'Failure', 'RescanStarted', + * 'RescanComplete', 'RescanFailed' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly currentStage?: UpdateOperationStage; /** - * The download progress. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {UpdateDownloadProgress} [downloadProgress] The download progress. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly downloadProgress?: UpdateDownloadProgress; /** - * The install progress. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {UpdateInstallProgress} [installProgress] The install progress. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly installProgress?: UpdateInstallProgress; /** - * Total number of errors encountered during the refresh process. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [totalRefreshErrors] Total number of errors encountered + * during the refresh process. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly totalRefreshErrors?: number; /** - * Local share/remote container relative path to the error manifest file of the refresh. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [errorManifestFile] Local share/remote container relative + * path to the error manifest file of the refresh. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly errorManifestFile?: string; /** - * ARM ID of the share that was refreshed. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [shareId] ARM ID of the share that was refreshed. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly shareId?: string; /** - * If only subfolders need to be refreshed, then the subfolder path inside the share. (The path - * is empty if there are no subfolders.) + * @member {string} [folder] 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; } /** + * @interface + * An interface representing MetricDimensionV1. * Metric Dimension v1. + * */ export interface MetricDimensionV1 { /** - * Name of the metrics dimension. + * @member {string} [name] Name of the metrics dimension. */ name?: string; /** - * Display name of the metrics dimension. + * @member {string} [displayName] Display name of the metrics dimension. */ displayName?: string; /** - * To be exported to shoe box. + * @member {boolean} [toBeExportedForShoebox] To be exported to shoe box. */ toBeExportedForShoebox?: boolean; } /** + * @interface + * An interface representing MetricSpecificationV1. * Metric specification version 1. + * */ export interface MetricSpecificationV1 { /** - * Name of the metric. + * @member {string} [name] Name of the metric. */ name?: string; /** - * Display name of the metric. + * @member {string} [displayName] Display name of the metric. */ displayName?: string; /** - * Description of the metric to be displayed. + * @member {string} [displayDescription] Description of the metric to be + * displayed. */ displayDescription?: string; /** - * Metric units. Possible values include: 'NotSpecified', 'Percent', 'Count', 'Seconds', - * 'Milliseconds', 'Bytes', 'BytesPerSecond', 'CountPerSecond' + * @member {MetricUnit} [unit] Metric units. Possible values include: + * 'NotSpecified', 'Percent', 'Count', 'Seconds', 'Milliseconds', 'Bytes', + * 'BytesPerSecond', 'CountPerSecond' */ unit?: MetricUnit; /** - * Metric aggregation type. Possible values include: 'NotSpecified', 'None', 'Average', - * 'Minimum', 'Maximum', 'Total', 'Count' + * @member {MetricAggregationType} [aggregationType] Metric aggregation type. + * Possible values include: 'NotSpecified', 'None', 'Average', 'Minimum', + * 'Maximum', 'Total', 'Count' */ aggregationType?: MetricAggregationType; /** - * Metric dimensions, other than default dimension which is resource. + * @member {MetricDimensionV1[]} [dimensions] Metric dimensions, other than + * default dimension which is resource. */ dimensions?: MetricDimensionV1[]; /** - * Set true to fill the gaps with zero. + * @member {boolean} [fillGapWithZero] Set true to fill the gaps with zero. */ fillGapWithZero?: boolean; /** - * Metric category. Possible values include: 'Capacity', 'Transaction' + * @member {MetricCategory} [category] Metric category. Possible values + * include: 'Capacity', 'Transaction' */ category?: MetricCategory; /** - * Resource name override. + * @member {string} [resourceIdDimensionNameOverride] Resource name override. */ resourceIdDimensionNameOverride?: string; /** - * Support granularity of metrics. + * @member {TimeGrain[]} [supportedTimeGrainTypes] Support granularity of + * metrics. */ supportedTimeGrainTypes?: TimeGrain[]; /** - * Support metric aggregation type. + * @member {MetricAggregationType[]} [supportedAggregationTypes] Support + * metric aggregation type. */ supportedAggregationTypes?: MetricAggregationType[]; } /** + * @interface + * An interface representing NetworkAdapterPosition. * The network adapter position. + * */ export interface NetworkAdapterPosition { /** - * The network group. Possible values include: 'None', 'NonRDMA', 'RDMA' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {NetworkGroup} [networkGroup] The network group. Possible values + * include: 'None', 'NonRDMA', 'RDMA' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly networkGroup?: NetworkGroup; /** - * The port. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [port] The port. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly port?: number; } /** + * @interface + * An interface representing NetworkAdapter. * Represents the networkAdapter on a device. + * */ export interface NetworkAdapter { /** - * Instance ID of network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [adapterId] Instance ID of network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly adapterId?: string; /** - * Hardware position of network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {NetworkAdapterPosition} [adapterPosition] Hardware position of + * network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly adapterPosition?: NetworkAdapterPosition; /** - * Logical index of the adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [index] Logical index of the adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly index?: number; /** - * Node ID of the network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nodeId] Node ID of the network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nodeId?: string; /** - * Network adapter name. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [networkAdapterName] Network adapter name. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly networkAdapterName?: string; /** - * Hardware label for the adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [label] Hardware label for the adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly label?: string; /** - * MAC address. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [macAddress] MAC address. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly macAddress?: string; /** - * Link speed. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [linkSpeed] Link speed. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly linkSpeed?: number; /** - * Value indicating whether this adapter is valid. Possible values include: 'Inactive', 'Active' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {NetworkAdapterStatus} [status] Value indicating whether this + * adapter is valid. Possible values include: 'Inactive', 'Active' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly status?: NetworkAdapterStatus; /** - * Value indicating whether this adapter is RDMA capable. Possible values include: 'Incapable', + * @member {NetworkAdapterRDMAStatus} [rdmaStatus] Value indicating whether + * this adapter is RDMA capable. Possible values include: 'Incapable', * 'Capable' */ rdmaStatus?: NetworkAdapterRDMAStatus; /** - * Value indicating whether this adapter has DHCP enabled. Possible values include: 'Disabled', + * @member {NetworkAdapterDHCPStatus} [dhcpStatus] Value indicating whether + * this adapter has DHCP enabled. Possible values include: 'Disabled', * 'Enabled' */ dhcpStatus?: NetworkAdapterDHCPStatus; /** - * The IPv4 configuration of the network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Ipv4Config} [ipv4Configuration] The IPv4 configuration of the + * network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly ipv4Configuration?: Ipv4Config; /** - * The IPv6 configuration of the network adapter. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Ipv6Config} [ipv6Configuration] The IPv6 configuration of the + * network adapter. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly ipv6Configuration?: Ipv6Config; /** - * The IPv6 local address. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [ipv6LinkLocalAddress] The IPv6 local address. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly ipv6LinkLocalAddress?: string; /** - * The list of DNS Servers of the device. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string[]} [dnsServers] The list of DNS Servers of the device. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly dnsServers?: string[]; } /** + * @interface + * An interface representing NetworkSettings. * The network settings of a device. + * + * @extends ARMBaseModel */ export interface NetworkSettings extends ARMBaseModel { /** - * The network adapter list on the device. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {NetworkAdapter[]} [networkAdapters] The network adapter list on + * the device. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly networkAdapters?: NetworkAdapter[]; } /** + * @interface + * An interface representing OperationDisplay. * Operation display properties. + * */ export interface OperationDisplay { /** - * Provider name. + * @member {string} [provider] Provider name. */ provider?: string; /** - * The type of resource in which the operation is performed. + * @member {string} [resource] The type of resource in which the operation is + * performed. */ resource?: string; /** - * Operation to be performed on the resource. + * @member {string} [operation] Operation to be performed on the resource. */ operation?: string; /** - * Description of the operation to be performed. + * @member {string} [description] Description of the operation to be + * performed. */ description?: string; } /** + * @interface + * An interface representing ServiceSpecification. * Service specification. + * */ export interface ServiceSpecification { /** - * Metric specification as defined by shoebox. + * @member {MetricSpecificationV1[]} [metricSpecifications] Metric + * specification as defined by shoebox. */ metricSpecifications?: MetricSpecificationV1[]; } /** + * @interface + * An interface representing Operation. * Operations. + * */ export interface Operation { /** - * Name of the operation. + * @member {string} [name] Name of the operation. */ name?: string; /** - * Properties displayed for the operation. + * @member {OperationDisplay} [display] Properties displayed for the + * operation. */ display?: OperationDisplay; /** - * Origin of the operation. + * @member {string} [origin] Origin of the operation. */ origin?: string; /** - * Service specification. + * @member {ServiceSpecification} [serviceSpecification] Service + * specification. */ serviceSpecification?: ServiceSpecification; } /** + * @interface + * An interface representing OrderStatus. * Represents a single status change. + * */ export interface OrderStatus { /** - * 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' + * @member {OrderState} 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' */ status: OrderState; /** - * Time of status update. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [updateDateTime] Time of status update. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly updateDateTime?: Date; /** - * Comments related to this status change. + * @member {string} [comments] Comments related to this status change. */ comments?: string; } /** + * @interface + * An interface representing TrackingInfo. * Tracking courier information. + * */ export interface TrackingInfo { /** - * Serial number of the device being tracked. + * @member {string} [serialNumber] Serial number of the device being tracked. */ serialNumber?: string; /** - * Name of the carrier used in the delivery. + * @member {string} [carrierName] Name of the carrier used in the delivery. */ carrierName?: string; /** - * Tracking ID of the shipment. + * @member {string} [trackingId] Tracking ID of the shipment. */ trackingId?: string; /** - * Tracking URL of the shipment. + * @member {string} [trackingUrl] Tracking URL of the shipment. */ trackingUrl?: string; } /** + * @interface + * An interface representing Order. * The order details. + * + * @extends ARMBaseModel */ export interface Order extends ARMBaseModel { /** - * The contact details. + * @member {ContactDetails} contactInformation The contact details. */ contactInformation: ContactDetails; /** - * The shipping address. + * @member {Address} shippingAddress The shipping address. */ shippingAddress: Address; /** - * Current status of the order. + * @member {OrderStatus} [currentStatus] Current status of the order. */ currentStatus?: OrderStatus; /** - * List of status changes in the order. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {OrderStatus[]} [orderHistory] List of status changes in the + * order. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly orderHistory?: OrderStatus[]; /** - * Serial number of the device. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [serialNumber] Serial number of the device. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly serialNumber?: string; /** - * Tracking information for the package delivered to the customer whether it has an original or a + * @member {TrackingInfo[]} [deliveryTrackingInfo] Tracking information for + * the package delivered to the customer whether it has an original or a * replacement device. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly deliveryTrackingInfo?: TrackingInfo[]; /** - * Tracking information for the package returned from the customer whether it has an original or - * a replacement device. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {TrackingInfo[]} [returnTrackingInfo] Tracking information for the + * package returned from the customer whether it has an original or a + * replacement device. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly returnTrackingInfo?: TrackingInfo[]; } /** + * @interface + * An interface representing PeriodicTimerSourceInfo. * Periodic timer event source. + * */ export interface PeriodicTimerSourceInfo { /** - * The time of the day that results in a valid trigger. Schedule is computed with reference to - * the time specified. + * @member {Date} startTime The time of the day that results in a valid + * trigger. Schedule is computed with reference to the time specified upto + * seconds. If timezone is not specified the time will considered to be in + * device timezone. The value will always be returned as UTC time. */ startTime: Date; /** - * Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, - * and seconds. + * @member {string} schedule Periodic frequency at which timer event needs to + * be raised. Supports daily, hourly, minutes, and seconds. */ schedule: string; /** - * Topic where periodic events are published to IoT device. + * @member {string} [topic] Topic where periodic events are published to IoT + * device. */ topic?: string; } /** + * @interface + * An interface representing PeriodicTimerEventTrigger. * Trigger details. + * */ export interface PeriodicTimerEventTrigger { /** - * Polymorphic Discriminator + * @member {string} kind Polymorphic Discriminator */ kind: "PeriodicTimerEvent"; /** - * The path ID that uniquely identifies the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [id] The path ID that uniquely identifies the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly id?: string; /** - * The object name. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [name] The object name. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: string; /** - * The hierarchical type of the object. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [type] The hierarchical type of the object. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly type?: string; /** - * Periodic timer details. + * @member {PeriodicTimerSourceInfo} sourceInfo Periodic timer details. */ sourceInfo: PeriodicTimerSourceInfo; /** - * Role Sink information. + * @member {RoleSinkInfo} sinkInfo Role Sink information. */ sinkInfo: RoleSinkInfo; /** - * 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 + * @member {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. */ customContextTag?: string; } /** + * @interface + * An interface representing RefreshDetails. * Fields for tracking refresh job on the share. + * */ export interface RefreshDetails { /** - * 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. + * @member {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. */ inProgressRefreshJobId?: string; /** - * 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. + * @member {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. */ 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. + * @member {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. */ 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. + * @member {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. */ lastJob?: string; } /** + * @interface + * An interface representing SecuritySettings. * The security settings of a device. + * + * @extends ARMBaseModel */ export interface SecuritySettings extends ARMBaseModel { /** - * Device administrator password as an 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. + * @member {AsymmetricEncryptedSecret} deviceAdminPassword Device + * administrator password as an 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. */ deviceAdminPassword: AsymmetricEncryptedSecret; } /** + * @interface + * An interface representing UserAccessRight. * The mapping between a particular user and the access type on the SMB share. + * */ export interface UserAccessRight { /** - * User ID (already existing in the device). + * @member {string} userId User ID (already existing in the device). */ userId: string; /** - * Type of access to be allowed for the user. Possible values include: 'Change', 'Read', 'Custom' + * @member {ShareAccessType} accessType Type of access to be allowed for the + * user. Possible values include: 'Change', 'Read', 'Custom' */ accessType: ShareAccessType; } /** + * @interface + * An interface representing Share. * Represents a share on the Data Box Edge/Gateway device. + * + * @extends ARMBaseModel */ export interface Share extends ARMBaseModel { /** - * Description for the share. + * @member {string} [description] Description for the share. */ description?: string; /** - * Current status of the share. Possible values include: 'Online', 'Offline' + * @member {ShareStatus} shareStatus Current status of the share. Possible + * values include: 'Online', 'Offline' */ shareStatus: ShareStatus; /** - * Current monitoring status of the share. Possible values include: 'Enabled', 'Disabled' + * @member {MonitoringStatus} monitoringStatus Current monitoring status of + * the share. Possible values include: 'Enabled', 'Disabled' */ monitoringStatus: MonitoringStatus; /** - * Azure container mapping for the share. + * @member {AzureContainerInfo} [azureContainerInfo] Azure container mapping + * for the share. */ azureContainerInfo?: AzureContainerInfo; /** - * Access protocol to be used by the share. Possible values include: 'SMB', 'NFS' + * @member {ShareAccessProtocol} accessProtocol Access protocol to be used by + * the share. Possible values include: 'SMB', 'NFS' */ accessProtocol: ShareAccessProtocol; /** - * Mapping of users and corresponding access rights on the share (required for SMB protocol). + * @member {UserAccessRight[]} [userAccessRights] 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(required for NFS protocol). + * @member {ClientAccessRight[]} [clientAccessRights] List of IP addresses + * and corresponding access rights on the share(required for NFS protocol). */ clientAccessRights?: ClientAccessRight[]; /** - * Details of the refresh job on this share. + * @member {RefreshDetails} [refreshDetails] Details of the refresh job on + * this share. */ refreshDetails?: RefreshDetails; /** - * Share mount point to the role. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {MountPointMap[]} [shareMappings] Share mount point to the role. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly shareMappings?: MountPointMap[]; /** - * Data policy of the share. Possible values include: 'Cloud', 'Local' + * @member {DataPolicy} [dataPolicy] Data policy of the share. Possible + * values include: 'Cloud', 'Local' */ dataPolicy?: DataPolicy; } /** - * Specifies the mapping between this particular user and the type of access he has on shares on - * this device. + * @interface + * An interface representing ShareAccessRight. + * Specifies the mapping between this particular user and the type of access he + * has on shares on this device. + * */ export interface ShareAccessRight { /** - * The share ID. + * @member {string} shareId The share ID. */ shareId: string; /** - * Type of access to be allowed on the share for this user. Possible values include: 'Change', - * 'Read', 'Custom' + * @member {ShareAccessType} accessType Type of access to be allowed on the + * share for this user. Possible values include: 'Change', 'Read', 'Custom' */ accessType: ShareAccessType; } /** + * @interface + * An interface representing StorageAccountCredential. * The storage account credential. + * + * @extends ARMBaseModel */ export interface StorageAccountCredential extends ARMBaseModel { /** - * Alias for the storage account. + * @member {string} alias Alias for the storage account. */ alias: string; /** - * Username for the storage account. + * @member {string} [userName] Username for the storage account. */ userName?: string; /** - * Encrypted storage key. + * @member {AsymmetricEncryptedSecret} [accountKey] Encrypted storage key. */ accountKey?: AsymmetricEncryptedSecret; /** - * Connection string for the storage account. Use this string if username and account key are not - * specified. + * @member {string} [connectionString] Connection string for the storage + * account. Use this string if username and account key are not specified. */ connectionString?: string; /** - * Signifies whether SSL needs to be enabled or not. Possible values include: 'Enabled', - * 'Disabled' + * @member {SSLStatus} sslStatus Signifies whether SSL needs to be enabled or + * not. Possible values include: 'Enabled', 'Disabled' */ sslStatus: SSLStatus; /** - * Blob end point for private clouds. + * @member {string} [blobDomainName] Blob end point for private clouds. */ blobDomainName?: string; /** - * Type of storage accessed on the storage account. Possible values include: - * 'GeneralPurposeStorage', 'BlobStorage' + * @member {AccountType} accountType Type of storage accessed on the storage + * account. Possible values include: 'GeneralPurposeStorage', 'BlobStorage' */ accountType: AccountType; } /** + * @interface + * An interface representing UpdateSummary. * Details about ongoing updates and availability of updates on the device. + * + * @extends ARMBaseModel */ export interface UpdateSummary extends ARMBaseModel { /** - * The current version of the device in format: 1.2.17312.13.", + * @member {string} [deviceVersionNumber] The current version of the device + * in format: 1.2.17312.13.", */ deviceVersionNumber?: string; /** - * The current version of the device in text format. + * @member {string} [friendlyDeviceVersionName] The current version of the + * device in text format. */ friendlyDeviceVersionName?: string; /** - * The last time when a scan was done on the device. + * @member {Date} [deviceLastScannedDateTime] The last time when a scan was + * done on the device. */ deviceLastScannedDateTime?: Date; /** - * The time when the last scan job was completed (success/cancelled/failed) on the appliance. + * @member {Date} [lastCompletedScanJobDateTime] The time when the last scan + * job was completed (success/cancelled/failed) on the appliance. */ lastCompletedScanJobDateTime?: Date; /** - * The time when the last Download job was completed (success/cancelled/failed) on the appliance. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [lastCompletedDownloadJobDateTime] The time when the last + * Download job was completed (success/cancelled/failed) on the appliance. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly lastCompletedDownloadJobDateTime?: Date; /** - * The time when the last Install job was completed (success/cancelled/failed) on the appliance. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [lastCompletedInstallJobDateTime] The time when the last + * Install job was completed (success/cancelled/failed) on the appliance. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly lastCompletedInstallJobDateTime?: Date; /** - * The number of updates available for the current device version as per the last device scan. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [totalNumberOfUpdatesAvailable] The number of updates + * available for the current device version as per the last device scan. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly totalNumberOfUpdatesAvailable?: number; /** - * The total number of items pending download. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [totalNumberOfUpdatesPendingDownload] The total number of + * items pending download. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly totalNumberOfUpdatesPendingDownload?: number; /** - * The total number of items pending install. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [totalNumberOfUpdatesPendingInstall] The total number of + * items pending install. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly totalNumberOfUpdatesPendingInstall?: number; /** - * Indicates if updates are available and at least one of the updates needs a reboot. Possible - * values include: 'NeverReboots', 'RequiresReboot', 'RequestReboot' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {InstallRebootBehavior} [rebootBehavior] Indicates if updates are + * available and at least one of the updates needs a reboot. Possible values + * include: 'NeverReboots', 'RequiresReboot', 'RequestReboot' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly rebootBehavior?: InstallRebootBehavior; /** - * The current update operation. Possible values include: 'None', 'Scan', 'Download', 'Install' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {UpdateOperation} [ongoingUpdateOperation] The current update + * operation. Possible values include: 'None', 'Scan', 'Download', 'Install' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly ongoingUpdateOperation?: UpdateOperation; /** - * The job ID of the download job in progress. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [inProgressDownloadJobId] The job ID of the download job + * in progress. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly inProgressDownloadJobId?: string; /** - * The job ID of the install job in progress. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [inProgressInstallJobId] The job ID of the install job in + * progress. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly inProgressInstallJobId?: string; /** - * The time when the currently running download (if any) started. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [inProgressDownloadJobStartedDateTime] The time when the + * currently running download (if any) started. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly inProgressDownloadJobStartedDateTime?: Date; /** - * The time when the currently running install (if any) started. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [inProgressInstallJobStartedDateTime] The time when the + * currently running install (if any) started. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly inProgressInstallJobStartedDateTime?: Date; /** - * The list of updates available for install. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string[]} [updateTitles] The list of updates available for + * install. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly updateTitles?: string[]; /** - * The total size of updates available for download in bytes. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [totalUpdateSizeInBytes] The total size of updates + * available for download in bytes. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly totalUpdateSizeInBytes?: number; } /** + * @interface + * An interface representing UploadCertificateRequest. * The upload certificate request. + * */ export interface UploadCertificateRequest { /** - * The authentication type. Possible values include: 'Invalid', 'AzureActiveDirectory' + * @member {AuthenticationType} [authenticationType] The authentication type. + * Possible values include: 'Invalid', 'AzureActiveDirectory' */ authenticationType?: AuthenticationType; /** - * The base64 encoded certificate raw data. + * @member {string} certificate The base64 encoded certificate raw data. */ certificate: string; } /** + * @interface + * An interface representing UploadCertificateResponse. * The upload registration certificate response. + * */ export interface UploadCertificateResponse { /** - * Specifies authentication type. Possible values include: 'Invalid', 'AzureActiveDirectory' + * @member {AuthenticationType} [authType] Specifies authentication type. + * Possible values include: 'Invalid', 'AzureActiveDirectory' */ authType?: AuthenticationType; /** - * The resource ID of the Data Box Edge/Gateway device. + * @member {string} resourceId The resource ID of the Data Box Edge/Gateway + * device. */ resourceId: string; /** - * Azure Active Directory tenant authority. + * @member {string} aadAuthority Azure Active Directory tenant authority. */ aadAuthority: string; /** - * Azure Active Directory tenant ID. + * @member {string} aadTenantId Azure Active Directory tenant ID. */ aadTenantId: string; /** - * Azure Active Directory service principal client ID. + * @member {string} servicePrincipalClientId Azure Active Directory service + * principal client ID. */ servicePrincipalClientId: string; /** - * Azure Active Directory service principal object ID. + * @member {string} servicePrincipalObjectId Azure Active Directory service + * principal object ID. */ servicePrincipalObjectId: string; /** - * The azure management endpoint audience. + * @member {string} azureManagementEndpointAudience The azure management + * endpoint audience. */ azureManagementEndpointAudience: string; } /** - * Represents a user who has access to one or more shares on the Data Box Edge/Gateway device. + * @interface + * An interface representing User. + * Represents a user who has access to one or more shares on the Data Box + * Edge/Gateway device. + * + * @extends ARMBaseModel */ export interface User extends ARMBaseModel { /** - * The password details. + * @member {AsymmetricEncryptedSecret} [encryptedPassword] The password + * details. */ encryptedPassword?: AsymmetricEncryptedSecret; /** - * List of shares that the user has rights on. This field should not be specified during user + * @member {ShareAccessRight[]} [shareAccessRights] List of shares that the + * user has rights on. This field should not be specified during user * creation. */ shareAccessRights?: ShareAccessRight[]; } /** + * @interface + * An interface representing DevicesListBySubscriptionOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface DevicesListBySubscriptionOptionalParams extends msRest.RequestOptionsBase { /** - * Specify $expand=details to populate additional fields related to the resource or Specify - * $skipToken= to populate the next page in the list. + * @member {string} [expand] Specify $expand=details to populate additional + * fields related to the resource or Specify $skipToken= to populate + * the next page in the list. */ expand?: string; } /** + * @interface + * An interface representing DevicesListByResourceGroupOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface DevicesListByResourceGroupOptionalParams extends msRest.RequestOptionsBase { /** - * Specify $expand=details to populate additional fields related to the resource or Specify - * $skipToken= to populate the next page in the list. + * @member {string} [expand] Specify $expand=details to populate additional + * fields related to the resource or Specify $skipToken= to populate + * the next page in the list. */ expand?: string; } /** + * @interface + * An interface representing DevicesUpdateOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface DevicesUpdateOptionalParams extends msRest.RequestOptionsBase { /** - * The tags attached to the Data Box Edge/Gateway resource. + * @member {{ [propertyName: string]: string }} [tags] The tags attached to + * the Data Box Edge/Gateway resource. */ tags?: { [propertyName: string]: string }; } /** + * @interface + * An interface representing DevicesUploadCertificateOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface DevicesUploadCertificateOptionalParams extends msRest.RequestOptionsBase { /** - * The authentication type. Possible values include: 'Invalid', 'AzureActiveDirectory' + * @member {AuthenticationType} [authenticationType] The authentication type. + * Possible values include: 'Invalid', 'AzureActiveDirectory' */ authenticationType?: AuthenticationType; } /** + * @interface + * An interface representing TriggersListByDataBoxEdgeDeviceOptionalParams. + * Optional Parameters. + * + * @extends RequestOptionsBase + */ +export interface TriggersListByDataBoxEdgeDeviceOptionalParams extends msRest.RequestOptionsBase { + /** + * @member {string} [expand] Specify $filter='CustomContextTag eq ' to + * filter on custom context tag property + */ + expand?: string; +} + +/** + * @interface + * An interface representing UsersCreateOrUpdateOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface UsersCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase { /** - * The password details. + * @member {AsymmetricEncryptedSecret} [encryptedPassword] The password + * details. */ encryptedPassword?: AsymmetricEncryptedSecret; /** - * List of shares that the user has rights on. This field should not be specified during user + * @member {ShareAccessRight[]} [shareAccessRights] List of shares that the + * user has rights on. This field should not be specified during user * creation. */ shareAccessRights?: ShareAccessRight[]; } /** + * @interface + * An interface representing UsersBeginCreateOrUpdateOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface UsersBeginCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase { /** - * The password details. + * @member {AsymmetricEncryptedSecret} [encryptedPassword] The password + * details. */ encryptedPassword?: AsymmetricEncryptedSecret; /** - * List of shares that the user has rights on. This field should not be specified during user + * @member {ShareAccessRight[]} [shareAccessRights] List of shares that the + * user has rights on. This field should not be specified during user * creation. */ shareAccessRights?: ShareAccessRight[]; } /** + * @interface * An interface representing DataBoxEdgeManagementClientOptions. + * @extends AzureServiceClientOptions */ export interface DataBoxEdgeManagementClientOptions extends AzureServiceClientOptions { + /** + * @member {string} [baseUri] + */ baseUri?: string; } + /** * @interface - * The list of operations used for the discovery of available provider operations. + * An interface representing the OperationsList. + * The list of operations used for the discovery of available provider + * operations. + * * @extends Array */ export interface OperationsList extends Array { /** - * Link to the next set of results. + * @member {string} [nextLink] Link to the next set of results. */ nextLink?: string; } /** * @interface + * An interface representing the DataBoxEdgeDeviceList. * The collection of Data Box Edge/Gateway devices. + * * @extends Array */ export interface DataBoxEdgeDeviceList extends Array { /** - * Link to the next set of results. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nextLink] Link to the next set of results. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nextLink?: string; } /** * @interface + * An interface representing the AlertList. * Collection of alerts. + * * @extends Array */ export interface AlertList extends Array { /** - * Link to the next set of results. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nextLink] Link to the next set of results. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nextLink?: string; } /** * @interface + * An interface representing the BandwidthSchedulesList. * The collection of bandwidth schedules. + * * @extends Array */ export interface BandwidthSchedulesList extends Array { /** - * Link to the next set of results. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nextLink] Link to the next set of results. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nextLink?: string; } /** * @interface + * An interface representing the OrderList. * List of order entities. + * * @extends Array */ export interface OrderList extends Array { /** - * Link to the next set of results. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nextLink] Link to the next set of results. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nextLink?: string; } /** * @interface + * An interface representing the RoleList. * Collection of all the roles on the Data Box Edge device. + * * @extends Array */ export interface RoleList extends Array { /** - * Link to the next set of results. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nextLink] Link to the next set of results. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nextLink?: string; } /** * @interface + * An interface representing the ShareList. * Collection of all the shares on the Data Box Edge/Gateway device. + * * @extends Array */ export interface ShareList extends Array { /** - * Link to the next set of results. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nextLink] Link to the next set of results. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nextLink?: string; } /** * @interface + * An interface representing the StorageAccountCredentialList. * The collection of storage account credentials. + * * @extends Array */ export interface StorageAccountCredentialList extends Array { /** - * Link to the next set of results. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nextLink] Link to the next set of results. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nextLink?: string; } /** * @interface + * An interface representing the TriggerList. * Collection of all trigger on the data box edge device. + * * @extends Array */ export interface TriggerList extends Array { /** - * Link to the next set of results. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nextLink] Link to the next set of results. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nextLink?: string; } /** * @interface + * An interface representing the UserList. * Collection of users. + * * @extends Array */ export interface UserList extends Array { /** - * Link to the next set of results. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [nextLink] Link to the next set of results. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nextLink?: string; } @@ -2011,7 +2489,6 @@ export type OperationsListResponse = OperationsList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2031,7 +2508,6 @@ export type OperationsListNextResponse = OperationsList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2051,7 +2527,6 @@ export type DevicesListBySubscriptionResponse = DataBoxEdgeDeviceList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2071,7 +2546,6 @@ export type DevicesListByResourceGroupResponse = DataBoxEdgeDeviceList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2091,7 +2565,6 @@ export type DevicesGetResponse = DataBoxEdgeDevice & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2111,7 +2584,6 @@ export type DevicesCreateOrUpdateResponse = DataBoxEdgeDevice & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2131,7 +2603,6 @@ export type DevicesUpdateResponse = DataBoxEdgeDevice & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2139,26 +2610,6 @@ export type DevicesUpdateResponse = DataBoxEdgeDevice & { }; }; -/** - * Contains response data for the createOrUpdateExtendedInfo operation. - */ -export type DevicesCreateOrUpdateExtendedInfoResponse = DataBoxEdgeDeviceExtendedInfo & { - /** - * The underlying HTTP response. - */ - _response: msRest.HttpResponse & { - /** - * The response body as text (string format) - */ - bodyAsText: string; - - /** - * The response body as parsed JSON or XML - */ - parsedBody: DataBoxEdgeDeviceExtendedInfo; - }; -}; - /** * Contains response data for the getExtendedInformation operation. */ @@ -2171,7 +2622,6 @@ export type DevicesGetExtendedInformationResponse = DataBoxEdgeDeviceExtendedInf * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2191,7 +2641,6 @@ export type DevicesGetNetworkSettingsResponse = NetworkSettings & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2211,7 +2660,6 @@ export type DevicesGetUpdateSummaryResponse = UpdateSummary & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2231,7 +2679,6 @@ export type DevicesUploadCertificateResponse = UploadCertificateResponse & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2251,7 +2698,6 @@ export type DevicesBeginCreateOrUpdateResponse = DataBoxEdgeDevice & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2271,7 +2717,6 @@ export type DevicesListBySubscriptionNextResponse = DataBoxEdgeDeviceList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2291,7 +2736,6 @@ export type DevicesListByResourceGroupNextResponse = DataBoxEdgeDeviceList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2311,7 +2755,6 @@ export type AlertsListByDataBoxEdgeDeviceResponse = AlertList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2331,7 +2774,6 @@ export type AlertsGetResponse = Alert & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2351,7 +2793,6 @@ export type AlertsListByDataBoxEdgeDeviceNextResponse = AlertList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2371,7 +2812,6 @@ export type BandwidthSchedulesListByDataBoxEdgeDeviceResponse = BandwidthSchedul * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2391,7 +2831,6 @@ export type BandwidthSchedulesGetResponse = BandwidthSchedule & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2411,7 +2850,6 @@ export type BandwidthSchedulesCreateOrUpdateResponse = BandwidthSchedule & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2431,7 +2869,6 @@ export type BandwidthSchedulesBeginCreateOrUpdateResponse = BandwidthSchedule & * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2451,7 +2888,6 @@ export type BandwidthSchedulesListByDataBoxEdgeDeviceNextResponse = BandwidthSch * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2471,7 +2907,6 @@ export type JobsGetResponse = Job & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2491,7 +2926,6 @@ export type OperationsStatusGetResponse = Job & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2511,7 +2945,6 @@ export type OrdersListByDataBoxEdgeDeviceResponse = OrderList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2531,7 +2964,6 @@ export type OrdersGetResponse = Order & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2551,7 +2983,6 @@ export type OrdersCreateOrUpdateResponse = Order & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2571,7 +3002,6 @@ export type OrdersBeginCreateOrUpdateResponse = Order & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2591,7 +3021,6 @@ export type OrdersListByDataBoxEdgeDeviceNextResponse = OrderList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2611,7 +3040,6 @@ export type RolesListByDataBoxEdgeDeviceResponse = RoleList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2631,7 +3059,6 @@ export type RolesGetResponse = RoleUnion & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2651,7 +3078,6 @@ export type RolesCreateOrUpdateResponse = RoleUnion & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2671,7 +3097,6 @@ export type RolesBeginCreateOrUpdateResponse = RoleUnion & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2691,7 +3116,6 @@ export type RolesListByDataBoxEdgeDeviceNextResponse = RoleList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2711,7 +3135,6 @@ export type SharesListByDataBoxEdgeDeviceResponse = ShareList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2731,7 +3154,6 @@ export type SharesGetResponse = Share & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2751,7 +3173,6 @@ export type SharesCreateOrUpdateResponse = Share & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2771,7 +3192,6 @@ export type SharesBeginCreateOrUpdateResponse = Share & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2791,7 +3211,6 @@ export type SharesListByDataBoxEdgeDeviceNextResponse = ShareList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2811,7 +3230,6 @@ export type StorageAccountCredentialsListByDataBoxEdgeDeviceResponse = StorageAc * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2831,7 +3249,6 @@ export type StorageAccountCredentialsGetResponse = StorageAccountCredential & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2851,7 +3268,6 @@ export type StorageAccountCredentialsCreateOrUpdateResponse = StorageAccountCred * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2871,7 +3287,6 @@ export type StorageAccountCredentialsBeginCreateOrUpdateResponse = StorageAccoun * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2891,7 +3306,6 @@ export type StorageAccountCredentialsListByDataBoxEdgeDeviceNextResponse = Stora * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2911,7 +3325,6 @@ export type TriggersListByDataBoxEdgeDeviceResponse = TriggerList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2931,7 +3344,6 @@ export type TriggersGetResponse = TriggerUnion & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2951,7 +3363,6 @@ export type TriggersCreateOrUpdateResponse = TriggerUnion & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2971,7 +3382,6 @@ export type TriggersBeginCreateOrUpdateResponse = TriggerUnion & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2991,7 +3401,6 @@ export type TriggersListByDataBoxEdgeDeviceNextResponse = TriggerList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -3011,7 +3420,6 @@ export type UsersListByDataBoxEdgeDeviceResponse = UserList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -3031,7 +3439,6 @@ export type UsersGetResponse = User & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -3051,7 +3458,6 @@ export type UsersCreateOrUpdateResponse = User & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -3071,7 +3477,6 @@ export type UsersBeginCreateOrUpdateResponse = User & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -3091,7 +3496,6 @@ export type UsersListByDataBoxEdgeDeviceNextResponse = UserList & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ diff --git a/packages/@azure/arm-edgegateway/lib/models/jobsMappers.ts b/packages/@azure/arm-edgegateway/lib/models/jobsMappers.ts index 0f195ce2be53..91686fb7863c 100644 --- a/packages/@azure/arm-edgegateway/lib/models/jobsMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/jobsMappers.ts @@ -1,17 +1,20 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - CloudError, Job, JobErrorDetails, JobErrorItem, UpdateDownloadProgress, - UpdateInstallProgress + UpdateInstallProgress, + CloudError } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/mappers.ts b/packages/@azure/arm-edgegateway/lib/models/mappers.ts index a82f4ada8e5b..110805c7873b 100644 --- a/packages/@azure/arm-edgegateway/lib/models/mappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/mappers.ts @@ -1,9 +1,11 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ import { CloudErrorMapper, BaseResourceMapper } from "@azure/ms-rest-azure-js"; @@ -566,13 +568,6 @@ export const DataBoxEdgeDeviceExtendedInfo: msRest.CompositeMapper = { className: "DataBoxEdgeDeviceExtendedInfo", modelProperties: { ...ARMBaseModel.type.modelProperties, - integrityKey: { - required: true, - serializedName: "properties.integrityKey", - type: { - name: "String" - } - }, encryptionKeyThumbprint: { serializedName: "properties.encryptionKeyThumbprint", type: { @@ -2582,5 +2577,4 @@ export const discriminators = { 'BaseResource.PeriodicTimerEvent' : PeriodicTimerEventTrigger, 'BaseResource.Role' : Role, 'BaseResource.Trigger' : Trigger - }; diff --git a/packages/@azure/arm-edgegateway/lib/models/operationsMappers.ts b/packages/@azure/arm-edgegateway/lib/models/operationsMappers.ts index af4a5e3a1bf6..8a562506ad8a 100644 --- a/packages/@azure/arm-edgegateway/lib/models/operationsMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/operationsMappers.ts @@ -1,18 +1,21 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - CloudError, - MetricDimensionV1, - MetricSpecificationV1, + OperationsList, Operation, OperationDisplay, - OperationsList, - ServiceSpecification + ServiceSpecification, + MetricSpecificationV1, + MetricDimensionV1, + CloudError } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/operationsStatusMappers.ts b/packages/@azure/arm-edgegateway/lib/models/operationsStatusMappers.ts index 0f195ce2be53..91686fb7863c 100644 --- a/packages/@azure/arm-edgegateway/lib/models/operationsStatusMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/operationsStatusMappers.ts @@ -1,17 +1,20 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - CloudError, Job, JobErrorDetails, JobErrorItem, UpdateDownloadProgress, - UpdateInstallProgress + UpdateInstallProgress, + CloudError } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/ordersMappers.ts b/packages/@azure/arm-edgegateway/lib/models/ordersMappers.ts index 36c1bc40c83e..da078d1e59a6 100644 --- a/packages/@azure/arm-edgegateway/lib/models/ordersMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/ordersMappers.ts @@ -1,54 +1,57 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, + OrderList, + Order, + ARMBaseModel, + BaseResource, + ContactDetails, Address, + OrderStatus, + TrackingInfo, + CloudError, Alert, AlertErrorDetails, - ARMBaseModel, - AsymmetricEncryptedSecret, - Authentication, - AzureContainerInfo, BandwidthSchedule, - BaseResource, - ClientAccessRight, - CloudError, - ContactDetails, DataBoxEdgeDevice, + Sku, DataBoxEdgeDeviceExtendedInfo, - FileEventTrigger, - FileSourceInfo, - IoTDeviceInfo, - IoTRole, - Ipv4Config, - Ipv6Config, - MountPointMap, + NetworkSettings, NetworkAdapter, NetworkAdapterPosition, - NetworkSettings, - Order, - OrderList, - OrderStatus, - PeriodicTimerEventTrigger, - PeriodicTimerSourceInfo, - RefreshDetails, + Ipv4Config, + Ipv6Config, Role, - RoleSinkInfo, SecuritySettings, + AsymmetricEncryptedSecret, Share, - ShareAccessRight, - Sku, + AzureContainerInfo, + UserAccessRight, + ClientAccessRight, + RefreshDetails, + MountPointMap, StorageAccountCredential, - SymmetricKey, - TrackingInfo, Trigger, UpdateSummary, User, - UserAccessRight + ShareAccessRight, + FileEventTrigger, + FileSourceInfo, + RoleSinkInfo, + IoTRole, + IoTDeviceInfo, + Authentication, + SymmetricKey, + PeriodicTimerEventTrigger, + PeriodicTimerSourceInfo } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/rolesMappers.ts b/packages/@azure/arm-edgegateway/lib/models/rolesMappers.ts index d39b46cba87c..99f483dba285 100644 --- a/packages/@azure/arm-edgegateway/lib/models/rolesMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/rolesMappers.ts @@ -1,54 +1,57 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - Address, - Alert, - AlertErrorDetails, + RoleList, + Role, ARMBaseModel, - AsymmetricEncryptedSecret, - Authentication, - AzureContainerInfo, - BandwidthSchedule, BaseResource, - ClientAccessRight, CloudError, - ContactDetails, + Alert, + AlertErrorDetails, + BandwidthSchedule, DataBoxEdgeDevice, + Sku, DataBoxEdgeDeviceExtendedInfo, - FileEventTrigger, - FileSourceInfo, - IoTDeviceInfo, IoTRole, - Ipv4Config, - Ipv6Config, + IoTDeviceInfo, + Authentication, + SymmetricKey, + AsymmetricEncryptedSecret, MountPointMap, + NetworkSettings, NetworkAdapter, NetworkAdapterPosition, - NetworkSettings, + Ipv4Config, + Ipv6Config, Order, + ContactDetails, + Address, OrderStatus, - PeriodicTimerEventTrigger, - PeriodicTimerSourceInfo, - RefreshDetails, - Role, - RoleList, - RoleSinkInfo, + TrackingInfo, SecuritySettings, Share, - ShareAccessRight, - Sku, + AzureContainerInfo, + UserAccessRight, + ClientAccessRight, + RefreshDetails, StorageAccountCredential, - SymmetricKey, - TrackingInfo, Trigger, UpdateSummary, User, - UserAccessRight + ShareAccessRight, + FileEventTrigger, + FileSourceInfo, + RoleSinkInfo, + PeriodicTimerEventTrigger, + PeriodicTimerSourceInfo } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/sharesMappers.ts b/packages/@azure/arm-edgegateway/lib/models/sharesMappers.ts index e99c4e89fe31..0786458259dd 100644 --- a/packages/@azure/arm-edgegateway/lib/models/sharesMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/sharesMappers.ts @@ -1,54 +1,57 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - Address, - Alert, - AlertErrorDetails, + ShareList, + Share, ARMBaseModel, - AsymmetricEncryptedSecret, - Authentication, - AzureContainerInfo, - BandwidthSchedule, BaseResource, + AzureContainerInfo, + UserAccessRight, ClientAccessRight, + RefreshDetails, + MountPointMap, CloudError, - ContactDetails, + Alert, + AlertErrorDetails, + BandwidthSchedule, DataBoxEdgeDevice, + Sku, DataBoxEdgeDeviceExtendedInfo, - FileEventTrigger, - FileSourceInfo, - IoTDeviceInfo, - IoTRole, - Ipv4Config, - Ipv6Config, - MountPointMap, + NetworkSettings, NetworkAdapter, NetworkAdapterPosition, - NetworkSettings, + Ipv4Config, + Ipv6Config, Order, + ContactDetails, + Address, OrderStatus, - PeriodicTimerEventTrigger, - PeriodicTimerSourceInfo, - RefreshDetails, + TrackingInfo, Role, - RoleSinkInfo, SecuritySettings, - Share, - ShareAccessRight, - ShareList, - Sku, + AsymmetricEncryptedSecret, StorageAccountCredential, - SymmetricKey, - TrackingInfo, Trigger, UpdateSummary, User, - UserAccessRight + ShareAccessRight, + FileEventTrigger, + FileSourceInfo, + RoleSinkInfo, + IoTRole, + IoTDeviceInfo, + Authentication, + SymmetricKey, + PeriodicTimerEventTrigger, + PeriodicTimerSourceInfo } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/storageAccountCredentialsMappers.ts b/packages/@azure/arm-edgegateway/lib/models/storageAccountCredentialsMappers.ts index 9628d0fad276..7e02b5a544d5 100644 --- a/packages/@azure/arm-edgegateway/lib/models/storageAccountCredentialsMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/storageAccountCredentialsMappers.ts @@ -1,54 +1,57 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - Address, - Alert, - AlertErrorDetails, + StorageAccountCredentialList, + StorageAccountCredential, ARMBaseModel, - AsymmetricEncryptedSecret, - Authentication, - AzureContainerInfo, - BandwidthSchedule, BaseResource, - ClientAccessRight, + AsymmetricEncryptedSecret, CloudError, - ContactDetails, + Alert, + AlertErrorDetails, + BandwidthSchedule, DataBoxEdgeDevice, + Sku, DataBoxEdgeDeviceExtendedInfo, - FileEventTrigger, - FileSourceInfo, - IoTDeviceInfo, - IoTRole, - Ipv4Config, - Ipv6Config, - MountPointMap, + NetworkSettings, NetworkAdapter, NetworkAdapterPosition, - NetworkSettings, + Ipv4Config, + Ipv6Config, Order, + ContactDetails, + Address, OrderStatus, - PeriodicTimerEventTrigger, - PeriodicTimerSourceInfo, - RefreshDetails, + TrackingInfo, Role, - RoleSinkInfo, SecuritySettings, Share, - ShareAccessRight, - Sku, - StorageAccountCredential, - StorageAccountCredentialList, - SymmetricKey, - TrackingInfo, + AzureContainerInfo, + UserAccessRight, + ClientAccessRight, + RefreshDetails, + MountPointMap, Trigger, UpdateSummary, User, - UserAccessRight + ShareAccessRight, + FileEventTrigger, + FileSourceInfo, + RoleSinkInfo, + IoTRole, + IoTDeviceInfo, + Authentication, + SymmetricKey, + PeriodicTimerEventTrigger, + PeriodicTimerSourceInfo } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/triggersMappers.ts b/packages/@azure/arm-edgegateway/lib/models/triggersMappers.ts index 87901b77e698..795430614404 100644 --- a/packages/@azure/arm-edgegateway/lib/models/triggersMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/triggersMappers.ts @@ -1,54 +1,57 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - Address, - Alert, - AlertErrorDetails, + TriggerList, + Trigger, ARMBaseModel, - AsymmetricEncryptedSecret, - Authentication, - AzureContainerInfo, - BandwidthSchedule, BaseResource, - ClientAccessRight, CloudError, - ContactDetails, + Alert, + AlertErrorDetails, + BandwidthSchedule, DataBoxEdgeDevice, + Sku, DataBoxEdgeDeviceExtendedInfo, FileEventTrigger, FileSourceInfo, - IoTDeviceInfo, - IoTRole, - Ipv4Config, - Ipv6Config, - MountPointMap, + RoleSinkInfo, + NetworkSettings, NetworkAdapter, NetworkAdapterPosition, - NetworkSettings, + Ipv4Config, + Ipv6Config, Order, + ContactDetails, + Address, OrderStatus, + TrackingInfo, PeriodicTimerEventTrigger, PeriodicTimerSourceInfo, - RefreshDetails, Role, - RoleSinkInfo, SecuritySettings, + AsymmetricEncryptedSecret, Share, - ShareAccessRight, - Sku, + AzureContainerInfo, + UserAccessRight, + ClientAccessRight, + RefreshDetails, + MountPointMap, StorageAccountCredential, - SymmetricKey, - TrackingInfo, - Trigger, - TriggerList, UpdateSummary, User, - UserAccessRight + ShareAccessRight, + IoTRole, + IoTDeviceInfo, + Authentication, + SymmetricKey } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/models/usersMappers.ts b/packages/@azure/arm-edgegateway/lib/models/usersMappers.ts index 64b85570f4d9..d1b6dd122577 100644 --- a/packages/@azure/arm-edgegateway/lib/models/usersMappers.ts +++ b/packages/@azure/arm-edgegateway/lib/models/usersMappers.ts @@ -1,54 +1,57 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { discriminators, - Address, - Alert, - AlertErrorDetails, + UserList, + User, ARMBaseModel, - AsymmetricEncryptedSecret, - Authentication, - AzureContainerInfo, - BandwidthSchedule, BaseResource, - ClientAccessRight, + AsymmetricEncryptedSecret, + ShareAccessRight, CloudError, - ContactDetails, + Alert, + AlertErrorDetails, + BandwidthSchedule, DataBoxEdgeDevice, + Sku, DataBoxEdgeDeviceExtendedInfo, - FileEventTrigger, - FileSourceInfo, - IoTDeviceInfo, - IoTRole, - Ipv4Config, - Ipv6Config, - MountPointMap, + NetworkSettings, NetworkAdapter, NetworkAdapterPosition, - NetworkSettings, + Ipv4Config, + Ipv6Config, Order, + ContactDetails, + Address, OrderStatus, - PeriodicTimerEventTrigger, - PeriodicTimerSourceInfo, - RefreshDetails, + TrackingInfo, Role, - RoleSinkInfo, SecuritySettings, Share, - ShareAccessRight, - Sku, + AzureContainerInfo, + UserAccessRight, + ClientAccessRight, + RefreshDetails, + MountPointMap, StorageAccountCredential, - SymmetricKey, - TrackingInfo, Trigger, UpdateSummary, - User, - UserAccessRight, - UserList + FileEventTrigger, + FileSourceInfo, + RoleSinkInfo, + IoTRole, + IoTDeviceInfo, + Authentication, + SymmetricKey, + PeriodicTimerEventTrigger, + PeriodicTimerSourceInfo } from "../models/mappers"; + diff --git a/packages/@azure/arm-edgegateway/lib/operations/devices.ts b/packages/@azure/arm-edgegateway/lib/operations/devices.ts index fccd4190c9aa..2a371497a691 100644 --- a/packages/@azure/arm-edgegateway/lib/operations/devices.ts +++ b/packages/@azure/arm-edgegateway/lib/operations/devices.ts @@ -180,42 +180,6 @@ export class Devices { .then(lroPoller => lroPoller.pollUntilFinished()); } - /** - * Creates or updates the additional information of a the data box edge/gateway device. - * @param deviceName The device name. - * @param parameters The additional information. - * @param resourceGroupName The resource group name. - * @param [options] The optional parameters - * @returns Promise - */ - createOrUpdateExtendedInfo(deviceName: string, parameters: Models.DataBoxEdgeDeviceExtendedInfo, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise; - /** - * @param deviceName The device name. - * @param parameters The additional information. - * @param resourceGroupName The resource group name. - * @param callback The callback - */ - createOrUpdateExtendedInfo(deviceName: string, parameters: Models.DataBoxEdgeDeviceExtendedInfo, resourceGroupName: string, callback: msRest.ServiceCallback): void; - /** - * @param deviceName The device name. - * @param parameters The additional information. - * @param resourceGroupName The resource group name. - * @param options The optional parameters - * @param callback The callback - */ - createOrUpdateExtendedInfo(deviceName: string, parameters: Models.DataBoxEdgeDeviceExtendedInfo, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback): void; - createOrUpdateExtendedInfo(deviceName: string, parameters: Models.DataBoxEdgeDeviceExtendedInfo, resourceGroupName: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { - return this.client.sendOperationRequest( - { - deviceName, - parameters, - resourceGroupName, - options - }, - createOrUpdateExtendedInfoOperationSpec, - callback) as Promise; - } - /** * Gets additional information for the specified data box edge/gateway device. * @param deviceName The device name. @@ -674,38 +638,6 @@ const updateOperationSpec: msRest.OperationSpec = { serializer }; -const createOrUpdateExtendedInfoOperationSpec: msRest.OperationSpec = { - httpMethod: "PUT", - path: "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation", - urlParameters: [ - Parameters.deviceName, - Parameters.subscriptionId, - Parameters.resourceGroupName - ], - queryParameters: [ - Parameters.apiVersion - ], - headerParameters: [ - Parameters.acceptLanguage - ], - requestBody: { - parameterPath: "parameters", - mapper: { - ...Mappers.DataBoxEdgeDeviceExtendedInfo, - required: true - } - }, - responses: { - 200: { - bodyMapper: Mappers.DataBoxEdgeDeviceExtendedInfo - }, - default: { - bodyMapper: Mappers.CloudError - } - }, - serializer -}; - const getExtendedInformationOperationSpec: msRest.OperationSpec = { httpMethod: "POST", path: "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation", diff --git a/packages/@azure/arm-edgegateway/lib/operations/orders.ts b/packages/@azure/arm-edgegateway/lib/operations/orders.ts index e2c545cc65c1..2bb00ccf6c10 100644 --- a/packages/@azure/arm-edgegateway/lib/operations/orders.ts +++ b/packages/@azure/arm-edgegateway/lib/operations/orders.ts @@ -93,7 +93,7 @@ export class Orders { /** * @summary Creates or updates an order. - * @param deviceName The order details of a device. + * @param deviceName The device name. * @param order The order to be created or updated. * @param resourceGroupName The resource group name. * @param [options] The optional parameters @@ -118,7 +118,7 @@ export class Orders { /** * @summary Creates or updates an order. - * @param deviceName The order details of a device. + * @param deviceName The device name. * @param order The order to be created or updated. * @param resourceGroupName The resource group name. * @param [options] The optional parameters diff --git a/packages/@azure/arm-edgegateway/lib/operations/triggers.ts b/packages/@azure/arm-edgegateway/lib/operations/triggers.ts index e45a8d6c5981..6da12f933693 100644 --- a/packages/@azure/arm-edgegateway/lib/operations/triggers.ts +++ b/packages/@azure/arm-edgegateway/lib/operations/triggers.ts @@ -34,7 +34,7 @@ export class Triggers { * @param [options] The optional parameters * @returns Promise */ - listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise; + listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: Models.TriggersListByDataBoxEdgeDeviceOptionalParams): Promise; /** * @param deviceName The device name. * @param resourceGroupName The resource group name. @@ -47,8 +47,8 @@ export class Triggers { * @param options The optional parameters * @param callback The callback */ - listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback): void; - listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { + listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options: Models.TriggersListByDataBoxEdgeDeviceOptionalParams, callback: msRest.ServiceCallback): void; + listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: Models.TriggersListByDataBoxEdgeDeviceOptionalParams | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { return this.client.sendOperationRequest( { deviceName, @@ -204,7 +204,8 @@ const listByDataBoxEdgeDeviceOperationSpec: msRest.OperationSpec = { Parameters.resourceGroupName ], queryParameters: [ - Parameters.apiVersion + Parameters.apiVersion, + Parameters.expand ], headerParameters: [ Parameters.acceptLanguage diff --git a/packages/@azure/arm-edgegateway/package.json b/packages/@azure/arm-edgegateway/package.json index b98ef71cd3bb..73ceb6ef0968 100644 --- a/packages/@azure/arm-edgegateway/package.json +++ b/packages/@azure/arm-edgegateway/package.json @@ -4,8 +4,8 @@ "description": "DataBoxEdgeManagementClient Library with typescript type definitions for node.js and browser.", "version": "1.0.0", "dependencies": { - "@azure/ms-rest-azure-js": "^1.3.2", - "@azure/ms-rest-js": "^1.6.0", + "@azure/ms-rest-azure-js": "^1.2.0", + "@azure/ms-rest-js": "^1.2.0", "tslib": "^1.9.3" }, "keywords": [ @@ -44,7 +44,6 @@ "esm/**/*.d.ts", "esm/**/*.d.ts.map", "lib/**/*.ts", - "README.md", "rollup.config.js", "tsconfig.json" ], @@ -53,6 +52,5 @@ "minify": "uglifyjs -c -m --comments --source-map \"content='./dist/arm-edgegateway.js.map'\" -o ./dist/arm-edgegateway.min.js ./dist/arm-edgegateway.js", "prepack": "npm install && npm run build" }, - "sideEffects": false, - "autoPublish": true + "sideEffects": false }