diff --git a/lib/services/computeManagement2/LICENSE.txt b/lib/services/computeManagement2/LICENSE.txt index 5431ba98b9..8f3d856145 100644 --- a/lib/services/computeManagement2/LICENSE.txt +++ b/lib/services/computeManagement2/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2018 Microsoft +Copyright (c) 2019 Microsoft Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/lib/services/computeManagement2/lib/models/accessUri.js b/lib/services/computeManagement2/lib/models/accessUri.js index 3fa859d644..923dbf42a6 100644 --- a/lib/services/computeManagement2/lib/models/accessUri.js +++ b/lib/services/computeManagement2/lib/models/accessUri.js @@ -17,7 +17,7 @@ class AccessUri { /** * Create a AccessUri. - * @member {string} [accessSAS] A SAS uri for accessing a disk. + * @property {string} [accessSAS] A SAS uri for accessing a disk. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/additionalCapabilities.js b/lib/services/computeManagement2/lib/models/additionalCapabilities.js index 746837a474..957c10fa44 100644 --- a/lib/services/computeManagement2/lib/models/additionalCapabilities.js +++ b/lib/services/computeManagement2/lib/models/additionalCapabilities.js @@ -18,7 +18,7 @@ class AdditionalCapabilities { /** * Create a AdditionalCapabilities. - * @member {boolean} [ultraSSDEnabled] The flag that enables or disables a + * @property {boolean} [ultraSSDEnabled] The flag that enables or disables a * capability to have one or more managed data disks with UltraSSD_LRS * storage account type on the VM or VMSS. Managed disks with storage account * type UltraSSD_LRS can be added to a virtual machine or virtual machine diff --git a/lib/services/computeManagement2/lib/models/additionalUnattendContent.js b/lib/services/computeManagement2/lib/models/additionalUnattendContent.js index d28f97b17d..1f27f15ade 100644 --- a/lib/services/computeManagement2/lib/models/additionalUnattendContent.js +++ b/lib/services/computeManagement2/lib/models/additionalUnattendContent.js @@ -19,15 +19,15 @@ class AdditionalUnattendContent { /** * Create a AdditionalUnattendContent. - * @member {string} [passName] The pass name. Currently, the only allowable + * @property {string} [passName] The pass name. Currently, the only allowable * value is OobeSystem. Possible values include: 'OobeSystem' - * @member {string} [componentName] The component name. Currently, the only + * @property {string} [componentName] The component name. Currently, the only * allowable value is Microsoft-Windows-Shell-Setup. Possible values include: * 'Microsoft-Windows-Shell-Setup' - * @member {string} [settingName] Specifies the name of the setting to which - * the content applies. Possible values are: FirstLogonCommands and + * @property {string} [settingName] Specifies the name of the setting to + * which the content applies. Possible values are: FirstLogonCommands and * AutoLogon. Possible values include: 'AutoLogon', 'FirstLogonCommands' - * @member {string} [content] Specifies the XML formatted content that is + * @property {string} [content] Specifies the XML formatted content that is * added to the unattend.xml file for the specified path and component. The * XML must be less than 4KB and must include the root element for the * setting or feature that is being inserted. diff --git a/lib/services/computeManagement2/lib/models/apiEntityReference.js b/lib/services/computeManagement2/lib/models/apiEntityReference.js index c2886a79e4..0cfeecdf55 100644 --- a/lib/services/computeManagement2/lib/models/apiEntityReference.js +++ b/lib/services/computeManagement2/lib/models/apiEntityReference.js @@ -17,8 +17,8 @@ class ApiEntityReference { /** * Create a ApiEntityReference. - * @member {string} [id] The ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * @property {string} [id] The ARM resource id in the form of + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/apiError.js b/lib/services/computeManagement2/lib/models/apiError.js index 9fd78c1fab..26390b124d 100644 --- a/lib/services/computeManagement2/lib/models/apiError.js +++ b/lib/services/computeManagement2/lib/models/apiError.js @@ -17,14 +17,14 @@ class ApiError { /** * Create a ApiError. - * @member {array} [details] The Api error details - * @member {object} [innererror] The Api inner error - * @member {string} [innererror.exceptiontype] The exception type. - * @member {string} [innererror.errordetail] The internal error message or + * @property {array} [details] The Api error details + * @property {object} [innererror] The Api inner error + * @property {string} [innererror.exceptiontype] The exception type. + * @property {string} [innererror.errordetail] The internal error message or * exception dump. - * @member {string} [code] The error code. - * @member {string} [target] The target of the particular error. - * @member {string} [message] The error message. + * @property {string} [code] The error code. + * @property {string} [target] The target of the particular error. + * @property {string} [message] The error message. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/apiErrorBase.js b/lib/services/computeManagement2/lib/models/apiErrorBase.js index f66f82ef56..a93aabea5b 100644 --- a/lib/services/computeManagement2/lib/models/apiErrorBase.js +++ b/lib/services/computeManagement2/lib/models/apiErrorBase.js @@ -17,9 +17,9 @@ class ApiErrorBase { /** * Create a ApiErrorBase. - * @member {string} [code] The error code. - * @member {string} [target] The target of the particular error. - * @member {string} [message] The error message. + * @property {string} [code] The error code. + * @property {string} [target] The target of the particular error. + * @property {string} [message] The error message. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/automaticOSUpgradePolicy.js b/lib/services/computeManagement2/lib/models/automaticOSUpgradePolicy.js index 5b701fce6a..6612e373c8 100644 --- a/lib/services/computeManagement2/lib/models/automaticOSUpgradePolicy.js +++ b/lib/services/computeManagement2/lib/models/automaticOSUpgradePolicy.js @@ -17,10 +17,10 @@ class AutomaticOSUpgradePolicy { /** * Create a AutomaticOSUpgradePolicy. - * @member {boolean} [enableAutomaticOSUpgrade] Whether OS upgrades should + * @property {boolean} [enableAutomaticOSUpgrade] Whether OS upgrades should * automatically be applied to scale set instances in a rolling fashion when * a newer version of the image becomes available. Default value is false. - * @member {boolean} [disableAutomaticRollback] Whether OS image rollback + * @property {boolean} [disableAutomaticRollback] Whether OS image rollback * feature should be disabled. Default value is false. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/automaticOSUpgradeProperties.js b/lib/services/computeManagement2/lib/models/automaticOSUpgradeProperties.js index 1e244f8c85..f1874adeda 100644 --- a/lib/services/computeManagement2/lib/models/automaticOSUpgradeProperties.js +++ b/lib/services/computeManagement2/lib/models/automaticOSUpgradeProperties.js @@ -17,8 +17,8 @@ class AutomaticOSUpgradeProperties { /** * Create a AutomaticOSUpgradeProperties. - * @member {boolean} automaticOSUpgradeSupported Specifies whether automatic - * OS upgrade is supported on the image. + * @property {boolean} automaticOSUpgradeSupported Specifies whether + * automatic OS upgrade is supported on the image. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/availabilitySet.js b/lib/services/computeManagement2/lib/models/availabilitySet.js index dbe8ef6d2c..ef47e05f22 100644 --- a/lib/services/computeManagement2/lib/models/availabilitySet.js +++ b/lib/services/computeManagement2/lib/models/availabilitySet.js @@ -18,7 +18,7 @@ const models = require('./index'); * set are allocated to different nodes to maximize availability. For more * information about availability sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

For more information on Azure planned maintainance, see [Planned + *

For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

Currently, a VM can only be added to availability set at creation @@ -29,20 +29,21 @@ const models = require('./index'); class AvailabilitySet extends models['Resource'] { /** * Create a AvailabilitySet. - * @member {number} [platformUpdateDomainCount] Update Domain count. - * @member {number} [platformFaultDomainCount] Fault Domain count. - * @member {array} [virtualMachines] A list of references to all virtual + * @property {number} [platformUpdateDomainCount] Update Domain count. + * @property {number} [platformFaultDomainCount] Fault Domain count. + * @property {array} [virtualMachines] A list of references to all virtual * machines in the availability set. - * @member {array} [statuses] The resource status information. - * @member {object} [sku] Sku of the availability set, only name is required - * to be set. See AvailabilitySetSkuTypes for possible set of values. Use - * 'Aligned' for virtual machines with managed disks and 'Classic' for - * virtual machines with unmanaged disks. Default value is 'Classic'. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a + * @property {array} [statuses] The resource status information. + * @property {object} [sku] Sku of the availability set, only name is + * required to be set. See AvailabilitySetSkuTypes for possible set of + * values. Use 'Aligned' for virtual machines with managed disks and + * 'Classic' for virtual machines with unmanaged disks. Default value is + * 'Classic'. + * @property {string} [sku.name] The sku name. + * @property {string} [sku.tier] Specifies the tier of virtual machines in a * scale set.

Possible Values:

**Standard**

**Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines + * @property {number} [sku.capacity] Specifies the number of virtual machines * in the scale set. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/availabilitySetListResult.js b/lib/services/computeManagement2/lib/models/availabilitySetListResult.js index e09a1f8b3d..44862e1563 100644 --- a/lib/services/computeManagement2/lib/models/availabilitySetListResult.js +++ b/lib/services/computeManagement2/lib/models/availabilitySetListResult.js @@ -16,7 +16,7 @@ class AvailabilitySetListResult extends Array { /** * Create a AvailabilitySetListResult. - * @member {string} [nextLink] The URI to fetch the next page of + * @property {string} [nextLink] The URI to fetch the next page of * AvailabilitySets. Call ListNext() with this URI to fetch the next page of * AvailabilitySets. */ diff --git a/lib/services/computeManagement2/lib/models/availabilitySetUpdate.js b/lib/services/computeManagement2/lib/models/availabilitySetUpdate.js index 2ce9f094d5..6e49dd6d54 100644 --- a/lib/services/computeManagement2/lib/models/availabilitySetUpdate.js +++ b/lib/services/computeManagement2/lib/models/availabilitySetUpdate.js @@ -21,17 +21,17 @@ const models = require('./index'); class AvailabilitySetUpdate extends models['UpdateResource'] { /** * Create a AvailabilitySetUpdate. - * @member {number} [platformUpdateDomainCount] Update Domain count. - * @member {number} [platformFaultDomainCount] Fault Domain count. - * @member {array} [virtualMachines] A list of references to all virtual + * @property {number} [platformUpdateDomainCount] Update Domain count. + * @property {number} [platformFaultDomainCount] Fault Domain count. + * @property {array} [virtualMachines] A list of references to all virtual * machines in the availability set. - * @member {array} [statuses] The resource status information. - * @member {object} [sku] Sku of the availability set - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a + * @property {array} [statuses] The resource status information. + * @property {object} [sku] Sku of the availability set + * @property {string} [sku.name] The sku name. + * @property {string} [sku.tier] Specifies the tier of virtual machines in a * scale set.

Possible Values:

**Standard**

**Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines + * @property {number} [sku.capacity] Specifies the number of virtual machines * in the scale set. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/bootDiagnostics.js b/lib/services/computeManagement2/lib/models/bootDiagnostics.js index e5976c4736..7363e8b322 100644 --- a/lib/services/computeManagement2/lib/models/bootDiagnostics.js +++ b/lib/services/computeManagement2/lib/models/bootDiagnostics.js @@ -20,9 +20,9 @@ class BootDiagnostics { /** * Create a BootDiagnostics. - * @member {boolean} [enabled] Whether boot diagnostics should be enabled on - * the Virtual Machine. - * @member {string} [storageUri] Uri of the storage account to use for + * @property {boolean} [enabled] Whether boot diagnostics should be enabled + * on the Virtual Machine. + * @property {string} [storageUri] Uri of the storage account to use for * placing the console output and screenshot. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/bootDiagnosticsInstanceView.js b/lib/services/computeManagement2/lib/models/bootDiagnosticsInstanceView.js index ac22bee1dd..c75c5e1f6b 100644 --- a/lib/services/computeManagement2/lib/models/bootDiagnosticsInstanceView.js +++ b/lib/services/computeManagement2/lib/models/bootDiagnosticsInstanceView.js @@ -17,21 +17,21 @@ class BootDiagnosticsInstanceView { /** * Create a BootDiagnosticsInstanceView. - * @member {string} [consoleScreenshotBlobUri] The console screenshot blob + * @property {string} [consoleScreenshotBlobUri] The console screenshot blob * URI. - * @member {string} [serialConsoleLogBlobUri] The Linux serial console log + * @property {string} [serialConsoleLogBlobUri] The Linux serial console log * blob Uri. - * @member {object} [status] The boot diagnostics status information for the - * VM.

NOTE: It will be set only if there are errors encountered in - * enabling boot diagnostics. - * @member {string} [status.code] The status code. - * @member {string} [status.level] The level code. Possible values include: + * @property {object} [status] The boot diagnostics status information for + * the VM.

NOTE: It will be set only if there are errors encountered + * in enabling boot diagnostics. + * @property {string} [status.code] The status code. + * @property {string} [status.level] The level code. Possible values include: * 'Info', 'Warning', 'Error' - * @member {string} [status.displayStatus] The short localizable label for + * @property {string} [status.displayStatus] The short localizable label for * the status. - * @member {string} [status.message] The detailed status message, including + * @property {string} [status.message] The detailed status message, including * for alerts and error messages. - * @member {date} [status.time] The time of the status. + * @property {date} [status.time] The time of the status. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/computeOperationValue.js b/lib/services/computeManagement2/lib/models/computeOperationValue.js index bb1f964dad..8ac9e0b36a 100644 --- a/lib/services/computeManagement2/lib/models/computeOperationValue.js +++ b/lib/services/computeManagement2/lib/models/computeOperationValue.js @@ -17,13 +17,13 @@ class ComputeOperationValue { /** * Create a ComputeOperationValue. - * @member {string} [origin] The origin of the compute operation. - * @member {string} [name] The name of the compute operation. - * @member {string} [operation] The display name of the compute operation. - * @member {string} [resource] The display name of the resource the operation - * applies to. - * @member {string} [description] The description of the operation. - * @member {string} [provider] The resource provider for the operation. + * @property {string} [origin] The origin of the compute operation. + * @property {string} [name] The name of the compute operation. + * @property {string} [operation] The display name of the compute operation. + * @property {string} [resource] The display name of the resource the + * operation applies to. + * @property {string} [description] The description of the operation. + * @property {string} [provider] The resource provider for the operation. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/containerService.js b/lib/services/computeManagement2/lib/models/containerService.js index e033d40316..9ed67ea538 100644 --- a/lib/services/computeManagement2/lib/models/containerService.js +++ b/lib/services/computeManagement2/lib/models/containerService.js @@ -20,49 +20,50 @@ const models = require('./index'); class ContainerService extends models['Resource'] { /** * Create a ContainerService. - * @member {string} [provisioningState] the current deployment or + * @property {string} [provisioningState] the current deployment or * provisioning state, which only appears in the response. - * @member {object} [orchestratorProfile] Properties of the orchestrator. - * @member {string} [orchestratorProfile.orchestratorType] The orchestrator + * @property {object} [orchestratorProfile] Properties of the orchestrator. + * @property {string} [orchestratorProfile.orchestratorType] The orchestrator * to use to manage container service cluster resources. Valid values are * Swarm, DCOS, and Custom. Possible values include: 'Swarm', 'DCOS', * 'Custom', 'Kubernetes' - * @member {object} [customProfile] Properties for custom clusters. - * @member {string} [customProfile.orchestrator] The name of the custom + * @property {object} [customProfile] Properties for custom clusters. + * @property {string} [customProfile.orchestrator] The name of the custom * orchestrator to use. - * @member {object} [servicePrincipalProfile] Properties for cluster service - * principals. - * @member {string} [servicePrincipalProfile.clientId] The ID for the service - * principal. - * @member {string} [servicePrincipalProfile.secret] The secret password + * @property {object} [servicePrincipalProfile] Properties for cluster + * service principals. + * @property {string} [servicePrincipalProfile.clientId] The ID for the + * service principal. + * @property {string} [servicePrincipalProfile.secret] The secret password * associated with the service principal. - * @member {object} masterProfile Properties of master agents. - * @member {number} [masterProfile.count] Number of masters (VMs) in the + * @property {object} masterProfile Properties of master agents. + * @property {number} [masterProfile.count] Number of masters (VMs) in the * container service cluster. Allowed values are 1, 3, and 5. The default * value is 1. - * @member {string} [masterProfile.dnsPrefix] DNS prefix to be used to create - * the FQDN for master. - * @member {string} [masterProfile.fqdn] FDQN for the master. - * @member {array} agentPoolProfiles Properties of the agent pool. - * @member {object} [windowsProfile] Properties of Windows VMs. - * @member {string} [windowsProfile.adminUsername] The administrator username - * to use for Windows VMs. - * @member {string} [windowsProfile.adminPassword] The administrator password - * to use for Windows VMs. - * @member {object} linuxProfile Properties of Linux VMs. - * @member {string} [linuxProfile.adminUsername] The administrator username + * @property {string} [masterProfile.dnsPrefix] DNS prefix to be used to + * create the FQDN for master. + * @property {string} [masterProfile.fqdn] FQDN for the master. + * @property {array} agentPoolProfiles Properties of the agent pool. + * @property {object} [windowsProfile] Properties of Windows VMs. + * @property {string} [windowsProfile.adminUsername] The administrator + * username to use for Windows VMs. + * @property {string} [windowsProfile.adminPassword] The administrator + * password to use for Windows VMs. + * @property {object} linuxProfile Properties of Linux VMs. + * @property {string} [linuxProfile.adminUsername] The administrator username * to use for Linux VMs. - * @member {object} [linuxProfile.ssh] The ssh key configuration for Linux + * @property {object} [linuxProfile.ssh] The ssh key configuration for Linux * VMs. - * @member {array} [linuxProfile.ssh.publicKeys] the list of SSH public keys - * used to authenticate with Linux-based VMs. - * @member {object} [diagnosticsProfile] Properties of the diagnostic agent. - * @member {object} [diagnosticsProfile.vmDiagnostics] Profile for the + * @property {array} [linuxProfile.ssh.publicKeys] the list of SSH public + * keys used to authenticate with Linux-based VMs. + * @property {object} [diagnosticsProfile] Properties of the diagnostic + * agent. + * @property {object} [diagnosticsProfile.vmDiagnostics] Profile for the * container service VM diagnostic agent. - * @member {boolean} [diagnosticsProfile.vmDiagnostics.enabled] Whether the + * @property {boolean} [diagnosticsProfile.vmDiagnostics.enabled] Whether the * VM diagnostic agent is provisioned on the VM. - * @member {string} [diagnosticsProfile.vmDiagnostics.storageUri] The URI of - * the storage account where diagnostics are stored. + * @property {string} [diagnosticsProfile.vmDiagnostics.storageUri] The URI + * of the storage account where diagnostics are stored. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/containerServiceAgentPoolProfile.js b/lib/services/computeManagement2/lib/models/containerServiceAgentPoolProfile.js index 89c1404dc9..f8e8f75700 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceAgentPoolProfile.js +++ b/lib/services/computeManagement2/lib/models/containerServiceAgentPoolProfile.js @@ -17,12 +17,12 @@ class ContainerServiceAgentPoolProfile { /** * Create a ContainerServiceAgentPoolProfile. - * @member {string} name Unique name of the agent pool profile in the context - * of the subscription and resource group. - * @member {number} count Number of agents (VMs) to host docker containers. + * @property {string} name Unique name of the agent pool profile in the + * context of the subscription and resource group. + * @property {number} count Number of agents (VMs) to host docker containers. * Allowed values must be in the range of 1 to 100 (inclusive). The default * value is 1. . Default value: 1 . - * @member {string} vmSize Size of agent VMs. Possible values include: + * @property {string} vmSize Size of agent VMs. Possible values include: * 'Standard_A0', 'Standard_A1', 'Standard_A2', 'Standard_A3', 'Standard_A4', * 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A9', * 'Standard_A10', 'Standard_A11', 'Standard_D1', 'Standard_D2', @@ -35,9 +35,9 @@ class ContainerServiceAgentPoolProfile { * 'Standard_DS11', 'Standard_DS12', 'Standard_DS13', 'Standard_DS14', * 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', * 'Standard_GS5' - * @member {string} dnsPrefix DNS prefix to be used to create the FQDN for + * @property {string} dnsPrefix DNS prefix to be used to create the FQDN for * the agent pool. - * @member {string} [fqdn] FDQN for the agent pool. + * @property {string} [fqdn] FQDN for the agent pool. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/containerServiceCustomProfile.js b/lib/services/computeManagement2/lib/models/containerServiceCustomProfile.js index ddf1584f4c..4d5655b870 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceCustomProfile.js +++ b/lib/services/computeManagement2/lib/models/containerServiceCustomProfile.js @@ -17,7 +17,8 @@ class ContainerServiceCustomProfile { /** * Create a ContainerServiceCustomProfile. - * @member {string} orchestrator The name of the custom orchestrator to use. + * @property {string} orchestrator The name of the custom orchestrator to + * use. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/containerServiceDiagnosticsProfile.js b/lib/services/computeManagement2/lib/models/containerServiceDiagnosticsProfile.js index 7307cbb2d1..59bea2799d 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceDiagnosticsProfile.js +++ b/lib/services/computeManagement2/lib/models/containerServiceDiagnosticsProfile.js @@ -16,12 +16,12 @@ class ContainerServiceDiagnosticsProfile { /** * Create a ContainerServiceDiagnosticsProfile. - * @member {object} vmDiagnostics Profile for the container service VM + * @property {object} vmDiagnostics Profile for the container service VM * diagnostic agent. - * @member {boolean} [vmDiagnostics.enabled] Whether the VM diagnostic agent - * is provisioned on the VM. - * @member {string} [vmDiagnostics.storageUri] The URI of the storage account - * where diagnostics are stored. + * @property {boolean} [vmDiagnostics.enabled] Whether the VM diagnostic + * agent is provisioned on the VM. + * @property {string} [vmDiagnostics.storageUri] The URI of the storage + * account where diagnostics are stored. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/containerServiceLinuxProfile.js b/lib/services/computeManagement2/lib/models/containerServiceLinuxProfile.js index a4c6e59a87..419b2d059c 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceLinuxProfile.js +++ b/lib/services/computeManagement2/lib/models/containerServiceLinuxProfile.js @@ -17,10 +17,10 @@ class ContainerServiceLinuxProfile { /** * Create a ContainerServiceLinuxProfile. - * @member {string} adminUsername The administrator username to use for Linux - * VMs. - * @member {object} ssh The ssh key configuration for Linux VMs. - * @member {array} [ssh.publicKeys] the list of SSH public keys used to + * @property {string} adminUsername The administrator username to use for + * Linux VMs. + * @property {object} ssh The ssh key configuration for Linux VMs. + * @property {array} [ssh.publicKeys] the list of SSH public keys used to * authenticate with Linux-based VMs. */ constructor() { @@ -44,7 +44,7 @@ class ContainerServiceLinuxProfile { required: true, serializedName: 'adminUsername', constraints: { - Pattern: '^[a-z][a-z0-9_-]*$' + Pattern: /^[a-z][a-z0-9_-]*$/ }, type: { name: 'String' diff --git a/lib/services/computeManagement2/lib/models/containerServiceListResult.js b/lib/services/computeManagement2/lib/models/containerServiceListResult.js index 48a64b5f13..4aa69ad701 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceListResult.js +++ b/lib/services/computeManagement2/lib/models/containerServiceListResult.js @@ -16,7 +16,7 @@ class ContainerServiceListResult extends Array { /** * Create a ContainerServiceListResult. - * @member {string} [nextLink] The URL to get the next set of container + * @property {string} [nextLink] The URL to get the next set of container * service results. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/containerServiceMasterProfile.js b/lib/services/computeManagement2/lib/models/containerServiceMasterProfile.js index 5816e6dbb6..edcd288e9f 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceMasterProfile.js +++ b/lib/services/computeManagement2/lib/models/containerServiceMasterProfile.js @@ -17,12 +17,12 @@ class ContainerServiceMasterProfile { /** * Create a ContainerServiceMasterProfile. - * @member {number} [count] Number of masters (VMs) in the container service - * cluster. Allowed values are 1, 3, and 5. The default value is 1. Default - * value: 1 . - * @member {string} dnsPrefix DNS prefix to be used to create the FQDN for + * @property {number} [count] Number of masters (VMs) in the container + * service cluster. Allowed values are 1, 3, and 5. The default value is 1. + * Default value: 1 . + * @property {string} dnsPrefix DNS prefix to be used to create the FQDN for * master. - * @member {string} [fqdn] FDQN for the master. + * @property {string} [fqdn] FQDN for the master. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/containerServiceOrchestratorProfile.js b/lib/services/computeManagement2/lib/models/containerServiceOrchestratorProfile.js index e95b6de3d4..f4182e646a 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceOrchestratorProfile.js +++ b/lib/services/computeManagement2/lib/models/containerServiceOrchestratorProfile.js @@ -17,7 +17,7 @@ class ContainerServiceOrchestratorProfile { /** * Create a ContainerServiceOrchestratorProfile. - * @member {string} orchestratorType The orchestrator to use to manage + * @property {string} orchestratorType The orchestrator to use to manage * container service cluster resources. Valid values are Swarm, DCOS, and * Custom. Possible values include: 'Swarm', 'DCOS', 'Custom', 'Kubernetes' */ diff --git a/lib/services/computeManagement2/lib/models/containerServiceServicePrincipalProfile.js b/lib/services/computeManagement2/lib/models/containerServiceServicePrincipalProfile.js index 37d421ac51..681fdfd8a1 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceServicePrincipalProfile.js +++ b/lib/services/computeManagement2/lib/models/containerServiceServicePrincipalProfile.js @@ -18,8 +18,8 @@ class ContainerServiceServicePrincipalProfile { /** * Create a ContainerServiceServicePrincipalProfile. - * @member {string} clientId The ID for the service principal. - * @member {string} secret The secret password associated with the service + * @property {string} clientId The ID for the service principal. + * @property {string} secret The secret password associated with the service * principal. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/containerServiceSshConfiguration.js b/lib/services/computeManagement2/lib/models/containerServiceSshConfiguration.js index f2399c73e1..3752f2c61a 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceSshConfiguration.js +++ b/lib/services/computeManagement2/lib/models/containerServiceSshConfiguration.js @@ -17,7 +17,7 @@ class ContainerServiceSshConfiguration { /** * Create a ContainerServiceSshConfiguration. - * @member {array} publicKeys the list of SSH public keys used to + * @property {array} publicKeys the list of SSH public keys used to * authenticate with Linux-based VMs. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/containerServiceSshPublicKey.js b/lib/services/computeManagement2/lib/models/containerServiceSshPublicKey.js index e6246dc5b4..b2e5bc6e41 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceSshPublicKey.js +++ b/lib/services/computeManagement2/lib/models/containerServiceSshPublicKey.js @@ -17,9 +17,9 @@ class ContainerServiceSshPublicKey { /** * Create a ContainerServiceSshPublicKey. - * @member {string} keyData Certificate public key used to authenticate with - * VMs through SSH. The certificate must be in PEM format with or without - * headers. + * @property {string} keyData Certificate public key used to authenticate + * with VMs through SSH. The certificate must be in PEM format with or + * without headers. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/containerServiceVMDiagnostics.js b/lib/services/computeManagement2/lib/models/containerServiceVMDiagnostics.js index 9c10887571..22306ec296 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceVMDiagnostics.js +++ b/lib/services/computeManagement2/lib/models/containerServiceVMDiagnostics.js @@ -17,9 +17,9 @@ class ContainerServiceVMDiagnostics { /** * Create a ContainerServiceVMDiagnostics. - * @member {boolean} enabled Whether the VM diagnostic agent is provisioned + * @property {boolean} enabled Whether the VM diagnostic agent is provisioned * on the VM. - * @member {string} [storageUri] The URI of the storage account where + * @property {string} [storageUri] The URI of the storage account where * diagnostics are stored. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/containerServiceWindowsProfile.js b/lib/services/computeManagement2/lib/models/containerServiceWindowsProfile.js index 3bb3b802ca..7978a3bed3 100644 --- a/lib/services/computeManagement2/lib/models/containerServiceWindowsProfile.js +++ b/lib/services/computeManagement2/lib/models/containerServiceWindowsProfile.js @@ -17,9 +17,9 @@ class ContainerServiceWindowsProfile { /** * Create a ContainerServiceWindowsProfile. - * @member {string} adminUsername The administrator username to use for + * @property {string} adminUsername The administrator username to use for * Windows VMs. - * @member {string} adminPassword The administrator password to use for + * @property {string} adminPassword The administrator password to use for * Windows VMs. */ constructor() { @@ -43,7 +43,7 @@ class ContainerServiceWindowsProfile { required: true, serializedName: 'adminUsername', constraints: { - Pattern: '^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$' + Pattern: /^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$/ }, type: { name: 'String' @@ -53,7 +53,7 @@ class ContainerServiceWindowsProfile { required: true, serializedName: 'adminPassword', constraints: { - Pattern: '^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\^&\*\(\)])[a-zA-Z\d!@#$%\^&\*\(\)]{12,123}$' + Pattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\^&\*\(\)])[a-zA-Z\d!@#$%\^&\*\(\)]{12,123}$/ }, type: { name: 'String' diff --git a/lib/services/computeManagement2/lib/models/creationData.js b/lib/services/computeManagement2/lib/models/creationData.js index bce32a88fb..72445e128b 100644 --- a/lib/services/computeManagement2/lib/models/creationData.js +++ b/lib/services/computeManagement2/lib/models/creationData.js @@ -17,21 +17,21 @@ class CreationData { /** * Create a CreationData. - * @member {string} createOption This enumerates the possible sources of a + * @property {string} createOption This enumerates the possible sources of a * disk's creation. Possible values include: 'Empty', 'Attach', 'FromImage', - * 'Import', 'Copy', 'Restore' - * @member {string} [storageAccountId] If createOption is Import, the Azure + * 'Import', 'Copy', 'Restore', 'Upload' + * @property {string} [storageAccountId] If createOption is Import, the Azure * Resource Manager identifier of the storage account containing the blob to * import as a disk. Required only if the blob is in a different subscription - * @member {object} [imageReference] Disk source information. - * @member {string} [imageReference.id] A relative uri containing either a + * @property {object} [imageReference] Disk source information. + * @property {string} [imageReference.id] A relative uri containing either a * Platform Image Repository or user image reference. - * @member {number} [imageReference.lun] If the disk is created from an + * @property {number} [imageReference.lun] If the disk is created from an * image's data disk, this is an index that indicates which of the data disks * in the image to use. For OS disks, this field is null. - * @member {string} [sourceUri] If createOption is Import, this is the URI of - * a blob to be imported into a managed disk. - * @member {string} [sourceResourceId] If createOption is Copy, this is the + * @property {string} [sourceUri] If createOption is Import, this is the URI + * of a blob to be imported into a managed disk. + * @property {string} [sourceResourceId] If createOption is Copy, this is the * ARM id of the source snapshot or disk. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/dataDisk.js b/lib/services/computeManagement2/lib/models/dataDisk.js index 60c1137744..9b5db51b51 100644 --- a/lib/services/computeManagement2/lib/models/dataDisk.js +++ b/lib/services/computeManagement2/lib/models/dataDisk.js @@ -17,37 +17,38 @@ class DataDisk { /** * Create a DataDisk. - * @member {number} lun Specifies the logical unit number of the data disk. + * @property {number} lun Specifies the logical unit number of the data disk. * This value is used to identify data disks within the VM and therefore must * be unique for each data disk attached to a VM. - * @member {string} [name] The disk name. - * @member {object} [vhd] The virtual hard disk. - * @member {string} [vhd.uri] Specifies the virtual hard disk's uri. - * @member {object} [image] The source user image virtual hard disk. The + * @property {string} [name] The disk name. + * @property {object} [vhd] The virtual hard disk. + * @property {string} [vhd.uri] Specifies the virtual hard disk's uri. + * @property {object} [image] The source user image virtual hard disk. The * virtual hard disk will be copied before being attached to the virtual * machine. If SourceImage is provided, the destination virtual hard drive * must not exist. - * @member {string} [image.uri] Specifies the virtual hard disk's uri. - * @member {string} [caching] Specifies the caching requirements.

+ * @property {string} [image.uri] Specifies the virtual hard disk's uri. + * @property {string} [caching] Specifies the caching requirements.

* Possible values are:

**None**

**ReadOnly**

* **ReadWrite**

Default: **None for Standard storage. ReadOnly for * Premium storage**. Possible values include: 'None', 'ReadOnly', * 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether + * @property {boolean} [writeAcceleratorEnabled] Specifies whether * writeAccelerator should be enabled or disabled on the disk. - * @member {string} createOption Specifies how the virtual machine should be - * created.

Possible values are:

**Attach** \u2013 This value - * is used when you are using a specialized disk to create the virtual + * @property {string} createOption Specifies how the virtual machine should + * be created.

Possible values are:

**Attach** \u2013 This + * value is used when you are using a specialized disk to create the virtual * machine.

**FromImage** \u2013 This value is used when you are * using an image to create the virtual machine. If you are using a platform * image, you also use the imageReference element described above. If you are * using a marketplace image, you also use the plan element previously * described. Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {number} [diskSizeGB] Specifies the size of an empty data disk in - * gigabytes. This element can be used to overwrite the size of the disk in a - * virtual machine image.

This value cannot be larger than 1023 GB - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage + * @property {number} [diskSizeGB] Specifies the size of an empty data disk + * in gigabytes. This element can be used to overwrite the size of the disk + * in a virtual machine image.

This value cannot be larger than 1023 + * GB + * @property {object} [managedDisk] The managed disk parameters. + * @property {string} [managedDisk.storageAccountType] Specifies the storage * account type for the managed disk. NOTE: UltraSSD_LRS can only be used * with data disks, it cannot be used with OS Disk. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' diff --git a/lib/services/computeManagement2/lib/models/dataDiskImage.js b/lib/services/computeManagement2/lib/models/dataDiskImage.js index b426c31fab..2e03e04ed4 100644 --- a/lib/services/computeManagement2/lib/models/dataDiskImage.js +++ b/lib/services/computeManagement2/lib/models/dataDiskImage.js @@ -17,9 +17,9 @@ class DataDiskImage { /** * Create a DataDiskImage. - * @member {number} [lun] Specifies the logical unit number of the data disk. - * This value is used to identify data disks within the VM and therefore must - * be unique for each data disk attached to a VM. + * @property {number} [lun] Specifies the logical unit number of the data + * disk. This value is used to identify data disks within the VM and + * therefore must be unique for each data disk attached to a VM. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/diagnosticsProfile.js b/lib/services/computeManagement2/lib/models/diagnosticsProfile.js index 8d712a8186..f399473b67 100644 --- a/lib/services/computeManagement2/lib/models/diagnosticsProfile.js +++ b/lib/services/computeManagement2/lib/models/diagnosticsProfile.js @@ -18,14 +18,14 @@ class DiagnosticsProfile { /** * Create a DiagnosticsProfile. - * @member {object} [bootDiagnostics] Boot Diagnostics is a debugging feature - * which allows you to view Console Output and Screenshot to diagnose VM - * status.

You can easily view the output of your console log. + * @property {object} [bootDiagnostics] Boot Diagnostics is a debugging + * feature which allows you to view Console Output and Screenshot to diagnose + * VM status.

You can easily view the output of your console log. *

Azure also enables you to see a screenshot of the VM from the * hypervisor. - * @member {boolean} [bootDiagnostics.enabled] Whether boot diagnostics + * @property {boolean} [bootDiagnostics.enabled] Whether boot diagnostics * should be enabled on the Virtual Machine. - * @member {string} [bootDiagnostics.storageUri] Uri of the storage account + * @property {string} [bootDiagnostics.storageUri] Uri of the storage account * to use for placing the console output and screenshot. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/diffDiskSettings.js b/lib/services/computeManagement2/lib/models/diffDiskSettings.js index 255adbef70..5f0477557e 100644 --- a/lib/services/computeManagement2/lib/models/diffDiskSettings.js +++ b/lib/services/computeManagement2/lib/models/diffDiskSettings.js @@ -11,15 +11,15 @@ 'use strict'; /** - * Describes the parameters of differencing disk settings that can be be - * specified for operating system disk.

NOTE: The differencing disk - * settings can only be specified for managed disk. + * Describes the parameters of ephemeral disk settings that can be specified + * for operating system disk.

NOTE: The ephemeral disk settings can + * only be specified for managed disk. * */ class DiffDiskSettings { /** * Create a DiffDiskSettings. - * @member {string} [option] Specifies the differencing disk settings for + * @property {string} [option] Specifies the ephemeral disk settings for * operating system disk. Possible values include: 'Local' */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/disallowed.js b/lib/services/computeManagement2/lib/models/disallowed.js index 9376c28ab0..e813a33f02 100644 --- a/lib/services/computeManagement2/lib/models/disallowed.js +++ b/lib/services/computeManagement2/lib/models/disallowed.js @@ -17,7 +17,7 @@ class Disallowed { /** * Create a Disallowed. - * @member {array} [diskTypes] A list of disk types. + * @property {array} [diskTypes] A list of disk types. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/disk.js b/lib/services/computeManagement2/lib/models/disk.js index 2fb2c6d801..2d5c69dede 100644 --- a/lib/services/computeManagement2/lib/models/disk.js +++ b/lib/services/computeManagement2/lib/models/disk.js @@ -20,70 +20,63 @@ const models = require('./index'); class Disk extends models['Resource'] { /** * Create a Disk. - * @member {string} [managedBy] A relative URI containing the ID of the VM + * @property {string} [managedBy] A relative URI containing the ID of the VM * that has the disk attached. - * @member {object} [sku] - * @member {string} [sku.name] The sku name. Possible values include: + * @property {object} [sku] + * @property {string} [sku.name] The sku name. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {string} [sku.tier] The sku tier. - * @member {array} [zones] The Logical zone list for Disk. - * @member {date} [timeCreated] The time when the disk was created. - * @member {string} [osType] The Operating System type. Possible values + * @property {string} [sku.tier] The sku tier. + * @property {array} [zones] The Logical zone list for Disk. + * @property {date} [timeCreated] The time when the disk was created. + * @property {string} [osType] The Operating System type. Possible values * include: 'Windows', 'Linux' - * @member {object} creationData Disk source information. CreationData + * @property {string} [hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: + * 'V1', 'V2' + * @property {object} creationData Disk source information. CreationData * information cannot be changed after the disk has been created. - * @member {string} [creationData.createOption] This enumerates the possible - * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' - * @member {string} [creationData.storageAccountId] If createOption is + * @property {string} [creationData.createOption] This enumerates the + * possible sources of a disk's creation. Possible values include: 'Empty', + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' + * @property {string} [creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account * containing the blob to import as a disk. Required only if the blob is in a * different subscription - * @member {object} [creationData.imageReference] Disk source information. - * @member {string} [creationData.imageReference.id] A relative uri + * @property {object} [creationData.imageReference] Disk source information. + * @property {string} [creationData.imageReference.id] A relative uri * containing either a Platform Image Repository or user image reference. - * @member {number} [creationData.imageReference.lun] If the disk is created - * from an image's data disk, this is an index that indicates which of the - * data disks in the image to use. For OS disks, this field is null. - * @member {string} [creationData.sourceUri] If createOption is Import, this - * is the URI of a blob to be imported into a managed disk. - * @member {string} [creationData.sourceResourceId] If createOption is Copy, - * this is the ARM id of the source snapshot or disk. - * @member {number} [diskSizeGB] If creationData.createOption is Empty, this - * field is mandatory and it indicates the size of the VHD to create. If this - * field is present for updates or creation with other options, it indicates - * a resize. Resizes are only allowed if the disk is not attached to a - * running VM, and can only increase the disk's size. - * @member {object} [encryptionSettings] Encryption settings for disk or - * snapshot - * @member {boolean} [encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @property {number} [creationData.imageReference.lun] If the disk is + * created from an image's data disk, this is an index that indicates which + * of the data disks in the image to use. For OS disks, this field is null. + * @property {string} [creationData.sourceUri] If createOption is Import, + * this is the URI of a blob to be imported into a managed disk. + * @property {string} [creationData.sourceResourceId] If createOption is + * Copy, this is the ARM id of the source snapshot or disk. + * @property {number} [diskSizeGB] If creationData.createOption is Empty, + * this field is mandatory and it indicates the size of the VHD to create. If + * this field is present for updates or creation with other options, it + * indicates a resize. Resizes are only allowed if the disk is not attached + * to a running VM, and can only increase the disk's size. + * @property {object} [encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. + * @property {boolean} [encryptionSettingsCollection.enabled] Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in * the request object, the existing settings remain unchanged. - * @member {object} [encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] - * Resource id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] Url - * pointing to a key or secret in KeyVault - * @member {object} [encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] - * Resource id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] Url pointing - * to a key or secret in KeyVault - * @member {string} [provisioningState] The disk provisioning state. - * @member {number} [diskIOPSReadWrite] The number of IOPS allowed for this + * @property {array} [encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. + * @property {string} [provisioningState] The disk provisioning state. + * @property {number} [diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between * 4k and 256k bytes. - * @member {number} [diskMBpsReadWrite] The bandwidth allowed for this disk; - * only settable for UltraSSD disks. MBps means millions of bytes per second - * - MB here uses the ISO notation, of powers of 10. + * @property {number} [diskMBpsReadWrite] The bandwidth allowed for this + * disk; only settable for UltraSSD disks. MBps means millions of bytes per + * second - MB here uses the ISO notation, of powers of 10. + * @property {string} [diskState] The state of the disk. Possible values + * include: 'Unattached', 'Attached', 'Reserved', 'ActiveSAS', + * 'ReadyToUpload', 'ActiveUpload' */ constructor() { super(); @@ -194,6 +187,13 @@ class Disk extends models['Resource'] { allowedValues: [ 'Windows', 'Linux' ] } }, + hyperVGeneration: { + required: false, + serializedName: 'properties.hyperVGeneration', + type: { + name: 'String' + } + }, creationData: { required: true, serializedName: 'properties.creationData', @@ -209,12 +209,12 @@ class Disk extends models['Resource'] { name: 'Number' } }, - encryptionSettings: { + encryptionSettingsCollection: { required: false, - serializedName: 'properties.encryptionSettings', + serializedName: 'properties.encryptionSettingsCollection', type: { name: 'Composite', - className: 'EncryptionSettings' + className: 'EncryptionSettingsCollection' } }, provisioningState: { @@ -238,6 +238,14 @@ class Disk extends models['Resource'] { type: { name: 'Number' } + }, + diskState: { + required: false, + readOnly: true, + serializedName: 'properties.diskState', + type: { + name: 'String' + } } } } diff --git a/lib/services/computeManagement2/lib/models/diskEncryptionSettings.js b/lib/services/computeManagement2/lib/models/diskEncryptionSettings.js index a33e93f831..3920d52c4b 100644 --- a/lib/services/computeManagement2/lib/models/diskEncryptionSettings.js +++ b/lib/services/computeManagement2/lib/models/diskEncryptionSettings.js @@ -17,21 +17,21 @@ class DiskEncryptionSettings { /** * Create a DiskEncryptionSettings. - * @member {object} [diskEncryptionKey] Specifies the location of the disk + * @property {object} [diskEncryptionKey] Specifies the location of the disk * encryption key, which is a Key Vault Secret. - * @member {string} [diskEncryptionKey.secretUrl] The URL referencing a + * @property {string} [diskEncryptionKey.secretUrl] The URL referencing a * secret in a Key Vault. - * @member {object} [diskEncryptionKey.sourceVault] The relative URL of the + * @property {object} [diskEncryptionKey.sourceVault] The relative URL of the * Key Vault containing the secret. - * @member {string} [diskEncryptionKey.sourceVault.id] Resource Id - * @member {object} [keyEncryptionKey] Specifies the location of the key + * @property {string} [diskEncryptionKey.sourceVault.id] Resource Id + * @property {object} [keyEncryptionKey] Specifies the location of the key * encryption key in Key Vault. - * @member {string} [keyEncryptionKey.keyUrl] The URL referencing a key + * @property {string} [keyEncryptionKey.keyUrl] The URL referencing a key * encryption key in Key Vault. - * @member {object} [keyEncryptionKey.sourceVault] The relative URL of the + * @property {object} [keyEncryptionKey.sourceVault] The relative URL of the * Key Vault containing the key. - * @member {string} [keyEncryptionKey.sourceVault.id] Resource Id - * @member {boolean} [enabled] Specifies whether disk encryption should be + * @property {string} [keyEncryptionKey.sourceVault.id] Resource Id + * @property {boolean} [enabled] Specifies whether disk encryption should be * enabled on the virtual machine. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/diskInstanceView.js b/lib/services/computeManagement2/lib/models/diskInstanceView.js index 53b49e1f71..fcadea4106 100644 --- a/lib/services/computeManagement2/lib/models/diskInstanceView.js +++ b/lib/services/computeManagement2/lib/models/diskInstanceView.js @@ -17,10 +17,10 @@ class DiskInstanceView { /** * Create a DiskInstanceView. - * @member {string} [name] The disk name. - * @member {array} [encryptionSettings] Specifies the encryption settings for - * the OS Disk.

Minimum api-version: 2015-06-15 - * @member {array} [statuses] The resource status information. + * @property {string} [name] The disk name. + * @property {array} [encryptionSettings] Specifies the encryption settings + * for the OS Disk.

Minimum api-version: 2015-06-15 + * @property {array} [statuses] The resource status information. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/diskList.js b/lib/services/computeManagement2/lib/models/diskList.js index 67a22a3f6e..c63da70116 100644 --- a/lib/services/computeManagement2/lib/models/diskList.js +++ b/lib/services/computeManagement2/lib/models/diskList.js @@ -16,8 +16,8 @@ class DiskList extends Array { /** * Create a DiskList. - * @member {string} [nextLink] The uri to fetch the next page of disks. Call - * ListNext() with this to fetch the next page of disks. + * @property {string} [nextLink] The uri to fetch the next page of disks. + * Call ListNext() with this to fetch the next page of disks. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/diskSku.js b/lib/services/computeManagement2/lib/models/diskSku.js index bbe7a171ba..036d022f79 100644 --- a/lib/services/computeManagement2/lib/models/diskSku.js +++ b/lib/services/computeManagement2/lib/models/diskSku.js @@ -18,9 +18,9 @@ class DiskSku { /** * Create a DiskSku. - * @member {string} [name] The sku name. Possible values include: + * @property {string} [name] The sku name. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {string} [tier] The sku tier. Default value: 'Standard' . + * @property {string} [tier] The sku tier. Default value: 'Standard' . */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/diskUpdate.js b/lib/services/computeManagement2/lib/models/diskUpdate.js index 8e023d33a8..2f2616265b 100644 --- a/lib/services/computeManagement2/lib/models/diskUpdate.js +++ b/lib/services/computeManagement2/lib/models/diskUpdate.js @@ -17,47 +17,34 @@ class DiskUpdate { /** * Create a DiskUpdate. - * @member {string} [osType] the Operating System type. Possible values + * @property {string} [osType] the Operating System type. Possible values * include: 'Windows', 'Linux' - * @member {number} [diskSizeGB] If creationData.createOption is Empty, this - * field is mandatory and it indicates the size of the VHD to create. If this - * field is present for updates or creation with other options, it indicates - * a resize. Resizes are only allowed if the disk is not attached to a - * running VM, and can only increase the disk's size. - * @member {object} [encryptionSettings] Encryption settings for disk or - * snapshot - * @member {boolean} [encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @property {number} [diskSizeGB] If creationData.createOption is Empty, + * this field is mandatory and it indicates the size of the VHD to create. If + * this field is present for updates or creation with other options, it + * indicates a resize. Resizes are only allowed if the disk is not attached + * to a running VM, and can only increase the disk's size. + * @property {object} [encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. + * @property {boolean} [encryptionSettingsCollection.enabled] Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in * the request object, the existing settings remain unchanged. - * @member {object} [encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] - * Resource id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] Url - * pointing to a key or secret in KeyVault - * @member {object} [encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] - * Resource id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] Url pointing - * to a key or secret in KeyVault - * @member {number} [diskIOPSReadWrite] The number of IOPS allowed for this + * @property {array} [encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. + * @property {number} [diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between * 4k and 256k bytes. - * @member {number} [diskMBpsReadWrite] The bandwidth allowed for this disk; - * only settable for UltraSSD disks. MBps means millions of bytes per second - * - MB here uses the ISO notation, of powers of 10. - * @member {object} [tags] Resource tags - * @member {object} [sku] - * @member {string} [sku.name] The sku name. Possible values include: + * @property {number} [diskMBpsReadWrite] The bandwidth allowed for this + * disk; only settable for UltraSSD disks. MBps means millions of bytes per + * second - MB here uses the ISO notation, of powers of 10. + * @property {object} [tags] Resource tags + * @property {object} [sku] + * @property {string} [sku.name] The sku name. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {string} [sku.tier] The sku tier. + * @property {string} [sku.tier] The sku tier. */ constructor() { } @@ -91,12 +78,12 @@ class DiskUpdate { name: 'Number' } }, - encryptionSettings: { + encryptionSettingsCollection: { required: false, - serializedName: 'properties.encryptionSettings', + serializedName: 'properties.encryptionSettingsCollection', type: { name: 'Composite', - className: 'EncryptionSettings' + className: 'EncryptionSettingsCollection' } }, diskIOPSReadWrite: { diff --git a/lib/services/computeManagement2/lib/models/encryptionSettingsCollection.js b/lib/services/computeManagement2/lib/models/encryptionSettingsCollection.js new file mode 100644 index 0000000000..47976c6d2a --- /dev/null +++ b/lib/services/computeManagement2/lib/models/encryptionSettingsCollection.js @@ -0,0 +1,73 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Encryption settings for disk or snapshot + * + */ +class EncryptionSettingsCollection { + /** + * Create a EncryptionSettingsCollection. + * @property {boolean} enabled Set this flag to true and provide + * DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set + * this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to + * disable encryption. If EncryptionSettings is null in the request object, + * the existing settings remain unchanged. + * @property {array} [encryptionSettings] A collection of encryption + * settings, one for each disk volume. + */ + constructor() { + } + + /** + * Defines the metadata of EncryptionSettingsCollection + * + * @returns {object} metadata of EncryptionSettingsCollection + * + */ + mapper() { + return { + required: false, + serializedName: 'EncryptionSettingsCollection', + type: { + name: 'Composite', + className: 'EncryptionSettingsCollection', + modelProperties: { + enabled: { + required: true, + serializedName: 'enabled', + type: { + name: 'Boolean' + } + }, + encryptionSettings: { + required: false, + serializedName: 'encryptionSettings', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'EncryptionSettingsElementElementType', + type: { + name: 'Composite', + className: 'EncryptionSettingsElement' + } + } + } + } + } + } + }; + } +} + +module.exports = EncryptionSettingsCollection; diff --git a/lib/services/computeManagement2/lib/models/encryptionSettingsElement.js b/lib/services/computeManagement2/lib/models/encryptionSettingsElement.js new file mode 100644 index 0000000000..ec6012f86d --- /dev/null +++ b/lib/services/computeManagement2/lib/models/encryptionSettingsElement.js @@ -0,0 +1,75 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Encryption settings for one disk volume. + * + */ +class EncryptionSettingsElement { + /** + * Create a EncryptionSettingsElement. + * @property {object} [diskEncryptionKey] Key Vault Secret Url and vault id + * of the disk encryption key + * @property {object} [diskEncryptionKey.sourceVault] Resource id of the + * KeyVault containing the key or secret + * @property {string} [diskEncryptionKey.sourceVault.id] Resource Id + * @property {string} [diskEncryptionKey.secretUrl] Url pointing to a key or + * secret in KeyVault + * @property {object} [keyEncryptionKey] Key Vault Key Url and vault id of + * the key encryption key. KeyEncryptionKey is optional and when provided is + * used to unwrap the disk encryption key. + * @property {object} [keyEncryptionKey.sourceVault] Resource id of the + * KeyVault containing the key or secret + * @property {string} [keyEncryptionKey.sourceVault.id] Resource Id + * @property {string} [keyEncryptionKey.keyUrl] Url pointing to a key or + * secret in KeyVault + */ + constructor() { + } + + /** + * Defines the metadata of EncryptionSettingsElement + * + * @returns {object} metadata of EncryptionSettingsElement + * + */ + mapper() { + return { + required: false, + serializedName: 'EncryptionSettingsElement', + type: { + name: 'Composite', + className: 'EncryptionSettingsElement', + modelProperties: { + diskEncryptionKey: { + required: false, + serializedName: 'diskEncryptionKey', + type: { + name: 'Composite', + className: 'KeyVaultAndSecretReference' + } + }, + keyEncryptionKey: { + required: false, + serializedName: 'keyEncryptionKey', + type: { + name: 'Composite', + className: 'KeyVaultAndKeyReference' + } + } + } + } + }; + } +} + +module.exports = EncryptionSettingsElement; diff --git a/lib/services/computeManagement2/lib/models/gallery.js b/lib/services/computeManagement2/lib/models/gallery.js index 2a046e2784..e9df7c4d87 100644 --- a/lib/services/computeManagement2/lib/models/gallery.js +++ b/lib/services/computeManagement2/lib/models/gallery.js @@ -21,14 +21,14 @@ const models = require('./index'); class Gallery extends models['Resource'] { /** * Create a Gallery. - * @member {string} [description] The description of this Shared Image - * Gallery resource. This property is updateable. - * @member {object} [identifier] - * @member {string} [identifier.uniqueName] The unique name of the Shared + * @property {string} [description] The description of this Shared Image + * Gallery resource. This property is updatable. + * @property {object} [identifier] + * @property {string} [identifier.uniqueName] The unique name of the Shared * Image Gallery. This name is generated automatically by Azure. - * @member {string} [provisioningState] The current state of the gallery. The - * provisioning state, which only appears in the response. Possible values - * include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting', + * @property {string} [provisioningState] The current state of the gallery. + * The provisioning state, which only appears in the response. Possible + * values include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting', * 'Migrating' */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/galleryArtifactPublishingProfileBase.js b/lib/services/computeManagement2/lib/models/galleryArtifactPublishingProfileBase.js index 31822f68b5..fac93e1323 100644 --- a/lib/services/computeManagement2/lib/models/galleryArtifactPublishingProfileBase.js +++ b/lib/services/computeManagement2/lib/models/galleryArtifactPublishingProfileBase.js @@ -17,11 +17,11 @@ class GalleryArtifactPublishingProfileBase { /** * Create a GalleryArtifactPublishingProfileBase. - * @member {array} [targetRegions] The target regions where the Image Version - * is going to be replicated to. This property is updateable. - * @member {object} source - * @member {object} [source.managedImage] - * @member {string} [source.managedImage.id] The managed artifact id. + * @property {array} [targetRegions] The target regions where the Image + * Version is going to be replicated to. This property is updatable. + * @property {object} source + * @property {object} [source.managedImage] + * @property {string} [source.managedImage.id] The managed artifact id. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/galleryArtifactSource.js b/lib/services/computeManagement2/lib/models/galleryArtifactSource.js index d2bd4723e5..d8245ac3bc 100644 --- a/lib/services/computeManagement2/lib/models/galleryArtifactSource.js +++ b/lib/services/computeManagement2/lib/models/galleryArtifactSource.js @@ -17,8 +17,8 @@ class GalleryArtifactSource { /** * Create a GalleryArtifactSource. - * @member {object} managedImage - * @member {string} [managedImage.id] The managed artifact id. + * @property {object} managedImage + * @property {string} [managedImage.id] The managed artifact id. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/galleryDataDiskImage.js b/lib/services/computeManagement2/lib/models/galleryDataDiskImage.js index 8ddf4e18fa..5af1352471 100644 --- a/lib/services/computeManagement2/lib/models/galleryDataDiskImage.js +++ b/lib/services/computeManagement2/lib/models/galleryDataDiskImage.js @@ -20,8 +20,8 @@ const models = require('./index'); class GalleryDataDiskImage extends models['GalleryDiskImage'] { /** * Create a GalleryDataDiskImage. - * @member {number} [lun] This property specifies the logical unit number of - * the data disk. This value is used to identify data disks within the + * @property {number} [lun] This property specifies the logical unit number + * of the data disk. This value is used to identify data disks within the * Virtual Machine and therefore must be unique for each data disk attached * to the Virtual Machine. */ diff --git a/lib/services/computeManagement2/lib/models/galleryDiskImage.js b/lib/services/computeManagement2/lib/models/galleryDiskImage.js index fb700c79dd..371eb38738 100644 --- a/lib/services/computeManagement2/lib/models/galleryDiskImage.js +++ b/lib/services/computeManagement2/lib/models/galleryDiskImage.js @@ -17,11 +17,11 @@ class GalleryDiskImage { /** * Create a GalleryDiskImage. - * @member {number} [sizeInGB] This property indicates the size of the VHD to - * be created. - * @member {string} [hostCaching] The host caching of the disk. Valid values - * are 'None', 'ReadOnly', and 'ReadWrite'. Possible values include: 'None', - * 'ReadOnly', 'ReadWrite' + * @property {number} [sizeInGB] This property indicates the size of the VHD + * to be created. + * @property {string} [hostCaching] The host caching of the disk. Valid + * values are 'None', 'ReadOnly', and 'ReadWrite'. Possible values include: + * 'None', 'ReadOnly', 'ReadWrite' */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/galleryIdentifier.js b/lib/services/computeManagement2/lib/models/galleryIdentifier.js index 64371a28d8..deb3c5c2c7 100644 --- a/lib/services/computeManagement2/lib/models/galleryIdentifier.js +++ b/lib/services/computeManagement2/lib/models/galleryIdentifier.js @@ -17,8 +17,8 @@ class GalleryIdentifier { /** * Create a GalleryIdentifier. - * @member {string} [uniqueName] The unique name of the Shared Image Gallery. - * This name is generated automatically by Azure. + * @property {string} [uniqueName] The unique name of the Shared Image + * Gallery. This name is generated automatically by Azure. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/galleryImage.js b/lib/services/computeManagement2/lib/models/galleryImage.js index f1ebd775ab..8122faa240 100644 --- a/lib/services/computeManagement2/lib/models/galleryImage.js +++ b/lib/services/computeManagement2/lib/models/galleryImage.js @@ -21,46 +21,46 @@ const models = require('./index'); class GalleryImage extends models['Resource'] { /** * Create a GalleryImage. - * @member {string} [description] The description of this gallery Image - * Definition resource. This property is updateable. - * @member {string} [eula] The Eula agreement for the gallery Image + * @property {string} [description] The description of this gallery Image + * Definition resource. This property is updatable. + * @property {string} [eula] The Eula agreement for the gallery Image * Definition. - * @member {string} [privacyStatementUri] The privacy statement uri. - * @member {string} [releaseNoteUri] The release note uri. - * @member {string} osType This property allows you to specify the type of + * @property {string} [privacyStatementUri] The privacy statement uri. + * @property {string} [releaseNoteUri] The release note uri. + * @property {string} osType This property allows you to specify the type of * the OS that is included in the disk when creating a VM from a managed * image.

Possible values are:

**Windows**

* **Linux**. Possible values include: 'Windows', 'Linux' - * @member {string} osState The allowed values for OS State are + * @property {string} osState The allowed values for OS State are * 'Generalized'. Possible values include: 'Generalized', 'Specialized' - * @member {date} [endOfLifeDate] The end of life date of the gallery Image + * @property {date} [endOfLifeDate] The end of life date of the gallery Image * Definition. This property can be used for decommissioning purposes. This - * property is updateable. - * @member {object} identifier - * @member {string} [identifier.publisher] The name of the gallery Image + * property is updatable. + * @property {object} identifier + * @property {string} [identifier.publisher] The name of the gallery Image * Definition publisher. - * @member {string} [identifier.offer] The name of the gallery Image + * @property {string} [identifier.offer] The name of the gallery Image * Definition offer. - * @member {string} [identifier.sku] The name of the gallery Image Definition - * SKU. - * @member {object} [recommended] - * @member {object} [recommended.vCPUs] - * @member {number} [recommended.vCPUs.min] The minimum number of the + * @property {string} [identifier.sku] The name of the gallery Image + * Definition SKU. + * @property {object} [recommended] + * @property {object} [recommended.vCPUs] + * @property {number} [recommended.vCPUs.min] The minimum number of the * resource. - * @member {number} [recommended.vCPUs.max] The maximum number of the + * @property {number} [recommended.vCPUs.max] The maximum number of the * resource. - * @member {object} [recommended.memory] - * @member {number} [recommended.memory.min] The minimum number of the + * @property {object} [recommended.memory] + * @property {number} [recommended.memory.min] The minimum number of the * resource. - * @member {number} [recommended.memory.max] The maximum number of the + * @property {number} [recommended.memory.max] The maximum number of the * resource. - * @member {object} [disallowed] - * @member {array} [disallowed.diskTypes] A list of disk types. - * @member {object} [purchasePlan] - * @member {string} [purchasePlan.name] The plan ID. - * @member {string} [purchasePlan.publisher] The publisher ID. - * @member {string} [purchasePlan.product] The product ID. - * @member {string} [provisioningState] The current state of the gallery + * @property {object} [disallowed] + * @property {array} [disallowed.diskTypes] A list of disk types. + * @property {object} [purchasePlan] + * @property {string} [purchasePlan.name] The plan ID. + * @property {string} [purchasePlan.publisher] The publisher ID. + * @property {string} [purchasePlan.product] The product ID. + * @property {string} [provisioningState] The current state of the gallery * Image Definition. The provisioning state, which only appears in the * response. Possible values include: 'Creating', 'Updating', 'Failed', * 'Succeeded', 'Deleting', 'Migrating' diff --git a/lib/services/computeManagement2/lib/models/galleryImageIdentifier.js b/lib/services/computeManagement2/lib/models/galleryImageIdentifier.js index 533f30ce82..c58edd0e92 100644 --- a/lib/services/computeManagement2/lib/models/galleryImageIdentifier.js +++ b/lib/services/computeManagement2/lib/models/galleryImageIdentifier.js @@ -17,10 +17,10 @@ class GalleryImageIdentifier { /** * Create a GalleryImageIdentifier. - * @member {string} publisher The name of the gallery Image Definition + * @property {string} publisher The name of the gallery Image Definition * publisher. - * @member {string} offer The name of the gallery Image Definition offer. - * @member {string} sku The name of the gallery Image Definition SKU. + * @property {string} offer The name of the gallery Image Definition offer. + * @property {string} sku The name of the gallery Image Definition SKU. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/galleryImageList.js b/lib/services/computeManagement2/lib/models/galleryImageList.js index fdafd72e76..b9daece577 100644 --- a/lib/services/computeManagement2/lib/models/galleryImageList.js +++ b/lib/services/computeManagement2/lib/models/galleryImageList.js @@ -16,7 +16,7 @@ class GalleryImageList extends Array { /** * Create a GalleryImageList. - * @member {string} [nextLink] The uri to fetch the next page of Image + * @property {string} [nextLink] The uri to fetch the next page of Image * Definitions in the Shared Image Gallery. Call ListNext() with this to * fetch the next page of gallery Image Definitions. */ diff --git a/lib/services/computeManagement2/lib/models/galleryImageVersion.js b/lib/services/computeManagement2/lib/models/galleryImageVersion.js index bf7d6e7a72..3f09463dd6 100644 --- a/lib/services/computeManagement2/lib/models/galleryImageVersion.js +++ b/lib/services/computeManagement2/lib/models/galleryImageVersion.js @@ -21,33 +21,33 @@ const models = require('./index'); class GalleryImageVersion extends models['Resource'] { /** * Create a GalleryImageVersion. - * @member {object} publishingProfile - * @member {number} [publishingProfile.replicaCount] The number of replicas + * @property {object} publishingProfile + * @property {number} [publishingProfile.replicaCount] The number of replicas * of the Image Version to be created per region. This property would take * effect for a region when regionalReplicaCount is not specified. This - * property is updateable. - * @member {boolean} [publishingProfile.excludeFromLatest] If set to true, + * property is updatable. + * @property {boolean} [publishingProfile.excludeFromLatest] If set to true, * Virtual Machines deployed from the latest version of the Image Definition * won't use this Image Version. - * @member {date} [publishingProfile.publishedDate] The timestamp for when + * @property {date} [publishingProfile.publishedDate] The timestamp for when * the gallery Image Version is published. - * @member {date} [publishingProfile.endOfLifeDate] The end of life date of + * @property {date} [publishingProfile.endOfLifeDate] The end of life date of * the gallery Image Version. This property can be used for decommissioning - * purposes. This property is updateable. - * @member {string} [provisioningState] The current state of the gallery + * purposes. This property is updatable. + * @property {string} [provisioningState] The current state of the gallery * Image Version. The provisioning state, which only appears in the response. * Possible values include: 'Creating', 'Updating', 'Failed', 'Succeeded', * 'Deleting', 'Migrating' - * @member {object} [storageProfile] - * @member {object} [storageProfile.osDiskImage] - * @member {array} [storageProfile.dataDiskImages] A list of data disk + * @property {object} [storageProfile] + * @property {object} [storageProfile.osDiskImage] + * @property {array} [storageProfile.dataDiskImages] A list of data disk * images. - * @member {object} [replicationStatus] - * @member {string} [replicationStatus.aggregatedState] This is the + * @property {object} [replicationStatus] + * @property {string} [replicationStatus.aggregatedState] This is the * aggregated replication status based on all the regional replication status * flags. Possible values include: 'Unknown', 'InProgress', 'Completed', * 'Failed' - * @member {array} [replicationStatus.summary] This is a summary of + * @property {array} [replicationStatus.summary] This is a summary of * replication status for each region. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/galleryImageVersionList.js b/lib/services/computeManagement2/lib/models/galleryImageVersionList.js index 959c808e30..c1d09a609d 100644 --- a/lib/services/computeManagement2/lib/models/galleryImageVersionList.js +++ b/lib/services/computeManagement2/lib/models/galleryImageVersionList.js @@ -16,7 +16,7 @@ class GalleryImageVersionList extends Array { /** * Create a GalleryImageVersionList. - * @member {string} [nextLink] The uri to fetch the next page of gallery + * @property {string} [nextLink] The uri to fetch the next page of gallery * Image Versions. Call ListNext() with this to fetch the next page of * gallery Image Versions. */ diff --git a/lib/services/computeManagement2/lib/models/galleryImageVersionPublishingProfile.js b/lib/services/computeManagement2/lib/models/galleryImageVersionPublishingProfile.js index 0db9f2a40b..c225debcf9 100644 --- a/lib/services/computeManagement2/lib/models/galleryImageVersionPublishingProfile.js +++ b/lib/services/computeManagement2/lib/models/galleryImageVersionPublishingProfile.js @@ -20,18 +20,18 @@ const models = require('./index'); class GalleryImageVersionPublishingProfile extends models['GalleryArtifactPublishingProfileBase'] { /** * Create a GalleryImageVersionPublishingProfile. - * @member {number} [replicaCount] The number of replicas of the Image + * @property {number} [replicaCount] The number of replicas of the Image * Version to be created per region. This property would take effect for a * region when regionalReplicaCount is not specified. This property is - * updateable. - * @member {boolean} [excludeFromLatest] If set to true, Virtual Machines + * updatable. + * @property {boolean} [excludeFromLatest] If set to true, Virtual Machines * deployed from the latest version of the Image Definition won't use this * Image Version. - * @member {date} [publishedDate] The timestamp for when the gallery Image + * @property {date} [publishedDate] The timestamp for when the gallery Image * Version is published. - * @member {date} [endOfLifeDate] The end of life date of the gallery Image + * @property {date} [endOfLifeDate] The end of life date of the gallery Image * Version. This property can be used for decommissioning purposes. This - * property is updateable. + * property is updatable. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/galleryImageVersionStorageProfile.js b/lib/services/computeManagement2/lib/models/galleryImageVersionStorageProfile.js index 4cca270246..60f17d4275 100644 --- a/lib/services/computeManagement2/lib/models/galleryImageVersionStorageProfile.js +++ b/lib/services/computeManagement2/lib/models/galleryImageVersionStorageProfile.js @@ -17,8 +17,8 @@ class GalleryImageVersionStorageProfile { /** * Create a GalleryImageVersionStorageProfile. - * @member {object} [osDiskImage] - * @member {array} [dataDiskImages] A list of data disk images. + * @property {object} [osDiskImage] + * @property {array} [dataDiskImages] A list of data disk images. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/galleryList.js b/lib/services/computeManagement2/lib/models/galleryList.js index 3d28a0c7fe..a5f456ff12 100644 --- a/lib/services/computeManagement2/lib/models/galleryList.js +++ b/lib/services/computeManagement2/lib/models/galleryList.js @@ -16,7 +16,7 @@ class GalleryList extends Array { /** * Create a GalleryList. - * @member {string} [nextLink] The uri to fetch the next page of galleries. + * @property {string} [nextLink] The uri to fetch the next page of galleries. * Call ListNext() with this to fetch the next page of galleries. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/grantAccessData.js b/lib/services/computeManagement2/lib/models/grantAccessData.js index efd49ef389..46ddf57f9f 100644 --- a/lib/services/computeManagement2/lib/models/grantAccessData.js +++ b/lib/services/computeManagement2/lib/models/grantAccessData.js @@ -17,9 +17,9 @@ class GrantAccessData { /** * Create a GrantAccessData. - * @member {string} access Possible values include: 'None', 'Read' - * @member {number} durationInSeconds Time duration in seconds until the SAS - * access expires. + * @property {string} access Possible values include: 'None', 'Read', 'Write' + * @property {number} durationInSeconds Time duration in seconds until the + * SAS access expires. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/hardwareProfile.js b/lib/services/computeManagement2/lib/models/hardwareProfile.js index 2204f011da..85ed393d1a 100644 --- a/lib/services/computeManagement2/lib/models/hardwareProfile.js +++ b/lib/services/computeManagement2/lib/models/hardwareProfile.js @@ -17,7 +17,7 @@ class HardwareProfile { /** * Create a HardwareProfile. - * @member {string} [vmSize] Specifies the size of the virtual machine. For + * @property {string} [vmSize] Specifies the size of the virtual machine. For * more information about virtual machine sizes, see [Sizes for virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). *

The available VM sizes depend on region and availability set. For diff --git a/lib/services/computeManagement2/lib/models/image.js b/lib/services/computeManagement2/lib/models/image.js index ef96bab47d..521680acf5 100644 --- a/lib/services/computeManagement2/lib/models/image.js +++ b/lib/services/computeManagement2/lib/models/image.js @@ -22,47 +22,47 @@ const models = require('./index'); class Image extends models['Resource'] { /** * Create a Image. - * @member {object} [sourceVirtualMachine] The source virtual machine from + * @property {object} [sourceVirtualMachine] The source virtual machine from * which Image is created. - * @member {string} [sourceVirtualMachine.id] Resource Id - * @member {object} [storageProfile] Specifies the storage settings for the + * @property {string} [sourceVirtualMachine.id] Resource Id + * @property {object} [storageProfile] Specifies the storage settings for the * virtual machine disks. - * @member {object} [storageProfile.osDisk] Specifies information about the + * @property {object} [storageProfile.osDisk] Specifies information about the * operating system disk used by the virtual machine.

For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you + * @property {string} [storageProfile.osDisk.osType] This property allows you * to specify the type of the OS that is included in the disk if creating a * VM from a custom image.

Possible values are:

**Windows** *

**Linux**. Possible values include: 'Windows', 'Linux' - * @member {string} [storageProfile.osDisk.osState] The OS State. Possible + * @property {string} [storageProfile.osDisk.osState] The OS State. Possible * values include: 'Generalized', 'Specialized' - * @member {object} [storageProfile.osDisk.snapshot] The snapshot. - * @member {string} [storageProfile.osDisk.snapshot.id] Resource Id - * @member {object} [storageProfile.osDisk.managedDisk] The managedDisk. - * @member {string} [storageProfile.osDisk.managedDisk.id] Resource Id - * @member {string} [storageProfile.osDisk.blobUri] The Virtual Hard Disk. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching + * @property {object} [storageProfile.osDisk.snapshot] The snapshot. + * @property {string} [storageProfile.osDisk.snapshot.id] Resource Id + * @property {object} [storageProfile.osDisk.managedDisk] The managedDisk. + * @property {string} [storageProfile.osDisk.managedDisk.id] Resource Id + * @property {string} [storageProfile.osDisk.blobUri] The Virtual Hard Disk. + * @property {string} [storageProfile.osDisk.caching] Specifies the caching * requirements.

Possible values are:

**None**

* **ReadOnly**

**ReadWrite**

Default: **None for Standard * storage. ReadOnly for Premium storage**. Possible values include: 'None', * 'ReadOnly', 'ReadWrite' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * empty data disks in gigabytes. This element can be used to overwrite the - * name of the disk in a virtual machine image.

This value cannot be - * larger than 1023 GB - * @member {string} [storageProfile.osDisk.storageAccountType] Specifies the - * storage account type for the managed disk. UltraSSD_LRS cannot be used + * @property {number} [storageProfile.osDisk.diskSizeGB] Specifies the size + * of empty data disks in gigabytes. This element can be used to overwrite + * the name of the disk in a virtual machine image.

This value + * cannot be larger than 1023 GB + * @property {string} [storageProfile.osDisk.storageAccountType] Specifies + * the storage account type for the managed disk. UltraSSD_LRS cannot be used * with OS Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that + * @property {array} [storageProfile.dataDisks] Specifies the parameters that * are used to add a data disk to a virtual machine.

For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {boolean} [storageProfile.zoneResilient] Specifies whether an + * @property {boolean} [storageProfile.zoneResilient] Specifies whether an * image is zone resilient or not. Default is false. Zone resilient images * can be created only in regions that provide Zone Redundant Storage (ZRS). - * @member {string} [provisioningState] The provisioning state. + * @property {string} [provisioningState] The provisioning state. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/imageDataDisk.js b/lib/services/computeManagement2/lib/models/imageDataDisk.js index 3042858ae8..3d9162b5e5 100644 --- a/lib/services/computeManagement2/lib/models/imageDataDisk.js +++ b/lib/services/computeManagement2/lib/models/imageDataDisk.js @@ -17,23 +17,23 @@ class ImageDataDisk { /** * Create a ImageDataDisk. - * @member {number} lun Specifies the logical unit number of the data disk. + * @property {number} lun Specifies the logical unit number of the data disk. * This value is used to identify data disks within the VM and therefore must * be unique for each data disk attached to a VM. - * @member {object} [snapshot] The snapshot. - * @member {string} [snapshot.id] Resource Id - * @member {object} [managedDisk] The managedDisk. - * @member {string} [managedDisk.id] Resource Id - * @member {string} [blobUri] The Virtual Hard Disk. - * @member {string} [caching] Specifies the caching requirements.

+ * @property {object} [snapshot] The snapshot. + * @property {string} [snapshot.id] Resource Id + * @property {object} [managedDisk] The managedDisk. + * @property {string} [managedDisk.id] Resource Id + * @property {string} [blobUri] The Virtual Hard Disk. + * @property {string} [caching] Specifies the caching requirements.

* Possible values are:

**None**

**ReadOnly**

* **ReadWrite**

Default: **None for Standard storage. ReadOnly for * Premium storage**. Possible values include: 'None', 'ReadOnly', * 'ReadWrite' - * @member {number} [diskSizeGB] Specifies the size of empty data disks in + * @property {number} [diskSizeGB] Specifies the size of empty data disks in * gigabytes. This element can be used to overwrite the name of the disk in a * virtual machine image.

This value cannot be larger than 1023 GB - * @member {string} [storageAccountType] Specifies the storage account type + * @property {string} [storageAccountType] Specifies the storage account type * for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, * it cannot be used with OS Disk. Possible values include: 'Standard_LRS', * 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' diff --git a/lib/services/computeManagement2/lib/models/imageDiskReference.js b/lib/services/computeManagement2/lib/models/imageDiskReference.js index 60268c8983..da3ccbdd07 100644 --- a/lib/services/computeManagement2/lib/models/imageDiskReference.js +++ b/lib/services/computeManagement2/lib/models/imageDiskReference.js @@ -17,9 +17,9 @@ class ImageDiskReference { /** * Create a ImageDiskReference. - * @member {string} id A relative uri containing either a Platform Image + * @property {string} id A relative uri containing either a Platform Image * Repository or user image reference. - * @member {number} [lun] If the disk is created from an image's data disk, + * @property {number} [lun] If the disk is created from an image's data disk, * this is an index that indicates which of the data disks in the image to * use. For OS disks, this field is null. */ diff --git a/lib/services/computeManagement2/lib/models/imageListResult.js b/lib/services/computeManagement2/lib/models/imageListResult.js index a3a6e0bce0..1af5266ce7 100644 --- a/lib/services/computeManagement2/lib/models/imageListResult.js +++ b/lib/services/computeManagement2/lib/models/imageListResult.js @@ -16,8 +16,8 @@ class ImageListResult extends Array { /** * Create a ImageListResult. - * @member {string} [nextLink] The uri to fetch the next page of Images. Call - * ListNext() with this to fetch the next page of Images. + * @property {string} [nextLink] The uri to fetch the next page of Images. + * Call ListNext() with this to fetch the next page of Images. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/imageOSDisk.js b/lib/services/computeManagement2/lib/models/imageOSDisk.js index 6dfa53bee5..0739be9d61 100644 --- a/lib/services/computeManagement2/lib/models/imageOSDisk.js +++ b/lib/services/computeManagement2/lib/models/imageOSDisk.js @@ -17,26 +17,26 @@ class ImageOSDisk { /** * Create a ImageOSDisk. - * @member {string} osType This property allows you to specify the type of + * @property {string} osType This property allows you to specify the type of * the OS that is included in the disk if creating a VM from a custom image. *

Possible values are:

**Windows**

**Linux**. * Possible values include: 'Windows', 'Linux' - * @member {string} osState The OS State. Possible values include: + * @property {string} osState The OS State. Possible values include: * 'Generalized', 'Specialized' - * @member {object} [snapshot] The snapshot. - * @member {string} [snapshot.id] Resource Id - * @member {object} [managedDisk] The managedDisk. - * @member {string} [managedDisk.id] Resource Id - * @member {string} [blobUri] The Virtual Hard Disk. - * @member {string} [caching] Specifies the caching requirements.

+ * @property {object} [snapshot] The snapshot. + * @property {string} [snapshot.id] Resource Id + * @property {object} [managedDisk] The managedDisk. + * @property {string} [managedDisk.id] Resource Id + * @property {string} [blobUri] The Virtual Hard Disk. + * @property {string} [caching] Specifies the caching requirements.

* Possible values are:

**None**

**ReadOnly**

* **ReadWrite**

Default: **None for Standard storage. ReadOnly for * Premium storage**. Possible values include: 'None', 'ReadOnly', * 'ReadWrite' - * @member {number} [diskSizeGB] Specifies the size of empty data disks in + * @property {number} [diskSizeGB] Specifies the size of empty data disks in * gigabytes. This element can be used to overwrite the name of the disk in a * virtual machine image.

This value cannot be larger than 1023 GB - * @member {string} [storageAccountType] Specifies the storage account type + * @property {string} [storageAccountType] Specifies the storage account type * for the managed disk. UltraSSD_LRS cannot be used with OS Disk. Possible * values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', * 'UltraSSD_LRS' diff --git a/lib/services/computeManagement2/lib/models/imagePurchasePlan.js b/lib/services/computeManagement2/lib/models/imagePurchasePlan.js index cd2aeaf85d..c775552597 100644 --- a/lib/services/computeManagement2/lib/models/imagePurchasePlan.js +++ b/lib/services/computeManagement2/lib/models/imagePurchasePlan.js @@ -18,9 +18,9 @@ class ImagePurchasePlan { /** * Create a ImagePurchasePlan. - * @member {string} [name] The plan ID. - * @member {string} [publisher] The publisher ID. - * @member {string} [product] The product ID. + * @property {string} [name] The plan ID. + * @property {string} [publisher] The publisher ID. + * @property {string} [product] The product ID. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/imageReference.js b/lib/services/computeManagement2/lib/models/imageReference.js index 8cca252687..d90c784d08 100644 --- a/lib/services/computeManagement2/lib/models/imageReference.js +++ b/lib/services/computeManagement2/lib/models/imageReference.js @@ -24,15 +24,15 @@ const models = require('./index'); class ImageReference extends models['SubResource'] { /** * Create a ImageReference. - * @member {string} [publisher] The image publisher. - * @member {string} [offer] Specifies the offer of the platform image or + * @property {string} [publisher] The image publisher. + * @property {string} [offer] Specifies the offer of the platform image or * marketplace image used to create the virtual machine. - * @member {string} [sku] The image SKU. - * @member {string} [version] Specifies the version of the platform image or - * marketplace image used to create the virtual machine. The allowed formats - * are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal - * numbers. Specify 'latest' to use the latest version of an image available - * at deploy time. Even if you use 'latest', the VM image will not + * @property {string} [sku] The image SKU. + * @property {string} [version] Specifies the version of the platform image + * or marketplace image used to create the virtual machine. The allowed + * formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are + * decimal numbers. Specify 'latest' to use the latest version of an image + * available at deploy time. Even if you use 'latest', the VM image will not * automatically update after deploy time even if a new version becomes * available. */ diff --git a/lib/services/computeManagement2/lib/models/imageStorageProfile.js b/lib/services/computeManagement2/lib/models/imageStorageProfile.js index 354a80a67f..f815aaab8a 100644 --- a/lib/services/computeManagement2/lib/models/imageStorageProfile.js +++ b/lib/services/computeManagement2/lib/models/imageStorageProfile.js @@ -17,39 +17,39 @@ class ImageStorageProfile { /** * Create a ImageStorageProfile. - * @member {object} [osDisk] Specifies information about the operating system - * disk used by the virtual machine.

For more information about - * disks, see [About disks and VHDs for Azure virtual + * @property {object} [osDisk] Specifies information about the operating + * system disk used by the virtual machine.

For more information + * about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [osDisk.osType] This property allows you to specify the + * @property {string} [osDisk.osType] This property allows you to specify the * type of the OS that is included in the disk if creating a VM from a custom * image.

Possible values are:

**Windows**

* **Linux**. Possible values include: 'Windows', 'Linux' - * @member {string} [osDisk.osState] The OS State. Possible values include: + * @property {string} [osDisk.osState] The OS State. Possible values include: * 'Generalized', 'Specialized' - * @member {object} [osDisk.snapshot] The snapshot. - * @member {string} [osDisk.snapshot.id] Resource Id - * @member {object} [osDisk.managedDisk] The managedDisk. - * @member {string} [osDisk.managedDisk.id] Resource Id - * @member {string} [osDisk.blobUri] The Virtual Hard Disk. - * @member {string} [osDisk.caching] Specifies the caching requirements. + * @property {object} [osDisk.snapshot] The snapshot. + * @property {string} [osDisk.snapshot.id] Resource Id + * @property {object} [osDisk.managedDisk] The managedDisk. + * @property {string} [osDisk.managedDisk.id] Resource Id + * @property {string} [osDisk.blobUri] The Virtual Hard Disk. + * @property {string} [osDisk.caching] Specifies the caching requirements. *

Possible values are:

**None**

**ReadOnly** *

**ReadWrite**

Default: **None for Standard storage. * ReadOnly for Premium storage**. Possible values include: 'None', * 'ReadOnly', 'ReadWrite' - * @member {number} [osDisk.diskSizeGB] Specifies the size of empty data + * @property {number} [osDisk.diskSizeGB] Specifies the size of empty data * disks in gigabytes. This element can be used to overwrite the name of the * disk in a virtual machine image.

This value cannot be larger than * 1023 GB - * @member {string} [osDisk.storageAccountType] Specifies the storage account - * type for the managed disk. UltraSSD_LRS cannot be used with OS Disk. - * Possible values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', - * 'UltraSSD_LRS' - * @member {array} [dataDisks] Specifies the parameters that are used to add - * a data disk to a virtual machine.

For more information about + * @property {string} [osDisk.storageAccountType] Specifies the storage + * account type for the managed disk. UltraSSD_LRS cannot be used with OS + * Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', + * 'StandardSSD_LRS', 'UltraSSD_LRS' + * @property {array} [dataDisks] Specifies the parameters that are used to + * add a data disk to a virtual machine.

For more information about * disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {boolean} [zoneResilient] Specifies whether an image is zone + * @property {boolean} [zoneResilient] Specifies whether an image is zone * resilient or not. Default is false. Zone resilient images can be created * only in regions that provide Zone Redundant Storage (ZRS). */ diff --git a/lib/services/computeManagement2/lib/models/imageUpdate.js b/lib/services/computeManagement2/lib/models/imageUpdate.js index 684d4b0221..40fb2b0d44 100644 --- a/lib/services/computeManagement2/lib/models/imageUpdate.js +++ b/lib/services/computeManagement2/lib/models/imageUpdate.js @@ -20,47 +20,47 @@ const models = require('./index'); class ImageUpdate extends models['UpdateResource'] { /** * Create a ImageUpdate. - * @member {object} [sourceVirtualMachine] The source virtual machine from + * @property {object} [sourceVirtualMachine] The source virtual machine from * which Image is created. - * @member {string} [sourceVirtualMachine.id] Resource Id - * @member {object} [storageProfile] Specifies the storage settings for the + * @property {string} [sourceVirtualMachine.id] Resource Id + * @property {object} [storageProfile] Specifies the storage settings for the * virtual machine disks. - * @member {object} [storageProfile.osDisk] Specifies information about the + * @property {object} [storageProfile.osDisk] Specifies information about the * operating system disk used by the virtual machine.

For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you + * @property {string} [storageProfile.osDisk.osType] This property allows you * to specify the type of the OS that is included in the disk if creating a * VM from a custom image.

Possible values are:

**Windows** *

**Linux**. Possible values include: 'Windows', 'Linux' - * @member {string} [storageProfile.osDisk.osState] The OS State. Possible + * @property {string} [storageProfile.osDisk.osState] The OS State. Possible * values include: 'Generalized', 'Specialized' - * @member {object} [storageProfile.osDisk.snapshot] The snapshot. - * @member {string} [storageProfile.osDisk.snapshot.id] Resource Id - * @member {object} [storageProfile.osDisk.managedDisk] The managedDisk. - * @member {string} [storageProfile.osDisk.managedDisk.id] Resource Id - * @member {string} [storageProfile.osDisk.blobUri] The Virtual Hard Disk. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching + * @property {object} [storageProfile.osDisk.snapshot] The snapshot. + * @property {string} [storageProfile.osDisk.snapshot.id] Resource Id + * @property {object} [storageProfile.osDisk.managedDisk] The managedDisk. + * @property {string} [storageProfile.osDisk.managedDisk.id] Resource Id + * @property {string} [storageProfile.osDisk.blobUri] The Virtual Hard Disk. + * @property {string} [storageProfile.osDisk.caching] Specifies the caching * requirements.

Possible values are:

**None**

* **ReadOnly**

**ReadWrite**

Default: **None for Standard * storage. ReadOnly for Premium storage**. Possible values include: 'None', * 'ReadOnly', 'ReadWrite' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * empty data disks in gigabytes. This element can be used to overwrite the - * name of the disk in a virtual machine image.

This value cannot be - * larger than 1023 GB - * @member {string} [storageProfile.osDisk.storageAccountType] Specifies the - * storage account type for the managed disk. UltraSSD_LRS cannot be used + * @property {number} [storageProfile.osDisk.diskSizeGB] Specifies the size + * of empty data disks in gigabytes. This element can be used to overwrite + * the name of the disk in a virtual machine image.

This value + * cannot be larger than 1023 GB + * @property {string} [storageProfile.osDisk.storageAccountType] Specifies + * the storage account type for the managed disk. UltraSSD_LRS cannot be used * with OS Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that + * @property {array} [storageProfile.dataDisks] Specifies the parameters that * are used to add a data disk to a virtual machine.

For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {boolean} [storageProfile.zoneResilient] Specifies whether an + * @property {boolean} [storageProfile.zoneResilient] Specifies whether an * image is zone resilient or not. Default is false. Zone resilient images * can be created only in regions that provide Zone Redundant Storage (ZRS). - * @member {string} [provisioningState] The provisioning state. + * @property {string} [provisioningState] The provisioning state. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/index.d.ts b/lib/services/computeManagement2/lib/models/index.d.ts index 7002177730..a4b5df815e 100644 --- a/lib/services/computeManagement2/lib/models/index.d.ts +++ b/lib/services/computeManagement2/lib/models/index.d.ts @@ -1,458 +1,454 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the ComputeOperationValue class. - * @constructor * Describes the properties of a Compute Operation value. - * - * @member {string} [origin] The origin of the compute operation. - * @member {string} [name] The name of the compute operation. - * @member {string} [operation] The display name of the compute operation. - * @member {string} [resource] The display name of the resource the operation - * applies to. - * @member {string} [description] The description of the operation. - * @member {string} [provider] The resource provider for the operation. */ export interface ComputeOperationValue { + /** + * The origin of the compute operation. + */ readonly origin?: string; + /** + * The name of the compute operation. + */ readonly name?: string; + /** + * The display name of the compute operation. + */ readonly operation?: string; + /** + * The display name of the resource the operation applies to. + */ readonly resource?: string; + /** + * The description of the operation. + */ readonly description?: string; + /** + * The resource provider for the operation. + */ readonly provider?: string; } /** - * @class - * Initializes a new instance of the InstanceViewStatus class. - * @constructor * Instance view status. - * - * @member {string} [code] The status code. - * @member {string} [level] The level code. Possible values include: 'Info', - * 'Warning', 'Error' - * @member {string} [displayStatus] The short localizable label for the status. - * @member {string} [message] The detailed status message, including for alerts - * and error messages. - * @member {date} [time] The time of the status. */ export interface InstanceViewStatus { + /** + * The status code. + */ code?: string; + /** + * The level code. Possible values include: 'Info', 'Warning', 'Error' + */ level?: string; + /** + * The short localizable label for the status. + */ displayStatus?: string; + /** + * The detailed status message, including for alerts and error messages. + */ message?: string; + /** + * The time of the status. + */ time?: Date; } -/** - * @class - * Initializes a new instance of the SubResource class. - * @constructor - * @member {string} [id] Resource Id - */ export interface SubResource extends BaseResource { + /** + * Resource Id + */ id?: string; } /** - * @class - * Initializes a new instance of the Sku class. - * @constructor * Describes a virtual machine scale set sku. - * - * @member {string} [name] The sku name. - * @member {string} [tier] Specifies the tier of virtual machines in a scale - * set.

Possible Values:

**Standard**

- * **Basic** - * @member {number} [capacity] Specifies the number of virtual machines in the - * scale set. - */ +*/ export interface Sku { + /** + * The sku name. + */ name?: string; + /** + * Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** + */ tier?: string; + /** + * Specifies the number of virtual machines in the scale set. + */ capacity?: number; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * The Resource model definition. - * - * @member {string} [id] Resource Id - * @member {string} [name] Resource name - * @member {string} [type] Resource type - * @member {string} location Resource location - * @member {object} [tags] Resource tags - */ +*/ export interface Resource extends BaseResource { + /** + * Resource Id + */ readonly id?: string; + /** + * Resource name + */ readonly name?: string; + /** + * Resource type + */ readonly type?: string; + /** + * Resource location + */ location: string; + /** + * Resource tags + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the AvailabilitySet class. - * @constructor - * Specifies information about the availability set that the virtual machine - * should be assigned to. Virtual machines specified in the same availability - * set are allocated to different nodes to maximize availability. For more - * information about availability sets, see [Manage the availability of virtual + * Specifies information about the availability set that the virtual machine should be assigned to. + * Virtual machines specified in the same availability set are allocated to different nodes to + * maximize availability. For more information about availability sets, see [Manage the + * availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

For more information on Azure planned maintainance, see [Planned - * maintenance for virtual machines in + *

For more information on Azure planned maintenance, see [Planned maintenance for virtual + * machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

Currently, a VM can only be added to availability set at creation - * time. An existing VM cannot be added to an availability set. - * - * @member {number} [platformUpdateDomainCount] Update Domain count. - * @member {number} [platformFaultDomainCount] Fault Domain count. - * @member {array} [virtualMachines] A list of references to all virtual - * machines in the availability set. - * @member {array} [statuses] The resource status information. - * @member {object} [sku] Sku of the availability set, only name is required to - * be set. See AvailabilitySetSkuTypes for possible set of values. Use - * 'Aligned' for virtual machines with managed disks and 'Classic' for virtual - * machines with unmanaged disks. Default value is 'Classic'. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a - * scale set.

Possible Values:

**Standard**

- * **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines in - * the scale set. - */ + *

Currently, a VM can only be added to availability set at creation time. An existing VM + * cannot be added to an availability set. +*/ export interface AvailabilitySet extends Resource { + /** + * Update Domain count. + */ platformUpdateDomainCount?: number; + /** + * Fault Domain count. + */ platformFaultDomainCount?: number; + /** + * A list of references to all virtual machines in the availability set. + */ virtualMachines?: SubResource[]; + /** + * The resource status information. + */ readonly statuses?: InstanceViewStatus[]; + /** + * Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for + * possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' + * for virtual machines with unmanaged disks. Default value is 'Classic'. + */ sku?: Sku; } /** - * @class - * Initializes a new instance of the UpdateResource class. - * @constructor * The Update Resource model definition. - * - * @member {object} [tags] Resource tags - */ +*/ export interface UpdateResource extends BaseResource { + /** + * Resource tags + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the AvailabilitySetUpdate class. - * @constructor - * Specifies information about the availability set that the virtual machine - * should be assigned to. Only tags may be updated. - * - * @member {number} [platformUpdateDomainCount] Update Domain count. - * @member {number} [platformFaultDomainCount] Fault Domain count. - * @member {array} [virtualMachines] A list of references to all virtual - * machines in the availability set. - * @member {array} [statuses] The resource status information. - * @member {object} [sku] Sku of the availability set - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a - * scale set.

Possible Values:

**Standard**

- * **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines in - * the scale set. - */ + * Specifies information about the availability set that the virtual machine should be assigned to. + * Only tags may be updated. +*/ export interface AvailabilitySetUpdate extends UpdateResource { + /** + * Update Domain count. + */ platformUpdateDomainCount?: number; + /** + * Fault Domain count. + */ platformFaultDomainCount?: number; + /** + * A list of references to all virtual machines in the availability set. + */ virtualMachines?: SubResource[]; + /** + * The resource status information. + */ readonly statuses?: InstanceViewStatus[]; + /** + * Sku of the availability set + */ sku?: Sku; } /** - * @class - * Initializes a new instance of the VirtualMachineSize class. - * @constructor * Describes the properties of a VM size. - * - * @member {string} [name] The name of the virtual machine size. - * @member {number} [numberOfCores] The number of cores supported by the - * virtual machine size. - * @member {number} [osDiskSizeInMB] The OS disk size, in MB, allowed by the - * virtual machine size. - * @member {number} [resourceDiskSizeInMB] The resource disk size, in MB, - * allowed by the virtual machine size. - * @member {number} [memoryInMB] The amount of memory, in MB, supported by the - * virtual machine size. - * @member {number} [maxDataDiskCount] The maximum number of data disks that - * can be attached to the virtual machine size. - */ +*/ export interface VirtualMachineSize { + /** + * The name of the virtual machine size. + */ name?: string; + /** + * The number of cores supported by the virtual machine size. + */ numberOfCores?: number; + /** + * The OS disk size, in MB, allowed by the virtual machine size. + */ osDiskSizeInMB?: number; + /** + * The resource disk size, in MB, allowed by the virtual machine size. + */ resourceDiskSizeInMB?: number; + /** + * The amount of memory, in MB, supported by the virtual machine size. + */ memoryInMB?: number; + /** + * The maximum number of data disks that can be attached to the virtual machine size. + */ maxDataDiskCount?: number; } /** - * @class - * Initializes a new instance of the VirtualMachineExtensionImage class. - * @constructor * Describes a Virtual Machine Extension Image. - * - * @member {string} operatingSystem The operating system this extension - * supports. - * @member {string} computeRole The type of role (IaaS or PaaS) this extension - * supports. - * @member {string} handlerSchema The schema defined by publisher, where - * extension consumers should provide settings in a matching schema. - * @member {boolean} [vmScaleSetEnabled] Whether the extension can be used on - * xRP VMScaleSets. By default existing extensions are usable on scalesets, but - * there might be cases where a publisher wants to explicitly indicate the - * extension is only enabled for CRP VMs but not VMSS. - * @member {boolean} [supportsMultipleExtensions] Whether the handler can - * support multiple extensions. - */ +*/ export interface VirtualMachineExtensionImage extends Resource { + /** + * The operating system this extension supports. + */ operatingSystem: string; + /** + * The type of role (IaaS or PaaS) this extension supports. + */ computeRole: string; + /** + * The schema defined by publisher, where extension consumers should provide settings in a + * matching schema. + */ handlerSchema: string; + /** + * Whether the extension can be used on xRP VMScaleSets. By default existing extensions are + * usable on scalesets, but there might be cases where a publisher wants to explicitly indicate + * the extension is only enabled for CRP VMs but not VMSS. + */ vmScaleSetEnabled?: boolean; + /** + * Whether the handler can support multiple extensions. + */ supportsMultipleExtensions?: boolean; } /** - * @class - * Initializes a new instance of the VirtualMachineImageResource class. - * @constructor * Virtual machine image resource information. - * - * @member {string} name The name of the resource. - * @member {string} location The supported Azure location of the resource. - * @member {object} [tags] Specifies the tags that are assigned to the virtual - * machine. For more information about using tags, see [Using tags to organize - * your Azure - * resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). - */ +*/ export interface VirtualMachineImageResource extends SubResource { + /** + * The name of the resource. + */ name: string; + /** + * The supported Azure location of the resource. + */ location: string; + /** + * Specifies the tags that are assigned to the virtual machine. For more information about using + * tags, see [Using tags to organize your Azure + * resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the VirtualMachineExtensionInstanceView class. - * @constructor * The instance view of a virtual machine extension. - * - * @member {string} [name] The virtual machine extension name. - * @member {string} [type] Specifies the type of the extension; an example is - * "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {array} [substatuses] The resource status information. - * @member {array} [statuses] The resource status information. - */ +*/ export interface VirtualMachineExtensionInstanceView { + /** + * The virtual machine extension name. + */ name?: string; + /** + * Specifies the type of the extension; an example is "CustomScriptExtension". + */ type?: string; + /** + * Specifies the version of the script handler. + */ typeHandlerVersion?: string; + /** + * The resource status information. + */ substatuses?: InstanceViewStatus[]; + /** + * The resource status information. + */ statuses?: InstanceViewStatus[]; } /** - * @class - * Initializes a new instance of the VirtualMachineExtension class. - * @constructor * Describes a Virtual Machine Extension. - * - * @member {string} [forceUpdateTag] How the extension handler should be forced - * to update even if the extension configuration has not changed. - * @member {string} [publisher] The name of the extension handler publisher. - * @member {string} [virtualMachineExtensionType] Specifies the type of the - * extension; an example is "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {boolean} [autoUpgradeMinorVersion] Indicates whether the extension - * should use a newer minor version if one is available at deployment time. - * Once deployed, however, the extension will not upgrade minor versions unless - * redeployed, even with this property set to true. - * @member {object} [settings] Json formatted public settings for the - * extension. - * @member {object} [protectedSettings] The extension can contain either - * protectedSettings or protectedSettingsFromKeyVault or no protected settings - * at all. - * @member {string} [provisioningState] The provisioning state, which only - * appears in the response. - * @member {object} [instanceView] The virtual machine extension instance view. - * @member {string} [instanceView.name] The virtual machine extension name. - * @member {string} [instanceView.type] Specifies the type of the extension; an - * example is "CustomScriptExtension". - * @member {string} [instanceView.typeHandlerVersion] Specifies the version of - * the script handler. - * @member {array} [instanceView.substatuses] The resource status information. - * @member {array} [instanceView.statuses] The resource status information. - */ +*/ export interface VirtualMachineExtension extends Resource { + /** + * How the extension handler should be forced to update even if the extension configuration has + * not changed. + */ forceUpdateTag?: string; + /** + * The name of the extension handler publisher. + */ publisher?: string; + /** + * Specifies the type of the extension; an example is "CustomScriptExtension". + */ virtualMachineExtensionType?: string; + /** + * Specifies the version of the script handler. + */ typeHandlerVersion?: string; + /** + * Indicates whether the extension should use a newer minor version if one is available at + * deployment time. Once deployed, however, the extension will not upgrade minor versions unless + * redeployed, even with this property set to true. + */ autoUpgradeMinorVersion?: boolean; + /** + * Json formatted public settings for the extension. + */ settings?: any; + /** + * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no + * protected settings at all. + */ protectedSettings?: any; + /** + * The provisioning state, which only appears in the response. + */ readonly provisioningState?: string; + /** + * The virtual machine extension instance view. + */ instanceView?: VirtualMachineExtensionInstanceView; } /** - * @class - * Initializes a new instance of the VirtualMachineExtensionUpdate class. - * @constructor * Describes a Virtual Machine Extension. - * - * @member {string} [forceUpdateTag] How the extension handler should be forced - * to update even if the extension configuration has not changed. - * @member {string} [publisher] The name of the extension handler publisher. - * @member {string} [type] Specifies the type of the extension; an example is - * "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {boolean} [autoUpgradeMinorVersion] Indicates whether the extension - * should use a newer minor version if one is available at deployment time. - * Once deployed, however, the extension will not upgrade minor versions unless - * redeployed, even with this property set to true. - * @member {object} [settings] Json formatted public settings for the - * extension. - * @member {object} [protectedSettings] The extension can contain either - * protectedSettings or protectedSettingsFromKeyVault or no protected settings - * at all. - */ +*/ export interface VirtualMachineExtensionUpdate extends UpdateResource { + /** + * How the extension handler should be forced to update even if the extension configuration has + * not changed. + */ forceUpdateTag?: string; + /** + * The name of the extension handler publisher. + */ publisher?: string; + /** + * Specifies the type of the extension; an example is "CustomScriptExtension". + */ type?: string; + /** + * Specifies the version of the script handler. + */ typeHandlerVersion?: string; + /** + * Indicates whether the extension should use a newer minor version if one is available at + * deployment time. Once deployed, however, the extension will not upgrade minor versions unless + * redeployed, even with this property set to true. + */ autoUpgradeMinorVersion?: boolean; + /** + * Json formatted public settings for the extension. + */ settings?: any; + /** + * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no + * protected settings at all. + */ protectedSettings?: any; } /** - * @class - * Initializes a new instance of the VirtualMachineExtensionsListResult class. - * @constructor * The List Extension operation response - * - * @member {array} [value] The list of extensions - */ +*/ export interface VirtualMachineExtensionsListResult { + /** + * The list of extensions + */ value?: VirtualMachineExtension[]; } /** - * @class - * Initializes a new instance of the PurchasePlan class. - * @constructor - * Used for establishing the purchase context of any 3rd Party artifact through - * MarketPlace. - * - * @member {string} publisher The publisher ID. - * @member {string} name The plan ID. - * @member {string} product Specifies the product of the image from the - * marketplace. This is the same value as Offer under the imageReference - * element. - */ + * Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. +*/ export interface PurchasePlan { + /** + * The publisher ID. + */ publisher: string; + /** + * The plan ID. + */ name: string; + /** + * Specifies the product of the image from the marketplace. This is the same value as Offer under + * the imageReference element. + */ product: string; } /** - * @class - * Initializes a new instance of the OSDiskImage class. - * @constructor * Contains the os disk image information. - * - * @member {string} operatingSystem The operating system of the osDiskImage. - * Possible values include: 'Windows', 'Linux' - */ +*/ export interface OSDiskImage { + /** + * The operating system of the osDiskImage. Possible values include: 'Windows', 'Linux' + */ operatingSystem: string; } /** - * @class - * Initializes a new instance of the DataDiskImage class. - * @constructor * Contains the data disk images information. - * - * @member {number} [lun] Specifies the logical unit number of the data disk. - * This value is used to identify data disks within the VM and therefore must - * be unique for each data disk attached to a VM. - */ +*/ export interface DataDiskImage { + /** + * Specifies the logical unit number of the data disk. This value is used to identify data disks + * within the VM and therefore must be unique for each data disk attached to a VM. + */ readonly lun?: number; } /** - * @class - * Initializes a new instance of the AutomaticOSUpgradeProperties class. - * @constructor * Describes automatic OS upgrade properties on the image. - * - * @member {boolean} automaticOSUpgradeSupported Specifies whether automatic OS - * upgrade is supported on the image. - */ +*/ export interface AutomaticOSUpgradeProperties { + /** + * Specifies whether automatic OS upgrade is supported on the image. + */ automaticOSUpgradeSupported: boolean; } /** - * @class - * Initializes a new instance of the VirtualMachineImage class. - * @constructor * Describes a Virtual Machine Image. - * - * @member {object} [plan] - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.product] Specifies the product of the image from the - * marketplace. This is the same value as Offer under the imageReference - * element. - * @member {object} [osDiskImage] - * @member {string} [osDiskImage.operatingSystem] The operating system of the - * osDiskImage. Possible values include: 'Windows', 'Linux' - * @member {array} [dataDiskImages] - * @member {object} [automaticOSUpgradeProperties] - * @member {boolean} [automaticOSUpgradeProperties.automaticOSUpgradeSupported] - * Specifies whether automatic OS upgrade is supported on the image. - */ +*/ export interface VirtualMachineImage extends VirtualMachineImageResource { plan?: PurchasePlan; osDiskImage?: OSDiskImage; @@ -461,6815 +457,4092 @@ export interface VirtualMachineImage extends VirtualMachineImageResource { } /** - * @class - * Initializes a new instance of the UsageName class. - * @constructor * The Usage Names. - * - * @member {string} [value] The name of the resource. - * @member {string} [localizedValue] The localized name of the resource. - */ +*/ export interface UsageName { + /** + * The name of the resource. + */ value?: string; + /** + * The localized name of the resource. + */ localizedValue?: string; } /** - * @class - * Initializes a new instance of the Usage class. - * @constructor * Describes Compute Resource Usage. - * - * @member {number} currentValue The current usage of the resource. - * @member {number} limit The maximum permitted usage of the resource. - * @member {object} name The name of the type of usage. - * @member {string} [name.value] The name of the resource. - * @member {string} [name.localizedValue] The localized name of the resource. - */ +*/ export interface Usage { + /** + * The current usage of the resource. + */ currentValue: number; + /** + * The maximum permitted usage of the resource. + */ limit: number; + /** + * The name of the type of usage. + */ name: UsageName; } /** - * @class - * Initializes a new instance of the VirtualMachineReimageParameters class. - * @constructor - * Paramaters for Reimaging Virtual Machine. Default value for OSDisk : true. - * - * @member {boolean} [tempDisk] Specified whether to reimage temp disk. Default - * value: false. - */ + * Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged +*/ export interface VirtualMachineReimageParameters { + /** + * Specifies whether to reimage temp disk. Default value: false. + */ tempDisk?: boolean; } /** - * @class - * Initializes a new instance of the VirtualMachineCaptureParameters class. - * @constructor * Capture Virtual Machine parameters. - * - * @member {string} vhdPrefix The captured virtual hard disk's name prefix. - * @member {string} destinationContainerName The destination container name. - * @member {boolean} overwriteVhds Specifies whether to overwrite the - * destination virtual hard disk, in case of conflict. - */ +*/ export interface VirtualMachineCaptureParameters { + /** + * The captured virtual hard disk's name prefix. + */ vhdPrefix: string; + /** + * The destination container name. + */ destinationContainerName: string; + /** + * Specifies whether to overwrite the destination virtual hard disk, in case of conflict. + */ overwriteVhds: boolean; } /** - * @class - * Initializes a new instance of the VirtualMachineCaptureResult class. - * @constructor * Output of virtual machine capture operation. - * - * @member {string} [schema] the schema of the captured virtual machine - * @member {string} [contentVersion] the version of the content - * @member {object} [parameters] parameters of the captured virtual machine - * @member {array} [resources] a list of resource items of the captured virtual - * machine - */ +*/ export interface VirtualMachineCaptureResult extends SubResource { + /** + * the schema of the captured virtual machine + */ readonly schema?: string; + /** + * the version of the content + */ readonly contentVersion?: string; + /** + * parameters of the captured virtual machine + */ readonly parameters?: any; + /** + * a list of resource items of the captured virtual machine + */ readonly resources?: any[]; } /** - * @class - * Initializes a new instance of the Plan class. - * @constructor - * Specifies information about the marketplace image used to create the virtual - * machine. This element is only used for marketplace images. Before you can - * use a marketplace image from an API, you must enable the image for - * programmatic use. In the Azure portal, find the marketplace image that you - * want to use and then click **Want to deploy programmatically, Get Started - * ->**. Enter any required information and then click **Save**. - * - * @member {string} [name] The plan ID. - * @member {string} [publisher] The publisher ID. - * @member {string} [product] Specifies the product of the image from the - * marketplace. This is the same value as Offer under the imageReference - * element. - * @member {string} [promotionCode] The promotion code. - */ + * Specifies information about the marketplace image used to create the virtual machine. This + * element is only used for marketplace images. Before you can use a marketplace image from an API, + * you must enable the image for programmatic use. In the Azure portal, find the marketplace image + * that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter + * any required information and then click **Save**. +*/ export interface Plan { + /** + * The plan ID. + */ name?: string; + /** + * The publisher ID. + */ publisher?: string; + /** + * Specifies the product of the image from the marketplace. This is the same value as Offer under + * the imageReference element. + */ product?: string; + /** + * The promotion code. + */ promotionCode?: string; } /** - * @class - * Initializes a new instance of the HardwareProfile class. - * @constructor * Specifies the hardware settings for the virtual machine. - * - * @member {string} [vmSize] Specifies the size of the virtual machine. For - * more information about virtual machine sizes, see [Sizes for virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

The available VM sizes depend on region and availability set. For a - * list of available sizes use these APIs:

[List all available - * virtual machine sizes in an availability - * set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) - *

[List all available virtual machine sizes in a - * region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list) - *

[List all available virtual machine sizes for - * resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). - * Possible values include: 'Basic_A0', 'Basic_A1', 'Basic_A2', 'Basic_A3', - * 'Basic_A4', 'Standard_A0', 'Standard_A1', 'Standard_A2', 'Standard_A3', - * 'Standard_A4', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', - * 'Standard_A9', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', - * 'Standard_A2_v2', 'Standard_A4_v2', 'Standard_A8_v2', 'Standard_A2m_v2', - * 'Standard_A4m_v2', 'Standard_A8m_v2', 'Standard_B1s', 'Standard_B1ms', - * 'Standard_B2s', 'Standard_B2ms', 'Standard_B4ms', 'Standard_B8ms', - * 'Standard_D1', 'Standard_D2', 'Standard_D3', 'Standard_D4', 'Standard_D11', - * 'Standard_D12', 'Standard_D13', 'Standard_D14', 'Standard_D1_v2', - * 'Standard_D2_v2', 'Standard_D3_v2', 'Standard_D4_v2', 'Standard_D5_v2', - * 'Standard_D2_v3', 'Standard_D4_v3', 'Standard_D8_v3', 'Standard_D16_v3', - * 'Standard_D32_v3', 'Standard_D64_v3', 'Standard_D2s_v3', 'Standard_D4s_v3', - * 'Standard_D8s_v3', 'Standard_D16s_v3', 'Standard_D32s_v3', - * 'Standard_D64s_v3', 'Standard_D11_v2', 'Standard_D12_v2', 'Standard_D13_v2', - * 'Standard_D14_v2', 'Standard_D15_v2', 'Standard_DS1', 'Standard_DS2', - * 'Standard_DS3', 'Standard_DS4', 'Standard_DS11', 'Standard_DS12', - * 'Standard_DS13', 'Standard_DS14', 'Standard_DS1_v2', 'Standard_DS2_v2', - * 'Standard_DS3_v2', 'Standard_DS4_v2', 'Standard_DS5_v2', 'Standard_DS11_v2', - * 'Standard_DS12_v2', 'Standard_DS13_v2', 'Standard_DS14_v2', - * 'Standard_DS15_v2', 'Standard_DS13-4_v2', 'Standard_DS13-2_v2', - * 'Standard_DS14-8_v2', 'Standard_DS14-4_v2', 'Standard_E2_v3', - * 'Standard_E4_v3', 'Standard_E8_v3', 'Standard_E16_v3', 'Standard_E32_v3', - * 'Standard_E64_v3', 'Standard_E2s_v3', 'Standard_E4s_v3', 'Standard_E8s_v3', - * 'Standard_E16s_v3', 'Standard_E32s_v3', 'Standard_E64s_v3', - * 'Standard_E32-16_v3', 'Standard_E32-8s_v3', 'Standard_E64-32s_v3', - * 'Standard_E64-16s_v3', 'Standard_F1', 'Standard_F2', 'Standard_F4', - * 'Standard_F8', 'Standard_F16', 'Standard_F1s', 'Standard_F2s', - * 'Standard_F4s', 'Standard_F8s', 'Standard_F16s', 'Standard_F2s_v2', - * 'Standard_F4s_v2', 'Standard_F8s_v2', 'Standard_F16s_v2', - * 'Standard_F32s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_G1', - * 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', - * 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS5', - * 'Standard_GS4-8', 'Standard_GS4-4', 'Standard_GS5-16', 'Standard_GS5-8', - * 'Standard_H8', 'Standard_H16', 'Standard_H8m', 'Standard_H16m', - * 'Standard_H16r', 'Standard_H16mr', 'Standard_L4s', 'Standard_L8s', - * 'Standard_L16s', 'Standard_L32s', 'Standard_M64s', 'Standard_M64ms', - * 'Standard_M128s', 'Standard_M128ms', 'Standard_M64-32ms', - * 'Standard_M64-16ms', 'Standard_M128-64ms', 'Standard_M128-32ms', - * 'Standard_NC6', 'Standard_NC12', 'Standard_NC24', 'Standard_NC24r', - * 'Standard_NC6s_v2', 'Standard_NC12s_v2', 'Standard_NC24s_v2', - * 'Standard_NC24rs_v2', 'Standard_NC6s_v3', 'Standard_NC12s_v3', - * 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', - * 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', - * 'Standard_NV12', 'Standard_NV24' - */ +*/ export interface HardwareProfile { + /** + * Specifies the size of the virtual machine. For more information about virtual machine sizes, + * see [Sizes for virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + *

The available VM sizes depend on region and availability set. For a list of available + * sizes use these APIs:

[List all available virtual machine sizes in an availability + * set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

+ * [List all available virtual machine sizes in a + * region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

[List + * all available virtual machine sizes for + * resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). + * Possible values include: 'Basic_A0', 'Basic_A1', 'Basic_A2', 'Basic_A3', 'Basic_A4', + * 'Standard_A0', 'Standard_A1', 'Standard_A2', 'Standard_A3', 'Standard_A4', 'Standard_A5', + * 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A9', 'Standard_A10', 'Standard_A11', + * 'Standard_A1_v2', 'Standard_A2_v2', 'Standard_A4_v2', 'Standard_A8_v2', 'Standard_A2m_v2', + * 'Standard_A4m_v2', 'Standard_A8m_v2', 'Standard_B1s', 'Standard_B1ms', 'Standard_B2s', + * 'Standard_B2ms', 'Standard_B4ms', 'Standard_B8ms', 'Standard_D1', 'Standard_D2', + * 'Standard_D3', 'Standard_D4', 'Standard_D11', 'Standard_D12', 'Standard_D13', 'Standard_D14', + * 'Standard_D1_v2', 'Standard_D2_v2', 'Standard_D3_v2', 'Standard_D4_v2', 'Standard_D5_v2', + * 'Standard_D2_v3', 'Standard_D4_v3', 'Standard_D8_v3', 'Standard_D16_v3', 'Standard_D32_v3', + * 'Standard_D64_v3', 'Standard_D2s_v3', 'Standard_D4s_v3', 'Standard_D8s_v3', + * 'Standard_D16s_v3', 'Standard_D32s_v3', 'Standard_D64s_v3', 'Standard_D11_v2', + * 'Standard_D12_v2', 'Standard_D13_v2', 'Standard_D14_v2', 'Standard_D15_v2', 'Standard_DS1', + * 'Standard_DS2', 'Standard_DS3', 'Standard_DS4', 'Standard_DS11', 'Standard_DS12', + * 'Standard_DS13', 'Standard_DS14', 'Standard_DS1_v2', 'Standard_DS2_v2', 'Standard_DS3_v2', + * 'Standard_DS4_v2', 'Standard_DS5_v2', 'Standard_DS11_v2', 'Standard_DS12_v2', + * 'Standard_DS13_v2', 'Standard_DS14_v2', 'Standard_DS15_v2', 'Standard_DS13-4_v2', + * 'Standard_DS13-2_v2', 'Standard_DS14-8_v2', 'Standard_DS14-4_v2', 'Standard_E2_v3', + * 'Standard_E4_v3', 'Standard_E8_v3', 'Standard_E16_v3', 'Standard_E32_v3', 'Standard_E64_v3', + * 'Standard_E2s_v3', 'Standard_E4s_v3', 'Standard_E8s_v3', 'Standard_E16s_v3', + * 'Standard_E32s_v3', 'Standard_E64s_v3', 'Standard_E32-16_v3', 'Standard_E32-8s_v3', + * 'Standard_E64-32s_v3', 'Standard_E64-16s_v3', 'Standard_F1', 'Standard_F2', 'Standard_F4', + * 'Standard_F8', 'Standard_F16', 'Standard_F1s', 'Standard_F2s', 'Standard_F4s', 'Standard_F8s', + * 'Standard_F16s', 'Standard_F2s_v2', 'Standard_F4s_v2', 'Standard_F8s_v2', 'Standard_F16s_v2', + * 'Standard_F32s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_G1', 'Standard_G2', + * 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', + * 'Standard_GS4', 'Standard_GS5', 'Standard_GS4-8', 'Standard_GS4-4', 'Standard_GS5-16', + * 'Standard_GS5-8', 'Standard_H8', 'Standard_H16', 'Standard_H8m', 'Standard_H16m', + * 'Standard_H16r', 'Standard_H16mr', 'Standard_L4s', 'Standard_L8s', 'Standard_L16s', + * 'Standard_L32s', 'Standard_M64s', 'Standard_M64ms', 'Standard_M128s', 'Standard_M128ms', + * 'Standard_M64-32ms', 'Standard_M64-16ms', 'Standard_M128-64ms', 'Standard_M128-32ms', + * 'Standard_NC6', 'Standard_NC12', 'Standard_NC24', 'Standard_NC24r', 'Standard_NC6s_v2', + * 'Standard_NC12s_v2', 'Standard_NC24s_v2', 'Standard_NC24rs_v2', 'Standard_NC6s_v3', + * 'Standard_NC12s_v3', 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', + * 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', 'Standard_NV12', + * 'Standard_NV24' + */ vmSize?: string; } /** - * @class - * Initializes a new instance of the ImageReference class. - * @constructor - * Specifies information about the image to use. You can specify information - * about platform images, marketplace images, or virtual machine images. This - * element is required when you want to use a platform image, marketplace - * image, or virtual machine image, but is not used in other creation + * Specifies information about the image to use. You can specify information about platform images, + * marketplace images, or virtual machine images. This element is required when you want to use a + * platform image, marketplace image, or virtual machine image, but is not used in other creation * operations. - * - * @member {string} [publisher] The image publisher. - * @member {string} [offer] Specifies the offer of the platform image or - * marketplace image used to create the virtual machine. - * @member {string} [sku] The image SKU. - * @member {string} [version] Specifies the version of the platform image or - * marketplace image used to create the virtual machine. The allowed formats - * are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal - * numbers. Specify 'latest' to use the latest version of an image available at - * deploy time. Even if you use 'latest', the VM image will not automatically - * update after deploy time even if a new version becomes available. - */ +*/ export interface ImageReference extends SubResource { + /** + * The image publisher. + */ publisher?: string; + /** + * Specifies the offer of the platform image or marketplace image used to create the virtual + * machine. + */ offer?: string; + /** + * The image SKU. + */ sku?: string; + /** + * Specifies the version of the platform image or marketplace image used to create the virtual + * machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are + * decimal numbers. Specify 'latest' to use the latest version of an image available at deploy + * time. Even if you use 'latest', the VM image will not automatically update after deploy time + * even if a new version becomes available. + */ version?: string; } /** - * @class - * Initializes a new instance of the KeyVaultSecretReference class. - * @constructor * Describes a reference to Key Vault Secret - * - * @member {string} secretUrl The URL referencing a secret in a Key Vault. - * @member {object} sourceVault The relative URL of the Key Vault containing - * the secret. - * @member {string} [sourceVault.id] Resource Id - */ +*/ export interface KeyVaultSecretReference { + /** + * The URL referencing a secret in a Key Vault. + */ secretUrl: string; + /** + * The relative URL of the Key Vault containing the secret. + */ sourceVault: SubResource; } /** - * @class - * Initializes a new instance of the KeyVaultKeyReference class. - * @constructor * Describes a reference to Key Vault Key - * - * @member {string} keyUrl The URL referencing a key encryption key in Key - * Vault. - * @member {object} sourceVault The relative URL of the Key Vault containing - * the key. - * @member {string} [sourceVault.id] Resource Id - */ +*/ export interface KeyVaultKeyReference { + /** + * The URL referencing a key encryption key in Key Vault. + */ keyUrl: string; + /** + * The relative URL of the Key Vault containing the key. + */ sourceVault: SubResource; } /** - * @class - * Initializes a new instance of the DiskEncryptionSettings class. - * @constructor * Describes a Encryption Settings for a Disk - * - * @member {object} [diskEncryptionKey] Specifies the location of the disk - * encryption key, which is a Key Vault Secret. - * @member {string} [diskEncryptionKey.secretUrl] The URL referencing a secret - * in a Key Vault. - * @member {object} [diskEncryptionKey.sourceVault] The relative URL of the Key - * Vault containing the secret. - * @member {string} [diskEncryptionKey.sourceVault.id] Resource Id - * @member {object} [keyEncryptionKey] Specifies the location of the key - * encryption key in Key Vault. - * @member {string} [keyEncryptionKey.keyUrl] The URL referencing a key - * encryption key in Key Vault. - * @member {object} [keyEncryptionKey.sourceVault] The relative URL of the Key - * Vault containing the key. - * @member {string} [keyEncryptionKey.sourceVault.id] Resource Id - * @member {boolean} [enabled] Specifies whether disk encryption should be - * enabled on the virtual machine. - */ +*/ export interface DiskEncryptionSettings { + /** + * Specifies the location of the disk encryption key, which is a Key Vault Secret. + */ diskEncryptionKey?: KeyVaultSecretReference; + /** + * Specifies the location of the key encryption key in Key Vault. + */ keyEncryptionKey?: KeyVaultKeyReference; + /** + * Specifies whether disk encryption should be enabled on the virtual machine. + */ enabled?: boolean; } /** - * @class - * Initializes a new instance of the VirtualHardDisk class. - * @constructor * Describes the uri of a disk. - * - * @member {string} [uri] Specifies the virtual hard disk's uri. - */ +*/ export interface VirtualHardDisk { + /** + * Specifies the virtual hard disk's uri. + */ uri?: string; } /** - * @class - * Initializes a new instance of the DiffDiskSettings class. - * @constructor - * Describes the parameters of differencing disk settings that can be be - * specified for operating system disk.

NOTE: The differencing disk - * settings can only be specified for managed disk. - * - * @member {string} [option] Specifies the differencing disk settings for - * operating system disk. Possible values include: 'Local' - */ + * Describes the parameters of ephemeral disk settings that can be specified for operating system + * disk.

NOTE: The ephemeral disk settings can only be specified for managed disk. +*/ export interface DiffDiskSettings { + /** + * Specifies the ephemeral disk settings for operating system disk. Possible values include: + * 'Local' + */ option?: string; } /** - * @class - * Initializes a new instance of the ManagedDiskParameters class. - * @constructor * The parameters of a managed disk. - * - * @member {string} [storageAccountType] Specifies the storage account type for - * the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it - * cannot be used with OS Disk. Possible values include: 'Standard_LRS', - * 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - */ +*/ export interface ManagedDiskParameters extends SubResource { + /** + * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used + * with data disks, it cannot be used with OS Disk. Possible values include: 'Standard_LRS', + * 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' + */ storageAccountType?: string; } /** - * @class - * Initializes a new instance of the OSDisk class. - * @constructor - * Specifies information about the operating system disk used by the virtual - * machine.

For more information about disks, see [About disks and - * VHDs for Azure virtual + * Specifies information about the operating system disk used by the virtual machine.

For + * more information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * - * @member {string} [osType] This property allows you to specify the type of - * the OS that is included in the disk if creating a VM from user-image or a - * specialized VHD.

Possible values are:

**Windows**

- * **Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [encryptionSettings] Specifies the encryption settings for - * the OS Disk.

Minimum api-version: 2015-06-15 - * @member {object} [encryptionSettings.diskEncryptionKey] Specifies the - * location of the disk encryption key, which is a Key Vault Secret. - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] The URL - * referencing a secret in a Key Vault. - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] The - * relative URL of the Key Vault containing the secret. - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {object} [encryptionSettings.keyEncryptionKey] Specifies the - * location of the key encryption key in Key Vault. - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] The URL - * referencing a key encryption key in Key Vault. - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] The - * relative URL of the Key Vault containing the key. - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {boolean} [encryptionSettings.enabled] Specifies whether disk - * encryption should be enabled on the virtual machine. - * @member {string} [name] The disk name. - * @member {object} [vhd] The virtual hard disk. - * @member {string} [vhd.uri] Specifies the virtual hard disk's uri. - * @member {object} [image] The source user image virtual hard disk. The - * virtual hard disk will be copied before being attached to the virtual - * machine. If SourceImage is provided, the destination virtual hard drive must - * not exist. - * @member {string} [image.uri] Specifies the virtual hard disk's uri. - * @member {string} [caching] Specifies the caching requirements.

- * Possible values are:

**None**

**ReadOnly**

- * **ReadWrite**

Default: **None for Standard storage. ReadOnly for - * Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether - * writeAccelerator should be enabled or disabled on the disk. - * @member {object} [diffDiskSettings] Specifies the differencing Disk Settings - * for the operating system disk used by the virtual machine. - * @member {string} [diffDiskSettings.option] Specifies the differencing disk - * settings for operating system disk. Possible values include: 'Local' - * @member {string} createOption Specifies how the virtual machine should be - * created.

Possible values are:

**Attach** \u2013 This value - * is used when you are using a specialized disk to create the virtual - * machine.

**FromImage** \u2013 This value is used when you are using - * an image to create the virtual machine. If you are using a platform image, - * you also use the imageReference element described above. If you are using a - * marketplace image, you also use the plan element previously described. - * Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {number} [diskSizeGB] Specifies the size of an empty data disk in - * gigabytes. This element can be used to overwrite the size of the disk in a - * virtual machine image.

This value cannot be larger than 1023 GB - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage - * account type for the managed disk. NOTE: UltraSSD_LRS can only be used with - * data disks, it cannot be used with OS Disk. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - */ +*/ export interface OSDisk { + /** + * This property allows you to specify the type of the OS that is included in the disk if + * creating a VM from user-image or a specialized VHD.

Possible values are:

+ * **Windows**

**Linux**. Possible values include: 'Windows', 'Linux' + */ osType?: string; + /** + * Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 + */ encryptionSettings?: DiskEncryptionSettings; + /** + * The disk name. + */ name?: string; + /** + * The virtual hard disk. + */ vhd?: VirtualHardDisk; + /** + * The source user image virtual hard disk. The virtual hard disk will be copied before being + * attached to the virtual machine. If SourceImage is provided, the destination virtual hard + * drive must not exist. + */ image?: VirtualHardDisk; + /** + * Specifies the caching requirements.

Possible values are:

**None**

+ * **ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly + * for Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' + */ caching?: string; + /** + * Specifies whether writeAccelerator should be enabled or disabled on the disk. + */ writeAcceleratorEnabled?: boolean; + /** + * Specifies the ephemeral Disk Settings for the operating system disk used by the virtual + * machine. + */ diffDiskSettings?: DiffDiskSettings; + /** + * Specifies how the virtual machine should be created.

Possible values are:

+ * **Attach** \u2013 This value is used when you are using a specialized disk to create the + * virtual machine.

**FromImage** \u2013 This value is used when you are using an image + * to create the virtual machine. If you are using a platform image, you also use the + * imageReference element described above. If you are using a marketplace image, you also use + * the plan element previously described. Possible values include: 'FromImage', 'Empty', 'Attach' + */ createOption: string; + /** + * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite + * the size of the disk in a virtual machine image.

This value cannot be larger than + * 1023 GB + */ diskSizeGB?: number; + /** + * The managed disk parameters. + */ managedDisk?: ManagedDiskParameters; } /** - * @class - * Initializes a new instance of the DataDisk class. - * @constructor * Describes a data disk. - * - * @member {number} lun Specifies the logical unit number of the data disk. - * This value is used to identify data disks within the VM and therefore must - * be unique for each data disk attached to a VM. - * @member {string} [name] The disk name. - * @member {object} [vhd] The virtual hard disk. - * @member {string} [vhd.uri] Specifies the virtual hard disk's uri. - * @member {object} [image] The source user image virtual hard disk. The - * virtual hard disk will be copied before being attached to the virtual - * machine. If SourceImage is provided, the destination virtual hard drive must - * not exist. - * @member {string} [image.uri] Specifies the virtual hard disk's uri. - * @member {string} [caching] Specifies the caching requirements.

- * Possible values are:

**None**

**ReadOnly**

- * **ReadWrite**

Default: **None for Standard storage. ReadOnly for - * Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether - * writeAccelerator should be enabled or disabled on the disk. - * @member {string} createOption Specifies how the virtual machine should be - * created.

Possible values are:

**Attach** \u2013 This value - * is used when you are using a specialized disk to create the virtual - * machine.

**FromImage** \u2013 This value is used when you are using - * an image to create the virtual machine. If you are using a platform image, - * you also use the imageReference element described above. If you are using a - * marketplace image, you also use the plan element previously described. - * Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {number} [diskSizeGB] Specifies the size of an empty data disk in - * gigabytes. This element can be used to overwrite the size of the disk in a - * virtual machine image.

This value cannot be larger than 1023 GB - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage - * account type for the managed disk. NOTE: UltraSSD_LRS can only be used with - * data disks, it cannot be used with OS Disk. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - */ +*/ export interface DataDisk { + /** + * Specifies the logical unit number of the data disk. This value is used to identify data disks + * within the VM and therefore must be unique for each data disk attached to a VM. + */ lun: number; + /** + * The disk name. + */ name?: string; + /** + * The virtual hard disk. + */ vhd?: VirtualHardDisk; + /** + * The source user image virtual hard disk. The virtual hard disk will be copied before being + * attached to the virtual machine. If SourceImage is provided, the destination virtual hard + * drive must not exist. + */ image?: VirtualHardDisk; + /** + * Specifies the caching requirements.

Possible values are:

**None**

+ * **ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly + * for Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' + */ caching?: string; + /** + * Specifies whether writeAccelerator should be enabled or disabled on the disk. + */ writeAcceleratorEnabled?: boolean; + /** + * Specifies how the virtual machine should be created.

Possible values are:

+ * **Attach** \u2013 This value is used when you are using a specialized disk to create the + * virtual machine.

**FromImage** \u2013 This value is used when you are using an image + * to create the virtual machine. If you are using a platform image, you also use the + * imageReference element described above. If you are using a marketplace image, you also use + * the plan element previously described. Possible values include: 'FromImage', 'Empty', 'Attach' + */ createOption: string; + /** + * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite + * the size of the disk in a virtual machine image.

This value cannot be larger than + * 1023 GB + */ diskSizeGB?: number; + /** + * The managed disk parameters. + */ managedDisk?: ManagedDiskParameters; } /** - * @class - * Initializes a new instance of the StorageProfile class. - * @constructor * Specifies the storage settings for the virtual machine disks. - * - * @member {object} [imageReference] Specifies information about the image to - * use. You can specify information about platform images, marketplace images, - * or virtual machine images. This element is required when you want to use a - * platform image, marketplace image, or virtual machine image, but is not used - * in other creation operations. - * @member {string} [imageReference.publisher] The image publisher. - * @member {string} [imageReference.offer] Specifies the offer of the platform - * image or marketplace image used to create the virtual machine. - * @member {string} [imageReference.sku] The image SKU. - * @member {string} [imageReference.version] Specifies the version of the - * platform image or marketplace image used to create the virtual machine. The - * allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build - * are decimal numbers. Specify 'latest' to use the latest version of an image - * available at deploy time. Even if you use 'latest', the VM image will not - * automatically update after deploy time even if a new version becomes - * available. - * @member {object} [osDisk] Specifies information about the operating system - * disk used by the virtual machine.

For more information about disks, - * see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [osDisk.osType] This property allows you to specify the - * type of the OS that is included in the disk if creating a VM from user-image - * or a specialized VHD.

Possible values are:

**Windows** - *

**Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [osDisk.encryptionSettings] Specifies the encryption - * settings for the OS Disk.

Minimum api-version: 2015-06-15 - * @member {object} [osDisk.encryptionSettings.diskEncryptionKey] Specifies the - * location of the disk encryption key, which is a Key Vault Secret. - * @member {string} [osDisk.encryptionSettings.diskEncryptionKey.secretUrl] The - * URL referencing a secret in a Key Vault. - * @member {object} [osDisk.encryptionSettings.diskEncryptionKey.sourceVault] - * The relative URL of the Key Vault containing the secret. - * @member {string} - * [osDisk.encryptionSettings.diskEncryptionKey.sourceVault.id] Resource Id - * @member {object} [osDisk.encryptionSettings.keyEncryptionKey] Specifies the - * location of the key encryption key in Key Vault. - * @member {string} [osDisk.encryptionSettings.keyEncryptionKey.keyUrl] The URL - * referencing a key encryption key in Key Vault. - * @member {object} [osDisk.encryptionSettings.keyEncryptionKey.sourceVault] - * The relative URL of the Key Vault containing the key. - * @member {string} [osDisk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {boolean} [osDisk.encryptionSettings.enabled] Specifies whether disk - * encryption should be enabled on the virtual machine. - * @member {string} [osDisk.name] The disk name. - * @member {object} [osDisk.vhd] The virtual hard disk. - * @member {string} [osDisk.vhd.uri] Specifies the virtual hard disk's uri. - * @member {object} [osDisk.image] The source user image virtual hard disk. The - * virtual hard disk will be copied before being attached to the virtual - * machine. If SourceImage is provided, the destination virtual hard drive must - * not exist. - * @member {string} [osDisk.image.uri] Specifies the virtual hard disk's uri. - * @member {string} [osDisk.caching] Specifies the caching requirements. - *

Possible values are:

**None**

**ReadOnly** - *

**ReadWrite**

Default: **None for Standard storage. - * ReadOnly for Premium storage**. Possible values include: 'None', 'ReadOnly', - * 'ReadWrite' - * @member {boolean} [osDisk.writeAcceleratorEnabled] Specifies whether - * writeAccelerator should be enabled or disabled on the disk. - * @member {object} [osDisk.diffDiskSettings] Specifies the differencing Disk - * Settings for the operating system disk used by the virtual machine. - * @member {string} [osDisk.diffDiskSettings.option] Specifies the differencing - * disk settings for operating system disk. Possible values include: 'Local' - * @member {string} [osDisk.createOption] Specifies how the virtual machine - * should be created.

Possible values are:

**Attach** \u2013 - * This value is used when you are using a specialized disk to create the - * virtual machine.

**FromImage** \u2013 This value is used when you - * are using an image to create the virtual machine. If you are using a - * platform image, you also use the imageReference element described above. If - * you are using a marketplace image, you also use the plan element previously - * described. Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {number} [osDisk.diskSizeGB] Specifies the size of an empty data - * disk in gigabytes. This element can be used to overwrite the size of the - * disk in a virtual machine image.

This value cannot be larger than - * 1023 GB - * @member {object} [osDisk.managedDisk] The managed disk parameters. - * @member {string} [osDisk.managedDisk.storageAccountType] Specifies the - * storage account type for the managed disk. NOTE: UltraSSD_LRS can only be - * used with data disks, it cannot be used with OS Disk. Possible values - * include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [dataDisks] Specifies the parameters that are used to add a - * data disk to a virtual machine.

For more information about disks, - * see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - */ +*/ export interface StorageProfile { + /** + * Specifies information about the image to use. You can specify information about platform + * images, marketplace images, or virtual machine images. This element is required when you want + * to use a platform image, marketplace image, or virtual machine image, but is not used in other + * creation operations. + */ imageReference?: ImageReference; + /** + * Specifies information about the operating system disk used by the virtual machine.

+ * For more information about disks, see [About disks and VHDs for Azure virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + */ osDisk?: OSDisk; + /** + * Specifies the parameters that are used to add a data disk to a virtual machine.

For + * more information about disks, see [About disks and VHDs for Azure virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + */ dataDisks?: DataDisk[]; } /** - * @class - * Initializes a new instance of the AdditionalCapabilities class. - * @constructor - * Enables or disables a capability on the virtual machine or virtual machine - * scale set. - * - * @member {boolean} [ultraSSDEnabled] The flag that enables or disables a - * capability to have one or more managed data disks with UltraSSD_LRS storage - * account type on the VM or VMSS. Managed disks with storage account type - * UltraSSD_LRS can be added to a virtual machine or virtual machine scale set - * only if this property is enabled. - */ + * Enables or disables a capability on the virtual machine or virtual machine scale set. +*/ export interface AdditionalCapabilities { + /** + * The flag that enables or disables a capability to have one or more managed data disks with + * UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type + * UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this + * property is enabled. + */ ultraSSDEnabled?: boolean; } /** - * @class - * Initializes a new instance of the AdditionalUnattendContent class. - * @constructor - * Specifies additional XML formatted information that can be included in the - * Unattend.xml file, which is used by Windows Setup. Contents are defined by - * setting name, component name, and the pass in which the content is applied. - * - * @member {string} [passName] The pass name. Currently, the only allowable - * value is OobeSystem. Possible values include: 'OobeSystem' - * @member {string} [componentName] The component name. Currently, the only - * allowable value is Microsoft-Windows-Shell-Setup. Possible values include: - * 'Microsoft-Windows-Shell-Setup' - * @member {string} [settingName] Specifies the name of the setting to which - * the content applies. Possible values are: FirstLogonCommands and AutoLogon. - * Possible values include: 'AutoLogon', 'FirstLogonCommands' - * @member {string} [content] Specifies the XML formatted content that is added - * to the unattend.xml file for the specified path and component. The XML must - * be less than 4KB and must include the root element for the setting or - * feature that is being inserted. - */ + * Specifies additional XML formatted information that can be included in the Unattend.xml file, + * which is used by Windows Setup. Contents are defined by setting name, component name, and the + * pass in which the content is applied. +*/ export interface AdditionalUnattendContent { + /** + * The pass name. Currently, the only allowable value is OobeSystem. Possible values include: + * 'OobeSystem' + */ passName?: string; + /** + * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. + * Possible values include: 'Microsoft-Windows-Shell-Setup' + */ componentName?: string; + /** + * Specifies the name of the setting to which the content applies. Possible values are: + * FirstLogonCommands and AutoLogon. Possible values include: 'AutoLogon', 'FirstLogonCommands' + */ settingName?: string; + /** + * Specifies the XML formatted content that is added to the unattend.xml file for the specified + * path and component. The XML must be less than 4KB and must include the root element for the + * setting or feature that is being inserted. + */ content?: string; } /** - * @class - * Initializes a new instance of the WinRMListener class. - * @constructor * Describes Protocol and thumbprint of Windows Remote Management listener - * - * @member {string} [protocol] Specifies the protocol of listener.

- * Possible values are:
**http**

**https**. Possible values - * include: 'Http', 'Https' - * @member {string} [certificateUrl] This is the URL of a certificate that has - * been uploaded to Key Vault as a secret. For adding a secret to the Key - * Vault, see [Add a key or secret to the key - * vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). - * In this case, your certificate needs to be It is the Base64 encoding of the - * following JSON Object which is encoded in UTF-8:

{
- * "data":"",
"dataType":"pfx",
- * "password":""
} - */ +*/ export interface WinRMListener { + /** + * Specifies the protocol of listener.

Possible values are:
**http**

+ * **https**. Possible values include: 'Http', 'Https' + */ protocol?: string; + /** + * This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a + * secret to the Key Vault, see [Add a key or secret to the key + * vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, + * your certificate needs to be It is the Base64 encoding of the following JSON Object which is + * encoded in UTF-8:

{
"data":"",
+ * "dataType":"pfx",
"password":""
} + */ certificateUrl?: string; } /** - * @class - * Initializes a new instance of the WinRMConfiguration class. - * @constructor * Describes Windows Remote Management configuration of the VM - * - * @member {array} [listeners] The list of Windows Remote Management listeners - */ +*/ export interface WinRMConfiguration { + /** + * The list of Windows Remote Management listeners + */ listeners?: WinRMListener[]; } /** - * @class - * Initializes a new instance of the WindowsConfiguration class. - * @constructor * Specifies Windows operating system settings on the virtual machine. - * - * @member {boolean} [provisionVMAgent] Indicates whether virtual machine agent - * should be provisioned on the virtual machine.

When this property is - * not specified in the request body, default behavior is to set it to true. - * This will ensure that VM Agent is installed on the VM so that extensions can - * be added to the VM later. - * @member {boolean} [enableAutomaticUpdates] Indicates whether virtual machine - * is enabled for automatic updates. - * @member {string} [timeZone] Specifies the time zone of the virtual machine. - * e.g. "Pacific Standard Time" - * @member {array} [additionalUnattendContent] Specifies additional base-64 - * encoded XML formatted information that can be included in the Unattend.xml - * file, which is used by Windows Setup. - * @member {object} [winRM] Specifies the Windows Remote Management listeners. - * This enables remote Windows PowerShell. - * @member {array} [winRM.listeners] The list of Windows Remote Management - * listeners - */ +*/ export interface WindowsConfiguration { + /** + * Indicates whether virtual machine agent should be provisioned on the virtual machine.

+ * When this property is not specified in the request body, default behavior is to set it to + * true. This will ensure that VM Agent is installed on the VM so that extensions can be added + * to the VM later. + */ provisionVMAgent?: boolean; + /** + * Indicates whether virtual machine is enabled for automatic updates. + */ enableAutomaticUpdates?: boolean; + /** + * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" + */ timeZone?: string; + /** + * Specifies additional base-64 encoded XML formatted information that can be included in the + * Unattend.xml file, which is used by Windows Setup. + */ additionalUnattendContent?: AdditionalUnattendContent[]; + /** + * Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. + */ winRM?: WinRMConfiguration; } /** - * @class - * Initializes a new instance of the SshPublicKey class. - * @constructor - * Contains information about SSH certificate public key and the path on the - * Linux VM where the public key is placed. - * - * @member {string} [path] Specifies the full path on the created VM where ssh - * public key is stored. If the file already exists, the specified key is - * appended to the file. Example: /home/user/.ssh/authorized_keys - * @member {string} [keyData] SSH public key certificate used to authenticate - * with the VM through ssh. The key needs to be at least 2048-bit and in - * ssh-rsa format.

For creating ssh keys, see [Create SSH keys on - * Linux and Mac for Linux VMs in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - */ + * Contains information about SSH certificate public key and the path on the Linux VM where the + * public key is placed. +*/ export interface SshPublicKey { + /** + * Specifies the full path on the created VM where ssh public key is stored. If the file already + * exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys + */ path?: string; + /** + * SSH public key certificate used to authenticate with the VM through ssh. The key needs to be + * at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys + * on Linux and Mac for Linux VMs in + * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + */ keyData?: string; } /** - * @class - * Initializes a new instance of the SshConfiguration class. - * @constructor * SSH configuration for Linux based VMs running on Azure - * - * @member {array} [publicKeys] The list of SSH public keys used to - * authenticate with linux based VMs. - */ +*/ export interface SshConfiguration { + /** + * The list of SSH public keys used to authenticate with linux based VMs. + */ publicKeys?: SshPublicKey[]; } /** - * @class - * Initializes a new instance of the LinuxConfiguration class. - * @constructor - * Specifies the Linux operating system settings on the virtual machine. - *

For a list of supported Linux distributions, see [Linux on - * Azure-Endorsed + * Specifies the Linux operating system settings on the virtual machine.

For a list of + * supported Linux distributions, see [Linux on Azure-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - *

For running non-endorsed distributions, see [Information for - * Non-Endorsed + *

For running non-endorsed distributions, see [Information for Non-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * - * @member {boolean} [disablePasswordAuthentication] Specifies whether password - * authentication should be disabled. - * @member {object} [ssh] Specifies the ssh key configuration for a Linux OS. - * @member {array} [ssh.publicKeys] The list of SSH public keys used to - * authenticate with linux based VMs. - * @member {boolean} [provisionVMAgent] Indicates whether virtual machine agent - * should be provisioned on the virtual machine.

When this property is - * not specified in the request body, default behavior is to set it to true. - * This will ensure that VM Agent is installed on the VM so that extensions can - * be added to the VM later. - */ +*/ export interface LinuxConfiguration { + /** + * Specifies whether password authentication should be disabled. + */ disablePasswordAuthentication?: boolean; + /** + * Specifies the ssh key configuration for a Linux OS. + */ ssh?: SshConfiguration; + /** + * Indicates whether virtual machine agent should be provisioned on the virtual machine.

+ * When this property is not specified in the request body, default behavior is to set it to + * true. This will ensure that VM Agent is installed on the VM so that extensions can be added + * to the VM later. + */ provisionVMAgent?: boolean; } /** - * @class - * Initializes a new instance of the VaultCertificate class. - * @constructor - * Describes a single certificate reference in a Key Vault, and where the - * certificate should reside on the VM. - * - * @member {string} [certificateUrl] This is the URL of a certificate that has - * been uploaded to Key Vault as a secret. For adding a secret to the Key - * Vault, see [Add a key or secret to the key - * vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). - * In this case, your certificate needs to be It is the Base64 encoding of the - * following JSON Object which is encoded in UTF-8:

{
- * "data":"",
"dataType":"pfx",
- * "password":""
} - * @member {string} [certificateStore] For Windows VMs, specifies the - * certificate store on the Virtual Machine to which the certificate should be - * added. The specified certificate store is implicitly in the LocalMachine - * account.

For Linux VMs, the certificate file is placed under the - * /var/lib/waagent directory, with the file name .crt for - * the X509 certificate file and .prv for private key. - * Both of these files are .pem formatted. - */ + * Describes a single certificate reference in a Key Vault, and where the certificate should reside + * on the VM. +*/ export interface VaultCertificate { + /** + * This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a + * secret to the Key Vault, see [Add a key or secret to the key + * vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, + * your certificate needs to be It is the Base64 encoding of the following JSON Object which is + * encoded in UTF-8:

{
"data":"",
+ * "dataType":"pfx",
"password":""
} + */ certificateUrl?: string; + /** + * For Windows VMs, specifies the certificate store on the Virtual Machine to which the + * certificate should be added. The specified certificate store is implicitly in the LocalMachine + * account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent + * directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file + * and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. + */ certificateStore?: string; } /** - * @class - * Initializes a new instance of the VaultSecretGroup class. - * @constructor * Describes a set of certificates which are all in the same Key Vault. - * - * @member {object} [sourceVault] The relative URL of the Key Vault containing - * all of the certificates in VaultCertificates. - * @member {string} [sourceVault.id] Resource Id - * @member {array} [vaultCertificates] The list of key vault references in - * SourceVault which contain certificates. - */ +*/ export interface VaultSecretGroup { + /** + * The relative URL of the Key Vault containing all of the certificates in VaultCertificates. + */ sourceVault?: SubResource; + /** + * The list of key vault references in SourceVault which contain certificates. + */ vaultCertificates?: VaultCertificate[]; } /** - * @class - * Initializes a new instance of the OSProfile class. - * @constructor * Specifies the operating system settings for the virtual machine. - * - * @member {string} [computerName] Specifies the host OS name of the virtual - * machine.

**Max-length (Windows):** 15 characters

- * **Max-length (Linux):** 64 characters.

For naming conventions and - * restrictions see [Azure infrastructure services implementation - * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). - * @member {string} [adminUsername] Specifies the name of the administrator - * account.

**Windows-only restriction:** Cannot end in "."

- * **Disallowed values:** "administrator", "admin", "user", "user1", "test", - * "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", - * "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", - * "root", "server", "sql", "support", "support_388945a0", "sys", "test2", - * "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character - *

**Max-length (Linux):** 64 characters

**Max-length - * (Windows):** 20 characters

  • For root access to the Linux VM, - * see [Using root privileges on Linux virtual machines in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • - * For a list of built-in system users on Linux that should not be used in this - * field, see [Selecting User Names for Linux on - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [adminPassword] Specifies the password of the administrator - * account.

    **Minimum-length (Windows):** 8 characters

    - * **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** - * 123 characters

    **Max-length (Linux):** 72 characters

    - * **Complexity requirements:** 3 out of 4 conditions below need to be - * fulfilled
    Has lower characters
    Has upper characters
    Has a - * digit
    Has a special character (Regex match [\W_])

    **Disallowed - * values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", - * "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    - * For resetting the password, see [How to reset the Remote Desktop service or - * its login password in a Windows - * VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    For resetting root password, see [Manage users, SSH, and check or - * repair disks on Azure Linux VMs using the VMAccess - * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [customData] Specifies a base-64 encoded string of custom - * data. The base-64 encoded string is decoded to a binary array that is saved - * as a file on the Virtual Machine. The maximum length of the binary array is - * 65535 bytes.

    For using cloud-init for your VM, see [Using - * cloud-init to customize a Linux VM during - * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [windowsConfiguration] Specifies Windows operating system - * settings on the virtual machine. - * @member {boolean} [windowsConfiguration.provisionVMAgent] Indicates whether - * virtual machine agent should be provisioned on the virtual machine.

    - * When this property is not specified in the request body, default behavior is - * to set it to true. This will ensure that VM Agent is installed on the VM so - * that extensions can be added to the VM later. - * @member {boolean} [windowsConfiguration.enableAutomaticUpdates] Indicates - * whether virtual machine is enabled for automatic updates. - * @member {string} [windowsConfiguration.timeZone] Specifies the time zone of - * the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [windowsConfiguration.additionalUnattendContent] Specifies - * additional base-64 encoded XML formatted information that can be included in - * the Unattend.xml file, which is used by Windows Setup. - * @member {object} [windowsConfiguration.winRM] Specifies the Windows Remote - * Management listeners. This enables remote Windows PowerShell. - * @member {array} [windowsConfiguration.winRM.listeners] The list of Windows - * Remote Management listeners - * @member {object} [linuxConfiguration] Specifies the Linux operating system - * settings on the virtual machine.

    For a list of supported Linux - * distributions, see [Linux on Azure-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - *

    For running non-endorsed distributions, see [Information for - * Non-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} [linuxConfiguration.disablePasswordAuthentication] - * Specifies whether password authentication should be disabled. - * @member {object} [linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [linuxConfiguration.ssh.publicKeys] The list of SSH public - * keys used to authenticate with linux based VMs. - * @member {boolean} [linuxConfiguration.provisionVMAgent] Indicates whether - * virtual machine agent should be provisioned on the virtual machine.

    - * When this property is not specified in the request body, default behavior is - * to set it to true. This will ensure that VM Agent is installed on the VM so - * that extensions can be added to the VM later. - * @member {array} [secrets] Specifies set of certificates that should be - * installed onto the virtual machine. - * @member {boolean} [allowExtensionOperations] Specifies whether extension - * operations should be allowed on the virtual machine.

    This may only - * be set to False when no extensions are present on the virtual machine. - */ +*/ export interface OSProfile { + /** + * Specifies the host OS name of the virtual machine.

    This name cannot be updated after + * the VM is created.

    **Max-length (Windows):** 15 characters

    **Max-length + * (Linux):** 64 characters.

    For naming conventions and restrictions see [Azure + * infrastructure services implementation + * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). + */ computerName?: string; + /** + * Specifies the name of the administrator account.

    **Windows-only restriction:** Cannot + * end in "."

    **Disallowed values:** "administrator", "admin", "user", "user1", "test", + * "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", + * "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", + * "support_388945a0", "sys", "test2", "test3", "user4", "user5".

    **Minimum-length + * (Linux):** 1 character

    **Max-length (Linux):** 64 characters

    **Max-length + * (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root + * privileges on Linux virtual machines in + * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • + * For a list of built-in system users on Linux that should not be used in this field, see + * [Selecting User Names for Linux on + * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + */ adminUsername?: string; + /** + * Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 + * characters

    **Minimum-length (Linux):** 6 characters

    **Max-length + * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    + * **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower + * characters
    Has upper characters
    Has a digit
    Has a special character (Regex match + * [\W_])

    **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", + * "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    For + * resetting the password, see [How to reset the Remote Desktop service or its login password in + * a Windows + * VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) + *

    For resetting root password, see [Manage users, SSH, and check or repair disks on + * Azure Linux VMs using the VMAccess + * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) + */ adminPassword?: string; + /** + * Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a + * binary array that is saved as a file on the Virtual Machine. The maximum length of the binary + * array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to + * customize a Linux VM during + * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + */ customData?: string; + /** + * Specifies Windows operating system settings on the virtual machine. + */ windowsConfiguration?: WindowsConfiguration; + /** + * Specifies the Linux operating system settings on the virtual machine.

    For a list of + * supported Linux distributions, see [Linux on Azure-Endorsed + * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + *

    For running non-endorsed distributions, see [Information for Non-Endorsed + * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + */ linuxConfiguration?: LinuxConfiguration; + /** + * Specifies set of certificates that should be installed onto the virtual machine. + */ secrets?: VaultSecretGroup[]; + /** + * Specifies whether extension operations should be allowed on the virtual machine.

    This + * may only be set to False when no extensions are present on the virtual machine. + */ allowExtensionOperations?: boolean; } /** - * @class - * Initializes a new instance of the NetworkInterfaceReference class. - * @constructor * Describes a network interface reference. - * - * @member {boolean} [primary] Specifies the primary network interface in case - * the virtual machine has more than 1 network interface. - */ +*/ export interface NetworkInterfaceReference extends SubResource { + /** + * Specifies the primary network interface in case the virtual machine has more than 1 network + * interface. + */ primary?: boolean; } /** - * @class - * Initializes a new instance of the NetworkProfile class. - * @constructor * Specifies the network interfaces of the virtual machine. - * - * @member {array} [networkInterfaces] Specifies the list of resource Ids for - * the network interfaces associated with the virtual machine. - */ +*/ export interface NetworkProfile { + /** + * Specifies the list of resource Ids for the network interfaces associated with the virtual + * machine. + */ networkInterfaces?: NetworkInterfaceReference[]; } /** - * @class - * Initializes a new instance of the BootDiagnostics class. - * @constructor - * Boot Diagnostics is a debugging feature which allows you to view Console - * Output and Screenshot to diagnose VM status.

    You can easily view - * the output of your console log.

    Azure also enables you to see a - * screenshot of the VM from the hypervisor. - * - * @member {boolean} [enabled] Whether boot diagnostics should be enabled on - * the Virtual Machine. - * @member {string} [storageUri] Uri of the storage account to use for placing - * the console output and screenshot. - */ + * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot + * to diagnose VM status.

    You can easily view the output of your console log.

    + * Azure also enables you to see a screenshot of the VM from the hypervisor. +*/ export interface BootDiagnostics { + /** + * Whether boot diagnostics should be enabled on the Virtual Machine. + */ enabled?: boolean; + /** + * Uri of the storage account to use for placing the console output and screenshot. + */ storageUri?: string; } /** - * @class - * Initializes a new instance of the DiagnosticsProfile class. - * @constructor - * Specifies the boot diagnostic settings state.

    Minimum api-version: - * 2015-06-15. - * - * @member {object} [bootDiagnostics] Boot Diagnostics is a debugging feature - * which allows you to view Console Output and Screenshot to diagnose VM - * status.

    You can easily view the output of your console log. - *

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {boolean} [bootDiagnostics.enabled] Whether boot diagnostics should - * be enabled on the Virtual Machine. - * @member {string} [bootDiagnostics.storageUri] Uri of the storage account to - * use for placing the console output and screenshot. - */ + * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +*/ export interface DiagnosticsProfile { + /** + * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot + * to diagnose VM status.

    You can easily view the output of your console log.

    + * Azure also enables you to see a screenshot of the VM from the hypervisor. + */ bootDiagnostics?: BootDiagnostics; } /** - * @class - * Initializes a new instance of the VirtualMachineExtensionHandlerInstanceView class. - * @constructor * The instance view of a virtual machine extension handler. - * - * @member {string} [type] Specifies the type of the extension; an example is - * "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {object} [status] The extension handler status. - * @member {string} [status.code] The status code. - * @member {string} [status.level] The level code. Possible values include: - * 'Info', 'Warning', 'Error' - * @member {string} [status.displayStatus] The short localizable label for the - * status. - * @member {string} [status.message] The detailed status message, including for - * alerts and error messages. - * @member {date} [status.time] The time of the status. - */ +*/ export interface VirtualMachineExtensionHandlerInstanceView { + /** + * Specifies the type of the extension; an example is "CustomScriptExtension". + */ type?: string; + /** + * Specifies the version of the script handler. + */ typeHandlerVersion?: string; + /** + * The extension handler status. + */ status?: InstanceViewStatus; } /** - * @class - * Initializes a new instance of the VirtualMachineAgentInstanceView class. - * @constructor * The instance view of the VM Agent running on the virtual machine. - * - * @member {string} [vmAgentVersion] The VM Agent full version. - * @member {array} [extensionHandlers] The virtual machine extension handler - * instance view. - * @member {array} [statuses] The resource status information. - */ +*/ export interface VirtualMachineAgentInstanceView { + /** + * The VM Agent full version. + */ vmAgentVersion?: string; + /** + * The virtual machine extension handler instance view. + */ extensionHandlers?: VirtualMachineExtensionHandlerInstanceView[]; + /** + * The resource status information. + */ statuses?: InstanceViewStatus[]; } /** - * @class - * Initializes a new instance of the DiskInstanceView class. - * @constructor * The instance view of the disk. - * - * @member {string} [name] The disk name. - * @member {array} [encryptionSettings] Specifies the encryption settings for - * the OS Disk.

    Minimum api-version: 2015-06-15 - * @member {array} [statuses] The resource status information. - */ +*/ export interface DiskInstanceView { + /** + * The disk name. + */ name?: string; + /** + * Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 + */ encryptionSettings?: DiskEncryptionSettings[]; + /** + * The resource status information. + */ statuses?: InstanceViewStatus[]; } /** - * @class - * Initializes a new instance of the BootDiagnosticsInstanceView class. - * @constructor * The instance view of a virtual machine boot diagnostics. - * - * @member {string} [consoleScreenshotBlobUri] The console screenshot blob URI. - * @member {string} [serialConsoleLogBlobUri] The Linux serial console log blob - * Uri. - * @member {object} [status] The boot diagnostics status information for the - * VM.

    NOTE: It will be set only if there are errors encountered in - * enabling boot diagnostics. - * @member {string} [status.code] The status code. - * @member {string} [status.level] The level code. Possible values include: - * 'Info', 'Warning', 'Error' - * @member {string} [status.displayStatus] The short localizable label for the - * status. - * @member {string} [status.message] The detailed status message, including for - * alerts and error messages. - * @member {date} [status.time] The time of the status. - */ +*/ export interface BootDiagnosticsInstanceView { + /** + * The console screenshot blob URI. + */ readonly consoleScreenshotBlobUri?: string; + /** + * The Linux serial console log blob Uri. + */ readonly serialConsoleLogBlobUri?: string; + /** + * The boot diagnostics status information for the VM.

    NOTE: It will be set only if + * there are errors encountered in enabling boot diagnostics. + */ readonly status?: InstanceViewStatus; } -/** - * @class - * Initializes a new instance of the VirtualMachineIdentityUserAssignedIdentitiesValue class. - * @constructor - * @member {string} [principalId] The principal id of user assigned identity. - * @member {string} [clientId] The client id of user assigned identity. - */ export interface VirtualMachineIdentityUserAssignedIdentitiesValue { + /** + * The principal id of user assigned identity. + */ readonly principalId?: string; + /** + * The client id of user assigned identity. + */ readonly clientId?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineIdentity class. - * @constructor * Identity for the virtual machine. - * - * @member {string} [principalId] The principal id of virtual machine identity. - * This property will only be provided for a system assigned identity. - * @member {string} [tenantId] The tenant id associated with the virtual - * machine. This property will only be provided for a system assigned identity. - * @member {string} [type] The type of identity used for the virtual machine. - * The type 'SystemAssigned, UserAssigned' includes both an implicitly created - * identity and a set of user assigned identities. The type 'None' will remove - * any identities from the virtual machine. Possible values include: - * 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' - * @member {object} [userAssignedIdentities] The list of user identities - * associated with the Virtual Machine. The user identity dictionary key - * references will be ARM resource ids in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - */ +*/ export interface VirtualMachineIdentity { + /** + * The principal id of virtual machine identity. This property will only be provided for a system + * assigned identity. + */ readonly principalId?: string; + /** + * The tenant id associated with the virtual machine. This property will only be provided for a + * system assigned identity. + */ readonly tenantId?: string; + /** + * The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' + * includes both an implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values include: + * 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + */ type?: string; - userAssignedIdentities?: { [propertyName: string]: VirtualMachineIdentityUserAssignedIdentitiesValue }; + /** + * The list of user identities associated with the Virtual Machine. The user identity dictionary + * key references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + */ + userAssignedIdentities?: { [propertyName: string]: + VirtualMachineIdentityUserAssignedIdentitiesValue }; } /** - * @class - * Initializes a new instance of the MaintenanceRedeployStatus class. - * @constructor * Maintenance Operation Status. - * - * @member {boolean} [isCustomerInitiatedMaintenanceAllowed] True, if customer - * is allowed to perform Maintenance. - * @member {date} [preMaintenanceWindowStartTime] Start Time for the Pre - * Maintenance Window. - * @member {date} [preMaintenanceWindowEndTime] End Time for the Pre - * Maintenance Window. - * @member {date} [maintenanceWindowStartTime] Start Time for the Maintenance - * Window. - * @member {date} [maintenanceWindowEndTime] End Time for the Maintenance - * Window. - * @member {string} [lastOperationResultCode] The Last Maintenance Operation - * Result Code. Possible values include: 'None', 'RetryLater', - * 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} [lastOperationMessage] Message returned for the last - * Maintenance Operation. - */ +*/ export interface MaintenanceRedeployStatus { + /** + * True, if customer is allowed to perform Maintenance. + */ isCustomerInitiatedMaintenanceAllowed?: boolean; + /** + * Start Time for the Pre Maintenance Window. + */ preMaintenanceWindowStartTime?: Date; + /** + * End Time for the Pre Maintenance Window. + */ preMaintenanceWindowEndTime?: Date; + /** + * Start Time for the Maintenance Window. + */ maintenanceWindowStartTime?: Date; + /** + * End Time for the Maintenance Window. + */ maintenanceWindowEndTime?: Date; + /** + * The Last Maintenance Operation Result Code. Possible values include: 'None', 'RetryLater', + * 'MaintenanceAborted', 'MaintenanceCompleted' + */ lastOperationResultCode?: string; + /** + * Message returned for the last Maintenance Operation. + */ lastOperationMessage?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineInstanceView class. - * @constructor * The instance view of a virtual machine. - * - * @member {number} [platformUpdateDomain] Specifies the update domain of the - * virtual machine. - * @member {number} [platformFaultDomain] Specifies the fault domain of the - * virtual machine. - * @member {string} [computerName] The computer name assigned to the virtual - * machine. - * @member {string} [osName] The Operating System running on the virtual - * machine. - * @member {string} [osVersion] The version of Operating System running on the - * virtual machine. - * @member {string} [rdpThumbPrint] The Remote desktop certificate thumbprint. - * @member {object} [vmAgent] The VM Agent running on the virtual machine. - * @member {string} [vmAgent.vmAgentVersion] The VM Agent full version. - * @member {array} [vmAgent.extensionHandlers] The virtual machine extension - * handler instance view. - * @member {array} [vmAgent.statuses] The resource status information. - * @member {object} [maintenanceRedeployStatus] The Maintenance Operation - * status on the virtual machine. - * @member {boolean} - * [maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] True, if - * customer is allowed to perform Maintenance. - * @member {date} [maintenanceRedeployStatus.preMaintenanceWindowStartTime] - * Start Time for the Pre Maintenance Window. - * @member {date} [maintenanceRedeployStatus.preMaintenanceWindowEndTime] End - * Time for the Pre Maintenance Window. - * @member {date} [maintenanceRedeployStatus.maintenanceWindowStartTime] Start - * Time for the Maintenance Window. - * @member {date} [maintenanceRedeployStatus.maintenanceWindowEndTime] End Time - * for the Maintenance Window. - * @member {string} [maintenanceRedeployStatus.lastOperationResultCode] The - * Last Maintenance Operation Result Code. Possible values include: 'None', - * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} [maintenanceRedeployStatus.lastOperationMessage] Message - * returned for the last Maintenance Operation. - * @member {array} [disks] The virtual machine disk information. - * @member {array} [extensions] The extensions information. - * @member {object} [bootDiagnostics] Boot Diagnostics is a debugging feature - * which allows you to view Console Output and Screenshot to diagnose VM - * status.

    You can easily view the output of your console log. - *

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {string} [bootDiagnostics.consoleScreenshotBlobUri] The console - * screenshot blob URI. - * @member {string} [bootDiagnostics.serialConsoleLogBlobUri] The Linux serial - * console log blob Uri. - * @member {object} [bootDiagnostics.status] The boot diagnostics status - * information for the VM.

    NOTE: It will be set only if there are - * errors encountered in enabling boot diagnostics. - * @member {string} [bootDiagnostics.status.code] The status code. - * @member {string} [bootDiagnostics.status.level] The level code. Possible - * values include: 'Info', 'Warning', 'Error' - * @member {string} [bootDiagnostics.status.displayStatus] The short - * localizable label for the status. - * @member {string} [bootDiagnostics.status.message] The detailed status - * message, including for alerts and error messages. - * @member {date} [bootDiagnostics.status.time] The time of the status. - * @member {array} [statuses] The resource status information. - */ +*/ export interface VirtualMachineInstanceView { + /** + * Specifies the update domain of the virtual machine. + */ platformUpdateDomain?: number; + /** + * Specifies the fault domain of the virtual machine. + */ platformFaultDomain?: number; + /** + * The computer name assigned to the virtual machine. + */ computerName?: string; + /** + * The Operating System running on the virtual machine. + */ osName?: string; + /** + * The version of Operating System running on the virtual machine. + */ osVersion?: string; + /** + * The Remote desktop certificate thumbprint. + */ rdpThumbPrint?: string; + /** + * The VM Agent running on the virtual machine. + */ vmAgent?: VirtualMachineAgentInstanceView; + /** + * The Maintenance Operation status on the virtual machine. + */ maintenanceRedeployStatus?: MaintenanceRedeployStatus; + /** + * The virtual machine disk information. + */ disks?: DiskInstanceView[]; + /** + * The extensions information. + */ extensions?: VirtualMachineExtensionInstanceView[]; + /** + * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot + * to diagnose VM status.

    You can easily view the output of your console log.

    + * Azure also enables you to see a screenshot of the VM from the hypervisor. + */ bootDiagnostics?: BootDiagnosticsInstanceView; + /** + * The resource status information. + */ statuses?: InstanceViewStatus[]; } /** - * @class - * Initializes a new instance of the VirtualMachine class. - * @constructor * Describes a Virtual Machine. - * - * @member {object} [plan] Specifies information about the marketplace image - * used to create the virtual machine. This element is only used for - * marketplace images. Before you can use a marketplace image from an API, you - * must enable the image for programmatic use. In the Azure portal, find the - * marketplace image that you want to use and then click **Want to deploy - * programmatically, Get Started ->**. Enter any required information and then - * click **Save**. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from the - * marketplace. This is the same value as Offer under the imageReference - * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {object} [hardwareProfile] Specifies the hardware settings for the - * virtual machine. - * @member {string} [hardwareProfile.vmSize] Specifies the size of the virtual - * machine. For more information about virtual machine sizes, see [Sizes for - * virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    The available VM sizes depend on region and availability set. For a - * list of available sizes use these APIs:

    [List all available - * virtual machine sizes in an availability - * set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) - *

    [List all available virtual machine sizes in a - * region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list) - *

    [List all available virtual machine sizes for - * resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). - * Possible values include: 'Basic_A0', 'Basic_A1', 'Basic_A2', 'Basic_A3', - * 'Basic_A4', 'Standard_A0', 'Standard_A1', 'Standard_A2', 'Standard_A3', - * 'Standard_A4', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', - * 'Standard_A9', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', - * 'Standard_A2_v2', 'Standard_A4_v2', 'Standard_A8_v2', 'Standard_A2m_v2', - * 'Standard_A4m_v2', 'Standard_A8m_v2', 'Standard_B1s', 'Standard_B1ms', - * 'Standard_B2s', 'Standard_B2ms', 'Standard_B4ms', 'Standard_B8ms', - * 'Standard_D1', 'Standard_D2', 'Standard_D3', 'Standard_D4', 'Standard_D11', - * 'Standard_D12', 'Standard_D13', 'Standard_D14', 'Standard_D1_v2', - * 'Standard_D2_v2', 'Standard_D3_v2', 'Standard_D4_v2', 'Standard_D5_v2', - * 'Standard_D2_v3', 'Standard_D4_v3', 'Standard_D8_v3', 'Standard_D16_v3', - * 'Standard_D32_v3', 'Standard_D64_v3', 'Standard_D2s_v3', 'Standard_D4s_v3', - * 'Standard_D8s_v3', 'Standard_D16s_v3', 'Standard_D32s_v3', - * 'Standard_D64s_v3', 'Standard_D11_v2', 'Standard_D12_v2', 'Standard_D13_v2', - * 'Standard_D14_v2', 'Standard_D15_v2', 'Standard_DS1', 'Standard_DS2', - * 'Standard_DS3', 'Standard_DS4', 'Standard_DS11', 'Standard_DS12', - * 'Standard_DS13', 'Standard_DS14', 'Standard_DS1_v2', 'Standard_DS2_v2', - * 'Standard_DS3_v2', 'Standard_DS4_v2', 'Standard_DS5_v2', 'Standard_DS11_v2', - * 'Standard_DS12_v2', 'Standard_DS13_v2', 'Standard_DS14_v2', - * 'Standard_DS15_v2', 'Standard_DS13-4_v2', 'Standard_DS13-2_v2', - * 'Standard_DS14-8_v2', 'Standard_DS14-4_v2', 'Standard_E2_v3', - * 'Standard_E4_v3', 'Standard_E8_v3', 'Standard_E16_v3', 'Standard_E32_v3', - * 'Standard_E64_v3', 'Standard_E2s_v3', 'Standard_E4s_v3', 'Standard_E8s_v3', - * 'Standard_E16s_v3', 'Standard_E32s_v3', 'Standard_E64s_v3', - * 'Standard_E32-16_v3', 'Standard_E32-8s_v3', 'Standard_E64-32s_v3', - * 'Standard_E64-16s_v3', 'Standard_F1', 'Standard_F2', 'Standard_F4', - * 'Standard_F8', 'Standard_F16', 'Standard_F1s', 'Standard_F2s', - * 'Standard_F4s', 'Standard_F8s', 'Standard_F16s', 'Standard_F2s_v2', - * 'Standard_F4s_v2', 'Standard_F8s_v2', 'Standard_F16s_v2', - * 'Standard_F32s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_G1', - * 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', - * 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS5', - * 'Standard_GS4-8', 'Standard_GS4-4', 'Standard_GS5-16', 'Standard_GS5-8', - * 'Standard_H8', 'Standard_H16', 'Standard_H8m', 'Standard_H16m', - * 'Standard_H16r', 'Standard_H16mr', 'Standard_L4s', 'Standard_L8s', - * 'Standard_L16s', 'Standard_L32s', 'Standard_M64s', 'Standard_M64ms', - * 'Standard_M128s', 'Standard_M128ms', 'Standard_M64-32ms', - * 'Standard_M64-16ms', 'Standard_M128-64ms', 'Standard_M128-32ms', - * 'Standard_NC6', 'Standard_NC12', 'Standard_NC24', 'Standard_NC24r', - * 'Standard_NC6s_v2', 'Standard_NC12s_v2', 'Standard_NC24s_v2', - * 'Standard_NC24rs_v2', 'Standard_NC6s_v3', 'Standard_NC12s_v3', - * 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', - * 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', - * 'Standard_NV12', 'Standard_NV24' - * @member {object} [storageProfile] Specifies the storage settings for the - * virtual machine disks. - * @member {object} [storageProfile.imageReference] Specifies information about - * the image to use. You can specify information about platform images, - * marketplace images, or virtual machine images. This element is required when - * you want to use a platform image, marketplace image, or virtual machine - * image, but is not used in other creation operations. - * @member {string} [storageProfile.imageReference.publisher] The image - * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the - * version of the platform image or marketplace image used to create the - * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. - * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the - * latest version of an image available at deploy time. Even if you use - * 'latest', the VM image will not automatically update after deploy time even - * if a new version becomes available. - * @member {object} [storageProfile.osDisk] Specifies information about the - * operating system disk used by the virtual machine.

    For more - * information about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you to - * specify the type of the OS that is included in the disk if creating a VM - * from user-image or a specialized VHD.

    Possible values are:

    - * **Windows**

    **Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [storageProfile.osDisk.encryptionSettings] Specifies the - * encryption settings for the OS Disk.

    Minimum api-version: - * 2015-06-15 - * @member {object} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey] Specifies the - * location of the disk encryption key, which is a Key Vault Secret. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.secretUrl] The - * URL referencing a secret in a Key Vault. - * @member {object} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault] The - * relative URL of the Key Vault containing the secret. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {object} [storageProfile.osDisk.encryptionSettings.keyEncryptionKey] - * Specifies the location of the key encryption key in Key Vault. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.keyUrl] The URL - * referencing a key encryption key in Key Vault. - * @member {object} - * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault] The - * relative URL of the Key Vault containing the key. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {boolean} [storageProfile.osDisk.encryptionSettings.enabled] - * Specifies whether disk encryption should be enabled on the virtual machine. - * @member {string} [storageProfile.osDisk.name] The disk name. - * @member {object} [storageProfile.osDisk.vhd] The virtual hard disk. - * @member {string} [storageProfile.osDisk.vhd.uri] Specifies the virtual hard - * disk's uri. - * @member {object} [storageProfile.osDisk.image] The source user image virtual - * hard disk. The virtual hard disk will be copied before being attached to the - * virtual machine. If SourceImage is provided, the destination virtual hard - * drive must not exist. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual - * hard disk's uri. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching - * requirements.

    Possible values are:

    **None**

    - * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard - * storage. ReadOnly for Premium storage**. Possible values include: 'None', - * 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] Specifies - * whether writeAccelerator should be enabled or disabled on the disk. - * @member {object} [storageProfile.osDisk.diffDiskSettings] Specifies the - * differencing Disk Settings for the operating system disk used by the virtual - * machine. - * @member {string} [storageProfile.osDisk.diffDiskSettings.option] Specifies - * the differencing disk settings for operating system disk. Possible values - * include: 'Local' - * @member {string} [storageProfile.osDisk.createOption] Specifies how the - * virtual machine should be created.

    Possible values are:

    - * **Attach** \u2013 This value is used when you are using a specialized disk - * to create the virtual machine.

    **FromImage** \u2013 This value is - * used when you are using an image to create the virtual machine. If you are - * using a platform image, you also use the imageReference element described - * above. If you are using a marketplace image, you also use the plan element - * previously described. Possible values include: 'FromImage', 'Empty', - * 'Attach' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of an - * empty data disk in gigabytes. This element can be used to overwrite the size - * of the disk in a virtual machine image.

    This value cannot be larger - * than 1023 GB - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk - * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS - * can only be used with data disks, it cannot be used with OS Disk. Possible - * values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', - * 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that are - * used to add a data disk to a virtual machine.

    For more information - * about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [additionalCapabilities] Specifies additional capabilities - * enabled or disabled on the virtual machine. - * @member {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that - * enables or disables a capability to have one or more managed data disks with - * UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with - * storage account type UltraSSD_LRS can be added to a virtual machine or - * virtual machine scale set only if this property is enabled. - * @member {object} [osProfile] Specifies the operating system settings for the - * virtual machine. - * @member {string} [osProfile.computerName] Specifies the host OS name of the - * virtual machine.

    **Max-length (Windows):** 15 characters

    - * **Max-length (Linux):** 64 characters.

    For naming conventions and - * restrictions see [Azure infrastructure services implementation - * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). - * @member {string} [osProfile.adminUsername] Specifies the name of the - * administrator account.

    **Windows-only restriction:** Cannot end in - * "."

    **Disallowed values:** "administrator", "admin", "user", - * "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", - * "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", - * "john", "owner", "root", "server", "sql", "support", "support_388945a0", - * "sys", "test2", "test3", "user4", "user5".

    **Minimum-length - * (Linux):** 1 character

    **Max-length (Linux):** 64 characters - *

    **Max-length (Windows):** 20 characters

  • For root - * access to the Linux VM, see [Using root privileges on Linux virtual machines - * in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • - * For a list of built-in system users on Linux that should not be used in this - * field, see [Selecting User Names for Linux on - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [osProfile.adminPassword] Specifies the password of the - * administrator account.

    **Minimum-length (Windows):** 8 characters - *

    **Minimum-length (Linux):** 6 characters

    **Max-length - * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters - *

    **Complexity requirements:** 3 out of 4 conditions below need to be - * fulfilled
    Has lower characters
    Has upper characters
    Has a - * digit
    Has a special character (Regex match [\W_])

    **Disallowed - * values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", - * "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    - * For resetting the password, see [How to reset the Remote Desktop service or - * its login password in a Windows - * VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    For resetting root password, see [Manage users, SSH, and check or - * repair disks on Azure Linux VMs using the VMAccess - * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [osProfile.customData] Specifies a base-64 encoded string - * of custom data. The base-64 encoded string is decoded to a binary array that - * is saved as a file on the Virtual Machine. The maximum length of the binary - * array is 65535 bytes.

    For using cloud-init for your VM, see [Using - * cloud-init to customize a Linux VM during - * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [osProfile.windowsConfiguration] Specifies Windows - * operating system settings on the virtual machine. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] - * Indicates whether virtual machine agent should be provisioned on the virtual - * machine.

    When this property is not specified in the request body, - * default behavior is to set it to true. This will ensure that VM Agent is - * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the - * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the - * Windows Remote Management listeners. This enables remote Windows PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list of - * Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] Specifies the Linux - * operating system settings on the virtual machine.

    For a list of - * supported Linux distributions, see [Linux on Azure-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - *

    For running non-endorsed distributions, see [Information for - * Non-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} - * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies - * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] Indicates - * whether virtual machine agent should be provisioned on the virtual machine. - *

    When this property is not specified in the request body, default - * behavior is to set it to true. This will ensure that VM Agent is installed - * on the VM so that extensions can be added to the VM later. - * @member {array} [osProfile.secrets] Specifies set of certificates that - * should be installed onto the virtual machine. - * @member {boolean} [osProfile.allowExtensionOperations] Specifies whether - * extension operations should be allowed on the virtual machine.

    This - * may only be set to False when no extensions are present on the virtual - * machine. - * @member {object} [networkProfile] Specifies the network interfaces of the - * virtual machine. - * @member {array} [networkProfile.networkInterfaces] Specifies the list of - * resource Ids for the network interfaces associated with the virtual machine. - * @member {object} [diagnosticsProfile] Specifies the boot diagnostic settings - * state.

    Minimum api-version: 2015-06-15. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is a - * debugging feature which allows you to view Console Output and Screenshot to - * diagnose VM status.

    You can easily view the output of your console - * log.

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether boot - * diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of the - * storage account to use for placing the console output and screenshot. - * @member {object} [availabilitySet] Specifies information about the - * availability set that the virtual machine should be assigned to. Virtual - * machines specified in the same availability set are allocated to different - * nodes to maximize availability. For more information about availability - * sets, see [Manage the availability of virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned - * maintenance for virtual machines in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    Currently, a VM can only be added to availability set at creation - * time. An existing VM cannot be added to an availability set. - * @member {string} [availabilitySet.id] Resource Id - * @member {string} [provisioningState] The provisioning state, which only - * appears in the response. - * @member {object} [instanceView] The virtual machine instance view. - * @member {number} [instanceView.platformUpdateDomain] Specifies the update - * domain of the virtual machine. - * @member {number} [instanceView.platformFaultDomain] Specifies the fault - * domain of the virtual machine. - * @member {string} [instanceView.computerName] The computer name assigned to - * the virtual machine. - * @member {string} [instanceView.osName] The Operating System running on the - * virtual machine. - * @member {string} [instanceView.osVersion] The version of Operating System - * running on the virtual machine. - * @member {string} [instanceView.rdpThumbPrint] The Remote desktop certificate - * thumbprint. - * @member {object} [instanceView.vmAgent] The VM Agent running on the virtual - * machine. - * @member {string} [instanceView.vmAgent.vmAgentVersion] The VM Agent full - * version. - * @member {array} [instanceView.vmAgent.extensionHandlers] The virtual machine - * extension handler instance view. - * @member {array} [instanceView.vmAgent.statuses] The resource status - * information. - * @member {object} [instanceView.maintenanceRedeployStatus] The Maintenance - * Operation status on the virtual machine. - * @member {boolean} - * [instanceView.maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] - * True, if customer is allowed to perform Maintenance. - * @member {date} - * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowStartTime] Start - * Time for the Pre Maintenance Window. - * @member {date} - * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowEndTime] End - * Time for the Pre Maintenance Window. - * @member {date} - * [instanceView.maintenanceRedeployStatus.maintenanceWindowStartTime] Start - * Time for the Maintenance Window. - * @member {date} - * [instanceView.maintenanceRedeployStatus.maintenanceWindowEndTime] End Time - * for the Maintenance Window. - * @member {string} - * [instanceView.maintenanceRedeployStatus.lastOperationResultCode] The Last - * Maintenance Operation Result Code. Possible values include: 'None', - * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} - * [instanceView.maintenanceRedeployStatus.lastOperationMessage] Message - * returned for the last Maintenance Operation. - * @member {array} [instanceView.disks] The virtual machine disk information. - * @member {array} [instanceView.extensions] The extensions information. - * @member {object} [instanceView.bootDiagnostics] Boot Diagnostics is a - * debugging feature which allows you to view Console Output and Screenshot to - * diagnose VM status.

    You can easily view the output of your console - * log.

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {string} [instanceView.bootDiagnostics.consoleScreenshotBlobUri] The - * console screenshot blob URI. - * @member {string} [instanceView.bootDiagnostics.serialConsoleLogBlobUri] The - * Linux serial console log blob Uri. - * @member {object} [instanceView.bootDiagnostics.status] The boot diagnostics - * status information for the VM.

    NOTE: It will be set only if there - * are errors encountered in enabling boot diagnostics. - * @member {string} [instanceView.bootDiagnostics.status.code] The status code. - * @member {string} [instanceView.bootDiagnostics.status.level] The level code. - * Possible values include: 'Info', 'Warning', 'Error' - * @member {string} [instanceView.bootDiagnostics.status.displayStatus] The - * short localizable label for the status. - * @member {string} [instanceView.bootDiagnostics.status.message] The detailed - * status message, including for alerts and error messages. - * @member {date} [instanceView.bootDiagnostics.status.time] The time of the - * status. - * @member {array} [instanceView.statuses] The resource status information. - * @member {string} [licenseType] Specifies that the image or disk that is - * being used was licensed on-premises. This element is only used for images - * that contain the Windows Server operating system.

    Possible values - * are:

    Windows_Client

    Windows_Server

    If this - * element is included in a request for an update, the value must match the - * initial value. This value cannot be updated.

    For more information, - * see [Azure Hybrid Use Benefit for Windows - * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    Minimum api-version: 2015-06-15 - * @member {string} [vmId] Specifies the VM unique ID which is a 128-bits - * identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can - * be read using platform BIOS commands. - * @member {array} [resources] The virtual machine child extension resources. - * @member {object} [identity] The identity of the virtual machine, if - * configured. - * @member {string} [identity.principalId] The principal id of virtual machine - * identity. This property will only be provided for a system assigned - * identity. - * @member {string} [identity.tenantId] The tenant id associated with the - * virtual machine. This property will only be provided for a system assigned - * identity. - * @member {string} [identity.type] The type of identity used for the virtual - * machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly - * created identity and a set of user assigned identities. The type 'None' will - * remove any identities from the virtual machine. Possible values include: - * 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user - * identities associated with the Virtual Machine. The user identity dictionary - * key references will be ARM resource ids in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - * @member {array} [zones] The virtual machine zones. - */ +*/ export interface VirtualMachine extends Resource { + /** + * Specifies information about the marketplace image used to create the virtual machine. This + * element is only used for marketplace images. Before you can use a marketplace image from an + * API, you must enable the image for programmatic use. In the Azure portal, find the + * marketplace image that you want to use and then click **Want to deploy programmatically, Get + * Started ->**. Enter any required information and then click **Save**. + */ plan?: Plan; + /** + * Specifies the hardware settings for the virtual machine. + */ hardwareProfile?: HardwareProfile; + /** + * Specifies the storage settings for the virtual machine disks. + */ storageProfile?: StorageProfile; + /** + * Specifies additional capabilities enabled or disabled on the virtual machine. + */ additionalCapabilities?: AdditionalCapabilities; + /** + * Specifies the operating system settings for the virtual machine. + */ osProfile?: OSProfile; + /** + * Specifies the network interfaces of the virtual machine. + */ networkProfile?: NetworkProfile; + /** + * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. + */ diagnosticsProfile?: DiagnosticsProfile; + /** + * Specifies information about the availability set that the virtual machine should be assigned + * to. Virtual machines specified in the same availability set are allocated to different nodes + * to maximize availability. For more information about availability sets, see [Manage the + * availability of virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + *

    For more information on Azure planned maintenance, see [Planned maintenance for + * virtual machines in + * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) + *

    Currently, a VM can only be added to availability set at creation time. An existing + * VM cannot be added to an availability set. + */ availabilitySet?: SubResource; + /** + * The provisioning state, which only appears in the response. + */ readonly provisioningState?: string; + /** + * The virtual machine instance view. + */ readonly instanceView?: VirtualMachineInstanceView; + /** + * Specifies that the image or disk that is being used was licensed on-premises. This element is + * only used for images that contain the Windows Server operating system.

    Possible + * values are:

    Windows_Client

    Windows_Server

    If this element is + * included in a request for an update, the value must match the initial value. This value cannot + * be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows + * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) + *

    Minimum api-version: 2015-06-15 + */ licenseType?: string; + /** + * Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all + * Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. + */ readonly vmId?: string; + /** + * The virtual machine child extension resources. + */ readonly resources?: VirtualMachineExtension[]; + /** + * The identity of the virtual machine, if configured. + */ identity?: VirtualMachineIdentity; + /** + * The virtual machine zones. + */ zones?: string[]; } /** - * @class - * Initializes a new instance of the VirtualMachineUpdate class. - * @constructor * Describes a Virtual Machine Update. - * - * @member {object} [plan] Specifies information about the marketplace image - * used to create the virtual machine. This element is only used for - * marketplace images. Before you can use a marketplace image from an API, you - * must enable the image for programmatic use. In the Azure portal, find the - * marketplace image that you want to use and then click **Want to deploy - * programmatically, Get Started ->**. Enter any required information and then - * click **Save**. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from the - * marketplace. This is the same value as Offer under the imageReference - * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {object} [hardwareProfile] Specifies the hardware settings for the - * virtual machine. - * @member {string} [hardwareProfile.vmSize] Specifies the size of the virtual - * machine. For more information about virtual machine sizes, see [Sizes for - * virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    The available VM sizes depend on region and availability set. For a - * list of available sizes use these APIs:

    [List all available - * virtual machine sizes in an availability - * set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) - *

    [List all available virtual machine sizes in a - * region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list) - *

    [List all available virtual machine sizes for - * resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). - * Possible values include: 'Basic_A0', 'Basic_A1', 'Basic_A2', 'Basic_A3', - * 'Basic_A4', 'Standard_A0', 'Standard_A1', 'Standard_A2', 'Standard_A3', - * 'Standard_A4', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', - * 'Standard_A9', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', - * 'Standard_A2_v2', 'Standard_A4_v2', 'Standard_A8_v2', 'Standard_A2m_v2', - * 'Standard_A4m_v2', 'Standard_A8m_v2', 'Standard_B1s', 'Standard_B1ms', - * 'Standard_B2s', 'Standard_B2ms', 'Standard_B4ms', 'Standard_B8ms', - * 'Standard_D1', 'Standard_D2', 'Standard_D3', 'Standard_D4', 'Standard_D11', - * 'Standard_D12', 'Standard_D13', 'Standard_D14', 'Standard_D1_v2', - * 'Standard_D2_v2', 'Standard_D3_v2', 'Standard_D4_v2', 'Standard_D5_v2', - * 'Standard_D2_v3', 'Standard_D4_v3', 'Standard_D8_v3', 'Standard_D16_v3', - * 'Standard_D32_v3', 'Standard_D64_v3', 'Standard_D2s_v3', 'Standard_D4s_v3', - * 'Standard_D8s_v3', 'Standard_D16s_v3', 'Standard_D32s_v3', - * 'Standard_D64s_v3', 'Standard_D11_v2', 'Standard_D12_v2', 'Standard_D13_v2', - * 'Standard_D14_v2', 'Standard_D15_v2', 'Standard_DS1', 'Standard_DS2', - * 'Standard_DS3', 'Standard_DS4', 'Standard_DS11', 'Standard_DS12', - * 'Standard_DS13', 'Standard_DS14', 'Standard_DS1_v2', 'Standard_DS2_v2', - * 'Standard_DS3_v2', 'Standard_DS4_v2', 'Standard_DS5_v2', 'Standard_DS11_v2', - * 'Standard_DS12_v2', 'Standard_DS13_v2', 'Standard_DS14_v2', - * 'Standard_DS15_v2', 'Standard_DS13-4_v2', 'Standard_DS13-2_v2', - * 'Standard_DS14-8_v2', 'Standard_DS14-4_v2', 'Standard_E2_v3', - * 'Standard_E4_v3', 'Standard_E8_v3', 'Standard_E16_v3', 'Standard_E32_v3', - * 'Standard_E64_v3', 'Standard_E2s_v3', 'Standard_E4s_v3', 'Standard_E8s_v3', - * 'Standard_E16s_v3', 'Standard_E32s_v3', 'Standard_E64s_v3', - * 'Standard_E32-16_v3', 'Standard_E32-8s_v3', 'Standard_E64-32s_v3', - * 'Standard_E64-16s_v3', 'Standard_F1', 'Standard_F2', 'Standard_F4', - * 'Standard_F8', 'Standard_F16', 'Standard_F1s', 'Standard_F2s', - * 'Standard_F4s', 'Standard_F8s', 'Standard_F16s', 'Standard_F2s_v2', - * 'Standard_F4s_v2', 'Standard_F8s_v2', 'Standard_F16s_v2', - * 'Standard_F32s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_G1', - * 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', - * 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS5', - * 'Standard_GS4-8', 'Standard_GS4-4', 'Standard_GS5-16', 'Standard_GS5-8', - * 'Standard_H8', 'Standard_H16', 'Standard_H8m', 'Standard_H16m', - * 'Standard_H16r', 'Standard_H16mr', 'Standard_L4s', 'Standard_L8s', - * 'Standard_L16s', 'Standard_L32s', 'Standard_M64s', 'Standard_M64ms', - * 'Standard_M128s', 'Standard_M128ms', 'Standard_M64-32ms', - * 'Standard_M64-16ms', 'Standard_M128-64ms', 'Standard_M128-32ms', - * 'Standard_NC6', 'Standard_NC12', 'Standard_NC24', 'Standard_NC24r', - * 'Standard_NC6s_v2', 'Standard_NC12s_v2', 'Standard_NC24s_v2', - * 'Standard_NC24rs_v2', 'Standard_NC6s_v3', 'Standard_NC12s_v3', - * 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', - * 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', - * 'Standard_NV12', 'Standard_NV24' - * @member {object} [storageProfile] Specifies the storage settings for the - * virtual machine disks. - * @member {object} [storageProfile.imageReference] Specifies information about - * the image to use. You can specify information about platform images, - * marketplace images, or virtual machine images. This element is required when - * you want to use a platform image, marketplace image, or virtual machine - * image, but is not used in other creation operations. - * @member {string} [storageProfile.imageReference.publisher] The image - * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the - * version of the platform image or marketplace image used to create the - * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. - * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the - * latest version of an image available at deploy time. Even if you use - * 'latest', the VM image will not automatically update after deploy time even - * if a new version becomes available. - * @member {object} [storageProfile.osDisk] Specifies information about the - * operating system disk used by the virtual machine.

    For more - * information about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you to - * specify the type of the OS that is included in the disk if creating a VM - * from user-image or a specialized VHD.

    Possible values are:

    - * **Windows**

    **Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [storageProfile.osDisk.encryptionSettings] Specifies the - * encryption settings for the OS Disk.

    Minimum api-version: - * 2015-06-15 - * @member {object} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey] Specifies the - * location of the disk encryption key, which is a Key Vault Secret. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.secretUrl] The - * URL referencing a secret in a Key Vault. - * @member {object} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault] The - * relative URL of the Key Vault containing the secret. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {object} [storageProfile.osDisk.encryptionSettings.keyEncryptionKey] - * Specifies the location of the key encryption key in Key Vault. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.keyUrl] The URL - * referencing a key encryption key in Key Vault. - * @member {object} - * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault] The - * relative URL of the Key Vault containing the key. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {boolean} [storageProfile.osDisk.encryptionSettings.enabled] - * Specifies whether disk encryption should be enabled on the virtual machine. - * @member {string} [storageProfile.osDisk.name] The disk name. - * @member {object} [storageProfile.osDisk.vhd] The virtual hard disk. - * @member {string} [storageProfile.osDisk.vhd.uri] Specifies the virtual hard - * disk's uri. - * @member {object} [storageProfile.osDisk.image] The source user image virtual - * hard disk. The virtual hard disk will be copied before being attached to the - * virtual machine. If SourceImage is provided, the destination virtual hard - * drive must not exist. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual - * hard disk's uri. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching - * requirements.

    Possible values are:

    **None**

    - * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard - * storage. ReadOnly for Premium storage**. Possible values include: 'None', - * 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] Specifies - * whether writeAccelerator should be enabled or disabled on the disk. - * @member {object} [storageProfile.osDisk.diffDiskSettings] Specifies the - * differencing Disk Settings for the operating system disk used by the virtual - * machine. - * @member {string} [storageProfile.osDisk.diffDiskSettings.option] Specifies - * the differencing disk settings for operating system disk. Possible values - * include: 'Local' - * @member {string} [storageProfile.osDisk.createOption] Specifies how the - * virtual machine should be created.

    Possible values are:

    - * **Attach** \u2013 This value is used when you are using a specialized disk - * to create the virtual machine.

    **FromImage** \u2013 This value is - * used when you are using an image to create the virtual machine. If you are - * using a platform image, you also use the imageReference element described - * above. If you are using a marketplace image, you also use the plan element - * previously described. Possible values include: 'FromImage', 'Empty', - * 'Attach' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of an - * empty data disk in gigabytes. This element can be used to overwrite the size - * of the disk in a virtual machine image.

    This value cannot be larger - * than 1023 GB - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk - * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS - * can only be used with data disks, it cannot be used with OS Disk. Possible - * values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', - * 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that are - * used to add a data disk to a virtual machine.

    For more information - * about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [additionalCapabilities] Specifies additional capabilities - * enabled or disabled on the virtual machine. - * @member {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that - * enables or disables a capability to have one or more managed data disks with - * UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with - * storage account type UltraSSD_LRS can be added to a virtual machine or - * virtual machine scale set only if this property is enabled. - * @member {object} [osProfile] Specifies the operating system settings for the - * virtual machine. - * @member {string} [osProfile.computerName] Specifies the host OS name of the - * virtual machine.

    **Max-length (Windows):** 15 characters

    - * **Max-length (Linux):** 64 characters.

    For naming conventions and - * restrictions see [Azure infrastructure services implementation - * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). - * @member {string} [osProfile.adminUsername] Specifies the name of the - * administrator account.

    **Windows-only restriction:** Cannot end in - * "."

    **Disallowed values:** "administrator", "admin", "user", - * "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", - * "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", - * "john", "owner", "root", "server", "sql", "support", "support_388945a0", - * "sys", "test2", "test3", "user4", "user5".

    **Minimum-length - * (Linux):** 1 character

    **Max-length (Linux):** 64 characters - *

    **Max-length (Windows):** 20 characters

  • For root - * access to the Linux VM, see [Using root privileges on Linux virtual machines - * in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • - * For a list of built-in system users on Linux that should not be used in this - * field, see [Selecting User Names for Linux on - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [osProfile.adminPassword] Specifies the password of the - * administrator account.

    **Minimum-length (Windows):** 8 characters - *

    **Minimum-length (Linux):** 6 characters

    **Max-length - * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters - *

    **Complexity requirements:** 3 out of 4 conditions below need to be - * fulfilled
    Has lower characters
    Has upper characters
    Has a - * digit
    Has a special character (Regex match [\W_])

    **Disallowed - * values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", - * "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    - * For resetting the password, see [How to reset the Remote Desktop service or - * its login password in a Windows - * VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    For resetting root password, see [Manage users, SSH, and check or - * repair disks on Azure Linux VMs using the VMAccess - * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [osProfile.customData] Specifies a base-64 encoded string - * of custom data. The base-64 encoded string is decoded to a binary array that - * is saved as a file on the Virtual Machine. The maximum length of the binary - * array is 65535 bytes.

    For using cloud-init for your VM, see [Using - * cloud-init to customize a Linux VM during - * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [osProfile.windowsConfiguration] Specifies Windows - * operating system settings on the virtual machine. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] - * Indicates whether virtual machine agent should be provisioned on the virtual - * machine.

    When this property is not specified in the request body, - * default behavior is to set it to true. This will ensure that VM Agent is - * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the - * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the - * Windows Remote Management listeners. This enables remote Windows PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list of - * Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] Specifies the Linux - * operating system settings on the virtual machine.

    For a list of - * supported Linux distributions, see [Linux on Azure-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - *

    For running non-endorsed distributions, see [Information for - * Non-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} - * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies - * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] Indicates - * whether virtual machine agent should be provisioned on the virtual machine. - *

    When this property is not specified in the request body, default - * behavior is to set it to true. This will ensure that VM Agent is installed - * on the VM so that extensions can be added to the VM later. - * @member {array} [osProfile.secrets] Specifies set of certificates that - * should be installed onto the virtual machine. - * @member {boolean} [osProfile.allowExtensionOperations] Specifies whether - * extension operations should be allowed on the virtual machine.

    This - * may only be set to False when no extensions are present on the virtual - * machine. - * @member {object} [networkProfile] Specifies the network interfaces of the - * virtual machine. - * @member {array} [networkProfile.networkInterfaces] Specifies the list of - * resource Ids for the network interfaces associated with the virtual machine. - * @member {object} [diagnosticsProfile] Specifies the boot diagnostic settings - * state.

    Minimum api-version: 2015-06-15. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is a - * debugging feature which allows you to view Console Output and Screenshot to - * diagnose VM status.

    You can easily view the output of your console - * log.

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether boot - * diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of the - * storage account to use for placing the console output and screenshot. - * @member {object} [availabilitySet] Specifies information about the - * availability set that the virtual machine should be assigned to. Virtual - * machines specified in the same availability set are allocated to different - * nodes to maximize availability. For more information about availability - * sets, see [Manage the availability of virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned - * maintenance for virtual machines in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    Currently, a VM can only be added to availability set at creation - * time. An existing VM cannot be added to an availability set. - * @member {string} [availabilitySet.id] Resource Id - * @member {string} [provisioningState] The provisioning state, which only - * appears in the response. - * @member {object} [instanceView] The virtual machine instance view. - * @member {number} [instanceView.platformUpdateDomain] Specifies the update - * domain of the virtual machine. - * @member {number} [instanceView.platformFaultDomain] Specifies the fault - * domain of the virtual machine. - * @member {string} [instanceView.computerName] The computer name assigned to - * the virtual machine. - * @member {string} [instanceView.osName] The Operating System running on the - * virtual machine. - * @member {string} [instanceView.osVersion] The version of Operating System - * running on the virtual machine. - * @member {string} [instanceView.rdpThumbPrint] The Remote desktop certificate - * thumbprint. - * @member {object} [instanceView.vmAgent] The VM Agent running on the virtual - * machine. - * @member {string} [instanceView.vmAgent.vmAgentVersion] The VM Agent full - * version. - * @member {array} [instanceView.vmAgent.extensionHandlers] The virtual machine - * extension handler instance view. - * @member {array} [instanceView.vmAgent.statuses] The resource status - * information. - * @member {object} [instanceView.maintenanceRedeployStatus] The Maintenance - * Operation status on the virtual machine. - * @member {boolean} - * [instanceView.maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] - * True, if customer is allowed to perform Maintenance. - * @member {date} - * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowStartTime] Start - * Time for the Pre Maintenance Window. - * @member {date} - * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowEndTime] End - * Time for the Pre Maintenance Window. - * @member {date} - * [instanceView.maintenanceRedeployStatus.maintenanceWindowStartTime] Start - * Time for the Maintenance Window. - * @member {date} - * [instanceView.maintenanceRedeployStatus.maintenanceWindowEndTime] End Time - * for the Maintenance Window. - * @member {string} - * [instanceView.maintenanceRedeployStatus.lastOperationResultCode] The Last - * Maintenance Operation Result Code. Possible values include: 'None', - * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} - * [instanceView.maintenanceRedeployStatus.lastOperationMessage] Message - * returned for the last Maintenance Operation. - * @member {array} [instanceView.disks] The virtual machine disk information. - * @member {array} [instanceView.extensions] The extensions information. - * @member {object} [instanceView.bootDiagnostics] Boot Diagnostics is a - * debugging feature which allows you to view Console Output and Screenshot to - * diagnose VM status.

    You can easily view the output of your console - * log.

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {string} [instanceView.bootDiagnostics.consoleScreenshotBlobUri] The - * console screenshot blob URI. - * @member {string} [instanceView.bootDiagnostics.serialConsoleLogBlobUri] The - * Linux serial console log blob Uri. - * @member {object} [instanceView.bootDiagnostics.status] The boot diagnostics - * status information for the VM.

    NOTE: It will be set only if there - * are errors encountered in enabling boot diagnostics. - * @member {string} [instanceView.bootDiagnostics.status.code] The status code. - * @member {string} [instanceView.bootDiagnostics.status.level] The level code. - * Possible values include: 'Info', 'Warning', 'Error' - * @member {string} [instanceView.bootDiagnostics.status.displayStatus] The - * short localizable label for the status. - * @member {string} [instanceView.bootDiagnostics.status.message] The detailed - * status message, including for alerts and error messages. - * @member {date} [instanceView.bootDiagnostics.status.time] The time of the - * status. - * @member {array} [instanceView.statuses] The resource status information. - * @member {string} [licenseType] Specifies that the image or disk that is - * being used was licensed on-premises. This element is only used for images - * that contain the Windows Server operating system.

    Possible values - * are:

    Windows_Client

    Windows_Server

    If this - * element is included in a request for an update, the value must match the - * initial value. This value cannot be updated.

    For more information, - * see [Azure Hybrid Use Benefit for Windows - * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    Minimum api-version: 2015-06-15 - * @member {string} [vmId] Specifies the VM unique ID which is a 128-bits - * identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can - * be read using platform BIOS commands. - * @member {object} [identity] The identity of the virtual machine, if - * configured. - * @member {string} [identity.principalId] The principal id of virtual machine - * identity. This property will only be provided for a system assigned - * identity. - * @member {string} [identity.tenantId] The tenant id associated with the - * virtual machine. This property will only be provided for a system assigned - * identity. - * @member {string} [identity.type] The type of identity used for the virtual - * machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly - * created identity and a set of user assigned identities. The type 'None' will - * remove any identities from the virtual machine. Possible values include: - * 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user - * identities associated with the Virtual Machine. The user identity dictionary - * key references will be ARM resource ids in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - * @member {array} [zones] The virtual machine zones. - */ +*/ export interface VirtualMachineUpdate extends UpdateResource { + /** + * Specifies information about the marketplace image used to create the virtual machine. This + * element is only used for marketplace images. Before you can use a marketplace image from an + * API, you must enable the image for programmatic use. In the Azure portal, find the + * marketplace image that you want to use and then click **Want to deploy programmatically, Get + * Started ->**. Enter any required information and then click **Save**. + */ plan?: Plan; + /** + * Specifies the hardware settings for the virtual machine. + */ hardwareProfile?: HardwareProfile; + /** + * Specifies the storage settings for the virtual machine disks. + */ storageProfile?: StorageProfile; + /** + * Specifies additional capabilities enabled or disabled on the virtual machine. + */ additionalCapabilities?: AdditionalCapabilities; + /** + * Specifies the operating system settings for the virtual machine. + */ osProfile?: OSProfile; + /** + * Specifies the network interfaces of the virtual machine. + */ networkProfile?: NetworkProfile; + /** + * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. + */ diagnosticsProfile?: DiagnosticsProfile; + /** + * Specifies information about the availability set that the virtual machine should be assigned + * to. Virtual machines specified in the same availability set are allocated to different nodes + * to maximize availability. For more information about availability sets, see [Manage the + * availability of virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + *

    For more information on Azure planned maintenance, see [Planned maintenance for + * virtual machines in + * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) + *

    Currently, a VM can only be added to availability set at creation time. An existing + * VM cannot be added to an availability set. + */ availabilitySet?: SubResource; + /** + * The provisioning state, which only appears in the response. + */ readonly provisioningState?: string; + /** + * The virtual machine instance view. + */ readonly instanceView?: VirtualMachineInstanceView; + /** + * Specifies that the image or disk that is being used was licensed on-premises. This element is + * only used for images that contain the Windows Server operating system.

    Possible + * values are:

    Windows_Client

    Windows_Server

    If this element is + * included in a request for an update, the value must match the initial value. This value cannot + * be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows + * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) + *

    Minimum api-version: 2015-06-15 + */ licenseType?: string; + /** + * Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all + * Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. + */ readonly vmId?: string; + /** + * The identity of the virtual machine, if configured. + */ identity?: VirtualMachineIdentity; + /** + * The virtual machine zones. + */ zones?: string[]; } /** - * @class - * Initializes a new instance of the AutomaticOSUpgradePolicy class. - * @constructor * The configuration parameters used for performing automatic OS upgrade. - * - * @member {boolean} [enableAutomaticOSUpgrade] Whether OS upgrades should - * automatically be applied to scale set instances in a rolling fashion when a - * newer version of the image becomes available. Default value is false. - * @member {boolean} [disableAutomaticRollback] Whether OS image rollback - * feature should be disabled. Default value is false. - */ +*/ export interface AutomaticOSUpgradePolicy { + /** + * Whether OS upgrades should automatically be applied to scale set instances in a rolling + * fashion when a newer version of the image becomes available. Default value is false. + */ enableAutomaticOSUpgrade?: boolean; + /** + * Whether OS image rollback feature should be disabled. Default value is false. + */ disableAutomaticRollback?: boolean; } /** - * @class - * Initializes a new instance of the RollingUpgradePolicy class. - * @constructor * The configuration parameters used while performing a rolling upgrade. - * - * @member {number} [maxBatchInstancePercent] The maximum percent of total - * virtual machine instances that will be upgraded simultaneously by the - * rolling upgrade in one batch. As this is a maximum, unhealthy instances in - * previous or future batches can cause the percentage of instances in a batch - * to decrease to ensure higher reliability. The default value for this - * parameter is 20%. - * @member {number} [maxUnhealthyInstancePercent] The maximum percentage of the - * total virtual machine instances in the scale set that can be simultaneously - * unhealthy, either as a result of being upgraded, or by being found in an - * unhealthy state by the virtual machine health checks before the rolling - * upgrade aborts. This constraint will be checked prior to starting any batch. - * The default value for this parameter is 20%. - * @member {number} [maxUnhealthyUpgradedInstancePercent] The maximum - * percentage of upgraded virtual machine instances that can be found to be in - * an unhealthy state. This check will happen after each batch is upgraded. If - * this percentage is ever exceeded, the rolling update aborts. The default - * value for this parameter is 20%. - * @member {string} [pauseTimeBetweenBatches] The wait time between completing - * the update for all virtual machines in one batch and starting the next - * batch. The time duration should be specified in ISO 8601 format. The default - * value is 0 seconds (PT0S). - */ +*/ export interface RollingUpgradePolicy { + /** + * The maximum percent of total virtual machine instances that will be upgraded simultaneously by + * the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or + * future batches can cause the percentage of instances in a batch to decrease to ensure higher + * reliability. The default value for this parameter is 20%. + */ maxBatchInstancePercent?: number; + /** + * The maximum percentage of the total virtual machine instances in the scale set that can be + * simultaneously unhealthy, either as a result of being upgraded, or by being found in an + * unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This + * constraint will be checked prior to starting any batch. The default value for this parameter + * is 20%. + */ maxUnhealthyInstancePercent?: number; + /** + * The maximum percentage of upgraded virtual machine instances that can be found to be in an + * unhealthy state. This check will happen after each batch is upgraded. If this percentage is + * ever exceeded, the rolling update aborts. The default value for this parameter is 20%. + */ maxUnhealthyUpgradedInstancePercent?: number; + /** + * The wait time between completing the update for all virtual machines in one batch and starting + * the next batch. The time duration should be specified in ISO 8601 format. The default value is + * 0 seconds (PT0S). + */ pauseTimeBetweenBatches?: string; } /** - * @class - * Initializes a new instance of the UpgradePolicy class. - * @constructor * Describes an upgrade policy - automatic, manual, or rolling. - * - * @member {string} [mode] Specifies the mode of an upgrade to virtual machines - * in the scale set.

    Possible values are:

    **Manual** - - * You control the application of updates to virtual machines in the scale - * set. You do this by using the manualUpgrade action.

    - * **Automatic** - All virtual machines in the scale set are automatically - * updated at the same time. Possible values include: 'Automatic', 'Manual', - * 'Rolling' - * @member {object} [rollingUpgradePolicy] The configuration parameters used - * while performing a rolling upgrade. - * @member {number} [rollingUpgradePolicy.maxBatchInstancePercent] The maximum - * percent of total virtual machine instances that will be upgraded - * simultaneously by the rolling upgrade in one batch. As this is a maximum, - * unhealthy instances in previous or future batches can cause the percentage - * of instances in a batch to decrease to ensure higher reliability. The - * default value for this parameter is 20%. - * @member {number} [rollingUpgradePolicy.maxUnhealthyInstancePercent] The - * maximum percentage of the total virtual machine instances in the scale set - * that can be simultaneously unhealthy, either as a result of being upgraded, - * or by being found in an unhealthy state by the virtual machine health checks - * before the rolling upgrade aborts. This constraint will be checked prior to - * starting any batch. The default value for this parameter is 20%. - * @member {number} [rollingUpgradePolicy.maxUnhealthyUpgradedInstancePercent] - * The maximum percentage of upgraded virtual machine instances that can be - * found to be in an unhealthy state. This check will happen after each batch - * is upgraded. If this percentage is ever exceeded, the rolling update aborts. - * The default value for this parameter is 20%. - * @member {string} [rollingUpgradePolicy.pauseTimeBetweenBatches] The wait - * time between completing the update for all virtual machines in one batch and - * starting the next batch. The time duration should be specified in ISO 8601 - * format. The default value is 0 seconds (PT0S). - * @member {object} [automaticOSUpgradePolicy] Configuration parameters used - * for performing automatic OS Upgrade. - * @member {boolean} [automaticOSUpgradePolicy.enableAutomaticOSUpgrade] - * Whether OS upgrades should automatically be applied to scale set instances - * in a rolling fashion when a newer version of the image becomes available. - * Default value is false. - * @member {boolean} [automaticOSUpgradePolicy.disableAutomaticRollback] - * Whether OS image rollback feature should be disabled. Default value is - * false. - */ +*/ export interface UpgradePolicy { + /** + * Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible + * values are:

    **Manual** - You control the application of updates to virtual + * machines in the scale set. You do this by using the manualUpgrade action.

    + * **Automatic** - All virtual machines in the scale set are automatically updated at the same + * time. Possible values include: 'Automatic', 'Manual', 'Rolling' + */ mode?: string; + /** + * The configuration parameters used while performing a rolling upgrade. + */ rollingUpgradePolicy?: RollingUpgradePolicy; + /** + * Configuration parameters used for performing automatic OS Upgrade. + */ automaticOSUpgradePolicy?: AutomaticOSUpgradePolicy; } /** - * @class - * Initializes a new instance of the ImageOSDisk class. - * @constructor * Describes an Operating System disk. - * - * @member {string} osType This property allows you to specify the type of the - * OS that is included in the disk if creating a VM from a custom image. - *

    Possible values are:

    **Windows**

    **Linux**. - * Possible values include: 'Windows', 'Linux' - * @member {string} osState The OS State. Possible values include: - * 'Generalized', 'Specialized' - * @member {object} [snapshot] The snapshot. - * @member {string} [snapshot.id] Resource Id - * @member {object} [managedDisk] The managedDisk. - * @member {string} [managedDisk.id] Resource Id - * @member {string} [blobUri] The Virtual Hard Disk. - * @member {string} [caching] Specifies the caching requirements.

    - * Possible values are:

    **None**

    **ReadOnly**

    - * **ReadWrite**

    Default: **None for Standard storage. ReadOnly for - * Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {number} [diskSizeGB] Specifies the size of empty data disks in - * gigabytes. This element can be used to overwrite the name of the disk in a - * virtual machine image.

    This value cannot be larger than 1023 GB - * @member {string} [storageAccountType] Specifies the storage account type for - * the managed disk. UltraSSD_LRS cannot be used with OS Disk. Possible values - * include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - */ +*/ export interface ImageOSDisk { + /** + * This property allows you to specify the type of the OS that is included in the disk if + * creating a VM from a custom image.

    Possible values are:

    **Windows**

    + * **Linux**. Possible values include: 'Windows', 'Linux' + */ osType: string; + /** + * The OS State. Possible values include: 'Generalized', 'Specialized' + */ osState: string; + /** + * The snapshot. + */ snapshot?: SubResource; + /** + * The managedDisk. + */ managedDisk?: SubResource; + /** + * The Virtual Hard Disk. + */ blobUri?: string; + /** + * Specifies the caching requirements.

    Possible values are:

    **None**

    + * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly + * for Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' + */ caching?: string; + /** + * Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the + * name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB + */ diskSizeGB?: number; + /** + * Specifies the storage account type for the managed disk. UltraSSD_LRS cannot be used with OS + * Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', + * 'UltraSSD_LRS' + */ storageAccountType?: string; } /** - * @class - * Initializes a new instance of the ImageDataDisk class. - * @constructor * Describes a data disk. - * - * @member {number} lun Specifies the logical unit number of the data disk. - * This value is used to identify data disks within the VM and therefore must - * be unique for each data disk attached to a VM. - * @member {object} [snapshot] The snapshot. - * @member {string} [snapshot.id] Resource Id - * @member {object} [managedDisk] The managedDisk. - * @member {string} [managedDisk.id] Resource Id - * @member {string} [blobUri] The Virtual Hard Disk. - * @member {string} [caching] Specifies the caching requirements.

    - * Possible values are:

    **None**

    **ReadOnly**

    - * **ReadWrite**

    Default: **None for Standard storage. ReadOnly for - * Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {number} [diskSizeGB] Specifies the size of empty data disks in - * gigabytes. This element can be used to overwrite the name of the disk in a - * virtual machine image.

    This value cannot be larger than 1023 GB - * @member {string} [storageAccountType] Specifies the storage account type for - * the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it - * cannot be used with OS Disk. Possible values include: 'Standard_LRS', - * 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - */ +*/ export interface ImageDataDisk { + /** + * Specifies the logical unit number of the data disk. This value is used to identify data disks + * within the VM and therefore must be unique for each data disk attached to a VM. + */ lun: number; + /** + * The snapshot. + */ snapshot?: SubResource; + /** + * The managedDisk. + */ managedDisk?: SubResource; + /** + * The Virtual Hard Disk. + */ blobUri?: string; + /** + * Specifies the caching requirements.

    Possible values are:

    **None**

    + * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly + * for Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' + */ caching?: string; + /** + * Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the + * name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB + */ diskSizeGB?: number; + /** + * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used + * with data disks, it cannot be used with OS Disk. Possible values include: 'Standard_LRS', + * 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' + */ storageAccountType?: string; } /** - * @class - * Initializes a new instance of the ImageStorageProfile class. - * @constructor * Describes a storage profile. - * - * @member {object} [osDisk] Specifies information about the operating system - * disk used by the virtual machine.

    For more information about disks, - * see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [osDisk.osType] This property allows you to specify the - * type of the OS that is included in the disk if creating a VM from a custom - * image.

    Possible values are:

    **Windows**

    - * **Linux**. Possible values include: 'Windows', 'Linux' - * @member {string} [osDisk.osState] The OS State. Possible values include: - * 'Generalized', 'Specialized' - * @member {object} [osDisk.snapshot] The snapshot. - * @member {string} [osDisk.snapshot.id] Resource Id - * @member {object} [osDisk.managedDisk] The managedDisk. - * @member {string} [osDisk.managedDisk.id] Resource Id - * @member {string} [osDisk.blobUri] The Virtual Hard Disk. - * @member {string} [osDisk.caching] Specifies the caching requirements. - *

    Possible values are:

    **None**

    **ReadOnly** - *

    **ReadWrite**

    Default: **None for Standard storage. - * ReadOnly for Premium storage**. Possible values include: 'None', 'ReadOnly', - * 'ReadWrite' - * @member {number} [osDisk.diskSizeGB] Specifies the size of empty data disks - * in gigabytes. This element can be used to overwrite the name of the disk in - * a virtual machine image.

    This value cannot be larger than 1023 GB - * @member {string} [osDisk.storageAccountType] Specifies the storage account - * type for the managed disk. UltraSSD_LRS cannot be used with OS Disk. - * Possible values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', - * 'UltraSSD_LRS' - * @member {array} [dataDisks] Specifies the parameters that are used to add a - * data disk to a virtual machine.

    For more information about disks, - * see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {boolean} [zoneResilient] Specifies whether an image is zone - * resilient or not. Default is false. Zone resilient images can be created - * only in regions that provide Zone Redundant Storage (ZRS). - */ +*/ export interface ImageStorageProfile { + /** + * Specifies information about the operating system disk used by the virtual machine.

    + * For more information about disks, see [About disks and VHDs for Azure virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + */ osDisk?: ImageOSDisk; + /** + * Specifies the parameters that are used to add a data disk to a virtual machine.

    For + * more information about disks, see [About disks and VHDs for Azure virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + */ dataDisks?: ImageDataDisk[]; + /** + * Specifies whether an image is zone resilient or not. Default is false. Zone resilient images + * can be created only in regions that provide Zone Redundant Storage (ZRS). + */ zoneResilient?: boolean; } /** - * @class - * Initializes a new instance of the Image class. - * @constructor - * The source user image virtual hard disk. The virtual hard disk will be - * copied before being attached to the virtual machine. If SourceImage is - * provided, the destination virtual hard drive must not exist. - * - * @member {object} [sourceVirtualMachine] The source virtual machine from - * which Image is created. - * @member {string} [sourceVirtualMachine.id] Resource Id - * @member {object} [storageProfile] Specifies the storage settings for the - * virtual machine disks. - * @member {object} [storageProfile.osDisk] Specifies information about the - * operating system disk used by the virtual machine.

    For more - * information about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you to - * specify the type of the OS that is included in the disk if creating a VM - * from a custom image.

    Possible values are:

    **Windows** - *

    **Linux**. Possible values include: 'Windows', 'Linux' - * @member {string} [storageProfile.osDisk.osState] The OS State. Possible - * values include: 'Generalized', 'Specialized' - * @member {object} [storageProfile.osDisk.snapshot] The snapshot. - * @member {string} [storageProfile.osDisk.snapshot.id] Resource Id - * @member {object} [storageProfile.osDisk.managedDisk] The managedDisk. - * @member {string} [storageProfile.osDisk.managedDisk.id] Resource Id - * @member {string} [storageProfile.osDisk.blobUri] The Virtual Hard Disk. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching - * requirements.

    Possible values are:

    **None**

    - * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard - * storage. ReadOnly for Premium storage**. Possible values include: 'None', - * 'ReadOnly', 'ReadWrite' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * empty data disks in gigabytes. This element can be used to overwrite the - * name of the disk in a virtual machine image.

    This value cannot be - * larger than 1023 GB - * @member {string} [storageProfile.osDisk.storageAccountType] Specifies the - * storage account type for the managed disk. UltraSSD_LRS cannot be used with - * OS Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', - * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that are - * used to add a data disk to a virtual machine.

    For more information - * about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {boolean} [storageProfile.zoneResilient] Specifies whether an image - * is zone resilient or not. Default is false. Zone resilient images can be - * created only in regions that provide Zone Redundant Storage (ZRS). - * @member {string} [provisioningState] The provisioning state. - */ + * The source user image virtual hard disk. The virtual hard disk will be copied before being + * attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive + * must not exist. +*/ export interface Image extends Resource { + /** + * The source virtual machine from which Image is created. + */ sourceVirtualMachine?: SubResource; + /** + * Specifies the storage settings for the virtual machine disks. + */ storageProfile?: ImageStorageProfile; + /** + * The provisioning state. + */ readonly provisioningState?: string; } /** - * @class - * Initializes a new instance of the ImageUpdate class. - * @constructor * The source user image virtual hard disk. Only tags may be updated. - * - * @member {object} [sourceVirtualMachine] The source virtual machine from - * which Image is created. - * @member {string} [sourceVirtualMachine.id] Resource Id - * @member {object} [storageProfile] Specifies the storage settings for the - * virtual machine disks. - * @member {object} [storageProfile.osDisk] Specifies information about the - * operating system disk used by the virtual machine.

    For more - * information about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you to - * specify the type of the OS that is included in the disk if creating a VM - * from a custom image.

    Possible values are:

    **Windows** - *

    **Linux**. Possible values include: 'Windows', 'Linux' - * @member {string} [storageProfile.osDisk.osState] The OS State. Possible - * values include: 'Generalized', 'Specialized' - * @member {object} [storageProfile.osDisk.snapshot] The snapshot. - * @member {string} [storageProfile.osDisk.snapshot.id] Resource Id - * @member {object} [storageProfile.osDisk.managedDisk] The managedDisk. - * @member {string} [storageProfile.osDisk.managedDisk.id] Resource Id - * @member {string} [storageProfile.osDisk.blobUri] The Virtual Hard Disk. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching - * requirements.

    Possible values are:

    **None**

    - * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard - * storage. ReadOnly for Premium storage**. Possible values include: 'None', - * 'ReadOnly', 'ReadWrite' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * empty data disks in gigabytes. This element can be used to overwrite the - * name of the disk in a virtual machine image.

    This value cannot be - * larger than 1023 GB - * @member {string} [storageProfile.osDisk.storageAccountType] Specifies the - * storage account type for the managed disk. UltraSSD_LRS cannot be used with - * OS Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', - * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that are - * used to add a data disk to a virtual machine.

    For more information - * about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {boolean} [storageProfile.zoneResilient] Specifies whether an image - * is zone resilient or not. Default is false. Zone resilient images can be - * created only in regions that provide Zone Redundant Storage (ZRS). - * @member {string} [provisioningState] The provisioning state. - */ +*/ export interface ImageUpdate extends UpdateResource { + /** + * The source virtual machine from which Image is created. + */ sourceVirtualMachine?: SubResource; + /** + * Specifies the storage settings for the virtual machine disks. + */ storageProfile?: ImageStorageProfile; + /** + * The provisioning state. + */ readonly provisioningState?: string; } -/** - * @class - * Initializes a new instance of the VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue class. - * @constructor - * @member {string} [principalId] The principal id of user assigned identity. - * @member {string} [clientId] The client id of user assigned identity. - */ export interface VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue { + /** + * The principal id of user assigned identity. + */ readonly principalId?: string; + /** + * The client id of user assigned identity. + */ readonly clientId?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetIdentity class. - * @constructor * Identity for the virtual machine scale set. - * - * @member {string} [principalId] The principal id of virtual machine scale set - * identity. This property will only be provided for a system assigned - * identity. - * @member {string} [tenantId] The tenant id associated with the virtual - * machine scale set. This property will only be provided for a system assigned - * identity. - * @member {string} [type] The type of identity used for the virtual machine - * scale set. The type 'SystemAssigned, UserAssigned' includes both an - * implicitly created identity and a set of user assigned identities. The type - * 'None' will remove any identities from the virtual machine scale set. - * Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, - * UserAssigned', 'None' - * @member {object} [userAssignedIdentities] The list of user identities - * associated with the virtual machine scale set. The user identity dictionary - * key references will be ARM resource ids in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - */ +*/ export interface VirtualMachineScaleSetIdentity { + /** + * The principal id of virtual machine scale set identity. This property will only be provided + * for a system assigned identity. + */ readonly principalId?: string; + /** + * The tenant id associated with the virtual machine scale set. This property will only be + * provided for a system assigned identity. + */ readonly tenantId?: string; + /** + * The type of identity used for the virtual machine scale set. The type 'SystemAssigned, + * UserAssigned' includes both an implicitly created identity and a set of user assigned + * identities. The type 'None' will remove any identities from the virtual machine scale set. + * Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + */ type?: string; - userAssignedIdentities?: { [propertyName: string]: VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue }; + /** + * The list of user identities associated with the virtual machine scale set. The user identity + * dictionary key references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + */ + userAssignedIdentities?: { [propertyName: string]: + VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue }; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetOSProfile class. - * @constructor * Describes a virtual machine scale set OS profile. - * - * @member {string} [computerNamePrefix] Specifies the computer name prefix for - * all of the virtual machines in the scale set. Computer name prefixes must be - * 1 to 15 characters long. - * @member {string} [adminUsername] Specifies the name of the administrator - * account.

    **Windows-only restriction:** Cannot end in "."

    - * **Disallowed values:** "administrator", "admin", "user", "user1", "test", - * "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", - * "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", - * "root", "server", "sql", "support", "support_388945a0", "sys", "test2", - * "test3", "user4", "user5".

    **Minimum-length (Linux):** 1 character - *

    **Max-length (Linux):** 64 characters

    **Max-length - * (Windows):** 20 characters

  • For root access to the Linux VM, - * see [Using root privileges on Linux virtual machines in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • - * For a list of built-in system users on Linux that should not be used in this - * field, see [Selecting User Names for Linux on - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [adminPassword] Specifies the password of the administrator - * account.

    **Minimum-length (Windows):** 8 characters

    - * **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** - * 123 characters

    **Max-length (Linux):** 72 characters

    - * **Complexity requirements:** 3 out of 4 conditions below need to be - * fulfilled
    Has lower characters
    Has upper characters
    Has a - * digit
    Has a special character (Regex match [\W_])

    **Disallowed - * values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", - * "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    - * For resetting the password, see [How to reset the Remote Desktop service or - * its login password in a Windows - * VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    For resetting root password, see [Manage users, SSH, and check or - * repair disks on Azure Linux VMs using the VMAccess - * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [customData] Specifies a base-64 encoded string of custom - * data. The base-64 encoded string is decoded to a binary array that is saved - * as a file on the Virtual Machine. The maximum length of the binary array is - * 65535 bytes.

    For using cloud-init for your VM, see [Using - * cloud-init to customize a Linux VM during - * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [windowsConfiguration] Specifies Windows operating system - * settings on the virtual machine. - * @member {boolean} [windowsConfiguration.provisionVMAgent] Indicates whether - * virtual machine agent should be provisioned on the virtual machine.

    - * When this property is not specified in the request body, default behavior is - * to set it to true. This will ensure that VM Agent is installed on the VM so - * that extensions can be added to the VM later. - * @member {boolean} [windowsConfiguration.enableAutomaticUpdates] Indicates - * whether virtual machine is enabled for automatic updates. - * @member {string} [windowsConfiguration.timeZone] Specifies the time zone of - * the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [windowsConfiguration.additionalUnattendContent] Specifies - * additional base-64 encoded XML formatted information that can be included in - * the Unattend.xml file, which is used by Windows Setup. - * @member {object} [windowsConfiguration.winRM] Specifies the Windows Remote - * Management listeners. This enables remote Windows PowerShell. - * @member {array} [windowsConfiguration.winRM.listeners] The list of Windows - * Remote Management listeners - * @member {object} [linuxConfiguration] Specifies the Linux operating system - * settings on the virtual machine.

    For a list of supported Linux - * distributions, see [Linux on Azure-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - *

    For running non-endorsed distributions, see [Information for - * Non-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} [linuxConfiguration.disablePasswordAuthentication] - * Specifies whether password authentication should be disabled. - * @member {object} [linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [linuxConfiguration.ssh.publicKeys] The list of SSH public - * keys used to authenticate with linux based VMs. - * @member {boolean} [linuxConfiguration.provisionVMAgent] Indicates whether - * virtual machine agent should be provisioned on the virtual machine.

    - * When this property is not specified in the request body, default behavior is - * to set it to true. This will ensure that VM Agent is installed on the VM so - * that extensions can be added to the VM later. - * @member {array} [secrets] Specifies set of certificates that should be - * installed onto the virtual machines in the scale set. - */ +*/ export interface VirtualMachineScaleSetOSProfile { + /** + * Specifies the computer name prefix for all of the virtual machines in the scale set. Computer + * name prefixes must be 1 to 15 characters long. + */ computerNamePrefix?: string; + /** + * Specifies the name of the administrator account.

    **Windows-only restriction:** Cannot + * end in "."

    **Disallowed values:** "administrator", "admin", "user", "user1", "test", + * "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", + * "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", + * "support_388945a0", "sys", "test2", "test3", "user4", "user5".

    **Minimum-length + * (Linux):** 1 character

    **Max-length (Linux):** 64 characters

    **Max-length + * (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root + * privileges on Linux virtual machines in + * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • + * For a list of built-in system users on Linux that should not be used in this field, see + * [Selecting User Names for Linux on + * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + */ adminUsername?: string; + /** + * Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 + * characters

    **Minimum-length (Linux):** 6 characters

    **Max-length + * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    + * **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower + * characters
    Has upper characters
    Has a digit
    Has a special character (Regex match + * [\W_])

    **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", + * "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    For + * resetting the password, see [How to reset the Remote Desktop service or its login password in + * a Windows + * VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) + *

    For resetting root password, see [Manage users, SSH, and check or repair disks on + * Azure Linux VMs using the VMAccess + * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) + */ adminPassword?: string; + /** + * Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a + * binary array that is saved as a file on the Virtual Machine. The maximum length of the binary + * array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to + * customize a Linux VM during + * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + */ customData?: string; + /** + * Specifies Windows operating system settings on the virtual machine. + */ windowsConfiguration?: WindowsConfiguration; + /** + * Specifies the Linux operating system settings on the virtual machine.

    For a list of + * supported Linux distributions, see [Linux on Azure-Endorsed + * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) + *

    For running non-endorsed distributions, see [Information for Non-Endorsed + * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + */ linuxConfiguration?: LinuxConfiguration; + /** + * Specifies set of certificates that should be installed onto the virtual machines in the scale + * set. + */ secrets?: VaultSecretGroup[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetUpdateOSProfile class. - * @constructor * Describes a virtual machine scale set OS profile. - * - * @member {string} [customData] A base-64 encoded string of custom data. - * @member {object} [windowsConfiguration] The Windows Configuration of the OS - * profile. - * @member {boolean} [windowsConfiguration.provisionVMAgent] Indicates whether - * virtual machine agent should be provisioned on the virtual machine.

    - * When this property is not specified in the request body, default behavior is - * to set it to true. This will ensure that VM Agent is installed on the VM so - * that extensions can be added to the VM later. - * @member {boolean} [windowsConfiguration.enableAutomaticUpdates] Indicates - * whether virtual machine is enabled for automatic updates. - * @member {string} [windowsConfiguration.timeZone] Specifies the time zone of - * the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [windowsConfiguration.additionalUnattendContent] Specifies - * additional base-64 encoded XML formatted information that can be included in - * the Unattend.xml file, which is used by Windows Setup. - * @member {object} [windowsConfiguration.winRM] Specifies the Windows Remote - * Management listeners. This enables remote Windows PowerShell. - * @member {array} [windowsConfiguration.winRM.listeners] The list of Windows - * Remote Management listeners - * @member {object} [linuxConfiguration] The Linux Configuration of the OS - * profile. - * @member {boolean} [linuxConfiguration.disablePasswordAuthentication] - * Specifies whether password authentication should be disabled. - * @member {object} [linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [linuxConfiguration.ssh.publicKeys] The list of SSH public - * keys used to authenticate with linux based VMs. - * @member {boolean} [linuxConfiguration.provisionVMAgent] Indicates whether - * virtual machine agent should be provisioned on the virtual machine.

    - * When this property is not specified in the request body, default behavior is - * to set it to true. This will ensure that VM Agent is installed on the VM so - * that extensions can be added to the VM later. - * @member {array} [secrets] The List of certificates for addition to the VM. - */ +*/ export interface VirtualMachineScaleSetUpdateOSProfile { + /** + * A base-64 encoded string of custom data. + */ customData?: string; + /** + * The Windows Configuration of the OS profile. + */ windowsConfiguration?: WindowsConfiguration; + /** + * The Linux Configuration of the OS profile. + */ linuxConfiguration?: LinuxConfiguration; + /** + * The List of certificates for addition to the VM. + */ secrets?: VaultSecretGroup[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetManagedDiskParameters class. - * @constructor * Describes the parameters of a ScaleSet managed disk. - * - * @member {string} [storageAccountType] Specifies the storage account type for - * the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it - * cannot be used with OS Disk. Possible values include: 'Standard_LRS', - * 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - */ +*/ export interface VirtualMachineScaleSetManagedDiskParameters { + /** + * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used + * with data disks, it cannot be used with OS Disk. Possible values include: 'Standard_LRS', + * 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' + */ storageAccountType?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetOSDisk class. - * @constructor * Describes a virtual machine scale set operating system disk. - * - * @member {string} [name] The disk name. - * @member {string} [caching] Specifies the caching requirements.

    - * Possible values are:

    **None**

    **ReadOnly**

    - * **ReadWrite**

    Default: **None for Standard storage. ReadOnly for - * Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether - * writeAccelerator should be enabled or disabled on the disk. - * @member {string} createOption Specifies how the virtual machines in the - * scale set should be created.

    The only allowed value is: - * **FromImage** \u2013 This value is used when you are using an image to - * create the virtual machine. If you are using a platform image, you also use - * the imageReference element described above. If you are using a marketplace - * image, you also use the plan element previously described. Possible values - * include: 'FromImage', 'Empty', 'Attach' - * @member {object} [diffDiskSettings] Specifies the differencing Disk Settings - * for the operating system disk used by the virtual machine scale set. - * @member {string} [diffDiskSettings.option] Specifies the differencing disk - * settings for operating system disk. Possible values include: 'Local' - * @member {number} [diskSizeGB] Specifies the size of the operating system - * disk in gigabytes. This element can be used to overwrite the size of the - * disk in a virtual machine image.

    This value cannot be larger than - * 1023 GB - * @member {string} [osType] This property allows you to specify the type of - * the OS that is included in the disk if creating a VM from user-image or a - * specialized VHD.

    Possible values are:

    **Windows**

    - * **Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [image] Specifies information about the unmanaged user - * image to base the scale set on. - * @member {string} [image.uri] Specifies the virtual hard disk's uri. - * @member {array} [vhdContainers] Specifies the container urls that are used - * to store operating system disks for the scale set. - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage - * account type for the managed disk. NOTE: UltraSSD_LRS can only be used with - * data disks, it cannot be used with OS Disk. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - */ +*/ export interface VirtualMachineScaleSetOSDisk { + /** + * The disk name. + */ name?: string; + /** + * Specifies the caching requirements.

    Possible values are:

    **None**

    + * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly + * for Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' + */ caching?: string; + /** + * Specifies whether writeAccelerator should be enabled or disabled on the disk. + */ writeAcceleratorEnabled?: boolean; + /** + * Specifies how the virtual machines in the scale set should be created.

    The only + * allowed value is: **FromImage** \u2013 This value is used when you are using an image to + * create the virtual machine. If you are using a platform image, you also use the imageReference + * element described above. If you are using a marketplace image, you also use the plan element + * previously described. Possible values include: 'FromImage', 'Empty', 'Attach' + */ createOption: string; + /** + * Specifies the ephemeral disk Settings for the operating system disk used by the virtual + * machine scale set. + */ diffDiskSettings?: DiffDiskSettings; + /** + * Specifies the size of the operating system disk in gigabytes. This element can be used to + * overwrite the size of the disk in a virtual machine image.

    This value cannot be + * larger than 1023 GB + */ diskSizeGB?: number; + /** + * This property allows you to specify the type of the OS that is included in the disk if + * creating a VM from user-image or a specialized VHD.

    Possible values are:

    + * **Windows**

    **Linux**. Possible values include: 'Windows', 'Linux' + */ osType?: string; + /** + * Specifies information about the unmanaged user image to base the scale set on. + */ image?: VirtualHardDisk; + /** + * Specifies the container urls that are used to store operating system disks for the scale set. + */ vhdContainers?: string[]; + /** + * The managed disk parameters. + */ managedDisk?: VirtualMachineScaleSetManagedDiskParameters; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetUpdateOSDisk class. - * @constructor - * Describes virtual machine scale set operating system disk Update Object. - * This should be used for Updating VMSS OS Disk. - * - * @member {string} [caching] The caching type. Possible values include: - * 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether - * writeAccelerator should be enabled or disabled on the disk. - * @member {number} [diskSizeGB] Specifies the size of the operating system - * disk in gigabytes. This element can be used to overwrite the size of the - * disk in a virtual machine image.

    This value cannot be larger than - * 1023 GB - * @member {object} [image] The Source User Image VirtualHardDisk. This - * VirtualHardDisk will be copied before using it to attach to the Virtual - * Machine. If SourceImage is provided, the destination VirtualHardDisk should - * not exist. - * @member {string} [image.uri] Specifies the virtual hard disk's uri. - * @member {array} [vhdContainers] The list of virtual hard disk container - * uris. - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage - * account type for the managed disk. NOTE: UltraSSD_LRS can only be used with - * data disks, it cannot be used with OS Disk. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - */ + * Describes virtual machine scale set operating system disk Update Object. This should be used for + * Updating VMSS OS Disk. +*/ export interface VirtualMachineScaleSetUpdateOSDisk { + /** + * The caching type. Possible values include: 'None', 'ReadOnly', 'ReadWrite' + */ caching?: string; + /** + * Specifies whether writeAccelerator should be enabled or disabled on the disk. + */ writeAcceleratorEnabled?: boolean; + /** + * Specifies the size of the operating system disk in gigabytes. This element can be used to + * overwrite the size of the disk in a virtual machine image.

    This value cannot be + * larger than 1023 GB + */ diskSizeGB?: number; + /** + * The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to + * attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk + * should not exist. + */ image?: VirtualHardDisk; + /** + * The list of virtual hard disk container uris. + */ vhdContainers?: string[]; + /** + * The managed disk parameters. + */ managedDisk?: VirtualMachineScaleSetManagedDiskParameters; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetDataDisk class. - * @constructor * Describes a virtual machine scale set data disk. - * - * @member {string} [name] The disk name. - * @member {number} lun Specifies the logical unit number of the data disk. - * This value is used to identify data disks within the VM and therefore must - * be unique for each data disk attached to a VM. - * @member {string} [caching] Specifies the caching requirements.

    - * Possible values are:

    **None**

    **ReadOnly**

    - * **ReadWrite**

    Default: **None for Standard storage. ReadOnly for - * Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether - * writeAccelerator should be enabled or disabled on the disk. - * @member {string} createOption The create option. Possible values include: - * 'FromImage', 'Empty', 'Attach' - * @member {number} [diskSizeGB] Specifies the size of an empty data disk in - * gigabytes. This element can be used to overwrite the size of the disk in a - * virtual machine image.

    This value cannot be larger than 1023 GB - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage - * account type for the managed disk. NOTE: UltraSSD_LRS can only be used with - * data disks, it cannot be used with OS Disk. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - */ +*/ export interface VirtualMachineScaleSetDataDisk { + /** + * The disk name. + */ name?: string; + /** + * Specifies the logical unit number of the data disk. This value is used to identify data disks + * within the VM and therefore must be unique for each data disk attached to a VM. + */ lun: number; + /** + * Specifies the caching requirements.

    Possible values are:

    **None**

    + * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly + * for Premium storage**. Possible values include: 'None', 'ReadOnly', 'ReadWrite' + */ caching?: string; + /** + * Specifies whether writeAccelerator should be enabled or disabled on the disk. + */ writeAcceleratorEnabled?: boolean; + /** + * The create option. Possible values include: 'FromImage', 'Empty', 'Attach' + */ createOption: string; + /** + * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite + * the size of the disk in a virtual machine image.

    This value cannot be larger than + * 1023 GB + */ diskSizeGB?: number; + /** + * The managed disk parameters. + */ managedDisk?: VirtualMachineScaleSetManagedDiskParameters; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetStorageProfile class. - * @constructor * Describes a virtual machine scale set storage profile. - * - * @member {object} [imageReference] Specifies information about the image to - * use. You can specify information about platform images, marketplace images, - * or virtual machine images. This element is required when you want to use a - * platform image, marketplace image, or virtual machine image, but is not used - * in other creation operations. - * @member {string} [imageReference.publisher] The image publisher. - * @member {string} [imageReference.offer] Specifies the offer of the platform - * image or marketplace image used to create the virtual machine. - * @member {string} [imageReference.sku] The image SKU. - * @member {string} [imageReference.version] Specifies the version of the - * platform image or marketplace image used to create the virtual machine. The - * allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build - * are decimal numbers. Specify 'latest' to use the latest version of an image - * available at deploy time. Even if you use 'latest', the VM image will not - * automatically update after deploy time even if a new version becomes - * available. - * @member {object} [osDisk] Specifies information about the operating system - * disk used by the virtual machines in the scale set.

    For more - * information about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [osDisk.name] The disk name. - * @member {string} [osDisk.caching] Specifies the caching requirements. - *

    Possible values are:

    **None**

    **ReadOnly** - *

    **ReadWrite**

    Default: **None for Standard storage. - * ReadOnly for Premium storage**. Possible values include: 'None', 'ReadOnly', - * 'ReadWrite' - * @member {boolean} [osDisk.writeAcceleratorEnabled] Specifies whether - * writeAccelerator should be enabled or disabled on the disk. - * @member {string} [osDisk.createOption] Specifies how the virtual machines in - * the scale set should be created.

    The only allowed value is: - * **FromImage** \u2013 This value is used when you are using an image to - * create the virtual machine. If you are using a platform image, you also use - * the imageReference element described above. If you are using a marketplace - * image, you also use the plan element previously described. Possible values - * include: 'FromImage', 'Empty', 'Attach' - * @member {object} [osDisk.diffDiskSettings] Specifies the differencing Disk - * Settings for the operating system disk used by the virtual machine scale - * set. - * @member {string} [osDisk.diffDiskSettings.option] Specifies the differencing - * disk settings for operating system disk. Possible values include: 'Local' - * @member {number} [osDisk.diskSizeGB] Specifies the size of the operating - * system disk in gigabytes. This element can be used to overwrite the size of - * the disk in a virtual machine image.

    This value cannot be larger - * than 1023 GB - * @member {string} [osDisk.osType] This property allows you to specify the - * type of the OS that is included in the disk if creating a VM from user-image - * or a specialized VHD.

    Possible values are:

    **Windows** - *

    **Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [osDisk.image] Specifies information about the unmanaged - * user image to base the scale set on. - * @member {string} [osDisk.image.uri] Specifies the virtual hard disk's uri. - * @member {array} [osDisk.vhdContainers] Specifies the container urls that are - * used to store operating system disks for the scale set. - * @member {object} [osDisk.managedDisk] The managed disk parameters. - * @member {string} [osDisk.managedDisk.storageAccountType] Specifies the - * storage account type for the managed disk. NOTE: UltraSSD_LRS can only be - * used with data disks, it cannot be used with OS Disk. Possible values - * include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [dataDisks] Specifies the parameters that are used to add - * data disks to the virtual machines in the scale set.

    For more - * information about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - */ +*/ export interface VirtualMachineScaleSetStorageProfile { + /** + * Specifies information about the image to use. You can specify information about platform + * images, marketplace images, or virtual machine images. This element is required when you want + * to use a platform image, marketplace image, or virtual machine image, but is not used in other + * creation operations. + */ imageReference?: ImageReference; + /** + * Specifies information about the operating system disk used by the virtual machines in the + * scale set.

    For more information about disks, see [About disks and VHDs for Azure + * virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + */ osDisk?: VirtualMachineScaleSetOSDisk; + /** + * Specifies the parameters that are used to add data disks to the virtual machines in the scale + * set.

    For more information about disks, see [About disks and VHDs for Azure virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + */ dataDisks?: VirtualMachineScaleSetDataDisk[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetUpdateStorageProfile class. - * @constructor * Describes a virtual machine scale set storage profile. - * - * @member {object} [imageReference] The image reference. - * @member {string} [imageReference.publisher] The image publisher. - * @member {string} [imageReference.offer] Specifies the offer of the platform - * image or marketplace image used to create the virtual machine. - * @member {string} [imageReference.sku] The image SKU. - * @member {string} [imageReference.version] Specifies the version of the - * platform image or marketplace image used to create the virtual machine. The - * allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build - * are decimal numbers. Specify 'latest' to use the latest version of an image - * available at deploy time. Even if you use 'latest', the VM image will not - * automatically update after deploy time even if a new version becomes - * available. - * @member {object} [osDisk] The OS disk. - * @member {string} [osDisk.caching] The caching type. Possible values include: - * 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [osDisk.writeAcceleratorEnabled] Specifies whether - * writeAccelerator should be enabled or disabled on the disk. - * @member {number} [osDisk.diskSizeGB] Specifies the size of the operating - * system disk in gigabytes. This element can be used to overwrite the size of - * the disk in a virtual machine image.

    This value cannot be larger - * than 1023 GB - * @member {object} [osDisk.image] The Source User Image VirtualHardDisk. This - * VirtualHardDisk will be copied before using it to attach to the Virtual - * Machine. If SourceImage is provided, the destination VirtualHardDisk should - * not exist. - * @member {string} [osDisk.image.uri] Specifies the virtual hard disk's uri. - * @member {array} [osDisk.vhdContainers] The list of virtual hard disk - * container uris. - * @member {object} [osDisk.managedDisk] The managed disk parameters. - * @member {string} [osDisk.managedDisk.storageAccountType] Specifies the - * storage account type for the managed disk. NOTE: UltraSSD_LRS can only be - * used with data disks, it cannot be used with OS Disk. Possible values - * include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [dataDisks] The data disks. - */ +*/ export interface VirtualMachineScaleSetUpdateStorageProfile { + /** + * The image reference. + */ imageReference?: ImageReference; + /** + * The OS disk. + */ osDisk?: VirtualMachineScaleSetUpdateOSDisk; + /** + * The data disks. + */ dataDisks?: VirtualMachineScaleSetDataDisk[]; } /** - * @class - * Initializes a new instance of the ApiEntityReference class. - * @constructor * The API entity reference. - * - * @member {string} [id] The ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - */ +*/ export interface ApiEntityReference { + /** + * The ARM resource id in the form of + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + */ id?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings class. - * @constructor - * Describes a virtual machines scale sets network configuration's DNS - * settings. - * - * @member {string} domainNameLabel The Domain name label.The concatenation of - * the domain name label and vm index will be the domain name labels of the - * PublicIPAddress resources that will be created - */ + * Describes a virtual machines scale sets network configuration's DNS settings. +*/ export interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings { + /** + * The Domain name label.The concatenation of the domain name label and vm index will be the + * domain name labels of the PublicIPAddress resources that will be created + */ domainNameLabel: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetIpTag class. - * @constructor * Contains the IP tag associated with the public IP address. - * - * @member {string} [ipTagType] IP tag type. Example: FirstPartyUsage. - * @member {string} [tag] IP tag associated with the public IP. Example: SQL, - * Storage etc. - */ +*/ export interface VirtualMachineScaleSetIpTag { + /** + * IP tag type. Example: FirstPartyUsage. + */ ipTagType?: string; + /** + * IP tag associated with the public IP. Example: SQL, Storage etc. + */ tag?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetPublicIPAddressConfiguration class. - * @constructor - * Describes a virtual machines scale set IP Configuration's PublicIPAddress - * configuration - * - * @member {string} name The publicIP address configuration name. - * @member {number} [idleTimeoutInMinutes] The idle timeout of the public IP - * address. - * @member {object} [dnsSettings] The dns settings to be applied on the - * publicIP addresses . - * @member {string} [dnsSettings.domainNameLabel] The Domain name label.The - * concatenation of the domain name label and vm index will be the domain name - * labels of the PublicIPAddress resources that will be created - * @member {array} [ipTags] The list of IP tags associated with the public IP - * address. - * @member {object} [publicIPPrefix] The PublicIPPrefix from which to allocate - * publicIP addresses. - * @member {string} [publicIPPrefix.id] Resource Id - */ + * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration +*/ export interface VirtualMachineScaleSetPublicIPAddressConfiguration { + /** + * The publicIP address configuration name. + */ name: string; + /** + * The idle timeout of the public IP address. + */ idleTimeoutInMinutes?: number; + /** + * The dns settings to be applied on the publicIP addresses . + */ dnsSettings?: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings; + /** + * The list of IP tags associated with the public IP address. + */ ipTags?: VirtualMachineScaleSetIpTag[]; + /** + * The PublicIPPrefix from which to allocate publicIP addresses. + */ publicIPPrefix?: SubResource; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetUpdatePublicIPAddressConfiguration class. - * @constructor - * Describes a virtual machines scale set IP Configuration's PublicIPAddress - * configuration - * - * @member {string} [name] The publicIP address configuration name. - * @member {number} [idleTimeoutInMinutes] The idle timeout of the public IP - * address. - * @member {object} [dnsSettings] The dns settings to be applied on the - * publicIP addresses . - * @member {string} [dnsSettings.domainNameLabel] The Domain name label.The - * concatenation of the domain name label and vm index will be the domain name - * labels of the PublicIPAddress resources that will be created - */ + * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration +*/ export interface VirtualMachineScaleSetUpdatePublicIPAddressConfiguration { + /** + * The publicIP address configuration name. + */ name?: string; + /** + * The idle timeout of the public IP address. + */ idleTimeoutInMinutes?: number; + /** + * The dns settings to be applied on the publicIP addresses . + */ dnsSettings?: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetIPConfiguration class. - * @constructor * Describes a virtual machine scale set network profile's IP configuration. - * - * @member {string} name The IP configuration name. - * @member {object} [subnet] Specifies the identifier of the subnet. - * @member {string} [subnet.id] The ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {boolean} [primary] Specifies the primary network interface in case - * the virtual machine has more than 1 network interface. - * @member {object} [publicIPAddressConfiguration] The - * publicIPAddressConfiguration. - * @member {string} [publicIPAddressConfiguration.name] The publicIP address - * configuration name. - * @member {number} [publicIPAddressConfiguration.idleTimeoutInMinutes] The - * idle timeout of the public IP address. - * @member {object} [publicIPAddressConfiguration.dnsSettings] The dns settings - * to be applied on the publicIP addresses . - * @member {string} [publicIPAddressConfiguration.dnsSettings.domainNameLabel] - * The Domain name label.The concatenation of the domain name label and vm - * index will be the domain name labels of the PublicIPAddress resources that - * will be created - * @member {array} [publicIPAddressConfiguration.ipTags] The list of IP tags - * associated with the public IP address. - * @member {object} [publicIPAddressConfiguration.publicIPPrefix] The - * PublicIPPrefix from which to allocate publicIP addresses. - * @member {string} [publicIPAddressConfiguration.publicIPPrefix.id] Resource - * Id - * @member {string} [privateIPAddressVersion] Available from Api-Version - * 2017-03-30 onwards, it represents whether the specific ipconfiguration is - * IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and - * 'IPv6'. Possible values include: 'IPv4', 'IPv6' - * @member {array} [applicationGatewayBackendAddressPools] Specifies an array - * of references to backend address pools of application gateways. A scale set - * can reference backend address pools of multiple application gateways. - * Multiple scale sets cannot use the same application gateway. - * @member {array} [applicationSecurityGroups] Specifies an array of references - * to application security group. - * @member {array} [loadBalancerBackendAddressPools] Specifies an array of - * references to backend address pools of load balancers. A scale set can - * reference backend address pools of one public and one internal load - * balancer. Multiple scale sets cannot use the same load balancer. - * @member {array} [loadBalancerInboundNatPools] Specifies an array of - * references to inbound Nat pools of the load balancers. A scale set can - * reference inbound nat pools of one public and one internal load balancer. - * Multiple scale sets cannot use the same load balancer - */ +*/ export interface VirtualMachineScaleSetIPConfiguration extends SubResource { + /** + * The IP configuration name. + */ name: string; + /** + * Specifies the identifier of the subnet. + */ subnet?: ApiEntityReference; + /** + * Specifies the primary network interface in case the virtual machine has more than 1 network + * interface. + */ primary?: boolean; + /** + * The publicIPAddressConfiguration. + */ publicIPAddressConfiguration?: VirtualMachineScaleSetPublicIPAddressConfiguration; + /** + * Available from Api-Version 2017-03-30 onwards, it represents whether the specific + * ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and + * 'IPv6'. Possible values include: 'IPv4', 'IPv6' + */ privateIPAddressVersion?: string; + /** + * Specifies an array of references to backend address pools of application gateways. A scale set + * can reference backend address pools of multiple application gateways. Multiple scale sets + * cannot use the same application gateway. + */ applicationGatewayBackendAddressPools?: SubResource[]; + /** + * Specifies an array of references to application security group. + */ applicationSecurityGroups?: SubResource[]; + /** + * Specifies an array of references to backend address pools of load balancers. A scale set can + * reference backend address pools of one public and one internal load balancer. Multiple scale + * sets cannot use the same load balancer. + */ loadBalancerBackendAddressPools?: SubResource[]; + /** + * Specifies an array of references to inbound Nat pools of the load balancers. A scale set can + * reference inbound nat pools of one public and one internal load balancer. Multiple scale sets + * cannot use the same load balancer + */ loadBalancerInboundNatPools?: SubResource[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetUpdateIPConfiguration class. - * @constructor * Describes a virtual machine scale set network profile's IP configuration. - * - * @member {string} [name] The IP configuration name. - * @member {object} [subnet] The subnet. - * @member {string} [subnet.id] The ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {boolean} [primary] Specifies the primary IP Configuration in case - * the network interface has more than one IP Configuration. - * @member {object} [publicIPAddressConfiguration] The - * publicIPAddressConfiguration. - * @member {string} [publicIPAddressConfiguration.name] The publicIP address - * configuration name. - * @member {number} [publicIPAddressConfiguration.idleTimeoutInMinutes] The - * idle timeout of the public IP address. - * @member {object} [publicIPAddressConfiguration.dnsSettings] The dns settings - * to be applied on the publicIP addresses . - * @member {string} [publicIPAddressConfiguration.dnsSettings.domainNameLabel] - * The Domain name label.The concatenation of the domain name label and vm - * index will be the domain name labels of the PublicIPAddress resources that - * will be created - * @member {string} [privateIPAddressVersion] Available from Api-Version - * 2017-03-30 onwards, it represents whether the specific ipconfiguration is - * IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and - * 'IPv6'. Possible values include: 'IPv4', 'IPv6' - * @member {array} [applicationGatewayBackendAddressPools] The application - * gateway backend address pools. - * @member {array} [applicationSecurityGroups] Specifies an array of references - * to application security group. - * @member {array} [loadBalancerBackendAddressPools] The load balancer backend - * address pools. - * @member {array} [loadBalancerInboundNatPools] The load balancer inbound nat - * pools. - */ +*/ export interface VirtualMachineScaleSetUpdateIPConfiguration extends SubResource { + /** + * The IP configuration name. + */ name?: string; + /** + * The subnet. + */ subnet?: ApiEntityReference; + /** + * Specifies the primary IP Configuration in case the network interface has more than one IP + * Configuration. + */ primary?: boolean; + /** + * The publicIPAddressConfiguration. + */ publicIPAddressConfiguration?: VirtualMachineScaleSetUpdatePublicIPAddressConfiguration; + /** + * Available from Api-Version 2017-03-30 onwards, it represents whether the specific + * ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and + * 'IPv6'. Possible values include: 'IPv4', 'IPv6' + */ privateIPAddressVersion?: string; + /** + * The application gateway backend address pools. + */ applicationGatewayBackendAddressPools?: SubResource[]; + /** + * Specifies an array of references to application security group. + */ applicationSecurityGroups?: SubResource[]; + /** + * The load balancer backend address pools. + */ loadBalancerBackendAddressPools?: SubResource[]; + /** + * The load balancer inbound nat pools. + */ loadBalancerInboundNatPools?: SubResource[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetNetworkConfigurationDnsSettings class. - * @constructor - * Describes a virtual machines scale sets network configuration's DNS - * settings. - * - * @member {array} [dnsServers] List of DNS servers IP addresses - */ + * Describes a virtual machines scale sets network configuration's DNS settings. +*/ export interface VirtualMachineScaleSetNetworkConfigurationDnsSettings { + /** + * List of DNS servers IP addresses + */ dnsServers?: string[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetNetworkConfiguration class. - * @constructor - * Describes a virtual machine scale set network profile's network - * configurations. - * - * @member {string} name The network configuration name. - * @member {boolean} [primary] Specifies the primary network interface in case - * the virtual machine has more than 1 network interface. - * @member {boolean} [enableAcceleratedNetworking] Specifies whether the - * network interface is accelerated networking-enabled. - * @member {object} [networkSecurityGroup] The network security group. - * @member {string} [networkSecurityGroup.id] Resource Id - * @member {object} [dnsSettings] The dns settings to be applied on the network - * interfaces. - * @member {array} [dnsSettings.dnsServers] List of DNS servers IP addresses - * @member {array} ipConfigurations Specifies the IP configurations of the - * network interface. - * @member {boolean} [enableIPForwarding] Whether IP forwarding enabled on this - * NIC. - */ + * Describes a virtual machine scale set network profile's network configurations. +*/ export interface VirtualMachineScaleSetNetworkConfiguration extends SubResource { + /** + * The network configuration name. + */ name: string; + /** + * Specifies the primary network interface in case the virtual machine has more than 1 network + * interface. + */ primary?: boolean; + /** + * Specifies whether the network interface is accelerated networking-enabled. + */ enableAcceleratedNetworking?: boolean; + /** + * The network security group. + */ networkSecurityGroup?: SubResource; + /** + * The dns settings to be applied on the network interfaces. + */ dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettings; + /** + * Specifies the IP configurations of the network interface. + */ ipConfigurations: VirtualMachineScaleSetIPConfiguration[]; + /** + * Whether IP forwarding enabled on this NIC. + */ enableIPForwarding?: boolean; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetUpdateNetworkConfiguration class. - * @constructor - * Describes a virtual machine scale set network profile's network - * configurations. - * - * @member {string} [name] The network configuration name. - * @member {boolean} [primary] Whether this is a primary NIC on a virtual - * machine. - * @member {boolean} [enableAcceleratedNetworking] Specifies whether the - * network interface is accelerated networking-enabled. - * @member {object} [networkSecurityGroup] The network security group. - * @member {string} [networkSecurityGroup.id] Resource Id - * @member {object} [dnsSettings] The dns settings to be applied on the network - * interfaces. - * @member {array} [dnsSettings.dnsServers] List of DNS servers IP addresses - * @member {array} [ipConfigurations] The virtual machine scale set IP - * Configuration. - * @member {boolean} [enableIPForwarding] Whether IP forwarding enabled on this - * NIC. - */ + * Describes a virtual machine scale set network profile's network configurations. +*/ export interface VirtualMachineScaleSetUpdateNetworkConfiguration extends SubResource { + /** + * The network configuration name. + */ name?: string; + /** + * Whether this is a primary NIC on a virtual machine. + */ primary?: boolean; + /** + * Specifies whether the network interface is accelerated networking-enabled. + */ enableAcceleratedNetworking?: boolean; + /** + * The network security group. + */ networkSecurityGroup?: SubResource; + /** + * The dns settings to be applied on the network interfaces. + */ dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettings; + /** + * The virtual machine scale set IP Configuration. + */ ipConfigurations?: VirtualMachineScaleSetUpdateIPConfiguration[]; + /** + * Whether IP forwarding enabled on this NIC. + */ enableIPForwarding?: boolean; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetNetworkProfile class. - * @constructor * Describes a virtual machine scale set network profile. - * - * @member {object} [healthProbe] A reference to a load balancer probe used to - * determine the health of an instance in the virtual machine scale set. The - * reference will be in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - * @member {string} [healthProbe.id] The ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {array} [networkInterfaceConfigurations] The list of network - * configurations. - */ +*/ export interface VirtualMachineScaleSetNetworkProfile { + /** + * A reference to a load balancer probe used to determine the health of an instance in the + * virtual machine scale set. The reference will be in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. + */ healthProbe?: ApiEntityReference; + /** + * The list of network configurations. + */ networkInterfaceConfigurations?: VirtualMachineScaleSetNetworkConfiguration[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetUpdateNetworkProfile class. - * @constructor * Describes a virtual machine scale set network profile. - * - * @member {array} [networkInterfaceConfigurations] The list of network - * configurations. - */ +*/ export interface VirtualMachineScaleSetUpdateNetworkProfile { + /** + * The list of network configurations. + */ networkInterfaceConfigurations?: VirtualMachineScaleSetUpdateNetworkConfiguration[]; } -/** - * @class - * Initializes a new instance of the SubResourceReadOnly class. - * @constructor - * @member {string} [id] Resource Id - */ export interface SubResourceReadOnly extends BaseResource { + /** + * Resource Id + */ readonly id?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetExtension class. - * @constructor * Describes a Virtual Machine Scale Set Extension. - * - * @member {string} [name] The name of the extension. - * @member {string} [forceUpdateTag] If a value is provided and is different - * from the previous value, the extension handler will be forced to update even - * if the extension configuration has not changed. - * @member {string} [publisher] The name of the extension handler publisher. - * @member {string} [type] Specifies the type of the extension; an example is - * "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {boolean} [autoUpgradeMinorVersion] Indicates whether the extension - * should use a newer minor version if one is available at deployment time. - * Once deployed, however, the extension will not upgrade minor versions unless - * redeployed, even with this property set to true. - * @member {object} [settings] Json formatted public settings for the - * extension. - * @member {object} [protectedSettings] The extension can contain either - * protectedSettings or protectedSettingsFromKeyVault or no protected settings - * at all. - * @member {string} [provisioningState] The provisioning state, which only - * appears in the response. - */ +*/ export interface VirtualMachineScaleSetExtension extends SubResourceReadOnly { + /** + * The name of the extension. + */ name?: string; + /** + * If a value is provided and is different from the previous value, the extension handler will be + * forced to update even if the extension configuration has not changed. + */ forceUpdateTag?: string; + /** + * The name of the extension handler publisher. + */ publisher?: string; + /** + * Specifies the type of the extension; an example is "CustomScriptExtension". + */ type?: string; + /** + * Specifies the version of the script handler. + */ typeHandlerVersion?: string; + /** + * Indicates whether the extension should use a newer minor version if one is available at + * deployment time. Once deployed, however, the extension will not upgrade minor versions unless + * redeployed, even with this property set to true. + */ autoUpgradeMinorVersion?: boolean; + /** + * Json formatted public settings for the extension. + */ settings?: any; + /** + * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no + * protected settings at all. + */ protectedSettings?: any; + /** + * The provisioning state, which only appears in the response. + */ readonly provisioningState?: string; + /** + * Collection of extension names after which this extension needs to be provisioned. + */ + provisionAfterExtensions?: string[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetExtensionProfile class. - * @constructor * Describes a virtual machine scale set extension profile. - * - * @member {array} [extensions] The virtual machine scale set child extension - * resources. - */ +*/ export interface VirtualMachineScaleSetExtensionProfile { + /** + * The virtual machine scale set child extension resources. + */ extensions?: VirtualMachineScaleSetExtension[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetVMProfile class. - * @constructor * Describes a virtual machine scale set virtual machine profile. - * - * @member {object} [osProfile] Specifies the operating system settings for the - * virtual machines in the scale set. - * @member {string} [osProfile.computerNamePrefix] Specifies the computer name - * prefix for all of the virtual machines in the scale set. Computer name - * prefixes must be 1 to 15 characters long. - * @member {string} [osProfile.adminUsername] Specifies the name of the - * administrator account.

    **Windows-only restriction:** Cannot end in - * "."

    **Disallowed values:** "administrator", "admin", "user", - * "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", - * "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", - * "john", "owner", "root", "server", "sql", "support", "support_388945a0", - * "sys", "test2", "test3", "user4", "user5".

    **Minimum-length - * (Linux):** 1 character

    **Max-length (Linux):** 64 characters - *

    **Max-length (Windows):** 20 characters

  • For root - * access to the Linux VM, see [Using root privileges on Linux virtual machines - * in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • - * For a list of built-in system users on Linux that should not be used in this - * field, see [Selecting User Names for Linux on - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [osProfile.adminPassword] Specifies the password of the - * administrator account.

    **Minimum-length (Windows):** 8 characters - *

    **Minimum-length (Linux):** 6 characters

    **Max-length - * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters - *

    **Complexity requirements:** 3 out of 4 conditions below need to be - * fulfilled
    Has lower characters
    Has upper characters
    Has a - * digit
    Has a special character (Regex match [\W_])

    **Disallowed - * values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", - * "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    - * For resetting the password, see [How to reset the Remote Desktop service or - * its login password in a Windows - * VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    For resetting root password, see [Manage users, SSH, and check or - * repair disks on Azure Linux VMs using the VMAccess - * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [osProfile.customData] Specifies a base-64 encoded string - * of custom data. The base-64 encoded string is decoded to a binary array that - * is saved as a file on the Virtual Machine. The maximum length of the binary - * array is 65535 bytes.

    For using cloud-init for your VM, see [Using - * cloud-init to customize a Linux VM during - * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [osProfile.windowsConfiguration] Specifies Windows - * operating system settings on the virtual machine. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] - * Indicates whether virtual machine agent should be provisioned on the virtual - * machine.

    When this property is not specified in the request body, - * default behavior is to set it to true. This will ensure that VM Agent is - * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the - * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the - * Windows Remote Management listeners. This enables remote Windows PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list of - * Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] Specifies the Linux - * operating system settings on the virtual machine.

    For a list of - * supported Linux distributions, see [Linux on Azure-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - *

    For running non-endorsed distributions, see [Information for - * Non-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} - * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies - * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] Indicates - * whether virtual machine agent should be provisioned on the virtual machine. - *

    When this property is not specified in the request body, default - * behavior is to set it to true. This will ensure that VM Agent is installed - * on the VM so that extensions can be added to the VM later. - * @member {array} [osProfile.secrets] Specifies set of certificates that - * should be installed onto the virtual machines in the scale set. - * @member {object} [storageProfile] Specifies the storage settings for the - * virtual machine disks. - * @member {object} [storageProfile.imageReference] Specifies information about - * the image to use. You can specify information about platform images, - * marketplace images, or virtual machine images. This element is required when - * you want to use a platform image, marketplace image, or virtual machine - * image, but is not used in other creation operations. - * @member {string} [storageProfile.imageReference.publisher] The image - * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the - * version of the platform image or marketplace image used to create the - * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. - * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the - * latest version of an image available at deploy time. Even if you use - * 'latest', the VM image will not automatically update after deploy time even - * if a new version becomes available. - * @member {object} [storageProfile.osDisk] Specifies information about the - * operating system disk used by the virtual machines in the scale set. - *

    For more information about disks, see [About disks and VHDs for - * Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.name] The disk name. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching - * requirements.

    Possible values are:

    **None**

    - * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard - * storage. ReadOnly for Premium storage**. Possible values include: 'None', - * 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] Specifies - * whether writeAccelerator should be enabled or disabled on the disk. - * @member {string} [storageProfile.osDisk.createOption] Specifies how the - * virtual machines in the scale set should be created.

    The only - * allowed value is: **FromImage** \u2013 This value is used when you are using - * an image to create the virtual machine. If you are using a platform image, - * you also use the imageReference element described above. If you are using a - * marketplace image, you also use the plan element previously described. - * Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {object} [storageProfile.osDisk.diffDiskSettings] Specifies the - * differencing Disk Settings for the operating system disk used by the virtual - * machine scale set. - * @member {string} [storageProfile.osDisk.diffDiskSettings.option] Specifies - * the differencing disk settings for operating system disk. Possible values - * include: 'Local' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * the operating system disk in gigabytes. This element can be used to - * overwrite the size of the disk in a virtual machine image.

    This - * value cannot be larger than 1023 GB - * @member {string} [storageProfile.osDisk.osType] This property allows you to - * specify the type of the OS that is included in the disk if creating a VM - * from user-image or a specialized VHD.

    Possible values are:

    - * **Windows**

    **Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [storageProfile.osDisk.image] Specifies information about - * the unmanaged user image to base the scale set on. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual - * hard disk's uri. - * @member {array} [storageProfile.osDisk.vhdContainers] Specifies the - * container urls that are used to store operating system disks for the scale - * set. - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk - * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS - * can only be used with data disks, it cannot be used with OS Disk. Possible - * values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', - * 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that are - * used to add data disks to the virtual machines in the scale set.

    - * For more information about disks, see [About disks and VHDs for Azure - * virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [additionalCapabilities] Specifies additional capabilities - * enabled or disabled on the virtual machine in the scale set. For instance: - * whether the virtual machine has the capability to support attaching managed - * data disks with UltraSSD_LRS storage account type. - * @member {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that - * enables or disables a capability to have one or more managed data disks with - * UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with - * storage account type UltraSSD_LRS can be added to a virtual machine or - * virtual machine scale set only if this property is enabled. - * @member {object} [networkProfile] Specifies properties of the network - * interfaces of the virtual machines in the scale set. - * @member {object} [networkProfile.healthProbe] A reference to a load balancer - * probe used to determine the health of an instance in the virtual machine - * scale set. The reference will be in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - * @member {string} [networkProfile.healthProbe.id] The ARM resource id in the - * form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {array} [networkProfile.networkInterfaceConfigurations] The list of - * network configurations. - * @member {object} [diagnosticsProfile] Specifies the boot diagnostic settings - * state.

    Minimum api-version: 2015-06-15. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is a - * debugging feature which allows you to view Console Output and Screenshot to - * diagnose VM status.

    You can easily view the output of your console - * log.

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether boot - * diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of the - * storage account to use for placing the console output and screenshot. - * @member {object} [extensionProfile] Specifies a collection of settings for - * extensions installed on virtual machines in the scale set. - * @member {array} [extensionProfile.extensions] The virtual machine scale set - * child extension resources. - * @member {string} [licenseType] Specifies that the image or disk that is - * being used was licensed on-premises. This element is only used for images - * that contain the Windows Server operating system.

    Possible values - * are:

    Windows_Client

    Windows_Server

    If this - * element is included in a request for an update, the value must match the - * initial value. This value cannot be updated.

    For more information, - * see [Azure Hybrid Use Benefit for Windows - * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    Minimum api-version: 2015-06-15 - * @member {string} [priority] Specifies the priority for the virtual machines - * in the scale set.

    Minimum api-version: 2017-10-30-preview. Possible - * values include: 'Regular', 'Low' - * @member {string} [evictionPolicy] Specifies the eviction policy for virtual - * machines in a low priority scale set.

    Minimum api-version: - * 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete' - */ +*/ export interface VirtualMachineScaleSetVMProfile { + /** + * Specifies the operating system settings for the virtual machines in the scale set. + */ osProfile?: VirtualMachineScaleSetOSProfile; + /** + * Specifies the storage settings for the virtual machine disks. + */ storageProfile?: VirtualMachineScaleSetStorageProfile; + /** + * Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. + * For instance: whether the virtual machine has the capability to support attaching managed data + * disks with UltraSSD_LRS storage account type. + */ additionalCapabilities?: AdditionalCapabilities; + /** + * Specifies properties of the network interfaces of the virtual machines in the scale set. + */ networkProfile?: VirtualMachineScaleSetNetworkProfile; + /** + * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. + */ diagnosticsProfile?: DiagnosticsProfile; + /** + * Specifies a collection of settings for extensions installed on virtual machines in the scale + * set. + */ extensionProfile?: VirtualMachineScaleSetExtensionProfile; + /** + * Specifies that the image or disk that is being used was licensed on-premises. This element is + * only used for images that contain the Windows Server operating system.

    Possible + * values are:

    Windows_Client

    Windows_Server

    If this element is + * included in a request for an update, the value must match the initial value. This value cannot + * be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows + * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) + *

    Minimum api-version: 2015-06-15 + */ licenseType?: string; + /** + * Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: + * 2017-10-30-preview. Possible values include: 'Regular', 'Low' + */ priority?: string; + /** + * Specifies the eviction policy for virtual machines in a low priority scale set. + *

    Minimum api-version: 2017-10-30-preview. Possible values include: 'Deallocate', + * 'Delete' + */ evictionPolicy?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetUpdateVMProfile class. - * @constructor * Describes a virtual machine scale set virtual machine profile. - * - * @member {object} [osProfile] The virtual machine scale set OS profile. - * @member {string} [osProfile.customData] A base-64 encoded string of custom - * data. - * @member {object} [osProfile.windowsConfiguration] The Windows Configuration - * of the OS profile. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] - * Indicates whether virtual machine agent should be provisioned on the virtual - * machine.

    When this property is not specified in the request body, - * default behavior is to set it to true. This will ensure that VM Agent is - * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the - * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the - * Windows Remote Management listeners. This enables remote Windows PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list of - * Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] The Linux Configuration of - * the OS profile. - * @member {boolean} - * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies - * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] Indicates - * whether virtual machine agent should be provisioned on the virtual machine. - *

    When this property is not specified in the request body, default - * behavior is to set it to true. This will ensure that VM Agent is installed - * on the VM so that extensions can be added to the VM later. - * @member {array} [osProfile.secrets] The List of certificates for addition to - * the VM. - * @member {object} [storageProfile] The virtual machine scale set storage - * profile. - * @member {object} [storageProfile.imageReference] The image reference. - * @member {string} [storageProfile.imageReference.publisher] The image - * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the - * version of the platform image or marketplace image used to create the - * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. - * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the - * latest version of an image available at deploy time. Even if you use - * 'latest', the VM image will not automatically update after deploy time even - * if a new version becomes available. - * @member {object} [storageProfile.osDisk] The OS disk. - * @member {string} [storageProfile.osDisk.caching] The caching type. Possible - * values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] Specifies - * whether writeAccelerator should be enabled or disabled on the disk. - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * the operating system disk in gigabytes. This element can be used to - * overwrite the size of the disk in a virtual machine image.

    This - * value cannot be larger than 1023 GB - * @member {object} [storageProfile.osDisk.image] The Source User Image - * VirtualHardDisk. This VirtualHardDisk will be copied before using it to - * attach to the Virtual Machine. If SourceImage is provided, the destination - * VirtualHardDisk should not exist. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual - * hard disk's uri. - * @member {array} [storageProfile.osDisk.vhdContainers] The list of virtual - * hard disk container uris. - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk - * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS - * can only be used with data disks, it cannot be used with OS Disk. Possible - * values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', - * 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] The data disks. - * @member {object} [networkProfile] The virtual machine scale set network - * profile. - * @member {array} [networkProfile.networkInterfaceConfigurations] The list of - * network configurations. - * @member {object} [diagnosticsProfile] The virtual machine scale set - * diagnostics profile. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is a - * debugging feature which allows you to view Console Output and Screenshot to - * diagnose VM status.

    You can easily view the output of your console - * log.

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether boot - * diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of the - * storage account to use for placing the console output and screenshot. - * @member {object} [extensionProfile] The virtual machine scale set extension - * profile. - * @member {array} [extensionProfile.extensions] The virtual machine scale set - * child extension resources. - * @member {string} [licenseType] The license type, which is for bring your own - * license scenario. - */ +*/ export interface VirtualMachineScaleSetUpdateVMProfile { + /** + * The virtual machine scale set OS profile. + */ osProfile?: VirtualMachineScaleSetUpdateOSProfile; + /** + * The virtual machine scale set storage profile. + */ storageProfile?: VirtualMachineScaleSetUpdateStorageProfile; + /** + * The virtual machine scale set network profile. + */ networkProfile?: VirtualMachineScaleSetUpdateNetworkProfile; + /** + * The virtual machine scale set diagnostics profile. + */ diagnosticsProfile?: DiagnosticsProfile; + /** + * The virtual machine scale set extension profile. + */ extensionProfile?: VirtualMachineScaleSetExtensionProfile; + /** + * The license type, which is for bring your own license scenario. + */ licenseType?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSet class. - * @constructor * Describes a Virtual Machine Scale Set. - * - * @member {object} [sku] The virtual machine scale set sku. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a - * scale set.

    Possible Values:

    **Standard**

    - * **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines in - * the scale set. - * @member {object} [plan] Specifies information about the marketplace image - * used to create the virtual machine. This element is only used for - * marketplace images. Before you can use a marketplace image from an API, you - * must enable the image for programmatic use. In the Azure portal, find the - * marketplace image that you want to use and then click **Want to deploy - * programmatically, Get Started ->**. Enter any required information and then - * click **Save**. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from the - * marketplace. This is the same value as Offer under the imageReference - * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {object} [upgradePolicy] The upgrade policy. - * @member {string} [upgradePolicy.mode] Specifies the mode of an upgrade to - * virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines - * in the scale set. You do this by using the manualUpgrade action.

    - * **Automatic** - All virtual machines in the scale set are automatically - * updated at the same time. Possible values include: 'Automatic', 'Manual', - * 'Rolling' - * @member {object} [upgradePolicy.rollingUpgradePolicy] The configuration - * parameters used while performing a rolling upgrade. - * @member {number} - * [upgradePolicy.rollingUpgradePolicy.maxBatchInstancePercent] The maximum - * percent of total virtual machine instances that will be upgraded - * simultaneously by the rolling upgrade in one batch. As this is a maximum, - * unhealthy instances in previous or future batches can cause the percentage - * of instances in a batch to decrease to ensure higher reliability. The - * default value for this parameter is 20%. - * @member {number} - * [upgradePolicy.rollingUpgradePolicy.maxUnhealthyInstancePercent] The maximum - * percentage of the total virtual machine instances in the scale set that can - * be simultaneously unhealthy, either as a result of being upgraded, or by - * being found in an unhealthy state by the virtual machine health checks - * before the rolling upgrade aborts. This constraint will be checked prior to - * starting any batch. The default value for this parameter is 20%. - * @member {number} - * [upgradePolicy.rollingUpgradePolicy.maxUnhealthyUpgradedInstancePercent] The - * maximum percentage of upgraded virtual machine instances that can be found - * to be in an unhealthy state. This check will happen after each batch is - * upgraded. If this percentage is ever exceeded, the rolling update aborts. - * The default value for this parameter is 20%. - * @member {string} - * [upgradePolicy.rollingUpgradePolicy.pauseTimeBetweenBatches] The wait time - * between completing the update for all virtual machines in one batch and - * starting the next batch. The time duration should be specified in ISO 8601 - * format. The default value is 0 seconds (PT0S). - * @member {object} [upgradePolicy.automaticOSUpgradePolicy] Configuration - * parameters used for performing automatic OS Upgrade. - * @member {boolean} - * [upgradePolicy.automaticOSUpgradePolicy.enableAutomaticOSUpgrade] Whether OS - * upgrades should automatically be applied to scale set instances in a rolling - * fashion when a newer version of the image becomes available. Default value - * is false. - * @member {boolean} - * [upgradePolicy.automaticOSUpgradePolicy.disableAutomaticRollback] Whether OS - * image rollback feature should be disabled. Default value is false. - * @member {object} [virtualMachineProfile] The virtual machine profile. - * @member {object} [virtualMachineProfile.osProfile] Specifies the operating - * system settings for the virtual machines in the scale set. - * @member {string} [virtualMachineProfile.osProfile.computerNamePrefix] - * Specifies the computer name prefix for all of the virtual machines in the - * scale set. Computer name prefixes must be 1 to 15 characters long. - * @member {string} [virtualMachineProfile.osProfile.adminUsername] Specifies - * the name of the administrator account.

    **Windows-only - * restriction:** Cannot end in "."

    **Disallowed values:** - * "administrator", "admin", "user", "user1", "test", "user2", "test1", - * "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", - * "backup", "console", "david", "guest", "john", "owner", "root", "server", - * "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", - * "user5".

    **Minimum-length (Linux):** 1 character

    - * **Max-length (Linux):** 64 characters

    **Max-length (Windows):** 20 - * characters

  • For root access to the Linux VM, see [Using root - * privileges on Linux virtual machines in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • - * For a list of built-in system users on Linux that should not be used in this - * field, see [Selecting User Names for Linux on - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [virtualMachineProfile.osProfile.adminPassword] Specifies - * the password of the administrator account.

    **Minimum-length - * (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters - *

    **Max-length (Windows):** 123 characters

    **Max-length - * (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 - * conditions below need to be fulfilled
    Has lower characters
    Has - * upper characters
    Has a digit
    Has a special character (Regex match - * [\W_])

    **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", - * "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", - * "Password22", "iloveyou!"

    For resetting the password, see [How to - * reset the Remote Desktop service or its login password in a Windows - * VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    For resetting root password, see [Manage users, SSH, and check or - * repair disks on Azure Linux VMs using the VMAccess - * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [virtualMachineProfile.osProfile.customData] Specifies a - * base-64 encoded string of custom data. The base-64 encoded string is decoded - * to a binary array that is saved as a file on the Virtual Machine. The - * maximum length of the binary array is 65535 bytes.

    For using - * cloud-init for your VM, see [Using cloud-init to customize a Linux VM during - * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [virtualMachineProfile.osProfile.windowsConfiguration] - * Specifies Windows operating system settings on the virtual machine. - * @member {boolean} - * [virtualMachineProfile.osProfile.windowsConfiguration.provisionVMAgent] - * Indicates whether virtual machine agent should be provisioned on the virtual - * machine.

    When this property is not specified in the request body, - * default behavior is to set it to true. This will ensure that VM Agent is - * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} - * [virtualMachineProfile.osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} - * [virtualMachineProfile.osProfile.windowsConfiguration.timeZone] Specifies - * the time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} - * [virtualMachineProfile.osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} - * [virtualMachineProfile.osProfile.windowsConfiguration.winRM] Specifies the - * Windows Remote Management listeners. This enables remote Windows PowerShell. - * @member {array} - * [virtualMachineProfile.osProfile.windowsConfiguration.winRM.listeners] The - * list of Windows Remote Management listeners - * @member {object} [virtualMachineProfile.osProfile.linuxConfiguration] - * Specifies the Linux operating system settings on the virtual machine. - *

    For a list of supported Linux distributions, see [Linux on - * Azure-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - *

    For running non-endorsed distributions, see [Information for - * Non-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} - * [virtualMachineProfile.osProfile.linuxConfiguration.disablePasswordAuthentication] - * Specifies whether password authentication should be disabled. - * @member {object} [virtualMachineProfile.osProfile.linuxConfiguration.ssh] - * Specifies the ssh key configuration for a Linux OS. - * @member {array} - * [virtualMachineProfile.osProfile.linuxConfiguration.ssh.publicKeys] The list - * of SSH public keys used to authenticate with linux based VMs. - * @member {boolean} - * [virtualMachineProfile.osProfile.linuxConfiguration.provisionVMAgent] - * Indicates whether virtual machine agent should be provisioned on the virtual - * machine.

    When this property is not specified in the request body, - * default behavior is to set it to true. This will ensure that VM Agent is - * installed on the VM so that extensions can be added to the VM later. - * @member {array} [virtualMachineProfile.osProfile.secrets] Specifies set of - * certificates that should be installed onto the virtual machines in the scale - * set. - * @member {object} [virtualMachineProfile.storageProfile] Specifies the - * storage settings for the virtual machine disks. - * @member {object} [virtualMachineProfile.storageProfile.imageReference] - * Specifies information about the image to use. You can specify information - * about platform images, marketplace images, or virtual machine images. This - * element is required when you want to use a platform image, marketplace - * image, or virtual machine image, but is not used in other creation - * operations. - * @member {string} - * [virtualMachineProfile.storageProfile.imageReference.publisher] The image - * publisher. - * @member {string} [virtualMachineProfile.storageProfile.imageReference.offer] - * Specifies the offer of the platform image or marketplace image used to - * create the virtual machine. - * @member {string} [virtualMachineProfile.storageProfile.imageReference.sku] - * The image SKU. - * @member {string} - * [virtualMachineProfile.storageProfile.imageReference.version] Specifies the - * version of the platform image or marketplace image used to create the - * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. - * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the - * latest version of an image available at deploy time. Even if you use - * 'latest', the VM image will not automatically update after deploy time even - * if a new version becomes available. - * @member {object} [virtualMachineProfile.storageProfile.osDisk] Specifies - * information about the operating system disk used by the virtual machines in - * the scale set.

    For more information about disks, see [About disks - * and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [virtualMachineProfile.storageProfile.osDisk.name] The disk - * name. - * @member {string} [virtualMachineProfile.storageProfile.osDisk.caching] - * Specifies the caching requirements.

    Possible values are:

    - * **None**

    **ReadOnly**

    **ReadWrite**

    Default: - * **None for Standard storage. ReadOnly for Premium storage**. Possible values - * include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} - * [virtualMachineProfile.storageProfile.osDisk.writeAcceleratorEnabled] - * Specifies whether writeAccelerator should be enabled or disabled on the - * disk. - * @member {string} [virtualMachineProfile.storageProfile.osDisk.createOption] - * Specifies how the virtual machines in the scale set should be - * created.

    The only allowed value is: **FromImage** \u2013 This value - * is used when you are using an image to create the virtual machine. If you - * are using a platform image, you also use the imageReference element - * described above. If you are using a marketplace image, you also use the - * plan element previously described. Possible values include: 'FromImage', - * 'Empty', 'Attach' - * @member {object} - * [virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] Specifies the - * differencing Disk Settings for the operating system disk used by the virtual - * machine scale set. - * @member {string} - * [virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible - * values include: 'Local' - * @member {number} [virtualMachineProfile.storageProfile.osDisk.diskSizeGB] - * Specifies the size of the operating system disk in gigabytes. This element - * can be used to overwrite the size of the disk in a virtual machine image. - *

    This value cannot be larger than 1023 GB - * @member {string} [virtualMachineProfile.storageProfile.osDisk.osType] This - * property allows you to specify the type of the OS that is included in the - * disk if creating a VM from user-image or a specialized VHD.

    - * Possible values are:

    **Windows**

    **Linux**. Possible - * values include: 'Windows', 'Linux' - * @member {object} [virtualMachineProfile.storageProfile.osDisk.image] - * Specifies information about the unmanaged user image to base the scale set - * on. - * @member {string} [virtualMachineProfile.storageProfile.osDisk.image.uri] - * Specifies the virtual hard disk's uri. - * @member {array} [virtualMachineProfile.storageProfile.osDisk.vhdContainers] - * Specifies the container urls that are used to store operating system disks - * for the scale set. - * @member {object} [virtualMachineProfile.storageProfile.osDisk.managedDisk] - * The managed disk parameters. - * @member {string} - * [virtualMachineProfile.storageProfile.osDisk.managedDisk.storageAccountType] - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS - * can only be used with data disks, it cannot be used with OS Disk. Possible - * values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', - * 'UltraSSD_LRS' - * @member {array} [virtualMachineProfile.storageProfile.dataDisks] Specifies - * the parameters that are used to add data disks to the virtual machines in - * the scale set.

    For more information about disks, see [About disks - * and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [virtualMachineProfile.additionalCapabilities] Specifies - * additional capabilities enabled or disabled on the virtual machine in the - * scale set. For instance: whether the virtual machine has the capability to - * support attaching managed data disks with UltraSSD_LRS storage account type. - * @member {boolean} - * [virtualMachineProfile.additionalCapabilities.ultraSSDEnabled] The flag that - * enables or disables a capability to have one or more managed data disks with - * UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with - * storage account type UltraSSD_LRS can be added to a virtual machine or - * virtual machine scale set only if this property is enabled. - * @member {object} [virtualMachineProfile.networkProfile] Specifies properties - * of the network interfaces of the virtual machines in the scale set. - * @member {object} [virtualMachineProfile.networkProfile.healthProbe] A - * reference to a load balancer probe used to determine the health of an - * instance in the virtual machine scale set. The reference will be in the - * form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - * @member {string} [virtualMachineProfile.networkProfile.healthProbe.id] The - * ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {array} - * [virtualMachineProfile.networkProfile.networkInterfaceConfigurations] The - * list of network configurations. - * @member {object} [virtualMachineProfile.diagnosticsProfile] Specifies the - * boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - * @member {object} [virtualMachineProfile.diagnosticsProfile.bootDiagnostics] - * Boot Diagnostics is a debugging feature which allows you to view Console - * Output and Screenshot to diagnose VM status.

    You can easily view - * the output of your console log.

    Azure also enables you to see a - * screenshot of the VM from the hypervisor. - * @member {boolean} - * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics.enabled] Whether - * boot diagnostics should be enabled on the Virtual Machine. - * @member {string} - * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics.storageUri] Uri of - * the storage account to use for placing the console output and screenshot. - * @member {object} [virtualMachineProfile.extensionProfile] Specifies a - * collection of settings for extensions installed on virtual machines in the - * scale set. - * @member {array} [virtualMachineProfile.extensionProfile.extensions] The - * virtual machine scale set child extension resources. - * @member {string} [virtualMachineProfile.licenseType] Specifies that the - * image or disk that is being used was licensed on-premises. This element is - * only used for images that contain the Windows Server operating system. - *

    Possible values are:

    Windows_Client

    - * Windows_Server

    If this element is included in a request for an - * update, the value must match the initial value. This value cannot be - * updated.

    For more information, see [Azure Hybrid Use Benefit for - * Windows - * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    Minimum api-version: 2015-06-15 - * @member {string} [virtualMachineProfile.priority] Specifies the priority for - * the virtual machines in the scale set.

    Minimum api-version: - * 2017-10-30-preview. Possible values include: 'Regular', 'Low' - * @member {string} [virtualMachineProfile.evictionPolicy] Specifies the - * eviction policy for virtual machines in a low priority scale set. - *

    Minimum api-version: 2017-10-30-preview. Possible values include: - * 'Deallocate', 'Delete' - * @member {string} [provisioningState] The provisioning state, which only - * appears in the response. - * @member {boolean} [overprovision] Specifies whether the Virtual Machine - * Scale Set should be overprovisioned. - * @member {string} [uniqueId] Specifies the ID which uniquely identifies a - * Virtual Machine Scale Set. - * @member {boolean} [singlePlacementGroup] When true this limits the scale set - * to a single placement group, of max size 100 virtual machines. - * @member {boolean} [zoneBalance] Whether to force stictly even Virtual - * Machine distribution cross x-zones in case there is zone outage. - * @member {number} [platformFaultDomainCount] Fault Domain count for each - * placement group. - * @member {object} [identity] The identity of the virtual machine scale set, - * if configured. - * @member {string} [identity.principalId] The principal id of virtual machine - * scale set identity. This property will only be provided for a system - * assigned identity. - * @member {string} [identity.tenantId] The tenant id associated with the - * virtual machine scale set. This property will only be provided for a system - * assigned identity. - * @member {string} [identity.type] The type of identity used for the virtual - * machine scale set. The type 'SystemAssigned, UserAssigned' includes both an - * implicitly created identity and a set of user assigned identities. The type - * 'None' will remove any identities from the virtual machine scale set. - * Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, - * UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user - * identities associated with the virtual machine scale set. The user identity - * dictionary key references will be ARM resource ids in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - * @member {array} [zones] The virtual machine scale set zones. - */ +*/ export interface VirtualMachineScaleSet extends Resource { + /** + * The virtual machine scale set sku. + */ sku?: Sku; + /** + * Specifies information about the marketplace image used to create the virtual machine. This + * element is only used for marketplace images. Before you can use a marketplace image from an + * API, you must enable the image for programmatic use. In the Azure portal, find the + * marketplace image that you want to use and then click **Want to deploy programmatically, Get + * Started ->**. Enter any required information and then click **Save**. + */ plan?: Plan; + /** + * The upgrade policy. + */ upgradePolicy?: UpgradePolicy; + /** + * The virtual machine profile. + */ virtualMachineProfile?: VirtualMachineScaleSetVMProfile; + /** + * The provisioning state, which only appears in the response. + */ readonly provisioningState?: string; + /** + * Specifies whether the Virtual Machine Scale Set should be overprovisioned. + */ overprovision?: boolean; + /** + * Specifies the ID which uniquely identifies a Virtual Machine Scale Set. + */ readonly uniqueId?: string; + /** + * When true this limits the scale set to a single placement group, of max size 100 virtual + * machines. + */ singlePlacementGroup?: boolean; + /** + * Whether to force strictly even Virtual Machine distribution cross x-zones in case there is + * zone outage. + */ zoneBalance?: boolean; + /** + * Fault Domain count for each placement group. + */ platformFaultDomainCount?: number; + /** + * The identity of the virtual machine scale set, if configured. + */ identity?: VirtualMachineScaleSetIdentity; + /** + * The virtual machine scale set zones. + */ zones?: string[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetVMReimageParameters class. - * @constructor * Describes a Virtual Machine Scale Set VM Reimage Parameters. - * - */ -export interface VirtualMachineScaleSetVMReimageParameters extends VirtualMachineReimageParameters { +*/ +export interface VirtualMachineScaleSetVMReimageParameters extends VirtualMachineReimageParameters +{ } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetReimageParameters class. - * @constructor * Describes a Virtual Machine Scale Set VM Reimage Parameters. - * - * @member {array} [instanceIds] The virtual machine scale set instance ids. - * Omitting the virtual machine scale set instance ids will result in the - * operation being performed on all virtual machines in the virtual machine - * scale set. - */ -export interface VirtualMachineScaleSetReimageParameters extends VirtualMachineScaleSetVMReimageParameters { +*/ +export interface VirtualMachineScaleSetReimageParameters extends +VirtualMachineScaleSetVMReimageParameters { + /** + * The virtual machine scale set instance ids. Omitting the virtual machine scale set instance + * ids will result in the operation being performed on all virtual machines in the virtual + * machine scale set. + */ instanceIds?: string[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetUpdate class. - * @constructor * Describes a Virtual Machine Scale Set. - * - * @member {object} [sku] The virtual machine scale set sku. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a - * scale set.

    Possible Values:

    **Standard**

    - * **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines in - * the scale set. - * @member {object} [plan] The purchase plan when deploying a virtual machine - * scale set from VM Marketplace images. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from the - * marketplace. This is the same value as Offer under the imageReference - * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {object} [upgradePolicy] The upgrade policy. - * @member {string} [upgradePolicy.mode] Specifies the mode of an upgrade to - * virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines - * in the scale set. You do this by using the manualUpgrade action.

    - * **Automatic** - All virtual machines in the scale set are automatically - * updated at the same time. Possible values include: 'Automatic', 'Manual', - * 'Rolling' - * @member {object} [upgradePolicy.rollingUpgradePolicy] The configuration - * parameters used while performing a rolling upgrade. - * @member {number} - * [upgradePolicy.rollingUpgradePolicy.maxBatchInstancePercent] The maximum - * percent of total virtual machine instances that will be upgraded - * simultaneously by the rolling upgrade in one batch. As this is a maximum, - * unhealthy instances in previous or future batches can cause the percentage - * of instances in a batch to decrease to ensure higher reliability. The - * default value for this parameter is 20%. - * @member {number} - * [upgradePolicy.rollingUpgradePolicy.maxUnhealthyInstancePercent] The maximum - * percentage of the total virtual machine instances in the scale set that can - * be simultaneously unhealthy, either as a result of being upgraded, or by - * being found in an unhealthy state by the virtual machine health checks - * before the rolling upgrade aborts. This constraint will be checked prior to - * starting any batch. The default value for this parameter is 20%. - * @member {number} - * [upgradePolicy.rollingUpgradePolicy.maxUnhealthyUpgradedInstancePercent] The - * maximum percentage of upgraded virtual machine instances that can be found - * to be in an unhealthy state. This check will happen after each batch is - * upgraded. If this percentage is ever exceeded, the rolling update aborts. - * The default value for this parameter is 20%. - * @member {string} - * [upgradePolicy.rollingUpgradePolicy.pauseTimeBetweenBatches] The wait time - * between completing the update for all virtual machines in one batch and - * starting the next batch. The time duration should be specified in ISO 8601 - * format. The default value is 0 seconds (PT0S). - * @member {object} [upgradePolicy.automaticOSUpgradePolicy] Configuration - * parameters used for performing automatic OS Upgrade. - * @member {boolean} - * [upgradePolicy.automaticOSUpgradePolicy.enableAutomaticOSUpgrade] Whether OS - * upgrades should automatically be applied to scale set instances in a rolling - * fashion when a newer version of the image becomes available. Default value - * is false. - * @member {boolean} - * [upgradePolicy.automaticOSUpgradePolicy.disableAutomaticRollback] Whether OS - * image rollback feature should be disabled. Default value is false. - * @member {object} [virtualMachineProfile] The virtual machine profile. - * @member {object} [virtualMachineProfile.osProfile] The virtual machine scale - * set OS profile. - * @member {string} [virtualMachineProfile.osProfile.customData] A base-64 - * encoded string of custom data. - * @member {object} [virtualMachineProfile.osProfile.windowsConfiguration] The - * Windows Configuration of the OS profile. - * @member {boolean} - * [virtualMachineProfile.osProfile.windowsConfiguration.provisionVMAgent] - * Indicates whether virtual machine agent should be provisioned on the virtual - * machine.

    When this property is not specified in the request body, - * default behavior is to set it to true. This will ensure that VM Agent is - * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} - * [virtualMachineProfile.osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} - * [virtualMachineProfile.osProfile.windowsConfiguration.timeZone] Specifies - * the time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} - * [virtualMachineProfile.osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} - * [virtualMachineProfile.osProfile.windowsConfiguration.winRM] Specifies the - * Windows Remote Management listeners. This enables remote Windows PowerShell. - * @member {array} - * [virtualMachineProfile.osProfile.windowsConfiguration.winRM.listeners] The - * list of Windows Remote Management listeners - * @member {object} [virtualMachineProfile.osProfile.linuxConfiguration] The - * Linux Configuration of the OS profile. - * @member {boolean} - * [virtualMachineProfile.osProfile.linuxConfiguration.disablePasswordAuthentication] - * Specifies whether password authentication should be disabled. - * @member {object} [virtualMachineProfile.osProfile.linuxConfiguration.ssh] - * Specifies the ssh key configuration for a Linux OS. - * @member {array} - * [virtualMachineProfile.osProfile.linuxConfiguration.ssh.publicKeys] The list - * of SSH public keys used to authenticate with linux based VMs. - * @member {boolean} - * [virtualMachineProfile.osProfile.linuxConfiguration.provisionVMAgent] - * Indicates whether virtual machine agent should be provisioned on the virtual - * machine.

    When this property is not specified in the request body, - * default behavior is to set it to true. This will ensure that VM Agent is - * installed on the VM so that extensions can be added to the VM later. - * @member {array} [virtualMachineProfile.osProfile.secrets] The List of - * certificates for addition to the VM. - * @member {object} [virtualMachineProfile.storageProfile] The virtual machine - * scale set storage profile. - * @member {object} [virtualMachineProfile.storageProfile.imageReference] The - * image reference. - * @member {string} - * [virtualMachineProfile.storageProfile.imageReference.publisher] The image - * publisher. - * @member {string} [virtualMachineProfile.storageProfile.imageReference.offer] - * Specifies the offer of the platform image or marketplace image used to - * create the virtual machine. - * @member {string} [virtualMachineProfile.storageProfile.imageReference.sku] - * The image SKU. - * @member {string} - * [virtualMachineProfile.storageProfile.imageReference.version] Specifies the - * version of the platform image or marketplace image used to create the - * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. - * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the - * latest version of an image available at deploy time. Even if you use - * 'latest', the VM image will not automatically update after deploy time even - * if a new version becomes available. - * @member {object} [virtualMachineProfile.storageProfile.osDisk] The OS disk. - * @member {string} [virtualMachineProfile.storageProfile.osDisk.caching] The - * caching type. Possible values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} - * [virtualMachineProfile.storageProfile.osDisk.writeAcceleratorEnabled] - * Specifies whether writeAccelerator should be enabled or disabled on the - * disk. - * @member {number} [virtualMachineProfile.storageProfile.osDisk.diskSizeGB] - * Specifies the size of the operating system disk in gigabytes. This element - * can be used to overwrite the size of the disk in a virtual machine image. - *

    This value cannot be larger than 1023 GB - * @member {object} [virtualMachineProfile.storageProfile.osDisk.image] The - * Source User Image VirtualHardDisk. This VirtualHardDisk will be copied - * before using it to attach to the Virtual Machine. If SourceImage is - * provided, the destination VirtualHardDisk should not exist. - * @member {string} [virtualMachineProfile.storageProfile.osDisk.image.uri] - * Specifies the virtual hard disk's uri. - * @member {array} [virtualMachineProfile.storageProfile.osDisk.vhdContainers] - * The list of virtual hard disk container uris. - * @member {object} [virtualMachineProfile.storageProfile.osDisk.managedDisk] - * The managed disk parameters. - * @member {string} - * [virtualMachineProfile.storageProfile.osDisk.managedDisk.storageAccountType] - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS - * can only be used with data disks, it cannot be used with OS Disk. Possible - * values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', - * 'UltraSSD_LRS' - * @member {array} [virtualMachineProfile.storageProfile.dataDisks] The data - * disks. - * @member {object} [virtualMachineProfile.networkProfile] The virtual machine - * scale set network profile. - * @member {array} - * [virtualMachineProfile.networkProfile.networkInterfaceConfigurations] The - * list of network configurations. - * @member {object} [virtualMachineProfile.diagnosticsProfile] The virtual - * machine scale set diagnostics profile. - * @member {object} [virtualMachineProfile.diagnosticsProfile.bootDiagnostics] - * Boot Diagnostics is a debugging feature which allows you to view Console - * Output and Screenshot to diagnose VM status.

    You can easily view - * the output of your console log.

    Azure also enables you to see a - * screenshot of the VM from the hypervisor. - * @member {boolean} - * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics.enabled] Whether - * boot diagnostics should be enabled on the Virtual Machine. - * @member {string} - * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics.storageUri] Uri of - * the storage account to use for placing the console output and screenshot. - * @member {object} [virtualMachineProfile.extensionProfile] The virtual - * machine scale set extension profile. - * @member {array} [virtualMachineProfile.extensionProfile.extensions] The - * virtual machine scale set child extension resources. - * @member {string} [virtualMachineProfile.licenseType] The license type, which - * is for bring your own license scenario. - * @member {boolean} [overprovision] Specifies whether the Virtual Machine - * Scale Set should be overprovisioned. - * @member {boolean} [singlePlacementGroup] When true this limits the scale set - * to a single placement group, of max size 100 virtual machines. - * @member {object} [identity] The identity of the virtual machine scale set, - * if configured. - * @member {string} [identity.principalId] The principal id of virtual machine - * scale set identity. This property will only be provided for a system - * assigned identity. - * @member {string} [identity.tenantId] The tenant id associated with the - * virtual machine scale set. This property will only be provided for a system - * assigned identity. - * @member {string} [identity.type] The type of identity used for the virtual - * machine scale set. The type 'SystemAssigned, UserAssigned' includes both an - * implicitly created identity and a set of user assigned identities. The type - * 'None' will remove any identities from the virtual machine scale set. - * Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, - * UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user - * identities associated with the virtual machine scale set. The user identity - * dictionary key references will be ARM resource ids in the form: - * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - */ +*/ export interface VirtualMachineScaleSetUpdate extends UpdateResource { + /** + * The virtual machine scale set sku. + */ sku?: Sku; + /** + * The purchase plan when deploying a virtual machine scale set from VM Marketplace images. + */ plan?: Plan; + /** + * The upgrade policy. + */ upgradePolicy?: UpgradePolicy; + /** + * The virtual machine profile. + */ virtualMachineProfile?: VirtualMachineScaleSetUpdateVMProfile; + /** + * Specifies whether the Virtual Machine Scale Set should be overprovisioned. + */ overprovision?: boolean; + /** + * When true this limits the scale set to a single placement group, of max size 100 virtual + * machines. + */ singlePlacementGroup?: boolean; + /** + * The identity of the virtual machine scale set, if configured. + */ identity?: VirtualMachineScaleSetIdentity; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetVMInstanceIDs class. - * @constructor * Specifies a list of virtual machine instance IDs from the VM scale set. - * - * @member {array} [instanceIds] The virtual machine scale set instance ids. - * Omitting the virtual machine scale set instance ids will result in the - * operation being performed on all virtual machines in the virtual machine - * scale set. - */ +*/ export interface VirtualMachineScaleSetVMInstanceIDs { + /** + * The virtual machine scale set instance ids. Omitting the virtual machine scale set instance + * ids will result in the operation being performed on all virtual machines in the virtual + * machine scale set. + */ instanceIds?: string[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetVMInstanceRequiredIDs class. - * @constructor * Specifies a list of virtual machine instance IDs from the VM scale set. - * - * @member {array} instanceIds The virtual machine scale set instance ids. - */ +*/ export interface VirtualMachineScaleSetVMInstanceRequiredIDs { + /** + * The virtual machine scale set instance ids. + */ instanceIds: string[]; } /** - * @class - * Initializes a new instance of the VirtualMachineStatusCodeCount class. - * @constructor - * The status code and count of the virtual machine scale set instance view - * status summary. - * - * @member {string} [code] The instance view status code. - * @member {number} [count] The number of instances having a particular status - * code. - */ + * The status code and count of the virtual machine scale set instance view status summary. +*/ export interface VirtualMachineStatusCodeCount { + /** + * The instance view status code. + */ readonly code?: string; + /** + * The number of instances having a particular status code. + */ readonly count?: number; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetInstanceViewStatusesSummary class. - * @constructor - * Instance view statuses summary for virtual machines of a virtual machine - * scale set. - * - * @member {array} [statusesSummary] The extensions information. - */ + * Instance view statuses summary for virtual machines of a virtual machine scale set. +*/ export interface VirtualMachineScaleSetInstanceViewStatusesSummary { + /** + * The extensions information. + */ readonly statusesSummary?: VirtualMachineStatusCodeCount[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetVMExtensionsSummary class. - * @constructor * Extensions summary for virtual machines of a virtual machine scale set. - * - * @member {string} [name] The extension name. - * @member {array} [statusesSummary] The extensions information. - */ +*/ export interface VirtualMachineScaleSetVMExtensionsSummary { + /** + * The extension name. + */ readonly name?: string; + /** + * The extensions information. + */ readonly statusesSummary?: VirtualMachineStatusCodeCount[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetInstanceView class. - * @constructor * The instance view of a virtual machine scale set. - * - * @member {object} [virtualMachine] The instance view status summary for the - * virtual machine scale set. - * @member {array} [virtualMachine.statusesSummary] The extensions information. - * @member {array} [extensions] The extensions information. - * @member {array} [statuses] The resource status information. - */ +*/ export interface VirtualMachineScaleSetInstanceView { + /** + * The instance view status summary for the virtual machine scale set. + */ readonly virtualMachine?: VirtualMachineScaleSetInstanceViewStatusesSummary; + /** + * The extensions information. + */ readonly extensions?: VirtualMachineScaleSetVMExtensionsSummary[]; + /** + * The resource status information. + */ statuses?: InstanceViewStatus[]; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetSkuCapacity class. - * @constructor * Describes scaling information of a sku. - * - * @member {number} [minimum] The minimum capacity. - * @member {number} [maximum] The maximum capacity that can be set. - * @member {number} [defaultCapacity] The default capacity. - * @member {string} [scaleType] The scale type applicable to the sku. Possible - * values include: 'Automatic', 'None' - */ +*/ export interface VirtualMachineScaleSetSkuCapacity { + /** + * The minimum capacity. + */ readonly minimum?: number; + /** + * The maximum capacity that can be set. + */ readonly maximum?: number; + /** + * The default capacity. + */ readonly defaultCapacity?: number; + /** + * The scale type applicable to the sku. Possible values include: 'Automatic', 'None' + */ readonly scaleType?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetSku class. - * @constructor * Describes an available virtual machine scale set sku. - * - * @member {string} [resourceType] The type of resource the sku applies to. - * @member {object} [sku] The Sku. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a - * scale set.

    Possible Values:

    **Standard**

    - * **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines in - * the scale set. - * @member {object} [capacity] Specifies the number of virtual machines in the - * scale set. - * @member {number} [capacity.minimum] The minimum capacity. - * @member {number} [capacity.maximum] The maximum capacity that can be set. - * @member {number} [capacity.defaultCapacity] The default capacity. - * @member {string} [capacity.scaleType] The scale type applicable to the sku. - * Possible values include: 'Automatic', 'None' - */ +*/ export interface VirtualMachineScaleSetSku { + /** + * The type of resource the sku applies to. + */ readonly resourceType?: string; + /** + * The Sku. + */ readonly sku?: Sku; + /** + * Specifies the number of virtual machines in the scale set. + */ readonly capacity?: VirtualMachineScaleSetSkuCapacity; } /** - * @class - * Initializes a new instance of the ApiErrorBase class. - * @constructor * Api error base. - * - * @member {string} [code] The error code. - * @member {string} [target] The target of the particular error. - * @member {string} [message] The error message. - */ +*/ export interface ApiErrorBase { + /** + * The error code. + */ code?: string; + /** + * The target of the particular error. + */ target?: string; + /** + * The error message. + */ message?: string; } /** - * @class - * Initializes a new instance of the InnerError class. - * @constructor * Inner error details. - * - * @member {string} [exceptiontype] The exception type. - * @member {string} [errordetail] The internal error message or exception dump. - */ +*/ export interface InnerError { + /** + * The exception type. + */ exceptiontype?: string; + /** + * The internal error message or exception dump. + */ errordetail?: string; } /** - * @class - * Initializes a new instance of the ApiError class. - * @constructor * Api error. - * - * @member {array} [details] The Api error details - * @member {object} [innererror] The Api inner error - * @member {string} [innererror.exceptiontype] The exception type. - * @member {string} [innererror.errordetail] The internal error message or - * exception dump. - * @member {string} [code] The error code. - * @member {string} [target] The target of the particular error. - * @member {string} [message] The error message. - */ +*/ export interface ApiError { + /** + * The Api error details + */ details?: ApiErrorBase[]; + /** + * The Api inner error + */ innererror?: InnerError; + /** + * The error code. + */ code?: string; + /** + * The target of the particular error. + */ target?: string; + /** + * The error message. + */ message?: string; } /** - * @class - * Initializes a new instance of the RollbackStatusInfo class. - * @constructor - * Information about rollback on failed VM instances after a OS Upgrade - * operation. - * - * @member {number} [successfullyRolledbackInstanceCount] The number of - * instances which have been successfully rolled back. - * @member {number} [failedRolledbackInstanceCount] The number of instances - * which failed to rollback. - * @member {object} [rollbackError] Error details if OS rollback failed. - * @member {array} [rollbackError.details] The Api error details - * @member {object} [rollbackError.innererror] The Api inner error - * @member {string} [rollbackError.innererror.exceptiontype] The exception - * type. - * @member {string} [rollbackError.innererror.errordetail] The internal error - * message or exception dump. - * @member {string} [rollbackError.code] The error code. - * @member {string} [rollbackError.target] The target of the particular error. - * @member {string} [rollbackError.message] The error message. - */ + * Information about rollback on failed VM instances after a OS Upgrade operation. +*/ export interface RollbackStatusInfo { + /** + * The number of instances which have been successfully rolled back. + */ readonly successfullyRolledbackInstanceCount?: number; + /** + * The number of instances which failed to rollback. + */ readonly failedRolledbackInstanceCount?: number; + /** + * Error details if OS rollback failed. + */ readonly rollbackError?: ApiError; } /** - * @class - * Initializes a new instance of the UpgradeOperationHistoryStatus class. - * @constructor * Information about the current running state of the overall upgrade. - * - * @member {string} [code] Code indicating the current status of the upgrade. - * Possible values include: 'RollingForward', 'Cancelled', 'Completed', - * 'Faulted' - * @member {date} [startTime] Start time of the upgrade. - * @member {date} [endTime] End time of the upgrade. - */ +*/ export interface UpgradeOperationHistoryStatus { + /** + * Code indicating the current status of the upgrade. Possible values include: 'RollingForward', + * 'Cancelled', 'Completed', 'Faulted' + */ readonly code?: string; + /** + * Start time of the upgrade. + */ readonly startTime?: Date; + /** + * End time of the upgrade. + */ readonly endTime?: Date; } /** - * @class - * Initializes a new instance of the RollingUpgradeProgressInfo class. - * @constructor - * Information about the number of virtual machine instances in each upgrade - * state. - * - * @member {number} [successfulInstanceCount] The number of instances that have - * been successfully upgraded. - * @member {number} [failedInstanceCount] The number of instances that have - * failed to be upgraded successfully. - * @member {number} [inProgressInstanceCount] The number of instances that are - * currently being upgraded. - * @member {number} [pendingInstanceCount] The number of instances that have - * not yet begun to be upgraded. - */ + * Information about the number of virtual machine instances in each upgrade state. +*/ export interface RollingUpgradeProgressInfo { + /** + * The number of instances that have been successfully upgraded. + */ readonly successfulInstanceCount?: number; + /** + * The number of instances that have failed to be upgraded successfully. + */ readonly failedInstanceCount?: number; + /** + * The number of instances that are currently being upgraded. + */ readonly inProgressInstanceCount?: number; + /** + * The number of instances that have not yet begun to be upgraded. + */ readonly pendingInstanceCount?: number; } /** - * @class - * Initializes a new instance of the UpgradeOperationHistoricalStatusInfoProperties class. - * @constructor * Describes each OS upgrade on the Virtual Machine Scale Set. - * - * @member {object} [runningStatus] Information about the overall status of the - * upgrade operation. - * @member {string} [runningStatus.code] Code indicating the current status of - * the upgrade. Possible values include: 'RollingForward', 'Cancelled', - * 'Completed', 'Faulted' - * @member {date} [runningStatus.startTime] Start time of the upgrade. - * @member {date} [runningStatus.endTime] End time of the upgrade. - * @member {object} [progress] Counts of the VM's in each state. - * @member {number} [progress.successfulInstanceCount] The number of instances - * that have been successfully upgraded. - * @member {number} [progress.failedInstanceCount] The number of instances that - * have failed to be upgraded successfully. - * @member {number} [progress.inProgressInstanceCount] The number of instances - * that are currently being upgraded. - * @member {number} [progress.pendingInstanceCount] The number of instances - * that have not yet begun to be upgraded. - * @member {object} [error] Error Details for this upgrade if there are any. - * @member {array} [error.details] The Api error details - * @member {object} [error.innererror] The Api inner error - * @member {string} [error.innererror.exceptiontype] The exception type. - * @member {string} [error.innererror.errordetail] The internal error message - * or exception dump. - * @member {string} [error.code] The error code. - * @member {string} [error.target] The target of the particular error. - * @member {string} [error.message] The error message. - * @member {string} [startedBy] Invoker of the Upgrade Operation. Possible - * values include: 'Unknown', 'User', 'Platform' - * @member {object} [targetImageReference] Image Reference details - * @member {string} [targetImageReference.publisher] The image publisher. - * @member {string} [targetImageReference.offer] Specifies the offer of the - * platform image or marketplace image used to create the virtual machine. - * @member {string} [targetImageReference.sku] The image SKU. - * @member {string} [targetImageReference.version] Specifies the version of the - * platform image or marketplace image used to create the virtual machine. The - * allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build - * are decimal numbers. Specify 'latest' to use the latest version of an image - * available at deploy time. Even if you use 'latest', the VM image will not - * automatically update after deploy time even if a new version becomes - * available. - * @member {object} [rollbackInfo] Information about OS rollback if performed - * @member {number} [rollbackInfo.successfullyRolledbackInstanceCount] The - * number of instances which have been successfully rolled back. - * @member {number} [rollbackInfo.failedRolledbackInstanceCount] The number of - * instances which failed to rollback. - * @member {object} [rollbackInfo.rollbackError] Error details if OS rollback - * failed. - * @member {array} [rollbackInfo.rollbackError.details] The Api error details - * @member {object} [rollbackInfo.rollbackError.innererror] The Api inner error - * @member {string} [rollbackInfo.rollbackError.innererror.exceptiontype] The - * exception type. - * @member {string} [rollbackInfo.rollbackError.innererror.errordetail] The - * internal error message or exception dump. - * @member {string} [rollbackInfo.rollbackError.code] The error code. - * @member {string} [rollbackInfo.rollbackError.target] The target of the - * particular error. - * @member {string} [rollbackInfo.rollbackError.message] The error message. - */ +*/ export interface UpgradeOperationHistoricalStatusInfoProperties { + /** + * Information about the overall status of the upgrade operation. + */ readonly runningStatus?: UpgradeOperationHistoryStatus; + /** + * Counts of the VMs in each state. + */ readonly progress?: RollingUpgradeProgressInfo; + /** + * Error Details for this upgrade if there are any. + */ readonly error?: ApiError; + /** + * Invoker of the Upgrade Operation. Possible values include: 'Unknown', 'User', 'Platform' + */ readonly startedBy?: string; + /** + * Image Reference details + */ readonly targetImageReference?: ImageReference; + /** + * Information about OS rollback if performed + */ readonly rollbackInfo?: RollbackStatusInfo; } /** - * @class - * Initializes a new instance of the UpgradeOperationHistoricalStatusInfo class. - * @constructor * Virtual Machine Scale Set OS Upgrade History operation response. - * - * @member {object} [properties] Information about the properties of the - * upgrade operation. - * @member {object} [properties.runningStatus] Information about the overall - * status of the upgrade operation. - * @member {string} [properties.runningStatus.code] Code indicating the current - * status of the upgrade. Possible values include: 'RollingForward', - * 'Cancelled', 'Completed', 'Faulted' - * @member {date} [properties.runningStatus.startTime] Start time of the - * upgrade. - * @member {date} [properties.runningStatus.endTime] End time of the upgrade. - * @member {object} [properties.progress] Counts of the VM's in each state. - * @member {number} [properties.progress.successfulInstanceCount] The number of - * instances that have been successfully upgraded. - * @member {number} [properties.progress.failedInstanceCount] The number of - * instances that have failed to be upgraded successfully. - * @member {number} [properties.progress.inProgressInstanceCount] The number of - * instances that are currently being upgraded. - * @member {number} [properties.progress.pendingInstanceCount] The number of - * instances that have not yet begun to be upgraded. - * @member {object} [properties.error] Error Details for this upgrade if there - * are any. - * @member {array} [properties.error.details] The Api error details - * @member {object} [properties.error.innererror] The Api inner error - * @member {string} [properties.error.innererror.exceptiontype] The exception - * type. - * @member {string} [properties.error.innererror.errordetail] The internal - * error message or exception dump. - * @member {string} [properties.error.code] The error code. - * @member {string} [properties.error.target] The target of the particular - * error. - * @member {string} [properties.error.message] The error message. - * @member {string} [properties.startedBy] Invoker of the Upgrade Operation. - * Possible values include: 'Unknown', 'User', 'Platform' - * @member {object} [properties.targetImageReference] Image Reference details - * @member {string} [properties.targetImageReference.publisher] The image - * publisher. - * @member {string} [properties.targetImageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [properties.targetImageReference.sku] The image SKU. - * @member {string} [properties.targetImageReference.version] Specifies the - * version of the platform image or marketplace image used to create the - * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. - * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the - * latest version of an image available at deploy time. Even if you use - * 'latest', the VM image will not automatically update after deploy time even - * if a new version becomes available. - * @member {object} [properties.rollbackInfo] Information about OS rollback if - * performed - * @member {number} - * [properties.rollbackInfo.successfullyRolledbackInstanceCount] The number of - * instances which have been successfully rolled back. - * @member {number} [properties.rollbackInfo.failedRolledbackInstanceCount] The - * number of instances which failed to rollback. - * @member {object} [properties.rollbackInfo.rollbackError] Error details if OS - * rollback failed. - * @member {array} [properties.rollbackInfo.rollbackError.details] The Api - * error details - * @member {object} [properties.rollbackInfo.rollbackError.innererror] The Api - * inner error - * @member {string} - * [properties.rollbackInfo.rollbackError.innererror.exceptiontype] The - * exception type. - * @member {string} - * [properties.rollbackInfo.rollbackError.innererror.errordetail] The internal - * error message or exception dump. - * @member {string} [properties.rollbackInfo.rollbackError.code] The error - * code. - * @member {string} [properties.rollbackInfo.rollbackError.target] The target - * of the particular error. - * @member {string} [properties.rollbackInfo.rollbackError.message] The error - * message. - * @member {string} [type] Resource type - * @member {string} [location] Resource location - */ +*/ export interface UpgradeOperationHistoricalStatusInfo { + /** + * Information about the properties of the upgrade operation. + */ readonly properties?: UpgradeOperationHistoricalStatusInfoProperties; + /** + * Resource type + */ readonly type?: string; + /** + * Resource location + */ readonly location?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineHealthStatus class. - * @constructor * The health status of the VM. - * - * @member {object} [status] The health status information for the VM. - * @member {string} [status.code] The status code. - * @member {string} [status.level] The level code. Possible values include: - * 'Info', 'Warning', 'Error' - * @member {string} [status.displayStatus] The short localizable label for the - * status. - * @member {string} [status.message] The detailed status message, including for - * alerts and error messages. - * @member {date} [status.time] The time of the status. - */ +*/ export interface VirtualMachineHealthStatus { + /** + * The health status information for the VM. + */ readonly status?: InstanceViewStatus; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetVMInstanceView class. - * @constructor * The instance view of a virtual machine scale set VM. - * - * @member {number} [platformUpdateDomain] The Update Domain count. - * @member {number} [platformFaultDomain] The Fault Domain count. - * @member {string} [rdpThumbPrint] The Remote desktop certificate thumbprint. - * @member {object} [vmAgent] The VM Agent running on the virtual machine. - * @member {string} [vmAgent.vmAgentVersion] The VM Agent full version. - * @member {array} [vmAgent.extensionHandlers] The virtual machine extension - * handler instance view. - * @member {array} [vmAgent.statuses] The resource status information. - * @member {object} [maintenanceRedeployStatus] The Maintenance Operation - * status on the virtual machine. - * @member {boolean} - * [maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] True, if - * customer is allowed to perform Maintenance. - * @member {date} [maintenanceRedeployStatus.preMaintenanceWindowStartTime] - * Start Time for the Pre Maintenance Window. - * @member {date} [maintenanceRedeployStatus.preMaintenanceWindowEndTime] End - * Time for the Pre Maintenance Window. - * @member {date} [maintenanceRedeployStatus.maintenanceWindowStartTime] Start - * Time for the Maintenance Window. - * @member {date} [maintenanceRedeployStatus.maintenanceWindowEndTime] End Time - * for the Maintenance Window. - * @member {string} [maintenanceRedeployStatus.lastOperationResultCode] The - * Last Maintenance Operation Result Code. Possible values include: 'None', - * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} [maintenanceRedeployStatus.lastOperationMessage] Message - * returned for the last Maintenance Operation. - * @member {array} [disks] The disks information. - * @member {array} [extensions] The extensions information. - * @member {object} [vmHealth] The health status for the VM. - * @member {object} [vmHealth.status] The health status information for the VM. - * @member {string} [vmHealth.status.code] The status code. - * @member {string} [vmHealth.status.level] The level code. Possible values - * include: 'Info', 'Warning', 'Error' - * @member {string} [vmHealth.status.displayStatus] The short localizable label - * for the status. - * @member {string} [vmHealth.status.message] The detailed status message, - * including for alerts and error messages. - * @member {date} [vmHealth.status.time] The time of the status. - * @member {object} [bootDiagnostics] Boot Diagnostics is a debugging feature - * which allows you to view Console Output and Screenshot to diagnose VM - * status.

    You can easily view the output of your console log. - *

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {string} [bootDiagnostics.consoleScreenshotBlobUri] The console - * screenshot blob URI. - * @member {string} [bootDiagnostics.serialConsoleLogBlobUri] The Linux serial - * console log blob Uri. - * @member {object} [bootDiagnostics.status] The boot diagnostics status - * information for the VM.

    NOTE: It will be set only if there are - * errors encountered in enabling boot diagnostics. - * @member {string} [bootDiagnostics.status.code] The status code. - * @member {string} [bootDiagnostics.status.level] The level code. Possible - * values include: 'Info', 'Warning', 'Error' - * @member {string} [bootDiagnostics.status.displayStatus] The short - * localizable label for the status. - * @member {string} [bootDiagnostics.status.message] The detailed status - * message, including for alerts and error messages. - * @member {date} [bootDiagnostics.status.time] The time of the status. - * @member {array} [statuses] The resource status information. - * @member {string} [placementGroupId] The placement group in which the VM is - * running. If the VM is deallocated it will not have a placementGroupId. - */ +*/ export interface VirtualMachineScaleSetVMInstanceView { + /** + * The Update Domain count. + */ platformUpdateDomain?: number; + /** + * The Fault Domain count. + */ platformFaultDomain?: number; + /** + * The Remote desktop certificate thumbprint. + */ rdpThumbPrint?: string; + /** + * The VM Agent running on the virtual machine. + */ vmAgent?: VirtualMachineAgentInstanceView; + /** + * The Maintenance Operation status on the virtual machine. + */ maintenanceRedeployStatus?: MaintenanceRedeployStatus; + /** + * The disks information. + */ disks?: DiskInstanceView[]; + /** + * The extensions information. + */ extensions?: VirtualMachineExtensionInstanceView[]; + /** + * The health status for the VM. + */ readonly vmHealth?: VirtualMachineHealthStatus; + /** + * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot + * to diagnose VM status.

    You can easily view the output of your console log.

    + * Azure also enables you to see a screenshot of the VM from the hypervisor. + */ bootDiagnostics?: BootDiagnosticsInstanceView; + /** + * The resource status information. + */ statuses?: InstanceViewStatus[]; + /** + * The placement group in which the VM is running. If the VM is deallocated it will not have a + * placementGroupId. + */ placementGroupId?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetVM class. - * @constructor * Describes a virtual machine scale set virtual machine. - * - * @member {string} [instanceId] The virtual machine instance ID. - * @member {object} [sku] The virtual machine SKU. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a - * scale set.

    Possible Values:

    **Standard**

    - * **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines in - * the scale set. - * @member {boolean} [latestModelApplied] Specifies whether the latest model - * has been applied to the virtual machine. - * @member {string} [vmId] Azure VM unique ID. - * @member {object} [instanceView] The virtual machine instance view. - * @member {number} [instanceView.platformUpdateDomain] The Update Domain - * count. - * @member {number} [instanceView.platformFaultDomain] The Fault Domain count. - * @member {string} [instanceView.rdpThumbPrint] The Remote desktop certificate - * thumbprint. - * @member {object} [instanceView.vmAgent] The VM Agent running on the virtual - * machine. - * @member {string} [instanceView.vmAgent.vmAgentVersion] The VM Agent full - * version. - * @member {array} [instanceView.vmAgent.extensionHandlers] The virtual machine - * extension handler instance view. - * @member {array} [instanceView.vmAgent.statuses] The resource status - * information. - * @member {object} [instanceView.maintenanceRedeployStatus] The Maintenance - * Operation status on the virtual machine. - * @member {boolean} - * [instanceView.maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] - * True, if customer is allowed to perform Maintenance. - * @member {date} - * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowStartTime] Start - * Time for the Pre Maintenance Window. - * @member {date} - * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowEndTime] End - * Time for the Pre Maintenance Window. - * @member {date} - * [instanceView.maintenanceRedeployStatus.maintenanceWindowStartTime] Start - * Time for the Maintenance Window. - * @member {date} - * [instanceView.maintenanceRedeployStatus.maintenanceWindowEndTime] End Time - * for the Maintenance Window. - * @member {string} - * [instanceView.maintenanceRedeployStatus.lastOperationResultCode] The Last - * Maintenance Operation Result Code. Possible values include: 'None', - * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} - * [instanceView.maintenanceRedeployStatus.lastOperationMessage] Message - * returned for the last Maintenance Operation. - * @member {array} [instanceView.disks] The disks information. - * @member {array} [instanceView.extensions] The extensions information. - * @member {object} [instanceView.vmHealth] The health status for the VM. - * @member {object} [instanceView.vmHealth.status] The health status - * information for the VM. - * @member {string} [instanceView.vmHealth.status.code] The status code. - * @member {string} [instanceView.vmHealth.status.level] The level code. - * Possible values include: 'Info', 'Warning', 'Error' - * @member {string} [instanceView.vmHealth.status.displayStatus] The short - * localizable label for the status. - * @member {string} [instanceView.vmHealth.status.message] The detailed status - * message, including for alerts and error messages. - * @member {date} [instanceView.vmHealth.status.time] The time of the status. - * @member {object} [instanceView.bootDiagnostics] Boot Diagnostics is a - * debugging feature which allows you to view Console Output and Screenshot to - * diagnose VM status.

    You can easily view the output of your console - * log.

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {string} [instanceView.bootDiagnostics.consoleScreenshotBlobUri] The - * console screenshot blob URI. - * @member {string} [instanceView.bootDiagnostics.serialConsoleLogBlobUri] The - * Linux serial console log blob Uri. - * @member {object} [instanceView.bootDiagnostics.status] The boot diagnostics - * status information for the VM.

    NOTE: It will be set only if there - * are errors encountered in enabling boot diagnostics. - * @member {string} [instanceView.bootDiagnostics.status.code] The status code. - * @member {string} [instanceView.bootDiagnostics.status.level] The level code. - * Possible values include: 'Info', 'Warning', 'Error' - * @member {string} [instanceView.bootDiagnostics.status.displayStatus] The - * short localizable label for the status. - * @member {string} [instanceView.bootDiagnostics.status.message] The detailed - * status message, including for alerts and error messages. - * @member {date} [instanceView.bootDiagnostics.status.time] The time of the - * status. - * @member {array} [instanceView.statuses] The resource status information. - * @member {string} [instanceView.placementGroupId] The placement group in - * which the VM is running. If the VM is deallocated it will not have a - * placementGroupId. - * @member {object} [hardwareProfile] Specifies the hardware settings for the - * virtual machine. - * @member {string} [hardwareProfile.vmSize] Specifies the size of the virtual - * machine. For more information about virtual machine sizes, see [Sizes for - * virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    The available VM sizes depend on region and availability set. For a - * list of available sizes use these APIs:

    [List all available - * virtual machine sizes in an availability - * set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) - *

    [List all available virtual machine sizes in a - * region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list) - *

    [List all available virtual machine sizes for - * resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). - * Possible values include: 'Basic_A0', 'Basic_A1', 'Basic_A2', 'Basic_A3', - * 'Basic_A4', 'Standard_A0', 'Standard_A1', 'Standard_A2', 'Standard_A3', - * 'Standard_A4', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', - * 'Standard_A9', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', - * 'Standard_A2_v2', 'Standard_A4_v2', 'Standard_A8_v2', 'Standard_A2m_v2', - * 'Standard_A4m_v2', 'Standard_A8m_v2', 'Standard_B1s', 'Standard_B1ms', - * 'Standard_B2s', 'Standard_B2ms', 'Standard_B4ms', 'Standard_B8ms', - * 'Standard_D1', 'Standard_D2', 'Standard_D3', 'Standard_D4', 'Standard_D11', - * 'Standard_D12', 'Standard_D13', 'Standard_D14', 'Standard_D1_v2', - * 'Standard_D2_v2', 'Standard_D3_v2', 'Standard_D4_v2', 'Standard_D5_v2', - * 'Standard_D2_v3', 'Standard_D4_v3', 'Standard_D8_v3', 'Standard_D16_v3', - * 'Standard_D32_v3', 'Standard_D64_v3', 'Standard_D2s_v3', 'Standard_D4s_v3', - * 'Standard_D8s_v3', 'Standard_D16s_v3', 'Standard_D32s_v3', - * 'Standard_D64s_v3', 'Standard_D11_v2', 'Standard_D12_v2', 'Standard_D13_v2', - * 'Standard_D14_v2', 'Standard_D15_v2', 'Standard_DS1', 'Standard_DS2', - * 'Standard_DS3', 'Standard_DS4', 'Standard_DS11', 'Standard_DS12', - * 'Standard_DS13', 'Standard_DS14', 'Standard_DS1_v2', 'Standard_DS2_v2', - * 'Standard_DS3_v2', 'Standard_DS4_v2', 'Standard_DS5_v2', 'Standard_DS11_v2', - * 'Standard_DS12_v2', 'Standard_DS13_v2', 'Standard_DS14_v2', - * 'Standard_DS15_v2', 'Standard_DS13-4_v2', 'Standard_DS13-2_v2', - * 'Standard_DS14-8_v2', 'Standard_DS14-4_v2', 'Standard_E2_v3', - * 'Standard_E4_v3', 'Standard_E8_v3', 'Standard_E16_v3', 'Standard_E32_v3', - * 'Standard_E64_v3', 'Standard_E2s_v3', 'Standard_E4s_v3', 'Standard_E8s_v3', - * 'Standard_E16s_v3', 'Standard_E32s_v3', 'Standard_E64s_v3', - * 'Standard_E32-16_v3', 'Standard_E32-8s_v3', 'Standard_E64-32s_v3', - * 'Standard_E64-16s_v3', 'Standard_F1', 'Standard_F2', 'Standard_F4', - * 'Standard_F8', 'Standard_F16', 'Standard_F1s', 'Standard_F2s', - * 'Standard_F4s', 'Standard_F8s', 'Standard_F16s', 'Standard_F2s_v2', - * 'Standard_F4s_v2', 'Standard_F8s_v2', 'Standard_F16s_v2', - * 'Standard_F32s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_G1', - * 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', - * 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS5', - * 'Standard_GS4-8', 'Standard_GS4-4', 'Standard_GS5-16', 'Standard_GS5-8', - * 'Standard_H8', 'Standard_H16', 'Standard_H8m', 'Standard_H16m', - * 'Standard_H16r', 'Standard_H16mr', 'Standard_L4s', 'Standard_L8s', - * 'Standard_L16s', 'Standard_L32s', 'Standard_M64s', 'Standard_M64ms', - * 'Standard_M128s', 'Standard_M128ms', 'Standard_M64-32ms', - * 'Standard_M64-16ms', 'Standard_M128-64ms', 'Standard_M128-32ms', - * 'Standard_NC6', 'Standard_NC12', 'Standard_NC24', 'Standard_NC24r', - * 'Standard_NC6s_v2', 'Standard_NC12s_v2', 'Standard_NC24s_v2', - * 'Standard_NC24rs_v2', 'Standard_NC6s_v3', 'Standard_NC12s_v3', - * 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', - * 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', - * 'Standard_NV12', 'Standard_NV24' - * @member {object} [storageProfile] Specifies the storage settings for the - * virtual machine disks. - * @member {object} [storageProfile.imageReference] Specifies information about - * the image to use. You can specify information about platform images, - * marketplace images, or virtual machine images. This element is required when - * you want to use a platform image, marketplace image, or virtual machine - * image, but is not used in other creation operations. - * @member {string} [storageProfile.imageReference.publisher] The image - * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the - * version of the platform image or marketplace image used to create the - * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. - * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the - * latest version of an image available at deploy time. Even if you use - * 'latest', the VM image will not automatically update after deploy time even - * if a new version becomes available. - * @member {object} [storageProfile.osDisk] Specifies information about the - * operating system disk used by the virtual machine.

    For more - * information about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you to - * specify the type of the OS that is included in the disk if creating a VM - * from user-image or a specialized VHD.

    Possible values are:

    - * **Windows**

    **Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [storageProfile.osDisk.encryptionSettings] Specifies the - * encryption settings for the OS Disk.

    Minimum api-version: - * 2015-06-15 - * @member {object} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey] Specifies the - * location of the disk encryption key, which is a Key Vault Secret. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.secretUrl] The - * URL referencing a secret in a Key Vault. - * @member {object} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault] The - * relative URL of the Key Vault containing the secret. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {object} [storageProfile.osDisk.encryptionSettings.keyEncryptionKey] - * Specifies the location of the key encryption key in Key Vault. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.keyUrl] The URL - * referencing a key encryption key in Key Vault. - * @member {object} - * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault] The - * relative URL of the Key Vault containing the key. - * @member {string} - * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {boolean} [storageProfile.osDisk.encryptionSettings.enabled] - * Specifies whether disk encryption should be enabled on the virtual machine. - * @member {string} [storageProfile.osDisk.name] The disk name. - * @member {object} [storageProfile.osDisk.vhd] The virtual hard disk. - * @member {string} [storageProfile.osDisk.vhd.uri] Specifies the virtual hard - * disk's uri. - * @member {object} [storageProfile.osDisk.image] The source user image virtual - * hard disk. The virtual hard disk will be copied before being attached to the - * virtual machine. If SourceImage is provided, the destination virtual hard - * drive must not exist. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual - * hard disk's uri. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching - * requirements.

    Possible values are:

    **None**

    - * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard - * storage. ReadOnly for Premium storage**. Possible values include: 'None', - * 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] Specifies - * whether writeAccelerator should be enabled or disabled on the disk. - * @member {object} [storageProfile.osDisk.diffDiskSettings] Specifies the - * differencing Disk Settings for the operating system disk used by the virtual - * machine. - * @member {string} [storageProfile.osDisk.diffDiskSettings.option] Specifies - * the differencing disk settings for operating system disk. Possible values - * include: 'Local' - * @member {string} [storageProfile.osDisk.createOption] Specifies how the - * virtual machine should be created.

    Possible values are:

    - * **Attach** \u2013 This value is used when you are using a specialized disk - * to create the virtual machine.

    **FromImage** \u2013 This value is - * used when you are using an image to create the virtual machine. If you are - * using a platform image, you also use the imageReference element described - * above. If you are using a marketplace image, you also use the plan element - * previously described. Possible values include: 'FromImage', 'Empty', - * 'Attach' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of an - * empty data disk in gigabytes. This element can be used to overwrite the size - * of the disk in a virtual machine image.

    This value cannot be larger - * than 1023 GB - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk - * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS - * can only be used with data disks, it cannot be used with OS Disk. Possible - * values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', - * 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that are - * used to add a data disk to a virtual machine.

    For more information - * about disks, see [About disks and VHDs for Azure virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [additionalCapabilities] Specifies additional capabilities - * enabled or disabled on the virtual machine in the scale set. For instance: - * whether the virtual machine has the capability to support attaching managed - * data disks with UltraSSD_LRS storage account type. - * @member {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that - * enables or disables a capability to have one or more managed data disks with - * UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with - * storage account type UltraSSD_LRS can be added to a virtual machine or - * virtual machine scale set only if this property is enabled. - * @member {object} [osProfile] Specifies the operating system settings for the - * virtual machine. - * @member {string} [osProfile.computerName] Specifies the host OS name of the - * virtual machine.

    **Max-length (Windows):** 15 characters

    - * **Max-length (Linux):** 64 characters.

    For naming conventions and - * restrictions see [Azure infrastructure services implementation - * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). - * @member {string} [osProfile.adminUsername] Specifies the name of the - * administrator account.

    **Windows-only restriction:** Cannot end in - * "."

    **Disallowed values:** "administrator", "admin", "user", - * "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", - * "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", - * "john", "owner", "root", "server", "sql", "support", "support_388945a0", - * "sys", "test2", "test3", "user4", "user5".

    **Minimum-length - * (Linux):** 1 character

    **Max-length (Linux):** 64 characters - *

    **Max-length (Windows):** 20 characters

  • For root - * access to the Linux VM, see [Using root privileges on Linux virtual machines - * in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • - * For a list of built-in system users on Linux that should not be used in this - * field, see [Selecting User Names for Linux on - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [osProfile.adminPassword] Specifies the password of the - * administrator account.

    **Minimum-length (Windows):** 8 characters - *

    **Minimum-length (Linux):** 6 characters

    **Max-length - * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters - *

    **Complexity requirements:** 3 out of 4 conditions below need to be - * fulfilled
    Has lower characters
    Has upper characters
    Has a - * digit
    Has a special character (Regex match [\W_])

    **Disallowed - * values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", - * "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    - * For resetting the password, see [How to reset the Remote Desktop service or - * its login password in a Windows - * VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    For resetting root password, see [Manage users, SSH, and check or - * repair disks on Azure Linux VMs using the VMAccess - * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [osProfile.customData] Specifies a base-64 encoded string - * of custom data. The base-64 encoded string is decoded to a binary array that - * is saved as a file on the Virtual Machine. The maximum length of the binary - * array is 65535 bytes.

    For using cloud-init for your VM, see [Using - * cloud-init to customize a Linux VM during - * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [osProfile.windowsConfiguration] Specifies Windows - * operating system settings on the virtual machine. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] - * Indicates whether virtual machine agent should be provisioned on the virtual - * machine.

    When this property is not specified in the request body, - * default behavior is to set it to true. This will ensure that VM Agent is - * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the - * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the - * Windows Remote Management listeners. This enables remote Windows PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list of - * Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] Specifies the Linux - * operating system settings on the virtual machine.

    For a list of - * supported Linux distributions, see [Linux on Azure-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - *

    For running non-endorsed distributions, see [Information for - * Non-Endorsed - * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} - * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies - * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] Indicates - * whether virtual machine agent should be provisioned on the virtual machine. - *

    When this property is not specified in the request body, default - * behavior is to set it to true. This will ensure that VM Agent is installed - * on the VM so that extensions can be added to the VM later. - * @member {array} [osProfile.secrets] Specifies set of certificates that - * should be installed onto the virtual machine. - * @member {boolean} [osProfile.allowExtensionOperations] Specifies whether - * extension operations should be allowed on the virtual machine.

    This - * may only be set to False when no extensions are present on the virtual - * machine. - * @member {object} [networkProfile] Specifies the network interfaces of the - * virtual machine. - * @member {array} [networkProfile.networkInterfaces] Specifies the list of - * resource Ids for the network interfaces associated with the virtual machine. - * @member {object} [diagnosticsProfile] Specifies the boot diagnostic settings - * state.

    Minimum api-version: 2015-06-15. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is a - * debugging feature which allows you to view Console Output and Screenshot to - * diagnose VM status.

    You can easily view the output of your console - * log.

    Azure also enables you to see a screenshot of the VM from the - * hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether boot - * diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of the - * storage account to use for placing the console output and screenshot. - * @member {object} [availabilitySet] Specifies information about the - * availability set that the virtual machine should be assigned to. Virtual - * machines specified in the same availability set are allocated to different - * nodes to maximize availability. For more information about availability - * sets, see [Manage the availability of virtual - * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned - * maintenance for virtual machines in - * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    Currently, a VM can only be added to availability set at creation - * time. An existing VM cannot be added to an availability set. - * @member {string} [availabilitySet.id] Resource Id - * @member {string} [provisioningState] The provisioning state, which only - * appears in the response. - * @member {string} [licenseType] Specifies that the image or disk that is - * being used was licensed on-premises. This element is only used for images - * that contain the Windows Server operating system.

    Possible values - * are:

    Windows_Client

    Windows_Server

    If this - * element is included in a request for an update, the value must match the - * initial value. This value cannot be updated.

    For more information, - * see [Azure Hybrid Use Benefit for Windows - * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) - *

    Minimum api-version: 2015-06-15 - * @member {object} [plan] Specifies information about the marketplace image - * used to create the virtual machine. This element is only used for - * marketplace images. Before you can use a marketplace image from an API, you - * must enable the image for programmatic use. In the Azure portal, find the - * marketplace image that you want to use and then click **Want to deploy - * programmatically, Get Started ->**. Enter any required information and then - * click **Save**. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from the - * marketplace. This is the same value as Offer under the imageReference - * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {array} [resources] The virtual machine child extension resources. - * @member {array} [zones] The virtual machine zones. - */ +*/ export interface VirtualMachineScaleSetVM extends Resource { + /** + * The virtual machine instance ID. + */ readonly instanceId?: string; + /** + * The virtual machine SKU. + */ readonly sku?: Sku; + /** + * Specifies whether the latest model has been applied to the virtual machine. + */ readonly latestModelApplied?: boolean; + /** + * Specifies whether the virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + */ + protectFromScaleIn?: boolean; + /** + * Azure VM unique ID. + */ readonly vmId?: string; + /** + * The virtual machine instance view. + */ readonly instanceView?: VirtualMachineScaleSetVMInstanceView; + /** + * Specifies the hardware settings for the virtual machine. + */ hardwareProfile?: HardwareProfile; + /** + * Specifies the storage settings for the virtual machine disks. + */ storageProfile?: StorageProfile; + /** + * Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. + * For instance: whether the virtual machine has the capability to support attaching managed data + * disks with UltraSSD_LRS storage account type. + */ additionalCapabilities?: AdditionalCapabilities; + /** + * Specifies the operating system settings for the virtual machine. + */ osProfile?: OSProfile; + /** + * Specifies the network interfaces of the virtual machine. + */ networkProfile?: NetworkProfile; + /** + * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. + */ diagnosticsProfile?: DiagnosticsProfile; + /** + * Specifies information about the availability set that the virtual machine should be assigned + * to. Virtual machines specified in the same availability set are allocated to different nodes + * to maximize availability. For more information about availability sets, see [Manage the + * availability of virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). + *

    For more information on Azure planned maintenance, see [Planned maintenance for + * virtual machines in + * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) + *

    Currently, a VM can only be added to availability set at creation time. An existing + * VM cannot be added to an availability set. + */ availabilitySet?: SubResource; + /** + * The provisioning state, which only appears in the response. + */ readonly provisioningState?: string; + /** + * Specifies that the image or disk that is being used was licensed on-premises. This element is + * only used for images that contain the Windows Server operating system.

    Possible + * values are:

    Windows_Client

    Windows_Server

    If this element is + * included in a request for an update, the value must match the initial value. This value cannot + * be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows + * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) + *

    Minimum api-version: 2015-06-15 + */ licenseType?: string; + /** + * Specifies information about the marketplace image used to create the virtual machine. This + * element is only used for marketplace images. Before you can use a marketplace image from an + * API, you must enable the image for programmatic use. In the Azure portal, find the + * marketplace image that you want to use and then click **Want to deploy programmatically, Get + * Started ->**. Enter any required information and then click **Save**. + */ plan?: Plan; + /** + * The virtual machine child extension resources. + */ readonly resources?: VirtualMachineExtension[]; + /** + * The virtual machine zones. + */ readonly zones?: string[]; } /** - * @class - * Initializes a new instance of the RollingUpgradeRunningStatus class. - * @constructor * Information about the current running state of the overall upgrade. - * - * @member {string} [code] Code indicating the current status of the upgrade. - * Possible values include: 'RollingForward', 'Cancelled', 'Completed', - * 'Faulted' - * @member {date} [startTime] Start time of the upgrade. - * @member {string} [lastAction] The last action performed on the rolling - * upgrade. Possible values include: 'Start', 'Cancel' - * @member {date} [lastActionTime] Last action time of the upgrade. - */ +*/ export interface RollingUpgradeRunningStatus { + /** + * Code indicating the current status of the upgrade. Possible values include: 'RollingForward', + * 'Cancelled', 'Completed', 'Faulted' + */ readonly code?: string; + /** + * Start time of the upgrade. + */ readonly startTime?: Date; + /** + * The last action performed on the rolling upgrade. Possible values include: 'Start', 'Cancel' + */ readonly lastAction?: string; + /** + * Last action time of the upgrade. + */ readonly lastActionTime?: Date; } /** - * @class - * Initializes a new instance of the RollingUpgradeStatusInfo class. - * @constructor * The status of the latest virtual machine scale set rolling upgrade. - * - * @member {object} [policy] The rolling upgrade policies applied for this - * upgrade. - * @member {number} [policy.maxBatchInstancePercent] The maximum percent of - * total virtual machine instances that will be upgraded simultaneously by the - * rolling upgrade in one batch. As this is a maximum, unhealthy instances in - * previous or future batches can cause the percentage of instances in a batch - * to decrease to ensure higher reliability. The default value for this - * parameter is 20%. - * @member {number} [policy.maxUnhealthyInstancePercent] The maximum percentage - * of the total virtual machine instances in the scale set that can be - * simultaneously unhealthy, either as a result of being upgraded, or by being - * found in an unhealthy state by the virtual machine health checks before the - * rolling upgrade aborts. This constraint will be checked prior to starting - * any batch. The default value for this parameter is 20%. - * @member {number} [policy.maxUnhealthyUpgradedInstancePercent] The maximum - * percentage of upgraded virtual machine instances that can be found to be in - * an unhealthy state. This check will happen after each batch is upgraded. If - * this percentage is ever exceeded, the rolling update aborts. The default - * value for this parameter is 20%. - * @member {string} [policy.pauseTimeBetweenBatches] The wait time between - * completing the update for all virtual machines in one batch and starting the - * next batch. The time duration should be specified in ISO 8601 format. The - * default value is 0 seconds (PT0S). - * @member {object} [runningStatus] Information about the current running state - * of the overall upgrade. - * @member {string} [runningStatus.code] Code indicating the current status of - * the upgrade. Possible values include: 'RollingForward', 'Cancelled', - * 'Completed', 'Faulted' - * @member {date} [runningStatus.startTime] Start time of the upgrade. - * @member {string} [runningStatus.lastAction] The last action performed on the - * rolling upgrade. Possible values include: 'Start', 'Cancel' - * @member {date} [runningStatus.lastActionTime] Last action time of the - * upgrade. - * @member {object} [progress] Information about the number of virtual machine - * instances in each upgrade state. - * @member {number} [progress.successfulInstanceCount] The number of instances - * that have been successfully upgraded. - * @member {number} [progress.failedInstanceCount] The number of instances that - * have failed to be upgraded successfully. - * @member {number} [progress.inProgressInstanceCount] The number of instances - * that are currently being upgraded. - * @member {number} [progress.pendingInstanceCount] The number of instances - * that have not yet begun to be upgraded. - * @member {object} [error] Error details for this upgrade, if there are any. - * @member {array} [error.details] The Api error details - * @member {object} [error.innererror] The Api inner error - * @member {string} [error.innererror.exceptiontype] The exception type. - * @member {string} [error.innererror.errordetail] The internal error message - * or exception dump. - * @member {string} [error.code] The error code. - * @member {string} [error.target] The target of the particular error. - * @member {string} [error.message] The error message. - */ +*/ export interface RollingUpgradeStatusInfo extends Resource { + /** + * The rolling upgrade policies applied for this upgrade. + */ readonly policy?: RollingUpgradePolicy; + /** + * Information about the current running state of the overall upgrade. + */ readonly runningStatus?: RollingUpgradeRunningStatus; + /** + * Information about the number of virtual machine instances in each upgrade state. + */ readonly progress?: RollingUpgradeProgressInfo; + /** + * Error details for this upgrade, if there are any. + */ readonly error?: ApiError; } /** - * @class - * Initializes a new instance of the RecoveryWalkResponse class. - * @constructor * Response after calling a manual recovery walk - * - * @member {boolean} [walkPerformed] Whether the recovery walk was performed - * @member {number} [nextPlatformUpdateDomain] The next update domain that - * needs to be walked. Null means walk spanning all update domains has been - * completed - */ +*/ export interface RecoveryWalkResponse { + /** + * Whether the recovery walk was performed + */ readonly walkPerformed?: boolean; + /** + * The next update domain that needs to be walked. Null means walk spanning all update domains + * has been completed + */ readonly nextPlatformUpdateDomain?: number; } /** - * @class - * Initializes a new instance of the LogAnalyticsInputBase class. - * @constructor * Api input base class for LogAnalytics Api. - * - * @member {string} blobContainerSasUri SAS Uri of the logging blob container - * to which LogAnalytics Api writes output logs to. - * @member {date} fromTime From time of the query - * @member {date} toTime To time of the query - * @member {boolean} [groupByThrottlePolicy] Group query result by Throttle - * Policy applied. - * @member {boolean} [groupByOperationName] Group query result by by Operation - * Name. - * @member {boolean} [groupByResourceName] Group query result by Resource Name. - */ +*/ export interface LogAnalyticsInputBase { + /** + * SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. + */ blobContainerSasUri: string; + /** + * From time of the query + */ fromTime: Date; + /** + * To time of the query + */ toTime: Date; + /** + * Group query result by Throttle Policy applied. + */ groupByThrottlePolicy?: boolean; + /** + * Group query result by Operation Name. + */ groupByOperationName?: boolean; + /** + * Group query result by Resource Name. + */ groupByResourceName?: boolean; } /** - * @class - * Initializes a new instance of the RequestRateByIntervalInput class. - * @constructor * Api request input for LogAnalytics getRequestRateByInterval Api. - * - * @member {string} intervalLength Interval value in minutes used to create - * LogAnalytics call rate logs. Possible values include: 'ThreeMins', - * 'FiveMins', 'ThirtyMins', 'SixtyMins' - */ +*/ export interface RequestRateByIntervalInput extends LogAnalyticsInputBase { + /** + * Interval value in minutes used to create LogAnalytics call rate logs. Possible values include: + * 'ThreeMins', 'FiveMins', 'ThirtyMins', 'SixtyMins' + */ intervalLength: string; } /** - * @class - * Initializes a new instance of the ThrottledRequestsInput class. - * @constructor * Api request input for LogAnalytics getThrottledRequests Api. - * - */ +*/ export interface ThrottledRequestsInput extends LogAnalyticsInputBase { } /** - * @class - * Initializes a new instance of the LogAnalyticsOutput class. - * @constructor * LogAnalytics output properties - * - * @member {string} [output] Output file Uri path to blob container. - */ +*/ export interface LogAnalyticsOutput { + /** + * Output file Uri path to blob container. + */ readonly output?: string; } /** - * @class - * Initializes a new instance of the LogAnalyticsOperationResult class. - * @constructor * LogAnalytics operation status response - * - * @member {object} [properties] LogAnalyticsOutput - * @member {string} [properties.output] Output file Uri path to blob container. - */ +*/ export interface LogAnalyticsOperationResult { + /** + * LogAnalyticsOutput + */ readonly properties?: LogAnalyticsOutput; } /** - * @class - * Initializes a new instance of the RunCommandInputParameter class. - * @constructor * Describes the properties of a run command parameter. - * - * @member {string} name The run command parameter name. - * @member {string} value The run command parameter value. - */ +*/ export interface RunCommandInputParameter { + /** + * The run command parameter name. + */ name: string; + /** + * The run command parameter value. + */ value: string; } /** - * @class - * Initializes a new instance of the RunCommandInput class. - * @constructor * Capture Virtual Machine parameters. - * - * @member {string} commandId The run command id. - * @member {array} [script] Optional. The script to be executed. When this - * value is given, the given script will override the default script of the - * command. - * @member {array} [parameters] The run command parameters. - */ +*/ export interface RunCommandInput { + /** + * The run command id. + */ commandId: string; + /** + * Optional. The script to be executed. When this value is given, the given script will override + * the default script of the command. + */ script?: string[]; + /** + * The run command parameters. + */ parameters?: RunCommandInputParameter[]; } /** - * @class - * Initializes a new instance of the RunCommandParameterDefinition class. - * @constructor * Describes the properties of a run command parameter. - * - * @member {string} name The run command parameter name. - * @member {string} type The run command parameter type. - * @member {string} [defaultValue] The run command parameter default value. - * @member {boolean} [required] The run command parameter required. Default - * value: false . - */ +*/ export interface RunCommandParameterDefinition { + /** + * The run command parameter name. + */ name: string; + /** + * The run command parameter type. + */ type: string; + /** + * The run command parameter default value. + */ defaultValue?: string; + /** + * The run command parameter required. + */ required?: boolean; } /** - * @class - * Initializes a new instance of the RunCommandDocumentBase class. - * @constructor * Describes the properties of a Run Command metadata. - * - * @member {string} schema The VM run command schema. - * @member {string} id The VM run command id. - * @member {string} osType The Operating System type. Possible values include: - * 'Windows', 'Linux' - * @member {string} label The VM run command label. - * @member {string} description The VM run command description. - */ +*/ export interface RunCommandDocumentBase { + /** + * The VM run command schema. + */ schema: string; + /** + * The VM run command id. + */ id: string; + /** + * The Operating System type. Possible values include: 'Windows', 'Linux' + */ osType: string; + /** + * The VM run command label. + */ label: string; + /** + * The VM run command description. + */ description: string; } /** - * @class - * Initializes a new instance of the RunCommandDocument class. - * @constructor * Describes the properties of a Run Command. - * - * @member {array} script The script to be executed. - * @member {array} [parameters] The parameters used by the script. - */ +*/ export interface RunCommandDocument extends RunCommandDocumentBase { + /** + * The script to be executed. + */ script: string[]; + /** + * The parameters used by the script. + */ parameters?: RunCommandParameterDefinition[]; } -/** - * @class - * Initializes a new instance of the RunCommandResult class. - * @constructor - * @member {array} [value] Run command operation response. - */ export interface RunCommandResult { + /** + * Run command operation response. + */ value?: InstanceViewStatus[]; } /** - * @class - * Initializes a new instance of the ResourceSkuCapacity class. - * @constructor * Describes scaling information of a SKU. - * - * @member {number} [minimum] The minimum capacity. - * @member {number} [maximum] The maximum capacity that can be set. - * @member {number} [default] The default capacity. - * @member {string} [scaleType] The scale type applicable to the sku. Possible - * values include: 'Automatic', 'Manual', 'None' - */ +*/ export interface ResourceSkuCapacity { + /** + * The minimum capacity. + */ readonly minimum?: number; + /** + * The maximum capacity that can be set. + */ readonly maximum?: number; + /** + * The default capacity. + */ readonly default?: number; + /** + * The scale type applicable to the sku. Possible values include: 'Automatic', 'Manual', 'None' + */ readonly scaleType?: string; } /** - * @class - * Initializes a new instance of the ResourceSkuCosts class. - * @constructor * Describes metadata for retrieving price info. - * - * @member {string} [meterID] Used for querying price from commerce. - * @member {number} [quantity] The multiplier is needed to extend the base - * metered cost. - * @member {string} [extendedUnit] An invariant to show the extended unit. - */ +*/ export interface ResourceSkuCosts { + /** + * Used for querying price from commerce. + */ readonly meterID?: string; + /** + * The multiplier is needed to extend the base metered cost. + */ readonly quantity?: number; + /** + * An invariant to show the extended unit. + */ readonly extendedUnit?: string; } /** - * @class - * Initializes a new instance of the ResourceSkuCapabilities class. - * @constructor - * Describes The SKU capabilites object. - * - * @member {string} [name] An invariant to describe the feature. - * @member {string} [value] An invariant if the feature is measured by - * quantity. - */ + * Describes The SKU capabilities object. +*/ export interface ResourceSkuCapabilities { + /** + * An invariant to describe the feature. + */ readonly name?: string; + /** + * An invariant if the feature is measured by quantity. + */ readonly value?: string; } -/** - * @class - * Initializes a new instance of the ResourceSkuRestrictionInfo class. - * @constructor - * @member {array} [locations] Locations where the SKU is restricted - * @member {array} [zones] List of availability zones where the SKU is - * restricted. - */ export interface ResourceSkuRestrictionInfo { + /** + * Locations where the SKU is restricted + */ readonly locations?: string[]; + /** + * List of availability zones where the SKU is restricted. + */ readonly zones?: string[]; } /** - * @class - * Initializes a new instance of the ResourceSkuRestrictions class. - * @constructor * Describes scaling information of a SKU. - * - * @member {string} [type] The type of restrictions. Possible values include: - * 'Location', 'Zone' - * @member {array} [values] The value of restrictions. If the restriction type - * is set to location. This would be different locations where the SKU is - * restricted. - * @member {object} [restrictionInfo] The information about the restriction - * where the SKU cannot be used. - * @member {array} [restrictionInfo.locations] Locations where the SKU is - * restricted - * @member {array} [restrictionInfo.zones] List of availability zones where the - * SKU is restricted. - * @member {string} [reasonCode] The reason for restriction. Possible values - * include: 'QuotaId', 'NotAvailableForSubscription' - */ +*/ export interface ResourceSkuRestrictions { + /** + * The type of restrictions. Possible values include: 'Location', 'Zone' + */ readonly type?: string; + /** + * The value of restrictions. If the restriction type is set to location. This would be different + * locations where the SKU is restricted. + */ readonly values?: string[]; + /** + * The information about the restriction where the SKU cannot be used. + */ readonly restrictionInfo?: ResourceSkuRestrictionInfo; + /** + * The reason for restriction. Possible values include: 'QuotaId', 'NotAvailableForSubscription' + */ readonly reasonCode?: string; } -/** - * @class - * Initializes a new instance of the ResourceSkuLocationInfo class. - * @constructor - * @member {string} [location] Location of the SKU - * @member {array} [zones] List of availability zones where the SKU is - * supported. - */ export interface ResourceSkuLocationInfo { + /** + * Location of the SKU + */ readonly location?: string; + /** + * List of availability zones where the SKU is supported. + */ readonly zones?: string[]; } /** - * @class - * Initializes a new instance of the ResourceSku class. - * @constructor * Describes an available Compute SKU. - * - * @member {string} [resourceType] The type of resource the SKU applies to. - * @member {string} [name] The name of SKU. - * @member {string} [tier] Specifies the tier of virtual machines in a scale - * set.

    Possible Values:

    **Standard**

    - * **Basic** - * @member {string} [size] The Size of the SKU. - * @member {string} [family] The Family of this particular SKU. - * @member {string} [kind] The Kind of resources that are supported in this - * SKU. - * @member {object} [capacity] Specifies the number of virtual machines in the - * scale set. - * @member {number} [capacity.minimum] The minimum capacity. - * @member {number} [capacity.maximum] The maximum capacity that can be set. - * @member {number} [capacity.default] The default capacity. - * @member {string} [capacity.scaleType] The scale type applicable to the sku. - * Possible values include: 'Automatic', 'Manual', 'None' - * @member {array} [locations] The set of locations that the SKU is available. - * @member {array} [locationInfo] A list of locations and availability zones in - * those locations where the SKU is available. - * @member {array} [apiVersions] The api versions that support this SKU. - * @member {array} [costs] Metadata for retrieving price info. - * @member {array} [capabilities] A name value pair to describe the capability. - * @member {array} [restrictions] The restrictions because of which SKU cannot - * be used. This is empty if there are no restrictions. - */ +*/ export interface ResourceSku { + /** + * The type of resource the SKU applies to. + */ readonly resourceType?: string; + /** + * The name of SKU. + */ readonly name?: string; + /** + * Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** + */ readonly tier?: string; + /** + * The Size of the SKU. + */ readonly size?: string; + /** + * The Family of this particular SKU. + */ readonly family?: string; + /** + * The Kind of resources that are supported in this SKU. + */ readonly kind?: string; + /** + * Specifies the number of virtual machines in the scale set. + */ readonly capacity?: ResourceSkuCapacity; + /** + * The set of locations that the SKU is available. + */ readonly locations?: string[]; + /** + * A list of locations and availability zones in those locations where the SKU is available. + */ readonly locationInfo?: ResourceSkuLocationInfo[]; + /** + * The api versions that support this SKU. + */ readonly apiVersions?: string[]; + /** + * Metadata for retrieving price info. + */ readonly costs?: ResourceSkuCosts[]; + /** + * A name value pair to describe the capability. + */ readonly capabilities?: ResourceSkuCapabilities[]; + /** + * The restrictions because of which SKU cannot be used. This is empty if there are no + * restrictions. + */ readonly restrictions?: ResourceSkuRestrictions[]; } /** - * @class - * Initializes a new instance of the DiskSku class. - * @constructor - * The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or - * UltraSSD_LRS. - * - * @member {string} [name] The sku name. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {string} [tier] The sku tier. Default value: 'Standard' . - */ + * The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS. +*/ export interface DiskSku { + /** + * The sku name. Possible values include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', + * 'UltraSSD_LRS' + */ name?: string; + /** + * The sku tier. + */ readonly tier?: string; } /** - * @class - * Initializes a new instance of the ImageDiskReference class. - * @constructor * The source image used for creating the disk. - * - * @member {string} id A relative uri containing either a Platform Image - * Repository or user image reference. - * @member {number} [lun] If the disk is created from an image's data disk, - * this is an index that indicates which of the data disks in the image to use. - * For OS disks, this field is null. - */ +*/ export interface ImageDiskReference { + /** + * A relative uri containing either a Platform Image Repository or user image reference. + */ id: string; + /** + * If the disk is created from an image's data disk, this is an index that indicates which of the + * data disks in the image to use. For OS disks, this field is null. + */ lun?: number; } /** - * @class - * Initializes a new instance of the CreationData class. - * @constructor * Data used when creating a disk. - * - * @member {string} createOption This enumerates the possible sources of a - * disk's creation. Possible values include: 'Empty', 'Attach', 'FromImage', - * 'Import', 'Copy', 'Restore' - * @member {string} [storageAccountId] If createOption is Import, the Azure - * Resource Manager identifier of the storage account containing the blob to - * import as a disk. Required only if the blob is in a different subscription - * @member {object} [imageReference] Disk source information. - * @member {string} [imageReference.id] A relative uri containing either a - * Platform Image Repository or user image reference. - * @member {number} [imageReference.lun] If the disk is created from an image's - * data disk, this is an index that indicates which of the data disks in the - * image to use. For OS disks, this field is null. - * @member {string} [sourceUri] If createOption is Import, this is the URI of a - * blob to be imported into a managed disk. - * @member {string} [sourceResourceId] If createOption is Copy, this is the ARM - * id of the source snapshot or disk. - */ +*/ export interface CreationData { + /** + * This enumerates the possible sources of a disk's creation. Possible values include: 'Empty', + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' + */ createOption: string; + /** + * If createOption is Import, the Azure Resource Manager identifier of the storage account + * containing the blob to import as a disk. Required only if the blob is in a different + * subscription + */ storageAccountId?: string; + /** + * Disk source information. + */ imageReference?: ImageDiskReference; + /** + * If createOption is Import, this is the URI of a blob to be imported into a managed disk. + */ sourceUri?: string; + /** + * If createOption is Copy, this is the ARM id of the source snapshot or disk. + */ sourceResourceId?: string; } /** - * @class - * Initializes a new instance of the SourceVault class. - * @constructor - * The vault id is an Azure Resource Manager Resoure id in the form + * The vault id is an Azure Resource Manager Resource id in the form * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - * - * @member {string} [id] Resource Id - */ +*/ export interface SourceVault { + /** + * Resource Id + */ id?: string; } /** - * @class - * Initializes a new instance of the KeyVaultAndSecretReference class. - * @constructor * Key Vault Secret Url and vault id of the encryption key - * - * @member {object} sourceVault Resource id of the KeyVault containing the key - * or secret - * @member {string} [sourceVault.id] Resource Id - * @member {string} secretUrl Url pointing to a key or secret in KeyVault - */ +*/ export interface KeyVaultAndSecretReference { + /** + * Resource id of the KeyVault containing the key or secret + */ sourceVault: SourceVault; + /** + * Url pointing to a key or secret in KeyVault + */ secretUrl: string; } /** - * @class - * Initializes a new instance of the KeyVaultAndKeyReference class. - * @constructor - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is - * used to unwrap the encryptionKey - * - * @member {object} sourceVault Resource id of the KeyVault containing the key - * or secret - * @member {string} [sourceVault.id] Resource Id - * @member {string} keyUrl Url pointing to a key or secret in KeyVault - */ + * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the + * encryptionKey +*/ export interface KeyVaultAndKeyReference { + /** + * Resource id of the KeyVault containing the key or secret + */ sourceVault: SourceVault; + /** + * Url pointing to a key or secret in KeyVault + */ keyUrl: string; } /** - * @class - * Initializes a new instance of the EncryptionSettings class. - * @constructor - * Encryption settings for disk or snapshot - * - * @member {boolean} [enabled] Set this flag to true and provide - * DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set - * this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to - * disable encryption. If EncryptionSettings is null in the request object, the - * existing settings remain unchanged. - * @member {object} [diskEncryptionKey] Key Vault Secret Url and vault id of - * the disk encryption key - * @member {object} [diskEncryptionKey.sourceVault] Resource id of the KeyVault - * containing the key or secret - * @member {string} [diskEncryptionKey.sourceVault.id] Resource Id - * @member {string} [diskEncryptionKey.secretUrl] Url pointing to a key or - * secret in KeyVault - * @member {object} [keyEncryptionKey] Key Vault Key Url and vault id of the - * key encryption key - * @member {object} [keyEncryptionKey.sourceVault] Resource id of the KeyVault - * containing the key or secret - * @member {string} [keyEncryptionKey.sourceVault.id] Resource Id - * @member {string} [keyEncryptionKey.keyUrl] Url pointing to a key or secret - * in KeyVault - */ -export interface EncryptionSettings { - enabled?: boolean; + * Encryption settings for one disk volume. +*/ +export interface EncryptionSettingsElement { + /** + * Key Vault Secret Url and vault id of the disk encryption key + */ diskEncryptionKey?: KeyVaultAndSecretReference; + /** + * Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and + * when provided is used to unwrap the disk encryption key. + */ keyEncryptionKey?: KeyVaultAndKeyReference; } /** - * @class - * Initializes a new instance of the Disk class. - * @constructor + * Encryption settings for disk or snapshot +*/ +export interface EncryptionSettingsCollection { + /** + * Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to + * disable encryption. If EncryptionSettings is null in the request object, the existing settings + * remain unchanged. + */ + enabled: boolean; + /** + * A collection of encryption settings, one for each disk volume. + */ + encryptionSettings?: EncryptionSettingsElement[]; +} + +/** * Disk resource. - * - * @member {string} [managedBy] A relative URI containing the ID of the VM that - * has the disk attached. - * @member {object} [sku] - * @member {string} [sku.name] The sku name. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {string} [sku.tier] The sku tier. - * @member {array} [zones] The Logical zone list for Disk. - * @member {date} [timeCreated] The time when the disk was created. - * @member {string} [osType] The Operating System type. Possible values - * include: 'Windows', 'Linux' - * @member {object} creationData Disk source information. CreationData - * information cannot be changed after the disk has been created. - * @member {string} [creationData.createOption] This enumerates the possible - * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' - * @member {string} [creationData.storageAccountId] If createOption is Import, - * the Azure Resource Manager identifier of the storage account containing the - * blob to import as a disk. Required only if the blob is in a different - * subscription - * @member {object} [creationData.imageReference] Disk source information. - * @member {string} [creationData.imageReference.id] A relative uri containing - * either a Platform Image Repository or user image reference. - * @member {number} [creationData.imageReference.lun] If the disk is created - * from an image's data disk, this is an index that indicates which of the data - * disks in the image to use. For OS disks, this field is null. - * @member {string} [creationData.sourceUri] If createOption is Import, this is - * the URI of a blob to be imported into a managed disk. - * @member {string} [creationData.sourceResourceId] If createOption is Copy, - * this is the ARM id of the source snapshot or disk. - * @member {number} [diskSizeGB] If creationData.createOption is Empty, this - * field is mandatory and it indicates the size of the VHD to create. If this - * field is present for updates or creation with other options, it indicates a - * resize. Resizes are only allowed if the disk is not attached to a running - * VM, and can only increase the disk's size. - * @member {object} [encryptionSettings] Encryption settings for disk or - * snapshot - * @member {boolean} [encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and - * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the - * request object, the existing settings remain unchanged. - * @member {object} [encryptionSettings.diskEncryptionKey] Key Vault Secret Url - * and vault id of the disk encryption key - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] Resource - * id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] Url - * pointing to a key or secret in KeyVault - * @member {object} [encryptionSettings.keyEncryptionKey] Key Vault Key Url and - * vault id of the key encryption key - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] Resource - * id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] Url pointing - * to a key or secret in KeyVault - * @member {string} [provisioningState] The disk provisioning state. - * @member {number} [diskIOPSReadWrite] The number of IOPS allowed for this - * disk; only settable for UltraSSD disks. One operation can transfer between - * 4k and 256k bytes. - * @member {number} [diskMBpsReadWrite] The bandwidth allowed for this disk; - * only settable for UltraSSD disks. MBps means millions of bytes per second - - * MB here uses the ISO notation, of powers of 10. - */ +*/ export interface Disk extends Resource { + /** + * A relative URI containing the ID of the VM that has the disk attached. + */ readonly managedBy?: string; sku?: DiskSku; + /** + * The Logical zone list for Disk. + */ zones?: string[]; + /** + * The time when the disk was created. + */ readonly timeCreated?: Date; + /** + * The Operating System type. Possible values include: 'Windows', 'Linux' + */ osType?: string; + /** + * The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values + * include: 'V1', 'V2' + */ + hyperVGeneration?: string; + /** + * Disk source information. CreationData information cannot be changed after the disk has been + * created. + */ creationData: CreationData; + /** + * If creationData.createOption is Empty, this field is mandatory and it indicates the size of + * the VHD to create. If this field is present for updates or creation with other options, it + * indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and + * can only increase the disk's size. + */ diskSizeGB?: number; - encryptionSettings?: EncryptionSettings; + /** + * Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. + */ + encryptionSettingsCollection?: EncryptionSettingsCollection; + /** + * The disk provisioning state. + */ readonly provisioningState?: string; + /** + * The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can + * transfer between 4k and 256k bytes. + */ diskIOPSReadWrite?: number; + /** + * The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of + * bytes per second - MB here uses the ISO notation, of powers of 10. + */ diskMBpsReadWrite?: number; + /** + * The state of the disk. Possible values include: 'Unattached', 'Attached', 'Reserved', + * 'ActiveSAS', 'ReadyToUpload', 'ActiveUpload' + */ + readonly diskState?: string; } /** - * @class - * Initializes a new instance of the DiskUpdate class. - * @constructor * Disk update resource. - * - * @member {string} [osType] the Operating System type. Possible values - * include: 'Windows', 'Linux' - * @member {number} [diskSizeGB] If creationData.createOption is Empty, this - * field is mandatory and it indicates the size of the VHD to create. If this - * field is present for updates or creation with other options, it indicates a - * resize. Resizes are only allowed if the disk is not attached to a running - * VM, and can only increase the disk's size. - * @member {object} [encryptionSettings] Encryption settings for disk or - * snapshot - * @member {boolean} [encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and - * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the - * request object, the existing settings remain unchanged. - * @member {object} [encryptionSettings.diskEncryptionKey] Key Vault Secret Url - * and vault id of the disk encryption key - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] Resource - * id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] Url - * pointing to a key or secret in KeyVault - * @member {object} [encryptionSettings.keyEncryptionKey] Key Vault Key Url and - * vault id of the key encryption key - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] Resource - * id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] Url pointing - * to a key or secret in KeyVault - * @member {number} [diskIOPSReadWrite] The number of IOPS allowed for this - * disk; only settable for UltraSSD disks. One operation can transfer between - * 4k and 256k bytes. - * @member {number} [diskMBpsReadWrite] The bandwidth allowed for this disk; - * only settable for UltraSSD disks. MBps means millions of bytes per second - - * MB here uses the ISO notation, of powers of 10. - * @member {object} [tags] Resource tags - * @member {object} [sku] - * @member {string} [sku.name] The sku name. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {string} [sku.tier] The sku tier. - */ +*/ export interface DiskUpdate { + /** + * the Operating System type. Possible values include: 'Windows', 'Linux' + */ osType?: string; + /** + * If creationData.createOption is Empty, this field is mandatory and it indicates the size of + * the VHD to create. If this field is present for updates or creation with other options, it + * indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and + * can only increase the disk's size. + */ diskSizeGB?: number; - encryptionSettings?: EncryptionSettings; + /** + * Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. + */ + encryptionSettingsCollection?: EncryptionSettingsCollection; + /** + * The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can + * transfer between 4k and 256k bytes. + */ diskIOPSReadWrite?: number; + /** + * The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of + * bytes per second - MB here uses the ISO notation, of powers of 10. + */ diskMBpsReadWrite?: number; + /** + * Resource tags + */ tags?: { [propertyName: string]: string }; sku?: DiskSku; } /** - * @class - * Initializes a new instance of the SnapshotSku class. - * @constructor * The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. - * - * @member {string} [name] The sku name. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'Standard_ZRS' - * @member {string} [tier] The sku tier. Default value: 'Standard' . - */ +*/ export interface SnapshotSku { + /** + * The sku name. Possible values include: 'Standard_LRS', 'Premium_LRS', 'Standard_ZRS' + */ name?: string; + /** + * The sku tier. + */ readonly tier?: string; } /** - * @class - * Initializes a new instance of the GrantAccessData class. - * @constructor * Data used for requesting a SAS. - * - * @member {string} access Possible values include: 'None', 'Read' - * @member {number} durationInSeconds Time duration in seconds until the SAS - * access expires. - */ +*/ export interface GrantAccessData { + /** + * Possible values include: 'None', 'Read', 'Write' + */ access: string; + /** + * Time duration in seconds until the SAS access expires. + */ durationInSeconds: number; } /** - * @class - * Initializes a new instance of the AccessUri class. - * @constructor * A disk access SAS uri. - * - * @member {string} [accessSAS] A SAS uri for accessing a disk. - */ +*/ export interface AccessUri { + /** + * A SAS uri for accessing a disk. + */ readonly accessSAS?: string; } /** - * @class - * Initializes a new instance of the Snapshot class. - * @constructor * Snapshot resource. - * - * @member {string} [managedBy] Unused. Always Null. - * @member {object} [sku] - * @member {string} [sku.name] The sku name. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'Standard_ZRS' - * @member {string} [sku.tier] The sku tier. - * @member {date} [timeCreated] The time when the disk was created. - * @member {string} [osType] The Operating System type. Possible values - * include: 'Windows', 'Linux' - * @member {object} creationData Disk source information. CreationData - * information cannot be changed after the disk has been created. - * @member {string} [creationData.createOption] This enumerates the possible - * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' - * @member {string} [creationData.storageAccountId] If createOption is Import, - * the Azure Resource Manager identifier of the storage account containing the - * blob to import as a disk. Required only if the blob is in a different - * subscription - * @member {object} [creationData.imageReference] Disk source information. - * @member {string} [creationData.imageReference.id] A relative uri containing - * either a Platform Image Repository or user image reference. - * @member {number} [creationData.imageReference.lun] If the disk is created - * from an image's data disk, this is an index that indicates which of the data - * disks in the image to use. For OS disks, this field is null. - * @member {string} [creationData.sourceUri] If createOption is Import, this is - * the URI of a blob to be imported into a managed disk. - * @member {string} [creationData.sourceResourceId] If createOption is Copy, - * this is the ARM id of the source snapshot or disk. - * @member {number} [diskSizeGB] If creationData.createOption is Empty, this - * field is mandatory and it indicates the size of the VHD to create. If this - * field is present for updates or creation with other options, it indicates a - * resize. Resizes are only allowed if the disk is not attached to a running - * VM, and can only increase the disk's size. - * @member {object} [encryptionSettings] Encryption settings for disk or - * snapshot - * @member {boolean} [encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and - * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the - * request object, the existing settings remain unchanged. - * @member {object} [encryptionSettings.diskEncryptionKey] Key Vault Secret Url - * and vault id of the disk encryption key - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] Resource - * id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] Url - * pointing to a key or secret in KeyVault - * @member {object} [encryptionSettings.keyEncryptionKey] Key Vault Key Url and - * vault id of the key encryption key - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] Resource - * id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] Url pointing - * to a key or secret in KeyVault - * @member {string} [provisioningState] The disk provisioning state. - */ +*/ export interface Snapshot extends Resource { + /** + * Unused. Always Null. + */ readonly managedBy?: string; sku?: SnapshotSku; + /** + * The time when the disk was created. + */ readonly timeCreated?: Date; + /** + * The Operating System type. Possible values include: 'Windows', 'Linux' + */ osType?: string; + /** + * The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values + * include: 'V1', 'V2' + */ + hyperVGeneration?: string; + /** + * Disk source information. CreationData information cannot be changed after the disk has been + * created. + */ creationData: CreationData; + /** + * If creationData.createOption is Empty, this field is mandatory and it indicates the size of + * the VHD to create. If this field is present for updates or creation with other options, it + * indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and + * can only increase the disk's size. + */ diskSizeGB?: number; - encryptionSettings?: EncryptionSettings; + /** + * Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. + */ + encryptionSettingsCollection?: EncryptionSettingsCollection; + /** + * The disk provisioning state. + */ readonly provisioningState?: string; } /** - * @class - * Initializes a new instance of the SnapshotUpdate class. - * @constructor * Snapshot update resource. - * - * @member {string} [osType] the Operating System type. Possible values - * include: 'Windows', 'Linux' - * @member {number} [diskSizeGB] If creationData.createOption is Empty, this - * field is mandatory and it indicates the size of the VHD to create. If this - * field is present for updates or creation with other options, it indicates a - * resize. Resizes are only allowed if the disk is not attached to a running - * VM, and can only increase the disk's size. - * @member {object} [encryptionSettings] Encryption settings for disk or - * snapshot - * @member {boolean} [encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and - * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the - * request object, the existing settings remain unchanged. - * @member {object} [encryptionSettings.diskEncryptionKey] Key Vault Secret Url - * and vault id of the disk encryption key - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] Resource - * id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] Url - * pointing to a key or secret in KeyVault - * @member {object} [encryptionSettings.keyEncryptionKey] Key Vault Key Url and - * vault id of the key encryption key - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] Resource - * id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] Url pointing - * to a key or secret in KeyVault - * @member {object} [tags] Resource tags - * @member {object} [sku] - * @member {string} [sku.name] The sku name. Possible values include: - * 'Standard_LRS', 'Premium_LRS', 'Standard_ZRS' - * @member {string} [sku.tier] The sku tier. - */ +*/ export interface SnapshotUpdate { + /** + * the Operating System type. Possible values include: 'Windows', 'Linux' + */ osType?: string; + /** + * If creationData.createOption is Empty, this field is mandatory and it indicates the size of + * the VHD to create. If this field is present for updates or creation with other options, it + * indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and + * can only increase the disk's size. + */ diskSizeGB?: number; - encryptionSettings?: EncryptionSettings; + /** + * Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. + */ + encryptionSettingsCollection?: EncryptionSettingsCollection; + /** + * Resource tags + */ tags?: { [propertyName: string]: string }; sku?: SnapshotSku; } /** - * @class - * Initializes a new instance of the GalleryIdentifier class. - * @constructor * Describes the gallery unique name. - * - * @member {string} [uniqueName] The unique name of the Shared Image Gallery. - * This name is generated automatically by Azure. - */ +*/ export interface GalleryIdentifier { + /** + * The unique name of the Shared Image Gallery. This name is generated automatically by Azure. + */ readonly uniqueName?: string; } /** - * @class - * Initializes a new instance of the Gallery class. - * @constructor - * Specifies information about the Shared Image Gallery that you want to create - * or update. - * - * @member {string} [description] The description of this Shared Image Gallery - * resource. This property is updateable. - * @member {object} [identifier] - * @member {string} [identifier.uniqueName] The unique name of the Shared Image - * Gallery. This name is generated automatically by Azure. - * @member {string} [provisioningState] The current state of the gallery. The - * provisioning state, which only appears in the response. Possible values - * include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting', - * 'Migrating' - */ + * Specifies information about the Shared Image Gallery that you want to create or update. +*/ export interface Gallery extends Resource { + /** + * The description of this Shared Image Gallery resource. This property is updatable. + */ description?: string; identifier?: GalleryIdentifier; + /** + * @summary The current state of the gallery. + * @description The provisioning state, which only appears in the response. Possible values + * include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting', 'Migrating' + */ readonly provisioningState?: string; } /** - * @class - * Initializes a new instance of the GalleryImageIdentifier class. - * @constructor * This is the gallery Image Definition identifier. - * - * @member {string} publisher The name of the gallery Image Definition - * publisher. - * @member {string} offer The name of the gallery Image Definition offer. - * @member {string} sku The name of the gallery Image Definition SKU. - */ +*/ export interface GalleryImageIdentifier { + /** + * The name of the gallery Image Definition publisher. + */ publisher: string; + /** + * The name of the gallery Image Definition offer. + */ offer: string; + /** + * The name of the gallery Image Definition SKU. + */ sku: string; } /** - * @class - * Initializes a new instance of the ResourceRange class. - * @constructor * Describes the resource range. - * - * @member {number} [min] The minimum number of the resource. - * @member {number} [max] The maximum number of the resource. - */ +*/ export interface ResourceRange { + /** + * The minimum number of the resource. + */ min?: number; + /** + * The maximum number of the resource. + */ max?: number; } /** - * @class - * Initializes a new instance of the RecommendedMachineConfiguration class. - * @constructor - * The properties describe the recommended machine configuration for this Image - * Definition. These properties are updateable. - * - * @member {object} [vCPUs] - * @member {number} [vCPUs.min] The minimum number of the resource. - * @member {number} [vCPUs.max] The maximum number of the resource. - * @member {object} [memory] - * @member {number} [memory.min] The minimum number of the resource. - * @member {number} [memory.max] The maximum number of the resource. - */ + * The properties describe the recommended machine configuration for this Image Definition. These + * properties are updatable. +*/ export interface RecommendedMachineConfiguration { vCPUs?: ResourceRange; memory?: ResourceRange; } /** - * @class - * Initializes a new instance of the Disallowed class. - * @constructor * Describes the disallowed disk types. - * - * @member {array} [diskTypes] A list of disk types. - */ +*/ export interface Disallowed { + /** + * A list of disk types. + */ diskTypes?: string[]; } /** - * @class - * Initializes a new instance of the ImagePurchasePlan class. - * @constructor - * Describes the gallery Image Definition purchase plan. This is used by - * marketplace images. - * - * @member {string} [name] The plan ID. - * @member {string} [publisher] The publisher ID. - * @member {string} [product] The product ID. - */ + * Describes the gallery Image Definition purchase plan. This is used by marketplace images. +*/ export interface ImagePurchasePlan { + /** + * The plan ID. + */ name?: string; + /** + * The publisher ID. + */ publisher?: string; + /** + * The product ID. + */ product?: string; } /** - * @class - * Initializes a new instance of the GalleryImage class. - * @constructor - * Specifies information about the gallery Image Definition that you want to - * create or update. - * - * @member {string} [description] The description of this gallery Image - * Definition resource. This property is updateable. - * @member {string} [eula] The Eula agreement for the gallery Image Definition. - * @member {string} [privacyStatementUri] The privacy statement uri. - * @member {string} [releaseNoteUri] The release note uri. - * @member {string} osType This property allows you to specify the type of the - * OS that is included in the disk when creating a VM from a managed image. - *

    Possible values are:

    **Windows**

    **Linux**. - * Possible values include: 'Windows', 'Linux' - * @member {string} osState The allowed values for OS State are 'Generalized'. - * Possible values include: 'Generalized', 'Specialized' - * @member {date} [endOfLifeDate] The end of life date of the gallery Image - * Definition. This property can be used for decommissioning purposes. This - * property is updateable. - * @member {object} identifier - * @member {string} [identifier.publisher] The name of the gallery Image - * Definition publisher. - * @member {string} [identifier.offer] The name of the gallery Image Definition - * offer. - * @member {string} [identifier.sku] The name of the gallery Image Definition - * SKU. - * @member {object} [recommended] - * @member {object} [recommended.vCPUs] - * @member {number} [recommended.vCPUs.min] The minimum number of the resource. - * @member {number} [recommended.vCPUs.max] The maximum number of the resource. - * @member {object} [recommended.memory] - * @member {number} [recommended.memory.min] The minimum number of the - * resource. - * @member {number} [recommended.memory.max] The maximum number of the - * resource. - * @member {object} [disallowed] - * @member {array} [disallowed.diskTypes] A list of disk types. - * @member {object} [purchasePlan] - * @member {string} [purchasePlan.name] The plan ID. - * @member {string} [purchasePlan.publisher] The publisher ID. - * @member {string} [purchasePlan.product] The product ID. - * @member {string} [provisioningState] The current state of the gallery Image - * Definition. The provisioning state, which only appears in the response. - * Possible values include: 'Creating', 'Updating', 'Failed', 'Succeeded', - * 'Deleting', 'Migrating' - */ + * Specifies information about the gallery Image Definition that you want to create or update. +*/ export interface GalleryImage extends Resource { + /** + * The description of this gallery Image Definition resource. This property is updatable. + */ description?: string; + /** + * The Eula agreement for the gallery Image Definition. + */ eula?: string; + /** + * The privacy statement uri. + */ privacyStatementUri?: string; + /** + * The release note uri. + */ releaseNoteUri?: string; + /** + * This property allows you to specify the type of the OS that is included in the disk when + * creating a VM from a managed image.

    Possible values are:

    **Windows** + *

    **Linux**. Possible values include: 'Windows', 'Linux' + */ osType: string; + /** + * The allowed values for OS State are 'Generalized'. Possible values include: 'Generalized', + * 'Specialized' + */ osState: string; + /** + * The end of life date of the gallery Image Definition. This property can be used for + * decommissioning purposes. This property is updatable. + */ endOfLifeDate?: Date; identifier: GalleryImageIdentifier; recommended?: RecommendedMachineConfiguration; disallowed?: Disallowed; purchasePlan?: ImagePurchasePlan; + /** + * @summary The current state of the gallery Image Definition. + * @description The provisioning state, which only appears in the response. Possible values + * include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting', 'Migrating' + */ readonly provisioningState?: string; } /** - * @class - * Initializes a new instance of the GalleryArtifactPublishingProfileBase class. - * @constructor * Describes the basic gallery artifact publishing profile. - * - * @member {array} [targetRegions] The target regions where the Image Version - * is going to be replicated to. This property is updateable. - * @member {object} source - * @member {object} [source.managedImage] - * @member {string} [source.managedImage.id] The managed artifact id. - */ +*/ export interface GalleryArtifactPublishingProfileBase { + /** + * The target regions where the Image Version is going to be replicated to. This property is + * updatable. + */ targetRegions?: TargetRegion[]; source: GalleryArtifactSource; } /** - * @class - * Initializes a new instance of the GalleryImageVersionPublishingProfile class. - * @constructor * The publishing profile of a gallery Image Version. - * - * @member {number} [replicaCount] The number of replicas of the Image Version - * to be created per region. This property would take effect for a region when - * regionalReplicaCount is not specified. This property is updateable. - * @member {boolean} [excludeFromLatest] If set to true, Virtual Machines - * deployed from the latest version of the Image Definition won't use this - * Image Version. - * @member {date} [publishedDate] The timestamp for when the gallery Image - * Version is published. - * @member {date} [endOfLifeDate] The end of life date of the gallery Image - * Version. This property can be used for decommissioning purposes. This - * property is updateable. - */ -export interface GalleryImageVersionPublishingProfile extends GalleryArtifactPublishingProfileBase { +*/ +export interface GalleryImageVersionPublishingProfile extends GalleryArtifactPublishingProfileBase +{ + /** + * The number of replicas of the Image Version to be created per region. This property would take + * effect for a region when regionalReplicaCount is not specified. This property is updatable. + */ replicaCount?: number; + /** + * If set to true, Virtual Machines deployed from the latest version of the Image Definition + * won't use this Image Version. + */ excludeFromLatest?: boolean; + /** + * The timestamp for when the gallery Image Version is published. + */ readonly publishedDate?: Date; + /** + * The end of life date of the gallery Image Version. This property can be used for + * decommissioning purposes. This property is updatable. + */ endOfLifeDate?: Date; } /** - * @class - * Initializes a new instance of the GalleryDiskImage class. - * @constructor * This is the disk image base class. - * - * @member {number} [sizeInGB] This property indicates the size of the VHD to - * be created. - * @member {string} [hostCaching] The host caching of the disk. Valid values - * are 'None', 'ReadOnly', and 'ReadWrite'. Possible values include: 'None', - * 'ReadOnly', 'ReadWrite' - */ +*/ export interface GalleryDiskImage { + /** + * This property indicates the size of the VHD to be created. + */ readonly sizeInGB?: number; + /** + * The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'. Possible + * values include: 'None', 'ReadOnly', 'ReadWrite' + */ readonly hostCaching?: string; } /** - * @class - * Initializes a new instance of the GalleryOSDiskImage class. - * @constructor * This is the OS disk image. - * - */ +*/ export interface GalleryOSDiskImage extends GalleryDiskImage { } /** - * @class - * Initializes a new instance of the GalleryDataDiskImage class. - * @constructor * This is the data disk image. - * - * @member {number} [lun] This property specifies the logical unit number of - * the data disk. This value is used to identify data disks within the Virtual - * Machine and therefore must be unique for each data disk attached to the - * Virtual Machine. - */ +*/ export interface GalleryDataDiskImage extends GalleryDiskImage { + /** + * This property specifies the logical unit number of the data disk. This value is used to + * identify data disks within the Virtual Machine and therefore must be unique for each data disk + * attached to the Virtual Machine. + */ readonly lun?: number; } /** - * @class - * Initializes a new instance of the GalleryImageVersionStorageProfile class. - * @constructor * This is the storage profile of a gallery Image Version. - * - * @member {object} [osDiskImage] - * @member {array} [dataDiskImages] A list of data disk images. - */ +*/ export interface GalleryImageVersionStorageProfile { readonly osDiskImage?: GalleryOSDiskImage; + /** + * A list of data disk images. + */ readonly dataDiskImages?: GalleryDataDiskImage[]; } /** - * @class - * Initializes a new instance of the RegionalReplicationStatus class. - * @constructor * This is the regional replication status. - * - * @member {string} [region] The region to which the gallery Image Version is - * being replicated to. - * @member {string} [state] This is the regional replication state. Possible - * values include: 'Unknown', 'Replicating', 'Completed', 'Failed' - * @member {string} [details] The details of the replication status. - * @member {number} [progress] It indicates progress of the replication job. - */ +*/ export interface RegionalReplicationStatus { + /** + * The region to which the gallery Image Version is being replicated to. + */ readonly region?: string; + /** + * This is the regional replication state. Possible values include: 'Unknown', 'Replicating', + * 'Completed', 'Failed' + */ readonly state?: string; + /** + * The details of the replication status. + */ readonly details?: string; + /** + * It indicates progress of the replication job. + */ readonly progress?: number; } /** - * @class - * Initializes a new instance of the ReplicationStatus class. - * @constructor * This is the replication status of the gallery Image Version. - * - * @member {string} [aggregatedState] This is the aggregated replication status - * based on all the regional replication status flags. Possible values include: - * 'Unknown', 'InProgress', 'Completed', 'Failed' - * @member {array} [summary] This is a summary of replication status for each - * region. - */ +*/ export interface ReplicationStatus { + /** + * This is the aggregated replication status based on all the regional replication status flags. + * Possible values include: 'Unknown', 'InProgress', 'Completed', 'Failed' + */ readonly aggregatedState?: string; + /** + * This is a summary of replication status for each region. + */ readonly summary?: RegionalReplicationStatus[]; } /** - * @class - * Initializes a new instance of the GalleryImageVersion class. - * @constructor - * Specifies information about the gallery Image Version that you want to - * create or update. - * - * @member {object} publishingProfile - * @member {number} [publishingProfile.replicaCount] The number of replicas of - * the Image Version to be created per region. This property would take effect - * for a region when regionalReplicaCount is not specified. This property is - * updateable. - * @member {boolean} [publishingProfile.excludeFromLatest] If set to true, - * Virtual Machines deployed from the latest version of the Image Definition - * won't use this Image Version. - * @member {date} [publishingProfile.publishedDate] The timestamp for when the - * gallery Image Version is published. - * @member {date} [publishingProfile.endOfLifeDate] The end of life date of the - * gallery Image Version. This property can be used for decommissioning - * purposes. This property is updateable. - * @member {string} [provisioningState] The current state of the gallery Image - * Version. The provisioning state, which only appears in the response. - * Possible values include: 'Creating', 'Updating', 'Failed', 'Succeeded', - * 'Deleting', 'Migrating' - * @member {object} [storageProfile] - * @member {object} [storageProfile.osDiskImage] - * @member {array} [storageProfile.dataDiskImages] A list of data disk images. - * @member {object} [replicationStatus] - * @member {string} [replicationStatus.aggregatedState] This is the aggregated - * replication status based on all the regional replication status flags. - * Possible values include: 'Unknown', 'InProgress', 'Completed', 'Failed' - * @member {array} [replicationStatus.summary] This is a summary of replication - * status for each region. - */ + * Specifies information about the gallery Image Version that you want to create or update. +*/ export interface GalleryImageVersion extends Resource { publishingProfile: GalleryImageVersionPublishingProfile; + /** + * @summary The current state of the gallery Image Version. + * @description The provisioning state, which only appears in the response. Possible values + * include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting', 'Migrating' + */ readonly provisioningState?: string; readonly storageProfile?: GalleryImageVersionStorageProfile; readonly replicationStatus?: ReplicationStatus; } /** - * @class - * Initializes a new instance of the TargetRegion class. - * @constructor * Describes the target region information. - * - * @member {string} name The name of the region. - * @member {number} [regionalReplicaCount] The number of replicas of the Image - * Version to be created per region. This property is updateable. - */ +*/ export interface TargetRegion { + /** + * The name of the region. + */ name: string; + /** + * The number of replicas of the Image Version to be created per region. This property is + * updatable. + */ regionalReplicaCount?: number; } /** - * @class - * Initializes a new instance of the ManagedArtifact class. - * @constructor * The managed artifact. - * - * @member {string} id The managed artifact id. - */ +*/ export interface ManagedArtifact { + /** + * The managed artifact id. + */ id: string; } /** - * @class - * Initializes a new instance of the GalleryArtifactSource class. - * @constructor * The source image from which the Image Version is going to be created. - * - * @member {object} managedImage - * @member {string} [managedImage.id] The managed artifact id. - */ +*/ export interface GalleryArtifactSource { managedImage: ManagedArtifact; } /** - * @class - * Initializes a new instance of the ContainerServiceCustomProfile class. - * @constructor * Properties to configure a custom container service cluster. - * - * @member {string} orchestrator The name of the custom orchestrator to use. - */ +*/ export interface ContainerServiceCustomProfile { + /** + * The name of the custom orchestrator to use. + */ orchestrator: string; } /** - * @class - * Initializes a new instance of the ContainerServiceServicePrincipalProfile class. - * @constructor - * Information about a service principal identity for the cluster to use for - * manipulating Azure APIs. - * - * @member {string} clientId The ID for the service principal. - * @member {string} secret The secret password associated with the service - * principal. - */ + * Information about a service principal identity for the cluster to use for manipulating Azure + * APIs. +*/ export interface ContainerServiceServicePrincipalProfile { + /** + * The ID for the service principal. + */ clientId: string; + /** + * The secret password associated with the service principal. + */ secret: string; } /** - * @class - * Initializes a new instance of the ContainerServiceOrchestratorProfile class. - * @constructor * Profile for the container service orchestrator. - * - * @member {string} orchestratorType The orchestrator to use to manage - * container service cluster resources. Valid values are Swarm, DCOS, and - * Custom. Possible values include: 'Swarm', 'DCOS', 'Custom', 'Kubernetes' - */ +*/ export interface ContainerServiceOrchestratorProfile { + /** + * The orchestrator to use to manage container service cluster resources. Valid values are Swarm, + * DCOS, and Custom. Possible values include: 'Swarm', 'DCOS', 'Custom', 'Kubernetes' + */ orchestratorType: string; } /** - * @class - * Initializes a new instance of the ContainerServiceMasterProfile class. - * @constructor * Profile for the container service master. - * - * @member {number} [count] Number of masters (VMs) in the container service - * cluster. Allowed values are 1, 3, and 5. The default value is 1. Default - * value: 1 . - * @member {string} dnsPrefix DNS prefix to be used to create the FQDN for - * master. - * @member {string} [fqdn] FDQN for the master. - */ +*/ export interface ContainerServiceMasterProfile { + /** + * Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The + * default value is 1. + */ count?: number; + /** + * DNS prefix to be used to create the FQDN for master. + */ dnsPrefix: string; + /** + * FQDN for the master. + */ readonly fqdn?: string; } /** - * @class - * Initializes a new instance of the ContainerServiceAgentPoolProfile class. - * @constructor * Profile for the container service agent pool. - * - * @member {string} name Unique name of the agent pool profile in the context - * of the subscription and resource group. - * @member {number} count Number of agents (VMs) to host docker containers. - * Allowed values must be in the range of 1 to 100 (inclusive). The default - * value is 1. . Default value: 1 . - * @member {string} vmSize Size of agent VMs. Possible values include: - * 'Standard_A0', 'Standard_A1', 'Standard_A2', 'Standard_A3', 'Standard_A4', - * 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A9', - * 'Standard_A10', 'Standard_A11', 'Standard_D1', 'Standard_D2', 'Standard_D3', - * 'Standard_D4', 'Standard_D11', 'Standard_D12', 'Standard_D13', - * 'Standard_D14', 'Standard_D1_v2', 'Standard_D2_v2', 'Standard_D3_v2', - * 'Standard_D4_v2', 'Standard_D5_v2', 'Standard_D11_v2', 'Standard_D12_v2', - * 'Standard_D13_v2', 'Standard_D14_v2', 'Standard_G1', 'Standard_G2', - * 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_DS1', 'Standard_DS2', - * 'Standard_DS3', 'Standard_DS4', 'Standard_DS11', 'Standard_DS12', - * 'Standard_DS13', 'Standard_DS14', 'Standard_GS1', 'Standard_GS2', - * 'Standard_GS3', 'Standard_GS4', 'Standard_GS5' - * @member {string} dnsPrefix DNS prefix to be used to create the FQDN for the - * agent pool. - * @member {string} [fqdn] FDQN for the agent pool. - */ +*/ export interface ContainerServiceAgentPoolProfile { + /** + * Unique name of the agent pool profile in the context of the subscription and resource group. + */ name: string; + /** + * Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to + * 100 (inclusive). The default value is 1. + */ count: number; + /** + * Size of agent VMs. Possible values include: 'Standard_A0', 'Standard_A1', 'Standard_A2', + * 'Standard_A3', 'Standard_A4', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', + * 'Standard_A9', 'Standard_A10', 'Standard_A11', 'Standard_D1', 'Standard_D2', 'Standard_D3', + * 'Standard_D4', 'Standard_D11', 'Standard_D12', 'Standard_D13', 'Standard_D14', + * 'Standard_D1_v2', 'Standard_D2_v2', 'Standard_D3_v2', 'Standard_D4_v2', 'Standard_D5_v2', + * 'Standard_D11_v2', 'Standard_D12_v2', 'Standard_D13_v2', 'Standard_D14_v2', 'Standard_G1', + * 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_DS1', 'Standard_DS2', + * 'Standard_DS3', 'Standard_DS4', 'Standard_DS11', 'Standard_DS12', 'Standard_DS13', + * 'Standard_DS14', 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', + * 'Standard_GS5' + */ vmSize: string; + /** + * DNS prefix to be used to create the FQDN for the agent pool. + */ dnsPrefix: string; + /** + * FQDN for the agent pool. + */ readonly fqdn?: string; } /** - * @class - * Initializes a new instance of the ContainerServiceWindowsProfile class. - * @constructor * Profile for Windows VMs in the container service cluster. - * - * @member {string} adminUsername The administrator username to use for Windows - * VMs. - * @member {string} adminPassword The administrator password to use for Windows - * VMs. - */ +*/ export interface ContainerServiceWindowsProfile { + /** + * The administrator username to use for Windows VMs. + */ adminUsername: string; + /** + * The administrator password to use for Windows VMs. + */ adminPassword: string; } /** - * @class - * Initializes a new instance of the ContainerServiceSshPublicKey class. - * @constructor * Contains information about SSH certificate public key data. - * - * @member {string} keyData Certificate public key used to authenticate with - * VMs through SSH. The certificate must be in PEM format with or without - * headers. - */ +*/ export interface ContainerServiceSshPublicKey { + /** + * Certificate public key used to authenticate with VMs through SSH. The certificate must be in + * PEM format with or without headers. + */ keyData: string; } /** - * @class - * Initializes a new instance of the ContainerServiceSshConfiguration class. - * @constructor * SSH configuration for Linux-based VMs running on Azure. - * - * @member {array} publicKeys the list of SSH public keys used to authenticate - * with Linux-based VMs. - */ +*/ export interface ContainerServiceSshConfiguration { + /** + * the list of SSH public keys used to authenticate with Linux-based VMs. + */ publicKeys: ContainerServiceSshPublicKey[]; } /** - * @class - * Initializes a new instance of the ContainerServiceLinuxProfile class. - * @constructor * Profile for Linux VMs in the container service cluster. - * - * @member {string} adminUsername The administrator username to use for Linux - * VMs. - * @member {object} ssh The ssh key configuration for Linux VMs. - * @member {array} [ssh.publicKeys] the list of SSH public keys used to - * authenticate with Linux-based VMs. - */ +*/ export interface ContainerServiceLinuxProfile { + /** + * The administrator username to use for Linux VMs. + */ adminUsername: string; + /** + * The ssh key configuration for Linux VMs. + */ ssh: ContainerServiceSshConfiguration; } /** - * @class - * Initializes a new instance of the ContainerServiceVMDiagnostics class. - * @constructor * Profile for diagnostics on the container service VMs. - * - * @member {boolean} enabled Whether the VM diagnostic agent is provisioned on - * the VM. - * @member {string} [storageUri] The URI of the storage account where - * diagnostics are stored. - */ +*/ export interface ContainerServiceVMDiagnostics { + /** + * Whether the VM diagnostic agent is provisioned on the VM. + */ enabled: boolean; + /** + * The URI of the storage account where diagnostics are stored. + */ readonly storageUri?: string; } -/** - * @class - * Initializes a new instance of the ContainerServiceDiagnosticsProfile class. - * @constructor - * @member {object} vmDiagnostics Profile for the container service VM - * diagnostic agent. - * @member {boolean} [vmDiagnostics.enabled] Whether the VM diagnostic agent is - * provisioned on the VM. - * @member {string} [vmDiagnostics.storageUri] The URI of the storage account - * where diagnostics are stored. - */ export interface ContainerServiceDiagnosticsProfile { + /** + * Profile for the container service VM diagnostic agent. + */ vmDiagnostics: ContainerServiceVMDiagnostics; } /** - * @class - * Initializes a new instance of the ContainerService class. - * @constructor * Container service. - * - * @member {string} [provisioningState] the current deployment or provisioning - * state, which only appears in the response. - * @member {object} [orchestratorProfile] Properties of the orchestrator. - * @member {string} [orchestratorProfile.orchestratorType] The orchestrator to - * use to manage container service cluster resources. Valid values are Swarm, - * DCOS, and Custom. Possible values include: 'Swarm', 'DCOS', 'Custom', - * 'Kubernetes' - * @member {object} [customProfile] Properties for custom clusters. - * @member {string} [customProfile.orchestrator] The name of the custom - * orchestrator to use. - * @member {object} [servicePrincipalProfile] Properties for cluster service - * principals. - * @member {string} [servicePrincipalProfile.clientId] The ID for the service - * principal. - * @member {string} [servicePrincipalProfile.secret] The secret password - * associated with the service principal. - * @member {object} masterProfile Properties of master agents. - * @member {number} [masterProfile.count] Number of masters (VMs) in the - * container service cluster. Allowed values are 1, 3, and 5. The default value - * is 1. - * @member {string} [masterProfile.dnsPrefix] DNS prefix to be used to create - * the FQDN for master. - * @member {string} [masterProfile.fqdn] FDQN for the master. - * @member {array} agentPoolProfiles Properties of the agent pool. - * @member {object} [windowsProfile] Properties of Windows VMs. - * @member {string} [windowsProfile.adminUsername] The administrator username - * to use for Windows VMs. - * @member {string} [windowsProfile.adminPassword] The administrator password - * to use for Windows VMs. - * @member {object} linuxProfile Properties of Linux VMs. - * @member {string} [linuxProfile.adminUsername] The administrator username to - * use for Linux VMs. - * @member {object} [linuxProfile.ssh] The ssh key configuration for Linux VMs. - * @member {array} [linuxProfile.ssh.publicKeys] the list of SSH public keys - * used to authenticate with Linux-based VMs. - * @member {object} [diagnosticsProfile] Properties of the diagnostic agent. - * @member {object} [diagnosticsProfile.vmDiagnostics] Profile for the - * container service VM diagnostic agent. - * @member {boolean} [diagnosticsProfile.vmDiagnostics.enabled] Whether the VM - * diagnostic agent is provisioned on the VM. - * @member {string} [diagnosticsProfile.vmDiagnostics.storageUri] The URI of - * the storage account where diagnostics are stored. - */ +*/ export interface ContainerService extends Resource { + /** + * the current deployment or provisioning state, which only appears in the response. + */ readonly provisioningState?: string; + /** + * Properties of the orchestrator. + */ orchestratorProfile?: ContainerServiceOrchestratorProfile; + /** + * Properties for custom clusters. + */ customProfile?: ContainerServiceCustomProfile; + /** + * Properties for cluster service principals. + */ servicePrincipalProfile?: ContainerServiceServicePrincipalProfile; + /** + * Properties of master agents. + */ masterProfile: ContainerServiceMasterProfile; + /** + * Properties of the agent pool. + */ agentPoolProfiles: ContainerServiceAgentPoolProfile[]; + /** + * Properties of Windows VMs. + */ windowsProfile?: ContainerServiceWindowsProfile; + /** + * Properties of Linux VMs. + */ linuxProfile: ContainerServiceLinuxProfile; + /** + * Properties of the diagnostic agent. + */ diagnosticsProfile?: ContainerServiceDiagnosticsProfile; } - /** - * @class - * Initializes a new instance of the ComputeOperationListResult class. - * @constructor * The List Compute Operation operation response. - * - */ +*/ export interface ComputeOperationListResult extends Array { } /** - * @class - * Initializes a new instance of the AvailabilitySetListResult class. - * @constructor * The List Availability Set operation response. - * - * @member {string} [nextLink] The URI to fetch the next page of - * AvailabilitySets. Call ListNext() with this URI to fetch the next page of - * AvailabilitySets. - */ +*/ export interface AvailabilitySetListResult extends Array { + /** + * The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the + * next page of AvailabilitySets. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineSizeListResult class. - * @constructor * The List Virtual Machine operation response. - * - */ +*/ export interface VirtualMachineSizeListResult extends Array { } /** - * @class - * Initializes a new instance of the ListUsagesResult class. - * @constructor * The List Usages operation response. - * - * @member {string} [nextLink] The URI to fetch the next page of compute - * resource usage information. Call ListNext() with this to fetch the next page - * of compute resource usage information. - */ +*/ export interface ListUsagesResult extends Array { + /** + * The URI to fetch the next page of compute resource usage information. Call ListNext() with + * this to fetch the next page of compute resource usage information. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineListResult class. - * @constructor * The List Virtual Machine operation response. - * - * @member {string} [nextLink] The URI to fetch the next page of VMs. Call - * ListNext() with this URI to fetch the next page of Virtual Machines. - */ +*/ export interface VirtualMachineListResult extends Array { + /** + * The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of + * Virtual Machines. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ImageListResult class. - * @constructor * The List Image operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of Images. Call - * ListNext() with this to fetch the next page of Images. - */ +*/ export interface ImageListResult extends Array { + /** + * The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of + * Images. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetListResult class. - * @constructor * The List Virtual Machine operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of Virtual - * Machine Scale Sets. Call ListNext() with this to fetch the next page of - * VMSS. - */ +*/ export interface VirtualMachineScaleSetListResult extends Array { + /** + * The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to + * fetch the next page of VMSS. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetListWithLinkResult class. - * @constructor * The List Virtual Machine operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of Virtual - * Machine Scale Sets. Call ListNext() with this to fetch the next page of - * Virtual Machine Scale Sets. - */ +*/ export interface VirtualMachineScaleSetListWithLinkResult extends Array { + /** + * The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to + * fetch the next page of Virtual Machine Scale Sets. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetListSkusResult class. - * @constructor * The Virtual Machine Scale Set List Skus operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of Virtual - * Machine Scale Set Skus. Call ListNext() with this to fetch the next page of - * VMSS Skus. - */ +*/ export interface VirtualMachineScaleSetListSkusResult extends Array { + /** + * The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to + * fetch the next page of VMSS Skus. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetListOSUpgradeHistory class. - * @constructor * List of Virtual Machine Scale Set OS Upgrade History operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of OS Upgrade - * History. Call ListNext() with this to fetch the next page of history of - * upgrades. - */ -export interface VirtualMachineScaleSetListOSUpgradeHistory extends Array { +*/ +export interface VirtualMachineScaleSetListOSUpgradeHistory extends +Array { + /** + * The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the + * next page of history of upgrades. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetExtensionListResult class. - * @constructor * The List VM scale set extension operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of VM scale set - * extensions. Call ListNext() with this to fetch the next page of VM scale set - * extensions. - */ -export interface VirtualMachineScaleSetExtensionListResult extends Array { +*/ +export interface VirtualMachineScaleSetExtensionListResult extends +Array { + /** + * The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch + * the next page of VM scale set extensions. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualMachineScaleSetVMListResult class. - * @constructor * The List Virtual Machine Scale Set VMs operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of Virtual - * Machine Scale Set VMs. Call ListNext() with this to fetch the next page of - * VMSS VMs - */ +*/ export interface VirtualMachineScaleSetVMListResult extends Array { + /** + * The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to + * fetch the next page of VMSS VMs + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RunCommandListResult class. - * @constructor * The List Virtual Machine operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of run commands. - * Call ListNext() with this to fetch the next page of run commands. - */ +*/ export interface RunCommandListResult extends Array { + /** + * The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next + * page of run commands. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ResourceSkusResult class. - * @constructor * The Compute List Skus operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of Compute Skus. - * Call ListNext() with this to fetch the next page of VMSS Skus. - */ +*/ export interface ResourceSkusResult extends Array { + /** + * The uri to fetch the next page of Compute Skus. Call ListNext() with this to fetch the next + * page of VMSS Skus. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the DiskList class. - * @constructor * The List Disks operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of disks. Call - * ListNext() with this to fetch the next page of disks. - */ +*/ export interface DiskList extends Array { + /** + * The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of + * disks. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the SnapshotList class. - * @constructor * The List Snapshots operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of snapshots. - * Call ListNext() with this to fetch the next page of snapshots. - */ +*/ export interface SnapshotList extends Array { + /** + * The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page + * of snapshots. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the GalleryList class. - * @constructor * The List Galleries operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of galleries. - * Call ListNext() with this to fetch the next page of galleries. - */ +*/ export interface GalleryList extends Array { + /** + * The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page + * of galleries. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the GalleryImageList class. - * @constructor * The List Gallery Images operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of Image - * Definitions in the Shared Image Gallery. Call ListNext() with this to fetch - * the next page of gallery Image Definitions. - */ +*/ export interface GalleryImageList extends Array { + /** + * The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call + * ListNext() with this to fetch the next page of gallery Image Definitions. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the GalleryImageVersionList class. - * @constructor * The List Gallery Image version operation response. - * - * @member {string} [nextLink] The uri to fetch the next page of gallery Image - * Versions. Call ListNext() with this to fetch the next page of gallery Image - * Versions. - */ +*/ export interface GalleryImageVersionList extends Array { + /** + * The uri to fetch the next page of gallery Image Versions. Call ListNext() with this to fetch + * the next page of gallery Image Versions. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ContainerServiceListResult class. - * @constructor * The response from the List Container Services operation. - * - * @member {string} [nextLink] The URL to get the next set of container service - * results. - */ +*/ export interface ContainerServiceListResult extends Array { + /** + * The URL to get the next set of container service results. + */ nextLink?: string; } diff --git a/lib/services/computeManagement2/lib/models/index.js b/lib/services/computeManagement2/lib/models/index.js index 51bcbcf378..9cd22c050c 100644 --- a/lib/services/computeManagement2/lib/models/index.js +++ b/lib/services/computeManagement2/lib/models/index.js @@ -165,7 +165,8 @@ exports.CreationData = require('./creationData'); exports.SourceVault = require('./sourceVault'); exports.KeyVaultAndSecretReference = require('./keyVaultAndSecretReference'); exports.KeyVaultAndKeyReference = require('./keyVaultAndKeyReference'); -exports.EncryptionSettings = require('./encryptionSettings'); +exports.EncryptionSettingsElement = require('./encryptionSettingsElement'); +exports.EncryptionSettingsCollection = require('./encryptionSettingsCollection'); exports.Disk = require('./disk'); exports.DiskUpdate = require('./diskUpdate'); exports.SnapshotSku = require('./snapshotSku'); diff --git a/lib/services/computeManagement2/lib/models/innerError.js b/lib/services/computeManagement2/lib/models/innerError.js index 95c1a511d5..d8830a5d2b 100644 --- a/lib/services/computeManagement2/lib/models/innerError.js +++ b/lib/services/computeManagement2/lib/models/innerError.js @@ -17,8 +17,8 @@ class InnerError { /** * Create a InnerError. - * @member {string} [exceptiontype] The exception type. - * @member {string} [errordetail] The internal error message or exception + * @property {string} [exceptiontype] The exception type. + * @property {string} [errordetail] The internal error message or exception * dump. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/instanceViewStatus.js b/lib/services/computeManagement2/lib/models/instanceViewStatus.js index fdc583e161..059860a34a 100644 --- a/lib/services/computeManagement2/lib/models/instanceViewStatus.js +++ b/lib/services/computeManagement2/lib/models/instanceViewStatus.js @@ -17,14 +17,14 @@ class InstanceViewStatus { /** * Create a InstanceViewStatus. - * @member {string} [code] The status code. - * @member {string} [level] The level code. Possible values include: 'Info', - * 'Warning', 'Error' - * @member {string} [displayStatus] The short localizable label for the + * @property {string} [code] The status code. + * @property {string} [level] The level code. Possible values include: + * 'Info', 'Warning', 'Error' + * @property {string} [displayStatus] The short localizable label for the * status. - * @member {string} [message] The detailed status message, including for + * @property {string} [message] The detailed status message, including for * alerts and error messages. - * @member {date} [time] The time of the status. + * @property {date} [time] The time of the status. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/keyVaultAndKeyReference.js b/lib/services/computeManagement2/lib/models/keyVaultAndKeyReference.js index 6c9bf7d60b..d264447e77 100644 --- a/lib/services/computeManagement2/lib/models/keyVaultAndKeyReference.js +++ b/lib/services/computeManagement2/lib/models/keyVaultAndKeyReference.js @@ -18,10 +18,10 @@ class KeyVaultAndKeyReference { /** * Create a KeyVaultAndKeyReference. - * @member {object} sourceVault Resource id of the KeyVault containing the + * @property {object} sourceVault Resource id of the KeyVault containing the * key or secret - * @member {string} [sourceVault.id] Resource Id - * @member {string} keyUrl Url pointing to a key or secret in KeyVault + * @property {string} [sourceVault.id] Resource Id + * @property {string} keyUrl Url pointing to a key or secret in KeyVault */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/keyVaultAndSecretReference.js b/lib/services/computeManagement2/lib/models/keyVaultAndSecretReference.js index aa6bcbfe5a..343583a8aa 100644 --- a/lib/services/computeManagement2/lib/models/keyVaultAndSecretReference.js +++ b/lib/services/computeManagement2/lib/models/keyVaultAndSecretReference.js @@ -17,10 +17,10 @@ class KeyVaultAndSecretReference { /** * Create a KeyVaultAndSecretReference. - * @member {object} sourceVault Resource id of the KeyVault containing the + * @property {object} sourceVault Resource id of the KeyVault containing the * key or secret - * @member {string} [sourceVault.id] Resource Id - * @member {string} secretUrl Url pointing to a key or secret in KeyVault + * @property {string} [sourceVault.id] Resource Id + * @property {string} secretUrl Url pointing to a key or secret in KeyVault */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/keyVaultKeyReference.js b/lib/services/computeManagement2/lib/models/keyVaultKeyReference.js index f66d9f0e9d..c969b9e50a 100644 --- a/lib/services/computeManagement2/lib/models/keyVaultKeyReference.js +++ b/lib/services/computeManagement2/lib/models/keyVaultKeyReference.js @@ -17,11 +17,11 @@ class KeyVaultKeyReference { /** * Create a KeyVaultKeyReference. - * @member {string} keyUrl The URL referencing a key encryption key in Key + * @property {string} keyUrl The URL referencing a key encryption key in Key * Vault. - * @member {object} sourceVault The relative URL of the Key Vault containing - * the key. - * @member {string} [sourceVault.id] Resource Id + * @property {object} sourceVault The relative URL of the Key Vault + * containing the key. + * @property {string} [sourceVault.id] Resource Id */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/keyVaultSecretReference.js b/lib/services/computeManagement2/lib/models/keyVaultSecretReference.js index 422a764da3..2df7a8fcea 100644 --- a/lib/services/computeManagement2/lib/models/keyVaultSecretReference.js +++ b/lib/services/computeManagement2/lib/models/keyVaultSecretReference.js @@ -17,10 +17,10 @@ class KeyVaultSecretReference { /** * Create a KeyVaultSecretReference. - * @member {string} secretUrl The URL referencing a secret in a Key Vault. - * @member {object} sourceVault The relative URL of the Key Vault containing - * the secret. - * @member {string} [sourceVault.id] Resource Id + * @property {string} secretUrl The URL referencing a secret in a Key Vault. + * @property {object} sourceVault The relative URL of the Key Vault + * containing the secret. + * @property {string} [sourceVault.id] Resource Id */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/linuxConfiguration.js b/lib/services/computeManagement2/lib/models/linuxConfiguration.js index e5b3822cc4..82b09dadab 100644 --- a/lib/services/computeManagement2/lib/models/linuxConfiguration.js +++ b/lib/services/computeManagement2/lib/models/linuxConfiguration.js @@ -23,12 +23,13 @@ class LinuxConfiguration { /** * Create a LinuxConfiguration. - * @member {boolean} [disablePasswordAuthentication] Specifies whether + * @property {boolean} [disablePasswordAuthentication] Specifies whether * password authentication should be disabled. - * @member {object} [ssh] Specifies the ssh key configuration for a Linux OS. - * @member {array} [ssh.publicKeys] The list of SSH public keys used to + * @property {object} [ssh] Specifies the ssh key configuration for a Linux + * OS. + * @property {array} [ssh.publicKeys] The list of SSH public keys used to * authenticate with linux based VMs. - * @member {boolean} [provisionVMAgent] Indicates whether virtual machine + * @property {boolean} [provisionVMAgent] Indicates whether virtual machine * agent should be provisioned on the virtual machine.

    When this * property is not specified in the request body, default behavior is to set * it to true. This will ensure that VM Agent is installed on the VM so that diff --git a/lib/services/computeManagement2/lib/models/listUsagesResult.js b/lib/services/computeManagement2/lib/models/listUsagesResult.js index b47f4a7160..8c6a1bdb9e 100644 --- a/lib/services/computeManagement2/lib/models/listUsagesResult.js +++ b/lib/services/computeManagement2/lib/models/listUsagesResult.js @@ -16,7 +16,7 @@ class ListUsagesResult extends Array { /** * Create a ListUsagesResult. - * @member {string} [nextLink] The URI to fetch the next page of compute + * @property {string} [nextLink] The URI to fetch the next page of compute * resource usage information. Call ListNext() with this to fetch the next * page of compute resource usage information. */ diff --git a/lib/services/computeManagement2/lib/models/logAnalyticsInputBase.js b/lib/services/computeManagement2/lib/models/logAnalyticsInputBase.js index 83958ab6b1..66c111f3a1 100644 --- a/lib/services/computeManagement2/lib/models/logAnalyticsInputBase.js +++ b/lib/services/computeManagement2/lib/models/logAnalyticsInputBase.js @@ -17,15 +17,15 @@ class LogAnalyticsInputBase { /** * Create a LogAnalyticsInputBase. - * @member {string} blobContainerSasUri SAS Uri of the logging blob container - * to which LogAnalytics Api writes output logs to. - * @member {date} fromTime From time of the query - * @member {date} toTime To time of the query - * @member {boolean} [groupByThrottlePolicy] Group query result by Throttle + * @property {string} blobContainerSasUri SAS Uri of the logging blob + * container to which LogAnalytics Api writes output logs to. + * @property {date} fromTime From time of the query + * @property {date} toTime To time of the query + * @property {boolean} [groupByThrottlePolicy] Group query result by Throttle * Policy applied. - * @member {boolean} [groupByOperationName] Group query result by by - * Operation Name. - * @member {boolean} [groupByResourceName] Group query result by Resource + * @property {boolean} [groupByOperationName] Group query result by Operation + * Name. + * @property {boolean} [groupByResourceName] Group query result by Resource * Name. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/logAnalyticsOperationResult.js b/lib/services/computeManagement2/lib/models/logAnalyticsOperationResult.js index 993e0aa9af..8fa7e5afcf 100644 --- a/lib/services/computeManagement2/lib/models/logAnalyticsOperationResult.js +++ b/lib/services/computeManagement2/lib/models/logAnalyticsOperationResult.js @@ -17,8 +17,8 @@ class LogAnalyticsOperationResult { /** * Create a LogAnalyticsOperationResult. - * @member {object} [properties] LogAnalyticsOutput - * @member {string} [properties.output] Output file Uri path to blob + * @property {object} [properties] LogAnalyticsOutput + * @property {string} [properties.output] Output file Uri path to blob * container. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/logAnalyticsOutput.js b/lib/services/computeManagement2/lib/models/logAnalyticsOutput.js index a69e948aed..eb57dc48c2 100644 --- a/lib/services/computeManagement2/lib/models/logAnalyticsOutput.js +++ b/lib/services/computeManagement2/lib/models/logAnalyticsOutput.js @@ -17,7 +17,7 @@ class LogAnalyticsOutput { /** * Create a LogAnalyticsOutput. - * @member {string} [output] Output file Uri path to blob container. + * @property {string} [output] Output file Uri path to blob container. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/maintenanceRedeployStatus.js b/lib/services/computeManagement2/lib/models/maintenanceRedeployStatus.js index 4fdc491a23..5c7457bcce 100644 --- a/lib/services/computeManagement2/lib/models/maintenanceRedeployStatus.js +++ b/lib/services/computeManagement2/lib/models/maintenanceRedeployStatus.js @@ -17,20 +17,20 @@ class MaintenanceRedeployStatus { /** * Create a MaintenanceRedeployStatus. - * @member {boolean} [isCustomerInitiatedMaintenanceAllowed] True, if + * @property {boolean} [isCustomerInitiatedMaintenanceAllowed] True, if * customer is allowed to perform Maintenance. - * @member {date} [preMaintenanceWindowStartTime] Start Time for the Pre + * @property {date} [preMaintenanceWindowStartTime] Start Time for the Pre * Maintenance Window. - * @member {date} [preMaintenanceWindowEndTime] End Time for the Pre + * @property {date} [preMaintenanceWindowEndTime] End Time for the Pre * Maintenance Window. - * @member {date} [maintenanceWindowStartTime] Start Time for the Maintenance - * Window. - * @member {date} [maintenanceWindowEndTime] End Time for the Maintenance + * @property {date} [maintenanceWindowStartTime] Start Time for the + * Maintenance Window. + * @property {date} [maintenanceWindowEndTime] End Time for the Maintenance * Window. - * @member {string} [lastOperationResultCode] The Last Maintenance Operation - * Result Code. Possible values include: 'None', 'RetryLater', + * @property {string} [lastOperationResultCode] The Last Maintenance + * Operation Result Code. Possible values include: 'None', 'RetryLater', * 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} [lastOperationMessage] Message returned for the last + * @property {string} [lastOperationMessage] Message returned for the last * Maintenance Operation. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/managedArtifact.js b/lib/services/computeManagement2/lib/models/managedArtifact.js index a9b4659fd4..a329f327fa 100644 --- a/lib/services/computeManagement2/lib/models/managedArtifact.js +++ b/lib/services/computeManagement2/lib/models/managedArtifact.js @@ -17,7 +17,7 @@ class ManagedArtifact { /** * Create a ManagedArtifact. - * @member {string} id The managed artifact id. + * @property {string} id The managed artifact id. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/managedDiskParameters.js b/lib/services/computeManagement2/lib/models/managedDiskParameters.js index 9505796d9c..5ab7d378ff 100644 --- a/lib/services/computeManagement2/lib/models/managedDiskParameters.js +++ b/lib/services/computeManagement2/lib/models/managedDiskParameters.js @@ -20,7 +20,7 @@ const models = require('./index'); class ManagedDiskParameters extends models['SubResource'] { /** * Create a ManagedDiskParameters. - * @member {string} [storageAccountType] Specifies the storage account type + * @property {string} [storageAccountType] Specifies the storage account type * for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, * it cannot be used with OS Disk. Possible values include: 'Standard_LRS', * 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' diff --git a/lib/services/computeManagement2/lib/models/networkInterfaceReference.js b/lib/services/computeManagement2/lib/models/networkInterfaceReference.js index d378edc9d1..9666ace70d 100644 --- a/lib/services/computeManagement2/lib/models/networkInterfaceReference.js +++ b/lib/services/computeManagement2/lib/models/networkInterfaceReference.js @@ -20,7 +20,7 @@ const models = require('./index'); class NetworkInterfaceReference extends models['SubResource'] { /** * Create a NetworkInterfaceReference. - * @member {boolean} [primary] Specifies the primary network interface in + * @property {boolean} [primary] Specifies the primary network interface in * case the virtual machine has more than 1 network interface. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/networkProfile.js b/lib/services/computeManagement2/lib/models/networkProfile.js index 7d6912dada..baf266e62d 100644 --- a/lib/services/computeManagement2/lib/models/networkProfile.js +++ b/lib/services/computeManagement2/lib/models/networkProfile.js @@ -17,8 +17,8 @@ class NetworkProfile { /** * Create a NetworkProfile. - * @member {array} [networkInterfaces] Specifies the list of resource Ids for - * the network interfaces associated with the virtual machine. + * @property {array} [networkInterfaces] Specifies the list of resource Ids + * for the network interfaces associated with the virtual machine. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/oSDisk.js b/lib/services/computeManagement2/lib/models/oSDisk.js index 18e3a4c0dd..73eab03bbd 100644 --- a/lib/services/computeManagement2/lib/models/oSDisk.js +++ b/lib/services/computeManagement2/lib/models/oSDisk.js @@ -20,62 +20,63 @@ class OSDisk { /** * Create a OSDisk. - * @member {string} [osType] This property allows you to specify the type of - * the OS that is included in the disk if creating a VM from user-image or a - * specialized VHD.

    Possible values are:

    **Windows** + * @property {string} [osType] This property allows you to specify the type + * of the OS that is included in the disk if creating a VM from user-image or + * a specialized VHD.

    Possible values are:

    **Windows** *

    **Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [encryptionSettings] Specifies the encryption settings + * @property {object} [encryptionSettings] Specifies the encryption settings * for the OS Disk.

    Minimum api-version: 2015-06-15 - * @member {object} [encryptionSettings.diskEncryptionKey] Specifies the + * @property {object} [encryptionSettings.diskEncryptionKey] Specifies the * location of the disk encryption key, which is a Key Vault Secret. - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] The URL - * referencing a secret in a Key Vault. - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] The + * @property {string} [encryptionSettings.diskEncryptionKey.secretUrl] The + * URL referencing a secret in a Key Vault. + * @property {object} [encryptionSettings.diskEncryptionKey.sourceVault] The * relative URL of the Key Vault containing the secret. - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] + * @property {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] * Resource Id - * @member {object} [encryptionSettings.keyEncryptionKey] Specifies the + * @property {object} [encryptionSettings.keyEncryptionKey] Specifies the * location of the key encryption key in Key Vault. - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] The URL + * @property {string} [encryptionSettings.keyEncryptionKey.keyUrl] The URL * referencing a key encryption key in Key Vault. - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] The + * @property {object} [encryptionSettings.keyEncryptionKey.sourceVault] The * relative URL of the Key Vault containing the key. - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] + * @property {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] * Resource Id - * @member {boolean} [encryptionSettings.enabled] Specifies whether disk + * @property {boolean} [encryptionSettings.enabled] Specifies whether disk * encryption should be enabled on the virtual machine. - * @member {string} [name] The disk name. - * @member {object} [vhd] The virtual hard disk. - * @member {string} [vhd.uri] Specifies the virtual hard disk's uri. - * @member {object} [image] The source user image virtual hard disk. The + * @property {string} [name] The disk name. + * @property {object} [vhd] The virtual hard disk. + * @property {string} [vhd.uri] Specifies the virtual hard disk's uri. + * @property {object} [image] The source user image virtual hard disk. The * virtual hard disk will be copied before being attached to the virtual * machine. If SourceImage is provided, the destination virtual hard drive * must not exist. - * @member {string} [image.uri] Specifies the virtual hard disk's uri. - * @member {string} [caching] Specifies the caching requirements.

    + * @property {string} [image.uri] Specifies the virtual hard disk's uri. + * @property {string} [caching] Specifies the caching requirements.

    * Possible values are:

    **None**

    **ReadOnly**

    * **ReadWrite**

    Default: **None for Standard storage. ReadOnly for * Premium storage**. Possible values include: 'None', 'ReadOnly', * 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether + * @property {boolean} [writeAcceleratorEnabled] Specifies whether * writeAccelerator should be enabled or disabled on the disk. - * @member {object} [diffDiskSettings] Specifies the differencing Disk + * @property {object} [diffDiskSettings] Specifies the ephemeral Disk * Settings for the operating system disk used by the virtual machine. - * @member {string} [diffDiskSettings.option] Specifies the differencing disk + * @property {string} [diffDiskSettings.option] Specifies the ephemeral disk * settings for operating system disk. Possible values include: 'Local' - * @member {string} createOption Specifies how the virtual machine should be - * created.

    Possible values are:

    **Attach** \u2013 This value - * is used when you are using a specialized disk to create the virtual + * @property {string} createOption Specifies how the virtual machine should + * be created.

    Possible values are:

    **Attach** \u2013 This + * value is used when you are using a specialized disk to create the virtual * machine.

    **FromImage** \u2013 This value is used when you are * using an image to create the virtual machine. If you are using a platform * image, you also use the imageReference element described above. If you are * using a marketplace image, you also use the plan element previously * described. Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {number} [diskSizeGB] Specifies the size of an empty data disk in - * gigabytes. This element can be used to overwrite the size of the disk in a - * virtual machine image.

    This value cannot be larger than 1023 GB - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage + * @property {number} [diskSizeGB] Specifies the size of an empty data disk + * in gigabytes. This element can be used to overwrite the size of the disk + * in a virtual machine image.

    This value cannot be larger than 1023 + * GB + * @property {object} [managedDisk] The managed disk parameters. + * @property {string} [managedDisk.storageAccountType] Specifies the storage * account type for the managed disk. NOTE: UltraSSD_LRS can only be used * with data disks, it cannot be used with OS Disk. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' diff --git a/lib/services/computeManagement2/lib/models/oSDiskImage.js b/lib/services/computeManagement2/lib/models/oSDiskImage.js index 8dff55f85e..0abe32fdd7 100644 --- a/lib/services/computeManagement2/lib/models/oSDiskImage.js +++ b/lib/services/computeManagement2/lib/models/oSDiskImage.js @@ -17,8 +17,8 @@ class OSDiskImage { /** * Create a OSDiskImage. - * @member {string} operatingSystem The operating system of the osDiskImage. - * Possible values include: 'Windows', 'Linux' + * @property {string} operatingSystem The operating system of the + * osDiskImage. Possible values include: 'Windows', 'Linux' */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/oSProfile.js b/lib/services/computeManagement2/lib/models/oSProfile.js index 60b86fa154..de1bfc7fdf 100644 --- a/lib/services/computeManagement2/lib/models/oSProfile.js +++ b/lib/services/computeManagement2/lib/models/oSProfile.js @@ -17,12 +17,13 @@ class OSProfile { /** * Create a OSProfile. - * @member {string} [computerName] Specifies the host OS name of the virtual - * machine.

    **Max-length (Windows):** 15 characters

    + * @property {string} [computerName] Specifies the host OS name of the + * virtual machine.

    This name cannot be updated after the VM is + * created.

    **Max-length (Windows):** 15 characters

    * **Max-length (Linux):** 64 characters.

    For naming conventions and * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). - * @member {string} [adminUsername] Specifies the name of the administrator + * @property {string} [adminUsername] Specifies the name of the administrator * account.

    **Windows-only restriction:** Cannot end in "."

    * **Disallowed values:** "administrator", "admin", "user", "user1", "test", * "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", @@ -36,7 +37,7 @@ class OSProfile { * For a list of built-in system users on Linux that should not be used in * this field, see [Selecting User Names for Linux on * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [adminPassword] Specifies the password of the + * @property {string} [adminPassword] Specifies the password of the * administrator account.

    **Minimum-length (Windows):** 8 characters *

    **Minimum-length (Linux):** 6 characters

    **Max-length * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters @@ -51,51 +52,51 @@ class OSProfile { *

    For resetting root password, see [Manage users, SSH, and check or * repair disks on Azure Linux VMs using the VMAccess * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [customData] Specifies a base-64 encoded string of custom - * data. The base-64 encoded string is decoded to a binary array that is - * saved as a file on the Virtual Machine. The maximum length of the binary - * array is 65535 bytes.

    For using cloud-init for your VM, see - * [Using cloud-init to customize a Linux VM during + * @property {string} [customData] Specifies a base-64 encoded string of + * custom data. The base-64 encoded string is decoded to a binary array that + * is saved as a file on the Virtual Machine. The maximum length of the + * binary array is 65535 bytes.

    For using cloud-init for your VM, + * see [Using cloud-init to customize a Linux VM during * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [windowsConfiguration] Specifies Windows operating system - * settings on the virtual machine. - * @member {boolean} [windowsConfiguration.provisionVMAgent] Indicates + * @property {object} [windowsConfiguration] Specifies Windows operating + * system settings on the virtual machine. + * @property {boolean} [windowsConfiguration.provisionVMAgent] Indicates * whether virtual machine agent should be provisioned on the virtual * machine.

    When this property is not specified in the request body, * default behavior is to set it to true. This will ensure that VM Agent is * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} [windowsConfiguration.enableAutomaticUpdates] Indicates - * whether virtual machine is enabled for automatic updates. - * @member {string} [windowsConfiguration.timeZone] Specifies the time zone + * @property {boolean} [windowsConfiguration.enableAutomaticUpdates] + * Indicates whether virtual machine is enabled for automatic updates. + * @property {string} [windowsConfiguration.timeZone] Specifies the time zone * of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [windowsConfiguration.additionalUnattendContent] Specifies - * additional base-64 encoded XML formatted information that can be included - * in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [windowsConfiguration.winRM] Specifies the Windows Remote - * Management listeners. This enables remote Windows PowerShell. - * @member {array} [windowsConfiguration.winRM.listeners] The list of Windows - * Remote Management listeners - * @member {object} [linuxConfiguration] Specifies the Linux operating system - * settings on the virtual machine.

    For a list of supported Linux - * distributions, see [Linux on Azure-Endorsed + * @property {array} [windowsConfiguration.additionalUnattendContent] + * Specifies additional base-64 encoded XML formatted information that can be + * included in the Unattend.xml file, which is used by Windows Setup. + * @property {object} [windowsConfiguration.winRM] Specifies the Windows + * Remote Management listeners. This enables remote Windows PowerShell. + * @property {array} [windowsConfiguration.winRM.listeners] The list of + * Windows Remote Management listeners + * @property {object} [linuxConfiguration] Specifies the Linux operating + * system settings on the virtual machine.

    For a list of supported + * Linux distributions, see [Linux on Azure-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) *

    For running non-endorsed distributions, see [Information for * Non-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} [linuxConfiguration.disablePasswordAuthentication] + * @property {boolean} [linuxConfiguration.disablePasswordAuthentication] * Specifies whether password authentication should be disabled. - * @member {object} [linuxConfiguration.ssh] Specifies the ssh key + * @property {object} [linuxConfiguration.ssh] Specifies the ssh key * configuration for a Linux OS. - * @member {array} [linuxConfiguration.ssh.publicKeys] The list of SSH public - * keys used to authenticate with linux based VMs. - * @member {boolean} [linuxConfiguration.provisionVMAgent] Indicates whether - * virtual machine agent should be provisioned on the virtual machine. - *

    When this property is not specified in the request body, default - * behavior is to set it to true. This will ensure that VM Agent is + * @property {array} [linuxConfiguration.ssh.publicKeys] The list of SSH + * public keys used to authenticate with linux based VMs. + * @property {boolean} [linuxConfiguration.provisionVMAgent] Indicates + * whether virtual machine agent should be provisioned on the virtual + * machine.

    When this property is not specified in the request body, + * default behavior is to set it to true. This will ensure that VM Agent is * installed on the VM so that extensions can be added to the VM later. - * @member {array} [secrets] Specifies set of certificates that should be + * @property {array} [secrets] Specifies set of certificates that should be * installed onto the virtual machine. - * @member {boolean} [allowExtensionOperations] Specifies whether extension + * @property {boolean} [allowExtensionOperations] Specifies whether extension * operations should be allowed on the virtual machine.

    This may only * be set to False when no extensions are present on the virtual machine. */ diff --git a/lib/services/computeManagement2/lib/models/plan.js b/lib/services/computeManagement2/lib/models/plan.js index e033d4c30b..e7aff65c87 100644 --- a/lib/services/computeManagement2/lib/models/plan.js +++ b/lib/services/computeManagement2/lib/models/plan.js @@ -22,12 +22,12 @@ class Plan { /** * Create a Plan. - * @member {string} [name] The plan ID. - * @member {string} [publisher] The publisher ID. - * @member {string} [product] Specifies the product of the image from the + * @property {string} [name] The plan ID. + * @property {string} [publisher] The publisher ID. + * @property {string} [product] Specifies the product of the image from the * marketplace. This is the same value as Offer under the imageReference * element. - * @member {string} [promotionCode] The promotion code. + * @property {string} [promotionCode] The promotion code. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/purchasePlan.js b/lib/services/computeManagement2/lib/models/purchasePlan.js index 28c42e6acb..db63628b50 100644 --- a/lib/services/computeManagement2/lib/models/purchasePlan.js +++ b/lib/services/computeManagement2/lib/models/purchasePlan.js @@ -18,9 +18,9 @@ class PurchasePlan { /** * Create a PurchasePlan. - * @member {string} publisher The publisher ID. - * @member {string} name The plan ID. - * @member {string} product Specifies the product of the image from the + * @property {string} publisher The publisher ID. + * @property {string} name The plan ID. + * @property {string} product Specifies the product of the image from the * marketplace. This is the same value as Offer under the imageReference * element. */ diff --git a/lib/services/computeManagement2/lib/models/recommendedMachineConfiguration.js b/lib/services/computeManagement2/lib/models/recommendedMachineConfiguration.js index d6ee2375a8..adc8da0e40 100644 --- a/lib/services/computeManagement2/lib/models/recommendedMachineConfiguration.js +++ b/lib/services/computeManagement2/lib/models/recommendedMachineConfiguration.js @@ -12,18 +12,18 @@ /** * The properties describe the recommended machine configuration for this Image - * Definition. These properties are updateable. + * Definition. These properties are updatable. * */ class RecommendedMachineConfiguration { /** * Create a RecommendedMachineConfiguration. - * @member {object} [vCPUs] - * @member {number} [vCPUs.min] The minimum number of the resource. - * @member {number} [vCPUs.max] The maximum number of the resource. - * @member {object} [memory] - * @member {number} [memory.min] The minimum number of the resource. - * @member {number} [memory.max] The maximum number of the resource. + * @property {object} [vCPUs] + * @property {number} [vCPUs.min] The minimum number of the resource. + * @property {number} [vCPUs.max] The maximum number of the resource. + * @property {object} [memory] + * @property {number} [memory.min] The minimum number of the resource. + * @property {number} [memory.max] The maximum number of the resource. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/recoveryWalkResponse.js b/lib/services/computeManagement2/lib/models/recoveryWalkResponse.js index ffe245c464..aeb3884f37 100644 --- a/lib/services/computeManagement2/lib/models/recoveryWalkResponse.js +++ b/lib/services/computeManagement2/lib/models/recoveryWalkResponse.js @@ -17,8 +17,9 @@ class RecoveryWalkResponse { /** * Create a RecoveryWalkResponse. - * @member {boolean} [walkPerformed] Whether the recovery walk was performed - * @member {number} [nextPlatformUpdateDomain] The next update domain that + * @property {boolean} [walkPerformed] Whether the recovery walk was + * performed + * @property {number} [nextPlatformUpdateDomain] The next update domain that * needs to be walked. Null means walk spanning all update domains has been * completed */ diff --git a/lib/services/computeManagement2/lib/models/regionalReplicationStatus.js b/lib/services/computeManagement2/lib/models/regionalReplicationStatus.js index 53949c1697..32f8ec7860 100644 --- a/lib/services/computeManagement2/lib/models/regionalReplicationStatus.js +++ b/lib/services/computeManagement2/lib/models/regionalReplicationStatus.js @@ -17,12 +17,13 @@ class RegionalReplicationStatus { /** * Create a RegionalReplicationStatus. - * @member {string} [region] The region to which the gallery Image Version is - * being replicated to. - * @member {string} [state] This is the regional replication state. Possible - * values include: 'Unknown', 'Replicating', 'Completed', 'Failed' - * @member {string} [details] The details of the replication status. - * @member {number} [progress] It indicates progress of the replication job. + * @property {string} [region] The region to which the gallery Image Version + * is being replicated to. + * @property {string} [state] This is the regional replication state. + * Possible values include: 'Unknown', 'Replicating', 'Completed', 'Failed' + * @property {string} [details] The details of the replication status. + * @property {number} [progress] It indicates progress of the replication + * job. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/replicationStatus.js b/lib/services/computeManagement2/lib/models/replicationStatus.js index 4fa05ebeed..c1ca1bd42d 100644 --- a/lib/services/computeManagement2/lib/models/replicationStatus.js +++ b/lib/services/computeManagement2/lib/models/replicationStatus.js @@ -17,11 +17,11 @@ class ReplicationStatus { /** * Create a ReplicationStatus. - * @member {string} [aggregatedState] This is the aggregated replication + * @property {string} [aggregatedState] This is the aggregated replication * status based on all the regional replication status flags. Possible values * include: 'Unknown', 'InProgress', 'Completed', 'Failed' - * @member {array} [summary] This is a summary of replication status for each - * region. + * @property {array} [summary] This is a summary of replication status for + * each region. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/requestRateByIntervalInput.js b/lib/services/computeManagement2/lib/models/requestRateByIntervalInput.js index be5f178830..77f9340fbf 100644 --- a/lib/services/computeManagement2/lib/models/requestRateByIntervalInput.js +++ b/lib/services/computeManagement2/lib/models/requestRateByIntervalInput.js @@ -20,7 +20,7 @@ const models = require('./index'); class RequestRateByIntervalInput extends models['LogAnalyticsInputBase'] { /** * Create a RequestRateByIntervalInput. - * @member {string} intervalLength Interval value in minutes used to create + * @property {string} intervalLength Interval value in minutes used to create * LogAnalytics call rate logs. Possible values include: 'ThreeMins', * 'FiveMins', 'ThirtyMins', 'SixtyMins' */ diff --git a/lib/services/computeManagement2/lib/models/resource.js b/lib/services/computeManagement2/lib/models/resource.js index 7c1448890e..8fa3f52687 100644 --- a/lib/services/computeManagement2/lib/models/resource.js +++ b/lib/services/computeManagement2/lib/models/resource.js @@ -20,11 +20,11 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] Resource Id - * @member {string} [name] Resource name - * @member {string} [type] Resource type - * @member {string} location Resource location - * @member {object} [tags] Resource tags + * @property {string} [id] Resource Id + * @property {string} [name] Resource name + * @property {string} [type] Resource type + * @property {string} location Resource location + * @property {object} [tags] Resource tags */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/resourceRange.js b/lib/services/computeManagement2/lib/models/resourceRange.js index 6c249385e7..a1543e3a18 100644 --- a/lib/services/computeManagement2/lib/models/resourceRange.js +++ b/lib/services/computeManagement2/lib/models/resourceRange.js @@ -17,8 +17,8 @@ class ResourceRange { /** * Create a ResourceRange. - * @member {number} [min] The minimum number of the resource. - * @member {number} [max] The maximum number of the resource. + * @property {number} [min] The minimum number of the resource. + * @property {number} [max] The maximum number of the resource. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/resourceSku.js b/lib/services/computeManagement2/lib/models/resourceSku.js index d6d21873b6..1a40755a76 100644 --- a/lib/services/computeManagement2/lib/models/resourceSku.js +++ b/lib/services/computeManagement2/lib/models/resourceSku.js @@ -17,31 +17,32 @@ class ResourceSku { /** * Create a ResourceSku. - * @member {string} [resourceType] The type of resource the SKU applies to. - * @member {string} [name] The name of SKU. - * @member {string} [tier] Specifies the tier of virtual machines in a scale - * set.

    Possible Values:

    **Standard**

    - * **Basic** - * @member {string} [size] The Size of the SKU. - * @member {string} [family] The Family of this particular SKU. - * @member {string} [kind] The Kind of resources that are supported in this + * @property {string} [resourceType] The type of resource the SKU applies to. + * @property {string} [name] The name of SKU. + * @property {string} [tier] Specifies the tier of virtual machines in a + * scale set.

    Possible Values:

    **Standard**

    **Basic** + * @property {string} [size] The Size of the SKU. + * @property {string} [family] The Family of this particular SKU. + * @property {string} [kind] The Kind of resources that are supported in this * SKU. - * @member {object} [capacity] Specifies the number of virtual machines in + * @property {object} [capacity] Specifies the number of virtual machines in * the scale set. - * @member {number} [capacity.minimum] The minimum capacity. - * @member {number} [capacity.maximum] The maximum capacity that can be set. - * @member {number} [capacity.default] The default capacity. - * @member {string} [capacity.scaleType] The scale type applicable to the + * @property {number} [capacity.minimum] The minimum capacity. + * @property {number} [capacity.maximum] The maximum capacity that can be + * set. + * @property {number} [capacity.default] The default capacity. + * @property {string} [capacity.scaleType] The scale type applicable to the * sku. Possible values include: 'Automatic', 'Manual', 'None' - * @member {array} [locations] The set of locations that the SKU is + * @property {array} [locations] The set of locations that the SKU is * available. - * @member {array} [locationInfo] A list of locations and availability zones - * in those locations where the SKU is available. - * @member {array} [apiVersions] The api versions that support this SKU. - * @member {array} [costs] Metadata for retrieving price info. - * @member {array} [capabilities] A name value pair to describe the + * @property {array} [locationInfo] A list of locations and availability + * zones in those locations where the SKU is available. + * @property {array} [apiVersions] The api versions that support this SKU. + * @property {array} [costs] Metadata for retrieving price info. + * @property {array} [capabilities] A name value pair to describe the * capability. - * @member {array} [restrictions] The restrictions because of which SKU + * @property {array} [restrictions] The restrictions because of which SKU * cannot be used. This is empty if there are no restrictions. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/resourceSkuCapabilities.js b/lib/services/computeManagement2/lib/models/resourceSkuCapabilities.js index 77ae0d4489..dd0c24728b 100644 --- a/lib/services/computeManagement2/lib/models/resourceSkuCapabilities.js +++ b/lib/services/computeManagement2/lib/models/resourceSkuCapabilities.js @@ -11,14 +11,14 @@ 'use strict'; /** - * Describes The SKU capabilites object. + * Describes The SKU capabilities object. * */ class ResourceSkuCapabilities { /** * Create a ResourceSkuCapabilities. - * @member {string} [name] An invariant to describe the feature. - * @member {string} [value] An invariant if the feature is measured by + * @property {string} [name] An invariant to describe the feature. + * @property {string} [value] An invariant if the feature is measured by * quantity. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/resourceSkuCapacity.js b/lib/services/computeManagement2/lib/models/resourceSkuCapacity.js index b36906fb80..02b448c951 100644 --- a/lib/services/computeManagement2/lib/models/resourceSkuCapacity.js +++ b/lib/services/computeManagement2/lib/models/resourceSkuCapacity.js @@ -17,10 +17,10 @@ class ResourceSkuCapacity { /** * Create a ResourceSkuCapacity. - * @member {number} [minimum] The minimum capacity. - * @member {number} [maximum] The maximum capacity that can be set. - * @member {number} [default] The default capacity. - * @member {string} [scaleType] The scale type applicable to the sku. + * @property {number} [minimum] The minimum capacity. + * @property {number} [maximum] The maximum capacity that can be set. + * @property {number} [default] The default capacity. + * @property {string} [scaleType] The scale type applicable to the sku. * Possible values include: 'Automatic', 'Manual', 'None' */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/resourceSkuCosts.js b/lib/services/computeManagement2/lib/models/resourceSkuCosts.js index 08e2bd632b..bff707548c 100644 --- a/lib/services/computeManagement2/lib/models/resourceSkuCosts.js +++ b/lib/services/computeManagement2/lib/models/resourceSkuCosts.js @@ -17,10 +17,10 @@ class ResourceSkuCosts { /** * Create a ResourceSkuCosts. - * @member {string} [meterID] Used for querying price from commerce. - * @member {number} [quantity] The multiplier is needed to extend the base + * @property {string} [meterID] Used for querying price from commerce. + * @property {number} [quantity] The multiplier is needed to extend the base * metered cost. - * @member {string} [extendedUnit] An invariant to show the extended unit. + * @property {string} [extendedUnit] An invariant to show the extended unit. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/resourceSkuLocationInfo.js b/lib/services/computeManagement2/lib/models/resourceSkuLocationInfo.js index 0b9c382836..7c64419dd2 100644 --- a/lib/services/computeManagement2/lib/models/resourceSkuLocationInfo.js +++ b/lib/services/computeManagement2/lib/models/resourceSkuLocationInfo.js @@ -16,8 +16,8 @@ class ResourceSkuLocationInfo { /** * Create a ResourceSkuLocationInfo. - * @member {string} [location] Location of the SKU - * @member {array} [zones] List of availability zones where the SKU is + * @property {string} [location] Location of the SKU + * @property {array} [zones] List of availability zones where the SKU is * supported. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/resourceSkuRestrictionInfo.js b/lib/services/computeManagement2/lib/models/resourceSkuRestrictionInfo.js index 9772ff3185..5d2bffb60c 100644 --- a/lib/services/computeManagement2/lib/models/resourceSkuRestrictionInfo.js +++ b/lib/services/computeManagement2/lib/models/resourceSkuRestrictionInfo.js @@ -16,8 +16,8 @@ class ResourceSkuRestrictionInfo { /** * Create a ResourceSkuRestrictionInfo. - * @member {array} [locations] Locations where the SKU is restricted - * @member {array} [zones] List of availability zones where the SKU is + * @property {array} [locations] Locations where the SKU is restricted + * @property {array} [zones] List of availability zones where the SKU is * restricted. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/resourceSkuRestrictions.js b/lib/services/computeManagement2/lib/models/resourceSkuRestrictions.js index 2a8db80958..a8d6c32b09 100644 --- a/lib/services/computeManagement2/lib/models/resourceSkuRestrictions.js +++ b/lib/services/computeManagement2/lib/models/resourceSkuRestrictions.js @@ -17,19 +17,19 @@ class ResourceSkuRestrictions { /** * Create a ResourceSkuRestrictions. - * @member {string} [type] The type of restrictions. Possible values include: - * 'Location', 'Zone' - * @member {array} [values] The value of restrictions. If the restriction + * @property {string} [type] The type of restrictions. Possible values + * include: 'Location', 'Zone' + * @property {array} [values] The value of restrictions. If the restriction * type is set to location. This would be different locations where the SKU * is restricted. - * @member {object} [restrictionInfo] The information about the restriction + * @property {object} [restrictionInfo] The information about the restriction * where the SKU cannot be used. - * @member {array} [restrictionInfo.locations] Locations where the SKU is + * @property {array} [restrictionInfo.locations] Locations where the SKU is * restricted - * @member {array} [restrictionInfo.zones] List of availability zones where + * @property {array} [restrictionInfo.zones] List of availability zones where * the SKU is restricted. - * @member {string} [reasonCode] The reason for restriction. Possible values - * include: 'QuotaId', 'NotAvailableForSubscription' + * @property {string} [reasonCode] The reason for restriction. Possible + * values include: 'QuotaId', 'NotAvailableForSubscription' */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/resourceSkusResult.js b/lib/services/computeManagement2/lib/models/resourceSkusResult.js index 5e48b5aac0..ba8d965be2 100644 --- a/lib/services/computeManagement2/lib/models/resourceSkusResult.js +++ b/lib/services/computeManagement2/lib/models/resourceSkusResult.js @@ -16,7 +16,7 @@ class ResourceSkusResult extends Array { /** * Create a ResourceSkusResult. - * @member {string} [nextLink] The uri to fetch the next page of Compute + * @property {string} [nextLink] The uri to fetch the next page of Compute * Skus. Call ListNext() with this to fetch the next page of VMSS Skus. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/rollbackStatusInfo.js b/lib/services/computeManagement2/lib/models/rollbackStatusInfo.js index bbfa82de4f..5d493d5e4b 100644 --- a/lib/services/computeManagement2/lib/models/rollbackStatusInfo.js +++ b/lib/services/computeManagement2/lib/models/rollbackStatusInfo.js @@ -18,21 +18,21 @@ class RollbackStatusInfo { /** * Create a RollbackStatusInfo. - * @member {number} [successfullyRolledbackInstanceCount] The number of + * @property {number} [successfullyRolledbackInstanceCount] The number of * instances which have been successfully rolled back. - * @member {number} [failedRolledbackInstanceCount] The number of instances + * @property {number} [failedRolledbackInstanceCount] The number of instances * which failed to rollback. - * @member {object} [rollbackError] Error details if OS rollback failed. - * @member {array} [rollbackError.details] The Api error details - * @member {object} [rollbackError.innererror] The Api inner error - * @member {string} [rollbackError.innererror.exceptiontype] The exception + * @property {object} [rollbackError] Error details if OS rollback failed. + * @property {array} [rollbackError.details] The Api error details + * @property {object} [rollbackError.innererror] The Api inner error + * @property {string} [rollbackError.innererror.exceptiontype] The exception * type. - * @member {string} [rollbackError.innererror.errordetail] The internal error - * message or exception dump. - * @member {string} [rollbackError.code] The error code. - * @member {string} [rollbackError.target] The target of the particular + * @property {string} [rollbackError.innererror.errordetail] The internal + * error message or exception dump. + * @property {string} [rollbackError.code] The error code. + * @property {string} [rollbackError.target] The target of the particular * error. - * @member {string} [rollbackError.message] The error message. + * @property {string} [rollbackError.message] The error message. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/rollingUpgradePolicy.js b/lib/services/computeManagement2/lib/models/rollingUpgradePolicy.js index b0ca116c76..c4c8d3268d 100644 --- a/lib/services/computeManagement2/lib/models/rollingUpgradePolicy.js +++ b/lib/services/computeManagement2/lib/models/rollingUpgradePolicy.js @@ -17,24 +17,24 @@ class RollingUpgradePolicy { /** * Create a RollingUpgradePolicy. - * @member {number} [maxBatchInstancePercent] The maximum percent of total + * @property {number} [maxBatchInstancePercent] The maximum percent of total * virtual machine instances that will be upgraded simultaneously by the * rolling upgrade in one batch. As this is a maximum, unhealthy instances in * previous or future batches can cause the percentage of instances in a * batch to decrease to ensure higher reliability. The default value for this * parameter is 20%. - * @member {number} [maxUnhealthyInstancePercent] The maximum percentage of + * @property {number} [maxUnhealthyInstancePercent] The maximum percentage of * the total virtual machine instances in the scale set that can be * simultaneously unhealthy, either as a result of being upgraded, or by * being found in an unhealthy state by the virtual machine health checks * before the rolling upgrade aborts. This constraint will be checked prior * to starting any batch. The default value for this parameter is 20%. - * @member {number} [maxUnhealthyUpgradedInstancePercent] The maximum + * @property {number} [maxUnhealthyUpgradedInstancePercent] The maximum * percentage of upgraded virtual machine instances that can be found to be * in an unhealthy state. This check will happen after each batch is * upgraded. If this percentage is ever exceeded, the rolling update aborts. * The default value for this parameter is 20%. - * @member {string} [pauseTimeBetweenBatches] The wait time between + * @property {string} [pauseTimeBetweenBatches] The wait time between * completing the update for all virtual machines in one batch and starting * the next batch. The time duration should be specified in ISO 8601 format. * The default value is 0 seconds (PT0S). diff --git a/lib/services/computeManagement2/lib/models/rollingUpgradeProgressInfo.js b/lib/services/computeManagement2/lib/models/rollingUpgradeProgressInfo.js index caab866d39..8e8c64d4dd 100644 --- a/lib/services/computeManagement2/lib/models/rollingUpgradeProgressInfo.js +++ b/lib/services/computeManagement2/lib/models/rollingUpgradeProgressInfo.js @@ -18,14 +18,14 @@ class RollingUpgradeProgressInfo { /** * Create a RollingUpgradeProgressInfo. - * @member {number} [successfulInstanceCount] The number of instances that + * @property {number} [successfulInstanceCount] The number of instances that * have been successfully upgraded. - * @member {number} [failedInstanceCount] The number of instances that have + * @property {number} [failedInstanceCount] The number of instances that have * failed to be upgraded successfully. - * @member {number} [inProgressInstanceCount] The number of instances that + * @property {number} [inProgressInstanceCount] The number of instances that * are currently being upgraded. - * @member {number} [pendingInstanceCount] The number of instances that have - * not yet begun to be upgraded. + * @property {number} [pendingInstanceCount] The number of instances that + * have not yet begun to be upgraded. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/rollingUpgradeRunningStatus.js b/lib/services/computeManagement2/lib/models/rollingUpgradeRunningStatus.js index 7ad18db085..636aa49084 100644 --- a/lib/services/computeManagement2/lib/models/rollingUpgradeRunningStatus.js +++ b/lib/services/computeManagement2/lib/models/rollingUpgradeRunningStatus.js @@ -17,13 +17,13 @@ class RollingUpgradeRunningStatus { /** * Create a RollingUpgradeRunningStatus. - * @member {string} [code] Code indicating the current status of the upgrade. - * Possible values include: 'RollingForward', 'Cancelled', 'Completed', - * 'Faulted' - * @member {date} [startTime] Start time of the upgrade. - * @member {string} [lastAction] The last action performed on the rolling + * @property {string} [code] Code indicating the current status of the + * upgrade. Possible values include: 'RollingForward', 'Cancelled', + * 'Completed', 'Faulted' + * @property {date} [startTime] Start time of the upgrade. + * @property {string} [lastAction] The last action performed on the rolling * upgrade. Possible values include: 'Start', 'Cancel' - * @member {date} [lastActionTime] Last action time of the upgrade. + * @property {date} [lastActionTime] Last action time of the upgrade. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/rollingUpgradeStatusInfo.js b/lib/services/computeManagement2/lib/models/rollingUpgradeStatusInfo.js index 6e64400b78..843330d252 100644 --- a/lib/services/computeManagement2/lib/models/rollingUpgradeStatusInfo.js +++ b/lib/services/computeManagement2/lib/models/rollingUpgradeStatusInfo.js @@ -20,58 +20,59 @@ const models = require('./index'); class RollingUpgradeStatusInfo extends models['Resource'] { /** * Create a RollingUpgradeStatusInfo. - * @member {object} [policy] The rolling upgrade policies applied for this + * @property {object} [policy] The rolling upgrade policies applied for this * upgrade. - * @member {number} [policy.maxBatchInstancePercent] The maximum percent of + * @property {number} [policy.maxBatchInstancePercent] The maximum percent of * total virtual machine instances that will be upgraded simultaneously by * the rolling upgrade in one batch. As this is a maximum, unhealthy * instances in previous or future batches can cause the percentage of * instances in a batch to decrease to ensure higher reliability. The default * value for this parameter is 20%. - * @member {number} [policy.maxUnhealthyInstancePercent] The maximum + * @property {number} [policy.maxUnhealthyInstancePercent] The maximum * percentage of the total virtual machine instances in the scale set that * can be simultaneously unhealthy, either as a result of being upgraded, or * by being found in an unhealthy state by the virtual machine health checks * before the rolling upgrade aborts. This constraint will be checked prior * to starting any batch. The default value for this parameter is 20%. - * @member {number} [policy.maxUnhealthyUpgradedInstancePercent] The maximum - * percentage of upgraded virtual machine instances that can be found to be - * in an unhealthy state. This check will happen after each batch is + * @property {number} [policy.maxUnhealthyUpgradedInstancePercent] The + * maximum percentage of upgraded virtual machine instances that can be found + * to be in an unhealthy state. This check will happen after each batch is * upgraded. If this percentage is ever exceeded, the rolling update aborts. * The default value for this parameter is 20%. - * @member {string} [policy.pauseTimeBetweenBatches] The wait time between + * @property {string} [policy.pauseTimeBetweenBatches] The wait time between * completing the update for all virtual machines in one batch and starting * the next batch. The time duration should be specified in ISO 8601 format. * The default value is 0 seconds (PT0S). - * @member {object} [runningStatus] Information about the current running + * @property {object} [runningStatus] Information about the current running * state of the overall upgrade. - * @member {string} [runningStatus.code] Code indicating the current status + * @property {string} [runningStatus.code] Code indicating the current status * of the upgrade. Possible values include: 'RollingForward', 'Cancelled', * 'Completed', 'Faulted' - * @member {date} [runningStatus.startTime] Start time of the upgrade. - * @member {string} [runningStatus.lastAction] The last action performed on + * @property {date} [runningStatus.startTime] Start time of the upgrade. + * @property {string} [runningStatus.lastAction] The last action performed on * the rolling upgrade. Possible values include: 'Start', 'Cancel' - * @member {date} [runningStatus.lastActionTime] Last action time of the + * @property {date} [runningStatus.lastActionTime] Last action time of the * upgrade. - * @member {object} [progress] Information about the number of virtual + * @property {object} [progress] Information about the number of virtual * machine instances in each upgrade state. - * @member {number} [progress.successfulInstanceCount] The number of + * @property {number} [progress.successfulInstanceCount] The number of * instances that have been successfully upgraded. - * @member {number} [progress.failedInstanceCount] The number of instances + * @property {number} [progress.failedInstanceCount] The number of instances * that have failed to be upgraded successfully. - * @member {number} [progress.inProgressInstanceCount] The number of + * @property {number} [progress.inProgressInstanceCount] The number of * instances that are currently being upgraded. - * @member {number} [progress.pendingInstanceCount] The number of instances + * @property {number} [progress.pendingInstanceCount] The number of instances * that have not yet begun to be upgraded. - * @member {object} [error] Error details for this upgrade, if there are any. - * @member {array} [error.details] The Api error details - * @member {object} [error.innererror] The Api inner error - * @member {string} [error.innererror.exceptiontype] The exception type. - * @member {string} [error.innererror.errordetail] The internal error message - * or exception dump. - * @member {string} [error.code] The error code. - * @member {string} [error.target] The target of the particular error. - * @member {string} [error.message] The error message. + * @property {object} [error] Error details for this upgrade, if there are + * any. + * @property {array} [error.details] The Api error details + * @property {object} [error.innererror] The Api inner error + * @property {string} [error.innererror.exceptiontype] The exception type. + * @property {string} [error.innererror.errordetail] The internal error + * message or exception dump. + * @property {string} [error.code] The error code. + * @property {string} [error.target] The target of the particular error. + * @property {string} [error.message] The error message. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/runCommandDocument.js b/lib/services/computeManagement2/lib/models/runCommandDocument.js index 2843629882..1b5a6ea086 100644 --- a/lib/services/computeManagement2/lib/models/runCommandDocument.js +++ b/lib/services/computeManagement2/lib/models/runCommandDocument.js @@ -20,8 +20,8 @@ const models = require('./index'); class RunCommandDocument extends models['RunCommandDocumentBase'] { /** * Create a RunCommandDocument. - * @member {array} script The script to be executed. - * @member {array} [parameters] The parameters used by the script. + * @property {array} script The script to be executed. + * @property {array} [parameters] The parameters used by the script. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/runCommandDocumentBase.js b/lib/services/computeManagement2/lib/models/runCommandDocumentBase.js index e464a5cc02..efeb5751f9 100644 --- a/lib/services/computeManagement2/lib/models/runCommandDocumentBase.js +++ b/lib/services/computeManagement2/lib/models/runCommandDocumentBase.js @@ -17,12 +17,12 @@ class RunCommandDocumentBase { /** * Create a RunCommandDocumentBase. - * @member {string} schema The VM run command schema. - * @member {string} id The VM run command id. - * @member {string} osType The Operating System type. Possible values + * @property {string} schema The VM run command schema. + * @property {string} id The VM run command id. + * @property {string} osType The Operating System type. Possible values * include: 'Windows', 'Linux' - * @member {string} label The VM run command label. - * @member {string} description The VM run command description. + * @property {string} label The VM run command label. + * @property {string} description The VM run command description. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/runCommandInput.js b/lib/services/computeManagement2/lib/models/runCommandInput.js index 0aebb6e982..b87d48f4e7 100644 --- a/lib/services/computeManagement2/lib/models/runCommandInput.js +++ b/lib/services/computeManagement2/lib/models/runCommandInput.js @@ -17,11 +17,11 @@ class RunCommandInput { /** * Create a RunCommandInput. - * @member {string} commandId The run command id. - * @member {array} [script] Optional. The script to be executed. When this + * @property {string} commandId The run command id. + * @property {array} [script] Optional. The script to be executed. When this * value is given, the given script will override the default script of the * command. - * @member {array} [parameters] The run command parameters. + * @property {array} [parameters] The run command parameters. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/runCommandInputParameter.js b/lib/services/computeManagement2/lib/models/runCommandInputParameter.js index 157c76d917..0546b2e1e5 100644 --- a/lib/services/computeManagement2/lib/models/runCommandInputParameter.js +++ b/lib/services/computeManagement2/lib/models/runCommandInputParameter.js @@ -17,8 +17,8 @@ class RunCommandInputParameter { /** * Create a RunCommandInputParameter. - * @member {string} name The run command parameter name. - * @member {string} value The run command parameter value. + * @property {string} name The run command parameter name. + * @property {string} value The run command parameter value. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/runCommandListResult.js b/lib/services/computeManagement2/lib/models/runCommandListResult.js index 314b5e148e..f7b10fc3c2 100644 --- a/lib/services/computeManagement2/lib/models/runCommandListResult.js +++ b/lib/services/computeManagement2/lib/models/runCommandListResult.js @@ -16,7 +16,7 @@ class RunCommandListResult extends Array { /** * Create a RunCommandListResult. - * @member {string} [nextLink] The uri to fetch the next page of run + * @property {string} [nextLink] The uri to fetch the next page of run * commands. Call ListNext() with this to fetch the next page of run * commands. */ diff --git a/lib/services/computeManagement2/lib/models/runCommandParameterDefinition.js b/lib/services/computeManagement2/lib/models/runCommandParameterDefinition.js index f725a842ec..9d7f66b33f 100644 --- a/lib/services/computeManagement2/lib/models/runCommandParameterDefinition.js +++ b/lib/services/computeManagement2/lib/models/runCommandParameterDefinition.js @@ -17,10 +17,10 @@ class RunCommandParameterDefinition { /** * Create a RunCommandParameterDefinition. - * @member {string} name The run command parameter name. - * @member {string} type The run command parameter type. - * @member {string} [defaultValue] The run command parameter default value. - * @member {boolean} [required] The run command parameter required. Default + * @property {string} name The run command parameter name. + * @property {string} type The run command parameter type. + * @property {string} [defaultValue] The run command parameter default value. + * @property {boolean} [required] The run command parameter required. Default * value: false . */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/runCommandResult.js b/lib/services/computeManagement2/lib/models/runCommandResult.js index 7b5d56c547..dc000b406e 100644 --- a/lib/services/computeManagement2/lib/models/runCommandResult.js +++ b/lib/services/computeManagement2/lib/models/runCommandResult.js @@ -16,7 +16,7 @@ class RunCommandResult { /** * Create a RunCommandResult. - * @member {array} [value] Run command operation response. + * @property {array} [value] Run command operation response. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/sku.js b/lib/services/computeManagement2/lib/models/sku.js index 94624da2bc..4e3d117bde 100644 --- a/lib/services/computeManagement2/lib/models/sku.js +++ b/lib/services/computeManagement2/lib/models/sku.js @@ -17,11 +17,11 @@ class Sku { /** * Create a Sku. - * @member {string} [name] The sku name. - * @member {string} [tier] Specifies the tier of virtual machines in a scale - * set.

    Possible Values:

    **Standard**

    - * **Basic** - * @member {number} [capacity] Specifies the number of virtual machines in + * @property {string} [name] The sku name. + * @property {string} [tier] Specifies the tier of virtual machines in a + * scale set.

    Possible Values:

    **Standard**

    **Basic** + * @property {number} [capacity] Specifies the number of virtual machines in * the scale set. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/snapshot.js b/lib/services/computeManagement2/lib/models/snapshot.js index 0107747e28..ca9c4ed87c 100644 --- a/lib/services/computeManagement2/lib/models/snapshot.js +++ b/lib/services/computeManagement2/lib/models/snapshot.js @@ -20,62 +20,52 @@ const models = require('./index'); class Snapshot extends models['Resource'] { /** * Create a Snapshot. - * @member {string} [managedBy] Unused. Always Null. - * @member {object} [sku] - * @member {string} [sku.name] The sku name. Possible values include: + * @property {string} [managedBy] Unused. Always Null. + * @property {object} [sku] + * @property {string} [sku.name] The sku name. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'Standard_ZRS' - * @member {string} [sku.tier] The sku tier. - * @member {date} [timeCreated] The time when the disk was created. - * @member {string} [osType] The Operating System type. Possible values + * @property {string} [sku.tier] The sku tier. + * @property {date} [timeCreated] The time when the disk was created. + * @property {string} [osType] The Operating System type. Possible values * include: 'Windows', 'Linux' - * @member {object} creationData Disk source information. CreationData + * @property {string} [hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: + * 'V1', 'V2' + * @property {object} creationData Disk source information. CreationData * information cannot be changed after the disk has been created. - * @member {string} [creationData.createOption] This enumerates the possible - * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' - * @member {string} [creationData.storageAccountId] If createOption is + * @property {string} [creationData.createOption] This enumerates the + * possible sources of a disk's creation. Possible values include: 'Empty', + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' + * @property {string} [creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account * containing the blob to import as a disk. Required only if the blob is in a * different subscription - * @member {object} [creationData.imageReference] Disk source information. - * @member {string} [creationData.imageReference.id] A relative uri + * @property {object} [creationData.imageReference] Disk source information. + * @property {string} [creationData.imageReference.id] A relative uri * containing either a Platform Image Repository or user image reference. - * @member {number} [creationData.imageReference.lun] If the disk is created - * from an image's data disk, this is an index that indicates which of the - * data disks in the image to use. For OS disks, this field is null. - * @member {string} [creationData.sourceUri] If createOption is Import, this - * is the URI of a blob to be imported into a managed disk. - * @member {string} [creationData.sourceResourceId] If createOption is Copy, - * this is the ARM id of the source snapshot or disk. - * @member {number} [diskSizeGB] If creationData.createOption is Empty, this - * field is mandatory and it indicates the size of the VHD to create. If this - * field is present for updates or creation with other options, it indicates - * a resize. Resizes are only allowed if the disk is not attached to a - * running VM, and can only increase the disk's size. - * @member {object} [encryptionSettings] Encryption settings for disk or - * snapshot - * @member {boolean} [encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @property {number} [creationData.imageReference.lun] If the disk is + * created from an image's data disk, this is an index that indicates which + * of the data disks in the image to use. For OS disks, this field is null. + * @property {string} [creationData.sourceUri] If createOption is Import, + * this is the URI of a blob to be imported into a managed disk. + * @property {string} [creationData.sourceResourceId] If createOption is + * Copy, this is the ARM id of the source snapshot or disk. + * @property {number} [diskSizeGB] If creationData.createOption is Empty, + * this field is mandatory and it indicates the size of the VHD to create. If + * this field is present for updates or creation with other options, it + * indicates a resize. Resizes are only allowed if the disk is not attached + * to a running VM, and can only increase the disk's size. + * @property {object} [encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. + * @property {boolean} [encryptionSettingsCollection.enabled] Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in * the request object, the existing settings remain unchanged. - * @member {object} [encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] - * Resource id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] Url - * pointing to a key or secret in KeyVault - * @member {object} [encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] - * Resource id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] Url pointing - * to a key or secret in KeyVault - * @member {string} [provisioningState] The disk provisioning state. + * @property {array} [encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. + * @property {string} [provisioningState] The disk provisioning state. */ constructor() { super(); @@ -172,6 +162,13 @@ class Snapshot extends models['Resource'] { allowedValues: [ 'Windows', 'Linux' ] } }, + hyperVGeneration: { + required: false, + serializedName: 'properties.hyperVGeneration', + type: { + name: 'String' + } + }, creationData: { required: true, serializedName: 'properties.creationData', @@ -187,12 +184,12 @@ class Snapshot extends models['Resource'] { name: 'Number' } }, - encryptionSettings: { + encryptionSettingsCollection: { required: false, - serializedName: 'properties.encryptionSettings', + serializedName: 'properties.encryptionSettingsCollection', type: { name: 'Composite', - className: 'EncryptionSettings' + className: 'EncryptionSettingsCollection' } }, provisioningState: { diff --git a/lib/services/computeManagement2/lib/models/snapshotList.js b/lib/services/computeManagement2/lib/models/snapshotList.js index ae3710c778..6ea1721239 100644 --- a/lib/services/computeManagement2/lib/models/snapshotList.js +++ b/lib/services/computeManagement2/lib/models/snapshotList.js @@ -16,7 +16,7 @@ class SnapshotList extends Array { /** * Create a SnapshotList. - * @member {string} [nextLink] The uri to fetch the next page of snapshots. + * @property {string} [nextLink] The uri to fetch the next page of snapshots. * Call ListNext() with this to fetch the next page of snapshots. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/snapshotSku.js b/lib/services/computeManagement2/lib/models/snapshotSku.js index ad7c46d018..1f3a086458 100644 --- a/lib/services/computeManagement2/lib/models/snapshotSku.js +++ b/lib/services/computeManagement2/lib/models/snapshotSku.js @@ -17,9 +17,9 @@ class SnapshotSku { /** * Create a SnapshotSku. - * @member {string} [name] The sku name. Possible values include: + * @property {string} [name] The sku name. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'Standard_ZRS' - * @member {string} [tier] The sku tier. Default value: 'Standard' . + * @property {string} [tier] The sku tier. Default value: 'Standard' . */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/snapshotUpdate.js b/lib/services/computeManagement2/lib/models/snapshotUpdate.js index 967545e4f8..b339af56d7 100644 --- a/lib/services/computeManagement2/lib/models/snapshotUpdate.js +++ b/lib/services/computeManagement2/lib/models/snapshotUpdate.js @@ -17,41 +17,28 @@ class SnapshotUpdate { /** * Create a SnapshotUpdate. - * @member {string} [osType] the Operating System type. Possible values + * @property {string} [osType] the Operating System type. Possible values * include: 'Windows', 'Linux' - * @member {number} [diskSizeGB] If creationData.createOption is Empty, this - * field is mandatory and it indicates the size of the VHD to create. If this - * field is present for updates or creation with other options, it indicates - * a resize. Resizes are only allowed if the disk is not attached to a - * running VM, and can only increase the disk's size. - * @member {object} [encryptionSettings] Encryption settings for disk or - * snapshot - * @member {boolean} [encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @property {number} [diskSizeGB] If creationData.createOption is Empty, + * this field is mandatory and it indicates the size of the VHD to create. If + * this field is present for updates or creation with other options, it + * indicates a resize. Resizes are only allowed if the disk is not attached + * to a running VM, and can only increase the disk's size. + * @property {object} [encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. + * @property {boolean} [encryptionSettingsCollection.enabled] Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in * the request object, the existing settings remain unchanged. - * @member {object} [encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * @member {object} [encryptionSettings.diskEncryptionKey.sourceVault] - * Resource id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.diskEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.diskEncryptionKey.secretUrl] Url - * pointing to a key or secret in KeyVault - * @member {object} [encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * @member {object} [encryptionSettings.keyEncryptionKey.sourceVault] - * Resource id of the KeyVault containing the key or secret - * @member {string} [encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * @member {string} [encryptionSettings.keyEncryptionKey.keyUrl] Url pointing - * to a key or secret in KeyVault - * @member {object} [tags] Resource tags - * @member {object} [sku] - * @member {string} [sku.name] The sku name. Possible values include: + * @property {array} [encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. + * @property {object} [tags] Resource tags + * @property {object} [sku] + * @property {string} [sku.name] The sku name. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'Standard_ZRS' - * @member {string} [sku.tier] The sku tier. + * @property {string} [sku.tier] The sku tier. */ constructor() { } @@ -85,12 +72,12 @@ class SnapshotUpdate { name: 'Number' } }, - encryptionSettings: { + encryptionSettingsCollection: { required: false, - serializedName: 'properties.encryptionSettings', + serializedName: 'properties.encryptionSettingsCollection', type: { name: 'Composite', - className: 'EncryptionSettings' + className: 'EncryptionSettingsCollection' } }, tags: { diff --git a/lib/services/computeManagement2/lib/models/sourceVault.js b/lib/services/computeManagement2/lib/models/sourceVault.js index 67e5d06c45..e0b8261282 100644 --- a/lib/services/computeManagement2/lib/models/sourceVault.js +++ b/lib/services/computeManagement2/lib/models/sourceVault.js @@ -11,14 +11,14 @@ 'use strict'; /** - * The vault id is an Azure Resource Manager Resoure id in the form + * The vault id is an Azure Resource Manager Resource id in the form * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} * */ class SourceVault { /** * Create a SourceVault. - * @member {string} [id] Resource Id + * @property {string} [id] Resource Id */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/sshConfiguration.js b/lib/services/computeManagement2/lib/models/sshConfiguration.js index dea2921dd5..dac2b11129 100644 --- a/lib/services/computeManagement2/lib/models/sshConfiguration.js +++ b/lib/services/computeManagement2/lib/models/sshConfiguration.js @@ -17,7 +17,7 @@ class SshConfiguration { /** * Create a SshConfiguration. - * @member {array} [publicKeys] The list of SSH public keys used to + * @property {array} [publicKeys] The list of SSH public keys used to * authenticate with linux based VMs. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/sshPublicKey.js b/lib/services/computeManagement2/lib/models/sshPublicKey.js index 38e8dd8379..23aa5a15d4 100644 --- a/lib/services/computeManagement2/lib/models/sshPublicKey.js +++ b/lib/services/computeManagement2/lib/models/sshPublicKey.js @@ -18,13 +18,13 @@ class SshPublicKey { /** * Create a SshPublicKey. - * @member {string} [path] Specifies the full path on the created VM where + * @property {string} [path] Specifies the full path on the created VM where * ssh public key is stored. If the file already exists, the specified key is * appended to the file. Example: /home/user/.ssh/authorized_keys - * @member {string} [keyData] SSH public key certificate used to authenticate - * with the VM through ssh. The key needs to be at least 2048-bit and in - * ssh-rsa format.

    For creating ssh keys, see [Create SSH keys on - * Linux and Mac for Linux VMs in + * @property {string} [keyData] SSH public key certificate used to + * authenticate with the VM through ssh. The key needs to be at least + * 2048-bit and in ssh-rsa format.

    For creating ssh keys, see + * [Create SSH keys on Linux and Mac for Linux VMs in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/storageProfile.js b/lib/services/computeManagement2/lib/models/storageProfile.js index cf4f2ce1e7..615e12a1d4 100644 --- a/lib/services/computeManagement2/lib/models/storageProfile.js +++ b/lib/services/computeManagement2/lib/models/storageProfile.js @@ -17,72 +17,75 @@ class StorageProfile { /** * Create a StorageProfile. - * @member {object} [imageReference] Specifies information about the image to - * use. You can specify information about platform images, marketplace + * @property {object} [imageReference] Specifies information about the image + * to use. You can specify information about platform images, marketplace * images, or virtual machine images. This element is required when you want * to use a platform image, marketplace image, or virtual machine image, but * is not used in other creation operations. - * @member {string} [imageReference.publisher] The image publisher. - * @member {string} [imageReference.offer] Specifies the offer of the + * @property {string} [imageReference.publisher] The image publisher. + * @property {string} [imageReference.offer] Specifies the offer of the * platform image or marketplace image used to create the virtual machine. - * @member {string} [imageReference.sku] The image SKU. - * @member {string} [imageReference.version] Specifies the version of the + * @property {string} [imageReference.sku] The image SKU. + * @property {string} [imageReference.version] Specifies the version of the * platform image or marketplace image used to create the virtual machine. * The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and * Build are decimal numbers. Specify 'latest' to use the latest version of * an image available at deploy time. Even if you use 'latest', the VM image * will not automatically update after deploy time even if a new version * becomes available. - * @member {object} [osDisk] Specifies information about the operating system - * disk used by the virtual machine.

    For more information about - * disks, see [About disks and VHDs for Azure virtual + * @property {object} [osDisk] Specifies information about the operating + * system disk used by the virtual machine.

    For more information + * about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [osDisk.osType] This property allows you to specify the + * @property {string} [osDisk.osType] This property allows you to specify the * type of the OS that is included in the disk if creating a VM from * user-image or a specialized VHD.

    Possible values are:

    * **Windows**

    **Linux**. Possible values include: 'Windows', * 'Linux' - * @member {object} [osDisk.encryptionSettings] Specifies the encryption + * @property {object} [osDisk.encryptionSettings] Specifies the encryption * settings for the OS Disk.

    Minimum api-version: 2015-06-15 - * @member {object} [osDisk.encryptionSettings.diskEncryptionKey] Specifies + * @property {object} [osDisk.encryptionSettings.diskEncryptionKey] Specifies * the location of the disk encryption key, which is a Key Vault Secret. - * @member {string} [osDisk.encryptionSettings.diskEncryptionKey.secretUrl] + * @property {string} [osDisk.encryptionSettings.diskEncryptionKey.secretUrl] * The URL referencing a secret in a Key Vault. - * @member {object} [osDisk.encryptionSettings.diskEncryptionKey.sourceVault] - * The relative URL of the Key Vault containing the secret. - * @member {string} + * @property {object} + * [osDisk.encryptionSettings.diskEncryptionKey.sourceVault] The relative URL + * of the Key Vault containing the secret. + * @property {string} * [osDisk.encryptionSettings.diskEncryptionKey.sourceVault.id] Resource Id - * @member {object} [osDisk.encryptionSettings.keyEncryptionKey] Specifies + * @property {object} [osDisk.encryptionSettings.keyEncryptionKey] Specifies * the location of the key encryption key in Key Vault. - * @member {string} [osDisk.encryptionSettings.keyEncryptionKey.keyUrl] The + * @property {string} [osDisk.encryptionSettings.keyEncryptionKey.keyUrl] The * URL referencing a key encryption key in Key Vault. - * @member {object} [osDisk.encryptionSettings.keyEncryptionKey.sourceVault] - * The relative URL of the Key Vault containing the key. - * @member {string} + * @property {object} + * [osDisk.encryptionSettings.keyEncryptionKey.sourceVault] The relative URL + * of the Key Vault containing the key. + * @property {string} * [osDisk.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * @member {boolean} [osDisk.encryptionSettings.enabled] Specifies whether + * @property {boolean} [osDisk.encryptionSettings.enabled] Specifies whether * disk encryption should be enabled on the virtual machine. - * @member {string} [osDisk.name] The disk name. - * @member {object} [osDisk.vhd] The virtual hard disk. - * @member {string} [osDisk.vhd.uri] Specifies the virtual hard disk's uri. - * @member {object} [osDisk.image] The source user image virtual hard disk. + * @property {string} [osDisk.name] The disk name. + * @property {object} [osDisk.vhd] The virtual hard disk. + * @property {string} [osDisk.vhd.uri] Specifies the virtual hard disk's uri. + * @property {object} [osDisk.image] The source user image virtual hard disk. * The virtual hard disk will be copied before being attached to the virtual * machine. If SourceImage is provided, the destination virtual hard drive * must not exist. - * @member {string} [osDisk.image.uri] Specifies the virtual hard disk's uri. - * @member {string} [osDisk.caching] Specifies the caching requirements. + * @property {string} [osDisk.image.uri] Specifies the virtual hard disk's + * uri. + * @property {string} [osDisk.caching] Specifies the caching requirements. *

    Possible values are:

    **None**

    **ReadOnly** *

    **ReadWrite**

    Default: **None for Standard storage. * ReadOnly for Premium storage**. Possible values include: 'None', * 'ReadOnly', 'ReadWrite' - * @member {boolean} [osDisk.writeAcceleratorEnabled] Specifies whether + * @property {boolean} [osDisk.writeAcceleratorEnabled] Specifies whether * writeAccelerator should be enabled or disabled on the disk. - * @member {object} [osDisk.diffDiskSettings] Specifies the differencing Disk + * @property {object} [osDisk.diffDiskSettings] Specifies the ephemeral Disk * Settings for the operating system disk used by the virtual machine. - * @member {string} [osDisk.diffDiskSettings.option] Specifies the - * differencing disk settings for operating system disk. Possible values + * @property {string} [osDisk.diffDiskSettings.option] Specifies the + * ephemeral disk settings for operating system disk. Possible values * include: 'Local' - * @member {string} [osDisk.createOption] Specifies how the virtual machine + * @property {string} [osDisk.createOption] Specifies how the virtual machine * should be created.

    Possible values are:

    **Attach** \u2013 * This value is used when you are using a specialized disk to create the * virtual machine.

    **FromImage** \u2013 This value is used when you @@ -91,17 +94,17 @@ class StorageProfile { * If you are using a marketplace image, you also use the plan element * previously described. Possible values include: 'FromImage', 'Empty', * 'Attach' - * @member {number} [osDisk.diskSizeGB] Specifies the size of an empty data + * @property {number} [osDisk.diskSizeGB] Specifies the size of an empty data * disk in gigabytes. This element can be used to overwrite the size of the * disk in a virtual machine image.

    This value cannot be larger than * 1023 GB - * @member {object} [osDisk.managedDisk] The managed disk parameters. - * @member {string} [osDisk.managedDisk.storageAccountType] Specifies the + * @property {object} [osDisk.managedDisk] The managed disk parameters. + * @property {string} [osDisk.managedDisk.storageAccountType] Specifies the * storage account type for the managed disk. NOTE: UltraSSD_LRS can only be * used with data disks, it cannot be used with OS Disk. Possible values * include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [dataDisks] Specifies the parameters that are used to add - * a data disk to a virtual machine.

    For more information about + * @property {array} [dataDisks] Specifies the parameters that are used to + * add a data disk to a virtual machine.

    For more information about * disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). */ diff --git a/lib/services/computeManagement2/lib/models/subResource.js b/lib/services/computeManagement2/lib/models/subResource.js index 5e3baea5a4..c7cced9e84 100644 --- a/lib/services/computeManagement2/lib/models/subResource.js +++ b/lib/services/computeManagement2/lib/models/subResource.js @@ -19,7 +19,7 @@ const models = require('./index'); class SubResource extends models['BaseResource'] { /** * Create a SubResource. - * @member {string} [id] Resource Id + * @property {string} [id] Resource Id */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/subResourceReadOnly.js b/lib/services/computeManagement2/lib/models/subResourceReadOnly.js index 98b60a6738..e02dfbfdf5 100644 --- a/lib/services/computeManagement2/lib/models/subResourceReadOnly.js +++ b/lib/services/computeManagement2/lib/models/subResourceReadOnly.js @@ -19,7 +19,7 @@ const models = require('./index'); class SubResourceReadOnly extends models['BaseResource'] { /** * Create a SubResourceReadOnly. - * @member {string} [id] Resource Id + * @property {string} [id] Resource Id */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/targetRegion.js b/lib/services/computeManagement2/lib/models/targetRegion.js index 1236907427..0bf1529b81 100644 --- a/lib/services/computeManagement2/lib/models/targetRegion.js +++ b/lib/services/computeManagement2/lib/models/targetRegion.js @@ -17,9 +17,9 @@ class TargetRegion { /** * Create a TargetRegion. - * @member {string} name The name of the region. - * @member {number} [regionalReplicaCount] The number of replicas of the - * Image Version to be created per region. This property is updateable. + * @property {string} name The name of the region. + * @property {number} [regionalReplicaCount] The number of replicas of the + * Image Version to be created per region. This property is updatable. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/updateResource.js b/lib/services/computeManagement2/lib/models/updateResource.js index 069580f99a..9d87923e71 100644 --- a/lib/services/computeManagement2/lib/models/updateResource.js +++ b/lib/services/computeManagement2/lib/models/updateResource.js @@ -20,7 +20,7 @@ const models = require('./index'); class UpdateResource extends models['BaseResource'] { /** * Create a UpdateResource. - * @member {object} [tags] Resource tags + * @property {object} [tags] Resource tags */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/upgradeOperationHistoricalStatusInfo.js b/lib/services/computeManagement2/lib/models/upgradeOperationHistoricalStatusInfo.js index cc5a4f043b..aec5f431f7 100644 --- a/lib/services/computeManagement2/lib/models/upgradeOperationHistoricalStatusInfo.js +++ b/lib/services/computeManagement2/lib/models/upgradeOperationHistoricalStatusInfo.js @@ -17,80 +17,82 @@ class UpgradeOperationHistoricalStatusInfo { /** * Create a UpgradeOperationHistoricalStatusInfo. - * @member {object} [properties] Information about the properties of the + * @property {object} [properties] Information about the properties of the * upgrade operation. - * @member {object} [properties.runningStatus] Information about the overall - * status of the upgrade operation. - * @member {string} [properties.runningStatus.code] Code indicating the + * @property {object} [properties.runningStatus] Information about the + * overall status of the upgrade operation. + * @property {string} [properties.runningStatus.code] Code indicating the * current status of the upgrade. Possible values include: 'RollingForward', * 'Cancelled', 'Completed', 'Faulted' - * @member {date} [properties.runningStatus.startTime] Start time of the + * @property {date} [properties.runningStatus.startTime] Start time of the * upgrade. - * @member {date} [properties.runningStatus.endTime] End time of the upgrade. - * @member {object} [properties.progress] Counts of the VM's in each state. - * @member {number} [properties.progress.successfulInstanceCount] The number - * of instances that have been successfully upgraded. - * @member {number} [properties.progress.failedInstanceCount] The number of + * @property {date} [properties.runningStatus.endTime] End time of the + * upgrade. + * @property {object} [properties.progress] Counts of the VMs in each state. + * @property {number} [properties.progress.successfulInstanceCount] The + * number of instances that have been successfully upgraded. + * @property {number} [properties.progress.failedInstanceCount] The number of * instances that have failed to be upgraded successfully. - * @member {number} [properties.progress.inProgressInstanceCount] The number - * of instances that are currently being upgraded. - * @member {number} [properties.progress.pendingInstanceCount] The number of - * instances that have not yet begun to be upgraded. - * @member {object} [properties.error] Error Details for this upgrade if + * @property {number} [properties.progress.inProgressInstanceCount] The + * number of instances that are currently being upgraded. + * @property {number} [properties.progress.pendingInstanceCount] The number + * of instances that have not yet begun to be upgraded. + * @property {object} [properties.error] Error Details for this upgrade if * there are any. - * @member {array} [properties.error.details] The Api error details - * @member {object} [properties.error.innererror] The Api inner error - * @member {string} [properties.error.innererror.exceptiontype] The exception - * type. - * @member {string} [properties.error.innererror.errordetail] The internal + * @property {array} [properties.error.details] The Api error details + * @property {object} [properties.error.innererror] The Api inner error + * @property {string} [properties.error.innererror.exceptiontype] The + * exception type. + * @property {string} [properties.error.innererror.errordetail] The internal * error message or exception dump. - * @member {string} [properties.error.code] The error code. - * @member {string} [properties.error.target] The target of the particular + * @property {string} [properties.error.code] The error code. + * @property {string} [properties.error.target] The target of the particular * error. - * @member {string} [properties.error.message] The error message. - * @member {string} [properties.startedBy] Invoker of the Upgrade Operation. - * Possible values include: 'Unknown', 'User', 'Platform' - * @member {object} [properties.targetImageReference] Image Reference details - * @member {string} [properties.targetImageReference.publisher] The image + * @property {string} [properties.error.message] The error message. + * @property {string} [properties.startedBy] Invoker of the Upgrade + * Operation. Possible values include: 'Unknown', 'User', 'Platform' + * @property {object} [properties.targetImageReference] Image Reference + * details + * @property {string} [properties.targetImageReference.publisher] The image * publisher. - * @member {string} [properties.targetImageReference.offer] Specifies the + * @property {string} [properties.targetImageReference.offer] Specifies the * offer of the platform image or marketplace image used to create the * virtual machine. - * @member {string} [properties.targetImageReference.sku] The image SKU. - * @member {string} [properties.targetImageReference.version] Specifies the + * @property {string} [properties.targetImageReference.sku] The image SKU. + * @property {string} [properties.targetImageReference.version] Specifies the * version of the platform image or marketplace image used to create the * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the * latest version of an image available at deploy time. Even if you use * 'latest', the VM image will not automatically update after deploy time * even if a new version becomes available. - * @member {object} [properties.rollbackInfo] Information about OS rollback + * @property {object} [properties.rollbackInfo] Information about OS rollback * if performed - * @member {number} + * @property {number} * [properties.rollbackInfo.successfullyRolledbackInstanceCount] The number * of instances which have been successfully rolled back. - * @member {number} [properties.rollbackInfo.failedRolledbackInstanceCount] + * @property {number} [properties.rollbackInfo.failedRolledbackInstanceCount] * The number of instances which failed to rollback. - * @member {object} [properties.rollbackInfo.rollbackError] Error details if - * OS rollback failed. - * @member {array} [properties.rollbackInfo.rollbackError.details] The Api + * @property {object} [properties.rollbackInfo.rollbackError] Error details + * if OS rollback failed. + * @property {array} [properties.rollbackInfo.rollbackError.details] The Api * error details - * @member {object} [properties.rollbackInfo.rollbackError.innererror] The + * @property {object} [properties.rollbackInfo.rollbackError.innererror] The * Api inner error - * @member {string} + * @property {string} * [properties.rollbackInfo.rollbackError.innererror.exceptiontype] The * exception type. - * @member {string} + * @property {string} * [properties.rollbackInfo.rollbackError.innererror.errordetail] The * internal error message or exception dump. - * @member {string} [properties.rollbackInfo.rollbackError.code] The error + * @property {string} [properties.rollbackInfo.rollbackError.code] The error * code. - * @member {string} [properties.rollbackInfo.rollbackError.target] The target - * of the particular error. - * @member {string} [properties.rollbackInfo.rollbackError.message] The error - * message. - * @member {string} [type] Resource type - * @member {string} [location] Resource location + * @property {string} [properties.rollbackInfo.rollbackError.target] The + * target of the particular error. + * @property {string} [properties.rollbackInfo.rollbackError.message] The + * error message. + * @property {string} [type] Resource type + * @property {string} [location] Resource location */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/upgradeOperationHistoricalStatusInfoProperties.js b/lib/services/computeManagement2/lib/models/upgradeOperationHistoricalStatusInfoProperties.js index 2b6ff23fa5..0546e9f65c 100644 --- a/lib/services/computeManagement2/lib/models/upgradeOperationHistoricalStatusInfoProperties.js +++ b/lib/services/computeManagement2/lib/models/upgradeOperationHistoricalStatusInfoProperties.js @@ -17,63 +17,66 @@ class UpgradeOperationHistoricalStatusInfoProperties { /** * Create a UpgradeOperationHistoricalStatusInfoProperties. - * @member {object} [runningStatus] Information about the overall status of + * @property {object} [runningStatus] Information about the overall status of * the upgrade operation. - * @member {string} [runningStatus.code] Code indicating the current status + * @property {string} [runningStatus.code] Code indicating the current status * of the upgrade. Possible values include: 'RollingForward', 'Cancelled', * 'Completed', 'Faulted' - * @member {date} [runningStatus.startTime] Start time of the upgrade. - * @member {date} [runningStatus.endTime] End time of the upgrade. - * @member {object} [progress] Counts of the VM's in each state. - * @member {number} [progress.successfulInstanceCount] The number of + * @property {date} [runningStatus.startTime] Start time of the upgrade. + * @property {date} [runningStatus.endTime] End time of the upgrade. + * @property {object} [progress] Counts of the VMs in each state. + * @property {number} [progress.successfulInstanceCount] The number of * instances that have been successfully upgraded. - * @member {number} [progress.failedInstanceCount] The number of instances + * @property {number} [progress.failedInstanceCount] The number of instances * that have failed to be upgraded successfully. - * @member {number} [progress.inProgressInstanceCount] The number of + * @property {number} [progress.inProgressInstanceCount] The number of * instances that are currently being upgraded. - * @member {number} [progress.pendingInstanceCount] The number of instances + * @property {number} [progress.pendingInstanceCount] The number of instances * that have not yet begun to be upgraded. - * @member {object} [error] Error Details for this upgrade if there are any. - * @member {array} [error.details] The Api error details - * @member {object} [error.innererror] The Api inner error - * @member {string} [error.innererror.exceptiontype] The exception type. - * @member {string} [error.innererror.errordetail] The internal error message - * or exception dump. - * @member {string} [error.code] The error code. - * @member {string} [error.target] The target of the particular error. - * @member {string} [error.message] The error message. - * @member {string} [startedBy] Invoker of the Upgrade Operation. Possible + * @property {object} [error] Error Details for this upgrade if there are + * any. + * @property {array} [error.details] The Api error details + * @property {object} [error.innererror] The Api inner error + * @property {string} [error.innererror.exceptiontype] The exception type. + * @property {string} [error.innererror.errordetail] The internal error + * message or exception dump. + * @property {string} [error.code] The error code. + * @property {string} [error.target] The target of the particular error. + * @property {string} [error.message] The error message. + * @property {string} [startedBy] Invoker of the Upgrade Operation. Possible * values include: 'Unknown', 'User', 'Platform' - * @member {object} [targetImageReference] Image Reference details - * @member {string} [targetImageReference.publisher] The image publisher. - * @member {string} [targetImageReference.offer] Specifies the offer of the + * @property {object} [targetImageReference] Image Reference details + * @property {string} [targetImageReference.publisher] The image publisher. + * @property {string} [targetImageReference.offer] Specifies the offer of the * platform image or marketplace image used to create the virtual machine. - * @member {string} [targetImageReference.sku] The image SKU. - * @member {string} [targetImageReference.version] Specifies the version of + * @property {string} [targetImageReference.sku] The image SKU. + * @property {string} [targetImageReference.version] Specifies the version of * the platform image or marketplace image used to create the virtual * machine. The allowed formats are Major.Minor.Build or 'latest'. Major, * Minor, and Build are decimal numbers. Specify 'latest' to use the latest * version of an image available at deploy time. Even if you use 'latest', * the VM image will not automatically update after deploy time even if a new * version becomes available. - * @member {object} [rollbackInfo] Information about OS rollback if performed - * @member {number} [rollbackInfo.successfullyRolledbackInstanceCount] The + * @property {object} [rollbackInfo] Information about OS rollback if + * performed + * @property {number} [rollbackInfo.successfullyRolledbackInstanceCount] The * number of instances which have been successfully rolled back. - * @member {number} [rollbackInfo.failedRolledbackInstanceCount] The number + * @property {number} [rollbackInfo.failedRolledbackInstanceCount] The number * of instances which failed to rollback. - * @member {object} [rollbackInfo.rollbackError] Error details if OS rollback - * failed. - * @member {array} [rollbackInfo.rollbackError.details] The Api error details - * @member {object} [rollbackInfo.rollbackError.innererror] The Api inner + * @property {object} [rollbackInfo.rollbackError] Error details if OS + * rollback failed. + * @property {array} [rollbackInfo.rollbackError.details] The Api error + * details + * @property {object} [rollbackInfo.rollbackError.innererror] The Api inner * error - * @member {string} [rollbackInfo.rollbackError.innererror.exceptiontype] The - * exception type. - * @member {string} [rollbackInfo.rollbackError.innererror.errordetail] The + * @property {string} [rollbackInfo.rollbackError.innererror.exceptiontype] + * The exception type. + * @property {string} [rollbackInfo.rollbackError.innererror.errordetail] The * internal error message or exception dump. - * @member {string} [rollbackInfo.rollbackError.code] The error code. - * @member {string} [rollbackInfo.rollbackError.target] The target of the + * @property {string} [rollbackInfo.rollbackError.code] The error code. + * @property {string} [rollbackInfo.rollbackError.target] The target of the * particular error. - * @member {string} [rollbackInfo.rollbackError.message] The error message. + * @property {string} [rollbackInfo.rollbackError.message] The error message. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/upgradeOperationHistoryStatus.js b/lib/services/computeManagement2/lib/models/upgradeOperationHistoryStatus.js index 989c1480d4..4e15282120 100644 --- a/lib/services/computeManagement2/lib/models/upgradeOperationHistoryStatus.js +++ b/lib/services/computeManagement2/lib/models/upgradeOperationHistoryStatus.js @@ -17,11 +17,11 @@ class UpgradeOperationHistoryStatus { /** * Create a UpgradeOperationHistoryStatus. - * @member {string} [code] Code indicating the current status of the upgrade. - * Possible values include: 'RollingForward', 'Cancelled', 'Completed', - * 'Faulted' - * @member {date} [startTime] Start time of the upgrade. - * @member {date} [endTime] End time of the upgrade. + * @property {string} [code] Code indicating the current status of the + * upgrade. Possible values include: 'RollingForward', 'Cancelled', + * 'Completed', 'Faulted' + * @property {date} [startTime] Start time of the upgrade. + * @property {date} [endTime] End time of the upgrade. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/upgradePolicy.js b/lib/services/computeManagement2/lib/models/upgradePolicy.js index 0bdfe637e9..333311368b 100644 --- a/lib/services/computeManagement2/lib/models/upgradePolicy.js +++ b/lib/services/computeManagement2/lib/models/upgradePolicy.js @@ -17,45 +17,45 @@ class UpgradePolicy { /** * Create a UpgradePolicy. - * @member {string} [mode] Specifies the mode of an upgrade to virtual + * @property {string} [mode] Specifies the mode of an upgrade to virtual * machines in the scale set.

    Possible values are:

    * **Manual** - You control the application of updates to virtual machines * in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are * automatically updated at the same time. Possible values include: * 'Automatic', 'Manual', 'Rolling' - * @member {object} [rollingUpgradePolicy] The configuration parameters used - * while performing a rolling upgrade. - * @member {number} [rollingUpgradePolicy.maxBatchInstancePercent] The + * @property {object} [rollingUpgradePolicy] The configuration parameters + * used while performing a rolling upgrade. + * @property {number} [rollingUpgradePolicy.maxBatchInstancePercent] The * maximum percent of total virtual machine instances that will be upgraded * simultaneously by the rolling upgrade in one batch. As this is a maximum, * unhealthy instances in previous or future batches can cause the percentage * of instances in a batch to decrease to ensure higher reliability. The * default value for this parameter is 20%. - * @member {number} [rollingUpgradePolicy.maxUnhealthyInstancePercent] The + * @property {number} [rollingUpgradePolicy.maxUnhealthyInstancePercent] The * maximum percentage of the total virtual machine instances in the scale set * that can be simultaneously unhealthy, either as a result of being * upgraded, or by being found in an unhealthy state by the virtual machine * health checks before the rolling upgrade aborts. This constraint will be * checked prior to starting any batch. The default value for this parameter * is 20%. - * @member {number} + * @property {number} * [rollingUpgradePolicy.maxUnhealthyUpgradedInstancePercent] The maximum * percentage of upgraded virtual machine instances that can be found to be * in an unhealthy state. This check will happen after each batch is * upgraded. If this percentage is ever exceeded, the rolling update aborts. * The default value for this parameter is 20%. - * @member {string} [rollingUpgradePolicy.pauseTimeBetweenBatches] The wait + * @property {string} [rollingUpgradePolicy.pauseTimeBetweenBatches] The wait * time between completing the update for all virtual machines in one batch * and starting the next batch. The time duration should be specified in ISO * 8601 format. The default value is 0 seconds (PT0S). - * @member {object} [automaticOSUpgradePolicy] Configuration parameters used - * for performing automatic OS Upgrade. - * @member {boolean} [automaticOSUpgradePolicy.enableAutomaticOSUpgrade] + * @property {object} [automaticOSUpgradePolicy] Configuration parameters + * used for performing automatic OS Upgrade. + * @property {boolean} [automaticOSUpgradePolicy.enableAutomaticOSUpgrade] * Whether OS upgrades should automatically be applied to scale set instances * in a rolling fashion when a newer version of the image becomes available. * Default value is false. - * @member {boolean} [automaticOSUpgradePolicy.disableAutomaticRollback] + * @property {boolean} [automaticOSUpgradePolicy.disableAutomaticRollback] * Whether OS image rollback feature should be disabled. Default value is * false. */ diff --git a/lib/services/computeManagement2/lib/models/usage.js b/lib/services/computeManagement2/lib/models/usage.js index c840e66a99..f45f4688ea 100644 --- a/lib/services/computeManagement2/lib/models/usage.js +++ b/lib/services/computeManagement2/lib/models/usage.js @@ -17,11 +17,12 @@ class Usage { /** * Create a Usage. - * @member {number} currentValue The current usage of the resource. - * @member {number} limit The maximum permitted usage of the resource. - * @member {object} name The name of the type of usage. - * @member {string} [name.value] The name of the resource. - * @member {string} [name.localizedValue] The localized name of the resource. + * @property {number} currentValue The current usage of the resource. + * @property {number} limit The maximum permitted usage of the resource. + * @property {object} name The name of the type of usage. + * @property {string} [name.value] The name of the resource. + * @property {string} [name.localizedValue] The localized name of the + * resource. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/usageName.js b/lib/services/computeManagement2/lib/models/usageName.js index fc33444bc4..ecea3bed39 100644 --- a/lib/services/computeManagement2/lib/models/usageName.js +++ b/lib/services/computeManagement2/lib/models/usageName.js @@ -17,8 +17,8 @@ class UsageName { /** * Create a UsageName. - * @member {string} [value] The name of the resource. - * @member {string} [localizedValue] The localized name of the resource. + * @property {string} [value] The name of the resource. + * @property {string} [localizedValue] The localized name of the resource. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/vaultCertificate.js b/lib/services/computeManagement2/lib/models/vaultCertificate.js index 81a1fa70ec..f9c81f0392 100644 --- a/lib/services/computeManagement2/lib/models/vaultCertificate.js +++ b/lib/services/computeManagement2/lib/models/vaultCertificate.js @@ -18,7 +18,7 @@ class VaultCertificate { /** * Create a VaultCertificate. - * @member {string} [certificateUrl] This is the URL of a certificate that + * @property {string} [certificateUrl] This is the URL of a certificate that * has been uploaded to Key Vault as a secret. For adding a secret to the Key * Vault, see [Add a key or secret to the key * vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). @@ -26,14 +26,14 @@ class VaultCertificate { * the following JSON Object which is encoded in UTF-8:

    {
    * "data":"",
    "dataType":"pfx",
    * "password":""
    } - * @member {string} [certificateStore] For Windows VMs, specifies the + * @property {string} [certificateStore] For Windows VMs, specifies the * certificate store on the Virtual Machine to which the certificate should * be added. The specified certificate store is implicitly in the * LocalMachine account.

    For Linux VMs, the certificate file is * placed under the /var/lib/waagent directory, with the file name - * .crt for the X509 certificate file and - * .prv for private key. Both of these files are .pem - * formatted. + * <UppercaseThumbprint>.crt for the X509 certificate file and + * <UppercaseThumbprint>.prv for private key. Both of these files are + * .pem formatted. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/vaultSecretGroup.js b/lib/services/computeManagement2/lib/models/vaultSecretGroup.js index 9922059631..fa0639bab7 100644 --- a/lib/services/computeManagement2/lib/models/vaultSecretGroup.js +++ b/lib/services/computeManagement2/lib/models/vaultSecretGroup.js @@ -17,10 +17,10 @@ class VaultSecretGroup { /** * Create a VaultSecretGroup. - * @member {object} [sourceVault] The relative URL of the Key Vault + * @property {object} [sourceVault] The relative URL of the Key Vault * containing all of the certificates in VaultCertificates. - * @member {string} [sourceVault.id] Resource Id - * @member {array} [vaultCertificates] The list of key vault references in + * @property {string} [sourceVault.id] Resource Id + * @property {array} [vaultCertificates] The list of key vault references in * SourceVault which contain certificates. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualHardDisk.js b/lib/services/computeManagement2/lib/models/virtualHardDisk.js index 1fbc70dca7..adfa510717 100644 --- a/lib/services/computeManagement2/lib/models/virtualHardDisk.js +++ b/lib/services/computeManagement2/lib/models/virtualHardDisk.js @@ -17,7 +17,7 @@ class VirtualHardDisk { /** * Create a VirtualHardDisk. - * @member {string} [uri] Specifies the virtual hard disk's uri. + * @property {string} [uri] Specifies the virtual hard disk's uri. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachine.js b/lib/services/computeManagement2/lib/models/virtualMachine.js index 0487bd8b55..1827e4a848 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachine.js +++ b/lib/services/computeManagement2/lib/models/virtualMachine.js @@ -20,22 +20,22 @@ const models = require('./index'); class VirtualMachine extends models['Resource'] { /** * Create a VirtualMachine. - * @member {object} [plan] Specifies information about the marketplace image - * used to create the virtual machine. This element is only used for + * @property {object} [plan] Specifies information about the marketplace + * image used to create the virtual machine. This element is only used for * marketplace images. Before you can use a marketplace image from an API, * you must enable the image for programmatic use. In the Azure portal, find * the marketplace image that you want to use and then click **Want to deploy * programmatically, Get Started ->**. Enter any required information and * then click **Save**. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from + * @property {string} [plan.name] The plan ID. + * @property {string} [plan.publisher] The publisher ID. + * @property {string} [plan.product] Specifies the product of the image from * the marketplace. This is the same value as Offer under the imageReference * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {object} [hardwareProfile] Specifies the hardware settings for the - * virtual machine. - * @member {string} [hardwareProfile.vmSize] Specifies the size of the + * @property {string} [plan.promotionCode] The promotion code. + * @property {object} [hardwareProfile] Specifies the hardware settings for + * the virtual machine. + * @property {string} [hardwareProfile.vmSize] Specifies the size of the * virtual machine. For more information about virtual machine sizes, see * [Sizes for virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). @@ -93,90 +93,90 @@ class VirtualMachine extends models['Resource'] { * 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', * 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', * 'Standard_NV12', 'Standard_NV24' - * @member {object} [storageProfile] Specifies the storage settings for the + * @property {object} [storageProfile] Specifies the storage settings for the * virtual machine disks. - * @member {object} [storageProfile.imageReference] Specifies information + * @property {object} [storageProfile.imageReference] Specifies information * about the image to use. You can specify information about platform images, * marketplace images, or virtual machine images. This element is required * when you want to use a platform image, marketplace image, or virtual * machine image, but is not used in other creation operations. - * @member {string} [storageProfile.imageReference.publisher] The image + * @property {string} [storageProfile.imageReference.publisher] The image * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the + * @property {string} [storageProfile.imageReference.offer] Specifies the + * offer of the platform image or marketplace image used to create the + * virtual machine. + * @property {string} [storageProfile.imageReference.sku] The image SKU. + * @property {string} [storageProfile.imageReference.version] Specifies the * version of the platform image or marketplace image used to create the * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the * latest version of an image available at deploy time. Even if you use * 'latest', the VM image will not automatically update after deploy time * even if a new version becomes available. - * @member {object} [storageProfile.osDisk] Specifies information about the + * @property {object} [storageProfile.osDisk] Specifies information about the * operating system disk used by the virtual machine.

    For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you + * @property {string} [storageProfile.osDisk.osType] This property allows you * to specify the type of the OS that is included in the disk if creating a * VM from user-image or a specialized VHD.

    Possible values are: *

    **Windows**

    **Linux**. Possible values include: * 'Windows', 'Linux' - * @member {object} [storageProfile.osDisk.encryptionSettings] Specifies the - * encryption settings for the OS Disk.

    Minimum api-version: + * @property {object} [storageProfile.osDisk.encryptionSettings] Specifies + * the encryption settings for the OS Disk.

    Minimum api-version: * 2015-06-15 - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey] Specifies the * location of the disk encryption key, which is a Key Vault Secret. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.secretUrl] The * URL referencing a secret in a Key Vault. - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault] * The relative URL of the Key Vault containing the secret. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault.id] * Resource Id - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey] Specifies the * location of the key encryption key in Key Vault. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.keyUrl] The URL * referencing a key encryption key in Key Vault. - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault] * The relative URL of the Key Vault containing the key. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault.id] * Resource Id - * @member {boolean} [storageProfile.osDisk.encryptionSettings.enabled] + * @property {boolean} [storageProfile.osDisk.encryptionSettings.enabled] * Specifies whether disk encryption should be enabled on the virtual * machine. - * @member {string} [storageProfile.osDisk.name] The disk name. - * @member {object} [storageProfile.osDisk.vhd] The virtual hard disk. - * @member {string} [storageProfile.osDisk.vhd.uri] Specifies the virtual + * @property {string} [storageProfile.osDisk.name] The disk name. + * @property {object} [storageProfile.osDisk.vhd] The virtual hard disk. + * @property {string} [storageProfile.osDisk.vhd.uri] Specifies the virtual * hard disk's uri. - * @member {object} [storageProfile.osDisk.image] The source user image + * @property {object} [storageProfile.osDisk.image] The source user image * virtual hard disk. The virtual hard disk will be copied before being * attached to the virtual machine. If SourceImage is provided, the * destination virtual hard drive must not exist. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual + * @property {string} [storageProfile.osDisk.image.uri] Specifies the virtual * hard disk's uri. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching + * @property {string} [storageProfile.osDisk.caching] Specifies the caching * requirements.

    Possible values are:

    **None**

    * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard * storage. ReadOnly for Premium storage**. Possible values include: 'None', * 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] + * @property {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] * Specifies whether writeAccelerator should be enabled or disabled on the * disk. - * @member {object} [storageProfile.osDisk.diffDiskSettings] Specifies the - * differencing Disk Settings for the operating system disk used by the - * virtual machine. - * @member {string} [storageProfile.osDisk.diffDiskSettings.option] Specifies - * the differencing disk settings for operating system disk. Possible values - * include: 'Local' - * @member {string} [storageProfile.osDisk.createOption] Specifies how the + * @property {object} [storageProfile.osDisk.diffDiskSettings] Specifies the + * ephemeral Disk Settings for the operating system disk used by the virtual + * machine. + * @property {string} [storageProfile.osDisk.diffDiskSettings.option] + * Specifies the ephemeral disk settings for operating system disk. Possible + * values include: 'Local' + * @property {string} [storageProfile.osDisk.createOption] Specifies how the * virtual machine should be created.

    Possible values are:

    * **Attach** \u2013 This value is used when you are using a specialized disk * to create the virtual machine.

    **FromImage** \u2013 This value is @@ -185,37 +185,37 @@ class VirtualMachine extends models['Resource'] { * above. If you are using a marketplace image, you also use the plan * element previously described. Possible values include: 'FromImage', * 'Empty', 'Attach' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * an empty data disk in gigabytes. This element can be used to overwrite the - * size of the disk in a virtual machine image.

    This value cannot be - * larger than 1023 GB - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk + * @property {number} [storageProfile.osDisk.diskSizeGB] Specifies the size + * of an empty data disk in gigabytes. This element can be used to overwrite + * the size of the disk in a virtual machine image.

    This value + * cannot be larger than 1023 GB + * @property {object} [storageProfile.osDisk.managedDisk] The managed disk * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] + * @property {string} [storageProfile.osDisk.managedDisk.storageAccountType] * Specifies the storage account type for the managed disk. NOTE: * UltraSSD_LRS can only be used with data disks, it cannot be used with OS * Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that + * @property {array} [storageProfile.dataDisks] Specifies the parameters that * are used to add a data disk to a virtual machine.

    For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [additionalCapabilities] Specifies additional + * @property {object} [additionalCapabilities] Specifies additional * capabilities enabled or disabled on the virtual machine. - * @member {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that + * @property {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that * enables or disables a capability to have one or more managed data disks * with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks * with storage account type UltraSSD_LRS can be added to a virtual machine * or virtual machine scale set only if this property is enabled. - * @member {object} [osProfile] Specifies the operating system settings for + * @property {object} [osProfile] Specifies the operating system settings for * the virtual machine. - * @member {string} [osProfile.computerName] Specifies the host OS name of - * the virtual machine.

    **Max-length (Windows):** 15 characters - *

    **Max-length (Linux):** 64 characters.

    For naming - * conventions and restrictions see [Azure infrastructure services - * implementation + * @property {string} [osProfile.computerName] Specifies the host OS name of + * the virtual machine.

    This name cannot be updated after the VM is + * created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). - * @member {string} [osProfile.adminUsername] Specifies the name of the + * @property {string} [osProfile.adminUsername] Specifies the name of the * administrator account.

    **Windows-only restriction:** Cannot end * in "."

    **Disallowed values:** "administrator", "admin", "user", * "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", @@ -230,7 +230,7 @@ class VirtualMachine extends models['Resource'] { * For a list of built-in system users on Linux that should not be used in * this field, see [Selecting User Names for Linux on * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [osProfile.adminPassword] Specifies the password of the + * @property {string} [osProfile.adminPassword] Specifies the password of the * administrator account.

    **Minimum-length (Windows):** 8 characters *

    **Minimum-length (Linux):** 6 characters

    **Max-length * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters @@ -245,159 +245,162 @@ class VirtualMachine extends models['Resource'] { *

    For resetting root password, see [Manage users, SSH, and check or * repair disks on Azure Linux VMs using the VMAccess * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [osProfile.customData] Specifies a base-64 encoded string - * of custom data. The base-64 encoded string is decoded to a binary array - * that is saved as a file on the Virtual Machine. The maximum length of the - * binary array is 65535 bytes.

    For using cloud-init for your VM, - * see [Using cloud-init to customize a Linux VM during + * @property {string} [osProfile.customData] Specifies a base-64 encoded + * string of custom data. The base-64 encoded string is decoded to a binary + * array that is saved as a file on the Virtual Machine. The maximum length + * of the binary array is 65535 bytes.

    For using cloud-init for your + * VM, see [Using cloud-init to customize a Linux VM during * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [osProfile.windowsConfiguration] Specifies Windows + * @property {object} [osProfile.windowsConfiguration] Specifies Windows * operating system settings on the virtual machine. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] + * @property {boolean} [osProfile.windowsConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the + * @property {boolean} + * [osProfile.windowsConfiguration.enableAutomaticUpdates] Indicates whether + * virtual machine is enabled for automatic updates. + * @property {string} [osProfile.windowsConfiguration.timeZone] Specifies the * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the + * @property {array} + * [osProfile.windowsConfiguration.additionalUnattendContent] Specifies + * additional base-64 encoded XML formatted information that can be included + * in the Unattend.xml file, which is used by Windows Setup. + * @property {object} [osProfile.windowsConfiguration.winRM] Specifies the * Windows Remote Management listeners. This enables remote Windows * PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list - * of Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] Specifies the Linux + * @property {array} [osProfile.windowsConfiguration.winRM.listeners] The + * list of Windows Remote Management listeners + * @property {object} [osProfile.linuxConfiguration] Specifies the Linux * operating system settings on the virtual machine.

    For a list of * supported Linux distributions, see [Linux on Azure-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) *

    For running non-endorsed distributions, see [Information for * Non-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} + * @property {boolean} * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] + * @property {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh + * key configuration for a Linux OS. + * @property {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list + * of SSH public keys used to authenticate with linux based VMs. + * @property {boolean} [osProfile.linuxConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {array} [osProfile.secrets] Specifies set of certificates that + * @property {array} [osProfile.secrets] Specifies set of certificates that * should be installed onto the virtual machine. - * @member {boolean} [osProfile.allowExtensionOperations] Specifies whether + * @property {boolean} [osProfile.allowExtensionOperations] Specifies whether * extension operations should be allowed on the virtual machine. *

    This may only be set to False when no extensions are present on * the virtual machine. - * @member {object} [networkProfile] Specifies the network interfaces of the - * virtual machine. - * @member {array} [networkProfile.networkInterfaces] Specifies the list of + * @property {object} [networkProfile] Specifies the network interfaces of + * the virtual machine. + * @property {array} [networkProfile.networkInterfaces] Specifies the list of * resource Ids for the network interfaces associated with the virtual * machine. - * @member {object} [diagnosticsProfile] Specifies the boot diagnostic + * @property {object} [diagnosticsProfile] Specifies the boot diagnostic * settings state.

    Minimum api-version: 2015-06-15. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is - * a debugging feature which allows you to view Console Output and Screenshot - * to diagnose VM status.

    You can easily view the output of your - * console log.

    Azure also enables you to see a screenshot of the VM - * from the hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether + * @property {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics + * is a debugging feature which allows you to view Console Output and + * Screenshot to diagnose VM status.

    You can easily view the output + * of your console log.

    Azure also enables you to see a screenshot + * of the VM from the hypervisor. + * @property {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether * boot diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of + * @property {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of * the storage account to use for placing the console output and screenshot. - * @member {object} [availabilitySet] Specifies information about the + * @property {object} [availabilitySet] Specifies information about the * availability set that the virtual machine should be assigned to. Virtual * machines specified in the same availability set are allocated to different * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation * time. An existing VM cannot be added to an availability set. - * @member {string} [availabilitySet.id] Resource Id - * @member {string} [provisioningState] The provisioning state, which only + * @property {string} [availabilitySet.id] Resource Id + * @property {string} [provisioningState] The provisioning state, which only * appears in the response. - * @member {object} [instanceView] The virtual machine instance view. - * @member {number} [instanceView.platformUpdateDomain] Specifies the update + * @property {object} [instanceView] The virtual machine instance view. + * @property {number} [instanceView.platformUpdateDomain] Specifies the + * update domain of the virtual machine. + * @property {number} [instanceView.platformFaultDomain] Specifies the fault * domain of the virtual machine. - * @member {number} [instanceView.platformFaultDomain] Specifies the fault - * domain of the virtual machine. - * @member {string} [instanceView.computerName] The computer name assigned to + * @property {string} [instanceView.computerName] The computer name assigned + * to the virtual machine. + * @property {string} [instanceView.osName] The Operating System running on * the virtual machine. - * @member {string} [instanceView.osName] The Operating System running on the - * virtual machine. - * @member {string} [instanceView.osVersion] The version of Operating System - * running on the virtual machine. - * @member {string} [instanceView.rdpThumbPrint] The Remote desktop + * @property {string} [instanceView.osVersion] The version of Operating + * System running on the virtual machine. + * @property {string} [instanceView.rdpThumbPrint] The Remote desktop * certificate thumbprint. - * @member {object} [instanceView.vmAgent] The VM Agent running on the + * @property {object} [instanceView.vmAgent] The VM Agent running on the * virtual machine. - * @member {string} [instanceView.vmAgent.vmAgentVersion] The VM Agent full + * @property {string} [instanceView.vmAgent.vmAgentVersion] The VM Agent full * version. - * @member {array} [instanceView.vmAgent.extensionHandlers] The virtual + * @property {array} [instanceView.vmAgent.extensionHandlers] The virtual * machine extension handler instance view. - * @member {array} [instanceView.vmAgent.statuses] The resource status + * @property {array} [instanceView.vmAgent.statuses] The resource status * information. - * @member {object} [instanceView.maintenanceRedeployStatus] The Maintenance - * Operation status on the virtual machine. - * @member {boolean} + * @property {object} [instanceView.maintenanceRedeployStatus] The + * Maintenance Operation status on the virtual machine. + * @property {boolean} * [instanceView.maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] * True, if customer is allowed to perform Maintenance. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowStartTime] * Start Time for the Pre Maintenance Window. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowEndTime] End * Time for the Pre Maintenance Window. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.maintenanceWindowStartTime] Start * Time for the Maintenance Window. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.maintenanceWindowEndTime] End Time * for the Maintenance Window. - * @member {string} + * @property {string} * [instanceView.maintenanceRedeployStatus.lastOperationResultCode] The Last * Maintenance Operation Result Code. Possible values include: 'None', * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} + * @property {string} * [instanceView.maintenanceRedeployStatus.lastOperationMessage] Message * returned for the last Maintenance Operation. - * @member {array} [instanceView.disks] The virtual machine disk information. - * @member {array} [instanceView.extensions] The extensions information. - * @member {object} [instanceView.bootDiagnostics] Boot Diagnostics is a + * @property {array} [instanceView.disks] The virtual machine disk + * information. + * @property {array} [instanceView.extensions] The extensions information. + * @property {object} [instanceView.bootDiagnostics] Boot Diagnostics is a * debugging feature which allows you to view Console Output and Screenshot * to diagnose VM status.

    You can easily view the output of your * console log.

    Azure also enables you to see a screenshot of the VM * from the hypervisor. - * @member {string} [instanceView.bootDiagnostics.consoleScreenshotBlobUri] + * @property {string} [instanceView.bootDiagnostics.consoleScreenshotBlobUri] * The console screenshot blob URI. - * @member {string} [instanceView.bootDiagnostics.serialConsoleLogBlobUri] + * @property {string} [instanceView.bootDiagnostics.serialConsoleLogBlobUri] * The Linux serial console log blob Uri. - * @member {object} [instanceView.bootDiagnostics.status] The boot + * @property {object} [instanceView.bootDiagnostics.status] The boot * diagnostics status information for the VM.

    NOTE: It will be set * only if there are errors encountered in enabling boot diagnostics. - * @member {string} [instanceView.bootDiagnostics.status.code] The status + * @property {string} [instanceView.bootDiagnostics.status.code] The status * code. - * @member {string} [instanceView.bootDiagnostics.status.level] The level + * @property {string} [instanceView.bootDiagnostics.status.level] The level * code. Possible values include: 'Info', 'Warning', 'Error' - * @member {string} [instanceView.bootDiagnostics.status.displayStatus] The + * @property {string} [instanceView.bootDiagnostics.status.displayStatus] The * short localizable label for the status. - * @member {string} [instanceView.bootDiagnostics.status.message] The + * @property {string} [instanceView.bootDiagnostics.status.message] The * detailed status message, including for alerts and error messages. - * @member {date} [instanceView.bootDiagnostics.status.time] The time of the - * status. - * @member {array} [instanceView.statuses] The resource status information. - * @member {string} [licenseType] Specifies that the image or disk that is + * @property {date} [instanceView.bootDiagnostics.status.time] The time of + * the status. + * @property {array} [instanceView.statuses] The resource status information. + * @property {string} [licenseType] Specifies that the image or disk that is * being used was licensed on-premises. This element is only used for images * that contain the Windows Server operating system.

    Possible values * are:

    Windows_Client

    Windows_Server

    If this @@ -406,29 +409,30 @@ class VirtualMachine extends models['Resource'] { * information, see [Azure Hybrid Use Benefit for Windows * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Minimum api-version: 2015-06-15 - * @member {string} [vmId] Specifies the VM unique ID which is a 128-bits + * @property {string} [vmId] Specifies the VM unique ID which is a 128-bits * identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can * be read using platform BIOS commands. - * @member {array} [resources] The virtual machine child extension resources. - * @member {object} [identity] The identity of the virtual machine, if + * @property {array} [resources] The virtual machine child extension + * resources. + * @property {object} [identity] The identity of the virtual machine, if * configured. - * @member {string} [identity.principalId] The principal id of virtual + * @property {string} [identity.principalId] The principal id of virtual * machine identity. This property will only be provided for a system * assigned identity. - * @member {string} [identity.tenantId] The tenant id associated with the + * @property {string} [identity.tenantId] The tenant id associated with the * virtual machine. This property will only be provided for a system assigned * identity. - * @member {string} [identity.type] The type of identity used for the virtual - * machine. The type 'SystemAssigned, UserAssigned' includes both an + * @property {string} [identity.type] The type of identity used for the + * virtual machine. The type 'SystemAssigned, UserAssigned' includes both an * implicitly created identity and a set of user assigned identities. The * type 'None' will remove any identities from the virtual machine. Possible * values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, * UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user + * @property {object} [identity.userAssignedIdentities] The list of user * identities associated with the Virtual Machine. The user identity * dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - * @member {array} [zones] The virtual machine zones. + * @property {array} [zones] The virtual machine zones. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/virtualMachineAgentInstanceView.js b/lib/services/computeManagement2/lib/models/virtualMachineAgentInstanceView.js index 25fe929ef7..738a072ba0 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineAgentInstanceView.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineAgentInstanceView.js @@ -17,10 +17,10 @@ class VirtualMachineAgentInstanceView { /** * Create a VirtualMachineAgentInstanceView. - * @member {string} [vmAgentVersion] The VM Agent full version. - * @member {array} [extensionHandlers] The virtual machine extension handler - * instance view. - * @member {array} [statuses] The resource status information. + * @property {string} [vmAgentVersion] The VM Agent full version. + * @property {array} [extensionHandlers] The virtual machine extension + * handler instance view. + * @property {array} [statuses] The resource status information. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineCaptureParameters.js b/lib/services/computeManagement2/lib/models/virtualMachineCaptureParameters.js index 37455a63a1..eebbb3e6da 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineCaptureParameters.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineCaptureParameters.js @@ -17,9 +17,10 @@ class VirtualMachineCaptureParameters { /** * Create a VirtualMachineCaptureParameters. - * @member {string} vhdPrefix The captured virtual hard disk's name prefix. - * @member {string} destinationContainerName The destination container name. - * @member {boolean} overwriteVhds Specifies whether to overwrite the + * @property {string} vhdPrefix The captured virtual hard disk's name prefix. + * @property {string} destinationContainerName The destination container + * name. + * @property {boolean} overwriteVhds Specifies whether to overwrite the * destination virtual hard disk, in case of conflict. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineCaptureResult.js b/lib/services/computeManagement2/lib/models/virtualMachineCaptureResult.js index 67facb1d8a..47cd85fe04 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineCaptureResult.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineCaptureResult.js @@ -20,10 +20,10 @@ const models = require('./index'); class VirtualMachineCaptureResult extends models['SubResource'] { /** * Create a VirtualMachineCaptureResult. - * @member {string} [schema] the schema of the captured virtual machine - * @member {string} [contentVersion] the version of the content - * @member {object} [parameters] parameters of the captured virtual machine - * @member {array} [resources] a list of resource items of the captured + * @property {string} [schema] the schema of the captured virtual machine + * @property {string} [contentVersion] the version of the content + * @property {object} [parameters] parameters of the captured virtual machine + * @property {array} [resources] a list of resource items of the captured * virtual machine */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineExtension.js b/lib/services/computeManagement2/lib/models/virtualMachineExtension.js index 86e56017ac..e2d9186c87 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineExtension.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineExtension.js @@ -20,34 +20,35 @@ const models = require('./index'); class VirtualMachineExtension extends models['Resource'] { /** * Create a VirtualMachineExtension. - * @member {string} [forceUpdateTag] How the extension handler should be + * @property {string} [forceUpdateTag] How the extension handler should be * forced to update even if the extension configuration has not changed. - * @member {string} [publisher] The name of the extension handler publisher. - * @member {string} [virtualMachineExtensionType] Specifies the type of the + * @property {string} [publisher] The name of the extension handler + * publisher. + * @property {string} [virtualMachineExtensionType] Specifies the type of the * extension; an example is "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {boolean} [autoUpgradeMinorVersion] Indicates whether the + * @property {string} [typeHandlerVersion] Specifies the version of the + * script handler. + * @property {boolean} [autoUpgradeMinorVersion] Indicates whether the * extension should use a newer minor version if one is available at * deployment time. Once deployed, however, the extension will not upgrade * minor versions unless redeployed, even with this property set to true. - * @member {object} [settings] Json formatted public settings for the + * @property {object} [settings] Json formatted public settings for the * extension. - * @member {object} [protectedSettings] The extension can contain either + * @property {object} [protectedSettings] The extension can contain either * protectedSettings or protectedSettingsFromKeyVault or no protected * settings at all. - * @member {string} [provisioningState] The provisioning state, which only + * @property {string} [provisioningState] The provisioning state, which only * appears in the response. - * @member {object} [instanceView] The virtual machine extension instance + * @property {object} [instanceView] The virtual machine extension instance * view. - * @member {string} [instanceView.name] The virtual machine extension name. - * @member {string} [instanceView.type] Specifies the type of the extension; - * an example is "CustomScriptExtension". - * @member {string} [instanceView.typeHandlerVersion] Specifies the version + * @property {string} [instanceView.name] The virtual machine extension name. + * @property {string} [instanceView.type] Specifies the type of the + * extension; an example is "CustomScriptExtension". + * @property {string} [instanceView.typeHandlerVersion] Specifies the version * of the script handler. - * @member {array} [instanceView.substatuses] The resource status + * @property {array} [instanceView.substatuses] The resource status * information. - * @member {array} [instanceView.statuses] The resource status information. + * @property {array} [instanceView.statuses] The resource status information. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/virtualMachineExtensionHandlerInstanceView.js b/lib/services/computeManagement2/lib/models/virtualMachineExtensionHandlerInstanceView.js index 4900bc611b..e93a9926dd 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineExtensionHandlerInstanceView.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineExtensionHandlerInstanceView.js @@ -17,19 +17,19 @@ class VirtualMachineExtensionHandlerInstanceView { /** * Create a VirtualMachineExtensionHandlerInstanceView. - * @member {string} [type] Specifies the type of the extension; an example is - * "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {object} [status] The extension handler status. - * @member {string} [status.code] The status code. - * @member {string} [status.level] The level code. Possible values include: + * @property {string} [type] Specifies the type of the extension; an example + * is "CustomScriptExtension". + * @property {string} [typeHandlerVersion] Specifies the version of the + * script handler. + * @property {object} [status] The extension handler status. + * @property {string} [status.code] The status code. + * @property {string} [status.level] The level code. Possible values include: * 'Info', 'Warning', 'Error' - * @member {string} [status.displayStatus] The short localizable label for + * @property {string} [status.displayStatus] The short localizable label for * the status. - * @member {string} [status.message] The detailed status message, including + * @property {string} [status.message] The detailed status message, including * for alerts and error messages. - * @member {date} [status.time] The time of the status. + * @property {date} [status.time] The time of the status. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineExtensionImage.js b/lib/services/computeManagement2/lib/models/virtualMachineExtensionImage.js index b25bb88e7d..bfe5b4af81 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineExtensionImage.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineExtensionImage.js @@ -20,17 +20,17 @@ const models = require('./index'); class VirtualMachineExtensionImage extends models['Resource'] { /** * Create a VirtualMachineExtensionImage. - * @member {string} operatingSystem The operating system this extension + * @property {string} operatingSystem The operating system this extension * supports. - * @member {string} computeRole The type of role (IaaS or PaaS) this + * @property {string} computeRole The type of role (IaaS or PaaS) this * extension supports. - * @member {string} handlerSchema The schema defined by publisher, where + * @property {string} handlerSchema The schema defined by publisher, where * extension consumers should provide settings in a matching schema. - * @member {boolean} [vmScaleSetEnabled] Whether the extension can be used on - * xRP VMScaleSets. By default existing extensions are usable on scalesets, - * but there might be cases where a publisher wants to explicitly indicate - * the extension is only enabled for CRP VMs but not VMSS. - * @member {boolean} [supportsMultipleExtensions] Whether the handler can + * @property {boolean} [vmScaleSetEnabled] Whether the extension can be used + * on xRP VMScaleSets. By default existing extensions are usable on + * scalesets, but there might be cases where a publisher wants to explicitly + * indicate the extension is only enabled for CRP VMs but not VMSS. + * @property {boolean} [supportsMultipleExtensions] Whether the handler can * support multiple extensions. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineExtensionInstanceView.js b/lib/services/computeManagement2/lib/models/virtualMachineExtensionInstanceView.js index 5e49fb98fa..a15a754cb1 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineExtensionInstanceView.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineExtensionInstanceView.js @@ -17,13 +17,13 @@ class VirtualMachineExtensionInstanceView { /** * Create a VirtualMachineExtensionInstanceView. - * @member {string} [name] The virtual machine extension name. - * @member {string} [type] Specifies the type of the extension; an example is - * "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {array} [substatuses] The resource status information. - * @member {array} [statuses] The resource status information. + * @property {string} [name] The virtual machine extension name. + * @property {string} [type] Specifies the type of the extension; an example + * is "CustomScriptExtension". + * @property {string} [typeHandlerVersion] Specifies the version of the + * script handler. + * @property {array} [substatuses] The resource status information. + * @property {array} [statuses] The resource status information. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineExtensionUpdate.js b/lib/services/computeManagement2/lib/models/virtualMachineExtensionUpdate.js index 4e7ec262f9..7013883ec4 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineExtensionUpdate.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineExtensionUpdate.js @@ -20,20 +20,21 @@ const models = require('./index'); class VirtualMachineExtensionUpdate extends models['UpdateResource'] { /** * Create a VirtualMachineExtensionUpdate. - * @member {string} [forceUpdateTag] How the extension handler should be + * @property {string} [forceUpdateTag] How the extension handler should be * forced to update even if the extension configuration has not changed. - * @member {string} [publisher] The name of the extension handler publisher. - * @member {string} [type] Specifies the type of the extension; an example is - * "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {boolean} [autoUpgradeMinorVersion] Indicates whether the + * @property {string} [publisher] The name of the extension handler + * publisher. + * @property {string} [type] Specifies the type of the extension; an example + * is "CustomScriptExtension". + * @property {string} [typeHandlerVersion] Specifies the version of the + * script handler. + * @property {boolean} [autoUpgradeMinorVersion] Indicates whether the * extension should use a newer minor version if one is available at * deployment time. Once deployed, however, the extension will not upgrade * minor versions unless redeployed, even with this property set to true. - * @member {object} [settings] Json formatted public settings for the + * @property {object} [settings] Json formatted public settings for the * extension. - * @member {object} [protectedSettings] The extension can contain either + * @property {object} [protectedSettings] The extension can contain either * protectedSettings or protectedSettingsFromKeyVault or no protected * settings at all. */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineExtensionsListResult.js b/lib/services/computeManagement2/lib/models/virtualMachineExtensionsListResult.js index f405c3d0f6..f0c6cbab8c 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineExtensionsListResult.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineExtensionsListResult.js @@ -17,7 +17,7 @@ class VirtualMachineExtensionsListResult { /** * Create a VirtualMachineExtensionsListResult. - * @member {array} [value] The list of extensions + * @property {array} [value] The list of extensions */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineHealthStatus.js b/lib/services/computeManagement2/lib/models/virtualMachineHealthStatus.js index 8a4fe2090e..f585390962 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineHealthStatus.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineHealthStatus.js @@ -17,15 +17,15 @@ class VirtualMachineHealthStatus { /** * Create a VirtualMachineHealthStatus. - * @member {object} [status] The health status information for the VM. - * @member {string} [status.code] The status code. - * @member {string} [status.level] The level code. Possible values include: + * @property {object} [status] The health status information for the VM. + * @property {string} [status.code] The status code. + * @property {string} [status.level] The level code. Possible values include: * 'Info', 'Warning', 'Error' - * @member {string} [status.displayStatus] The short localizable label for + * @property {string} [status.displayStatus] The short localizable label for * the status. - * @member {string} [status.message] The detailed status message, including + * @property {string} [status.message] The detailed status message, including * for alerts and error messages. - * @member {date} [status.time] The time of the status. + * @property {date} [status.time] The time of the status. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineIdentity.js b/lib/services/computeManagement2/lib/models/virtualMachineIdentity.js index bc329d687a..c9d86b198f 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineIdentity.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineIdentity.js @@ -17,19 +17,19 @@ class VirtualMachineIdentity { /** * Create a VirtualMachineIdentity. - * @member {string} [principalId] The principal id of virtual machine + * @property {string} [principalId] The principal id of virtual machine * identity. This property will only be provided for a system assigned * identity. - * @member {string} [tenantId] The tenant id associated with the virtual + * @property {string} [tenantId] The tenant id associated with the virtual * machine. This property will only be provided for a system assigned * identity. - * @member {string} [type] The type of identity used for the virtual machine. - * The type 'SystemAssigned, UserAssigned' includes both an implicitly - * created identity and a set of user assigned identities. The type 'None' - * will remove any identities from the virtual machine. Possible values - * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', - * 'None' - * @member {object} [userAssignedIdentities] The list of user identities + * @property {string} [type] The type of identity used for the virtual + * machine. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The + * type 'None' will remove any identities from the virtual machine. Possible + * values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, + * UserAssigned', 'None' + * @property {object} [userAssignedIdentities] The list of user identities * associated with the Virtual Machine. The user identity dictionary key * references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. diff --git a/lib/services/computeManagement2/lib/models/virtualMachineIdentityUserAssignedIdentitiesValue.js b/lib/services/computeManagement2/lib/models/virtualMachineIdentityUserAssignedIdentitiesValue.js index 09033f5b29..1ba0f1bcd8 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineIdentityUserAssignedIdentitiesValue.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineIdentityUserAssignedIdentitiesValue.js @@ -16,8 +16,9 @@ class VirtualMachineIdentityUserAssignedIdentitiesValue { /** * Create a VirtualMachineIdentityUserAssignedIdentitiesValue. - * @member {string} [principalId] The principal id of user assigned identity. - * @member {string} [clientId] The client id of user assigned identity. + * @property {string} [principalId] The principal id of user assigned + * identity. + * @property {string} [clientId] The client id of user assigned identity. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineImage.js b/lib/services/computeManagement2/lib/models/virtualMachineImage.js index 0e7d76e352..95d6e355be 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineImage.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineImage.js @@ -20,18 +20,18 @@ const models = require('./index'); class VirtualMachineImage extends models['VirtualMachineImageResource'] { /** * Create a VirtualMachineImage. - * @member {object} [plan] - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.product] Specifies the product of the image from + * @property {object} [plan] + * @property {string} [plan.publisher] The publisher ID. + * @property {string} [plan.name] The plan ID. + * @property {string} [plan.product] Specifies the product of the image from * the marketplace. This is the same value as Offer under the imageReference * element. - * @member {object} [osDiskImage] - * @member {string} [osDiskImage.operatingSystem] The operating system of the - * osDiskImage. Possible values include: 'Windows', 'Linux' - * @member {array} [dataDiskImages] - * @member {object} [automaticOSUpgradeProperties] - * @member {boolean} + * @property {object} [osDiskImage] + * @property {string} [osDiskImage.operatingSystem] The operating system of + * the osDiskImage. Possible values include: 'Windows', 'Linux' + * @property {array} [dataDiskImages] + * @property {object} [automaticOSUpgradeProperties] + * @property {boolean} * [automaticOSUpgradeProperties.automaticOSUpgradeSupported] Specifies * whether automatic OS upgrade is supported on the image. */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineImageResource.js b/lib/services/computeManagement2/lib/models/virtualMachineImageResource.js index 93e856089d..1aa4e6b7d4 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineImageResource.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineImageResource.js @@ -20,9 +20,9 @@ const models = require('./index'); class VirtualMachineImageResource extends models['SubResource'] { /** * Create a VirtualMachineImageResource. - * @member {string} name The name of the resource. - * @member {string} location The supported Azure location of the resource. - * @member {object} [tags] Specifies the tags that are assigned to the + * @property {string} name The name of the resource. + * @property {string} location The supported Azure location of the resource. + * @property {object} [tags] Specifies the tags that are assigned to the * virtual machine. For more information about using tags, see [Using tags to * organize your Azure * resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). diff --git a/lib/services/computeManagement2/lib/models/virtualMachineInstanceView.js b/lib/services/computeManagement2/lib/models/virtualMachineInstanceView.js index 05b74a3195..5abdcecd8c 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineInstanceView.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineInstanceView.js @@ -17,64 +17,64 @@ class VirtualMachineInstanceView { /** * Create a VirtualMachineInstanceView. - * @member {number} [platformUpdateDomain] Specifies the update domain of the + * @property {number} [platformUpdateDomain] Specifies the update domain of + * the virtual machine. + * @property {number} [platformFaultDomain] Specifies the fault domain of the * virtual machine. - * @member {number} [platformFaultDomain] Specifies the fault domain of the + * @property {string} [computerName] The computer name assigned to the * virtual machine. - * @member {string} [computerName] The computer name assigned to the virtual - * machine. - * @member {string} [osName] The Operating System running on the virtual + * @property {string} [osName] The Operating System running on the virtual * machine. - * @member {string} [osVersion] The version of Operating System running on + * @property {string} [osVersion] The version of Operating System running on * the virtual machine. - * @member {string} [rdpThumbPrint] The Remote desktop certificate + * @property {string} [rdpThumbPrint] The Remote desktop certificate * thumbprint. - * @member {object} [vmAgent] The VM Agent running on the virtual machine. - * @member {string} [vmAgent.vmAgentVersion] The VM Agent full version. - * @member {array} [vmAgent.extensionHandlers] The virtual machine extension - * handler instance view. - * @member {array} [vmAgent.statuses] The resource status information. - * @member {object} [maintenanceRedeployStatus] The Maintenance Operation + * @property {object} [vmAgent] The VM Agent running on the virtual machine. + * @property {string} [vmAgent.vmAgentVersion] The VM Agent full version. + * @property {array} [vmAgent.extensionHandlers] The virtual machine + * extension handler instance view. + * @property {array} [vmAgent.statuses] The resource status information. + * @property {object} [maintenanceRedeployStatus] The Maintenance Operation * status on the virtual machine. - * @member {boolean} + * @property {boolean} * [maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] True, if * customer is allowed to perform Maintenance. - * @member {date} [maintenanceRedeployStatus.preMaintenanceWindowStartTime] + * @property {date} [maintenanceRedeployStatus.preMaintenanceWindowStartTime] * Start Time for the Pre Maintenance Window. - * @member {date} [maintenanceRedeployStatus.preMaintenanceWindowEndTime] End - * Time for the Pre Maintenance Window. - * @member {date} [maintenanceRedeployStatus.maintenanceWindowStartTime] + * @property {date} [maintenanceRedeployStatus.preMaintenanceWindowEndTime] + * End Time for the Pre Maintenance Window. + * @property {date} [maintenanceRedeployStatus.maintenanceWindowStartTime] * Start Time for the Maintenance Window. - * @member {date} [maintenanceRedeployStatus.maintenanceWindowEndTime] End + * @property {date} [maintenanceRedeployStatus.maintenanceWindowEndTime] End * Time for the Maintenance Window. - * @member {string} [maintenanceRedeployStatus.lastOperationResultCode] The + * @property {string} [maintenanceRedeployStatus.lastOperationResultCode] The * Last Maintenance Operation Result Code. Possible values include: 'None', * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} [maintenanceRedeployStatus.lastOperationMessage] Message - * returned for the last Maintenance Operation. - * @member {array} [disks] The virtual machine disk information. - * @member {array} [extensions] The extensions information. - * @member {object} [bootDiagnostics] Boot Diagnostics is a debugging feature - * which allows you to view Console Output and Screenshot to diagnose VM - * status.

    You can easily view the output of your console log. + * @property {string} [maintenanceRedeployStatus.lastOperationMessage] + * Message returned for the last Maintenance Operation. + * @property {array} [disks] The virtual machine disk information. + * @property {array} [extensions] The extensions information. + * @property {object} [bootDiagnostics] Boot Diagnostics is a debugging + * feature which allows you to view Console Output and Screenshot to diagnose + * VM status.

    You can easily view the output of your console log. *

    Azure also enables you to see a screenshot of the VM from the * hypervisor. - * @member {string} [bootDiagnostics.consoleScreenshotBlobUri] The console + * @property {string} [bootDiagnostics.consoleScreenshotBlobUri] The console * screenshot blob URI. - * @member {string} [bootDiagnostics.serialConsoleLogBlobUri] The Linux + * @property {string} [bootDiagnostics.serialConsoleLogBlobUri] The Linux * serial console log blob Uri. - * @member {object} [bootDiagnostics.status] The boot diagnostics status + * @property {object} [bootDiagnostics.status] The boot diagnostics status * information for the VM.

    NOTE: It will be set only if there are * errors encountered in enabling boot diagnostics. - * @member {string} [bootDiagnostics.status.code] The status code. - * @member {string} [bootDiagnostics.status.level] The level code. Possible + * @property {string} [bootDiagnostics.status.code] The status code. + * @property {string} [bootDiagnostics.status.level] The level code. Possible * values include: 'Info', 'Warning', 'Error' - * @member {string} [bootDiagnostics.status.displayStatus] The short + * @property {string} [bootDiagnostics.status.displayStatus] The short * localizable label for the status. - * @member {string} [bootDiagnostics.status.message] The detailed status + * @property {string} [bootDiagnostics.status.message] The detailed status * message, including for alerts and error messages. - * @member {date} [bootDiagnostics.status.time] The time of the status. - * @member {array} [statuses] The resource status information. + * @property {date} [bootDiagnostics.status.time] The time of the status. + * @property {array} [statuses] The resource status information. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineListResult.js b/lib/services/computeManagement2/lib/models/virtualMachineListResult.js index f3cd4ea797..fe2a25a36b 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineListResult.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineListResult.js @@ -16,7 +16,7 @@ class VirtualMachineListResult extends Array { /** * Create a VirtualMachineListResult. - * @member {string} [nextLink] The URI to fetch the next page of VMs. Call + * @property {string} [nextLink] The URI to fetch the next page of VMs. Call * ListNext() with this URI to fetch the next page of Virtual Machines. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineReimageParameters.js b/lib/services/computeManagement2/lib/models/virtualMachineReimageParameters.js index 40ef0604ba..f016054db9 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineReimageParameters.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineReimageParameters.js @@ -11,13 +11,14 @@ 'use strict'; /** - * Paramaters for Reimaging Virtual Machine. Default value for OSDisk : true. + * Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will + * always be reimaged * */ class VirtualMachineReimageParameters { /** * Create a VirtualMachineReimageParameters. - * @member {boolean} [tempDisk] Specified whether to reimage temp disk. + * @property {boolean} [tempDisk] Specifies whether to reimage temp disk. * Default value: false. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSet.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSet.js index fd29c2b1da..6119a9a90d 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSet.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSet.js @@ -20,44 +20,44 @@ const models = require('./index'); class VirtualMachineScaleSet extends models['Resource'] { /** * Create a VirtualMachineScaleSet. - * @member {object} [sku] The virtual machine scale set sku. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a + * @property {object} [sku] The virtual machine scale set sku. + * @property {string} [sku.name] The sku name. + * @property {string} [sku.tier] Specifies the tier of virtual machines in a * scale set.

    Possible Values:

    **Standard**

    **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines + * @property {number} [sku.capacity] Specifies the number of virtual machines * in the scale set. - * @member {object} [plan] Specifies information about the marketplace image - * used to create the virtual machine. This element is only used for + * @property {object} [plan] Specifies information about the marketplace + * image used to create the virtual machine. This element is only used for * marketplace images. Before you can use a marketplace image from an API, * you must enable the image for programmatic use. In the Azure portal, find * the marketplace image that you want to use and then click **Want to deploy * programmatically, Get Started ->**. Enter any required information and * then click **Save**. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from + * @property {string} [plan.name] The plan ID. + * @property {string} [plan.publisher] The publisher ID. + * @property {string} [plan.product] Specifies the product of the image from * the marketplace. This is the same value as Offer under the imageReference * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {object} [upgradePolicy] The upgrade policy. - * @member {string} [upgradePolicy.mode] Specifies the mode of an upgrade to - * virtual machines in the scale set.

    Possible values are:

    Possible values are:

    **Manual** - You control the application of updates to virtual * machines in the scale set. You do this by using the manualUpgrade * action.

    **Automatic** - All virtual machines in the scale set * are automatically updated at the same time. Possible values include: * 'Automatic', 'Manual', 'Rolling' - * @member {object} [upgradePolicy.rollingUpgradePolicy] The configuration + * @property {object} [upgradePolicy.rollingUpgradePolicy] The configuration * parameters used while performing a rolling upgrade. - * @member {number} + * @property {number} * [upgradePolicy.rollingUpgradePolicy.maxBatchInstancePercent] The maximum * percent of total virtual machine instances that will be upgraded * simultaneously by the rolling upgrade in one batch. As this is a maximum, * unhealthy instances in previous or future batches can cause the percentage * of instances in a batch to decrease to ensure higher reliability. The * default value for this parameter is 20%. - * @member {number} + * @property {number} * [upgradePolicy.rollingUpgradePolicy.maxUnhealthyInstancePercent] The * maximum percentage of the total virtual machine instances in the scale set * that can be simultaneously unhealthy, either as a result of being @@ -65,35 +65,35 @@ class VirtualMachineScaleSet extends models['Resource'] { * health checks before the rolling upgrade aborts. This constraint will be * checked prior to starting any batch. The default value for this parameter * is 20%. - * @member {number} + * @property {number} * [upgradePolicy.rollingUpgradePolicy.maxUnhealthyUpgradedInstancePercent] * The maximum percentage of upgraded virtual machine instances that can be * found to be in an unhealthy state. This check will happen after each batch * is upgraded. If this percentage is ever exceeded, the rolling update * aborts. The default value for this parameter is 20%. - * @member {string} + * @property {string} * [upgradePolicy.rollingUpgradePolicy.pauseTimeBetweenBatches] The wait time * between completing the update for all virtual machines in one batch and * starting the next batch. The time duration should be specified in ISO 8601 * format. The default value is 0 seconds (PT0S). - * @member {object} [upgradePolicy.automaticOSUpgradePolicy] Configuration + * @property {object} [upgradePolicy.automaticOSUpgradePolicy] Configuration * parameters used for performing automatic OS Upgrade. - * @member {boolean} + * @property {boolean} * [upgradePolicy.automaticOSUpgradePolicy.enableAutomaticOSUpgrade] Whether * OS upgrades should automatically be applied to scale set instances in a * rolling fashion when a newer version of the image becomes available. * Default value is false. - * @member {boolean} + * @property {boolean} * [upgradePolicy.automaticOSUpgradePolicy.disableAutomaticRollback] Whether * OS image rollback feature should be disabled. Default value is false. - * @member {object} [virtualMachineProfile] The virtual machine profile. - * @member {object} [virtualMachineProfile.osProfile] Specifies the operating - * system settings for the virtual machines in the scale set. - * @member {string} [virtualMachineProfile.osProfile.computerNamePrefix] + * @property {object} [virtualMachineProfile] The virtual machine profile. + * @property {object} [virtualMachineProfile.osProfile] Specifies the + * operating system settings for the virtual machines in the scale set. + * @property {string} [virtualMachineProfile.osProfile.computerNamePrefix] * Specifies the computer name prefix for all of the virtual machines in the * scale set. Computer name prefixes must be 1 to 15 characters long. - * @member {string} [virtualMachineProfile.osProfile.adminUsername] Specifies - * the name of the administrator account.

    **Windows-only + * @property {string} [virtualMachineProfile.osProfile.adminUsername] + * Specifies the name of the administrator account.

    **Windows-only * restriction:** Cannot end in "."

    **Disallowed values:** * "administrator", "admin", "user", "user1", "test", "user2", "test1", * "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", @@ -107,11 +107,11 @@ class VirtualMachineScaleSet extends models['Resource'] { * For a list of built-in system users on Linux that should not be used in * this field, see [Selecting User Names for Linux on * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [virtualMachineProfile.osProfile.adminPassword] Specifies - * the password of the administrator account.

    **Minimum-length - * (Windows):** 8 characters

    **Minimum-length (Linux):** 6 - * characters

    **Max-length (Windows):** 123 characters

    - * **Max-length (Linux):** 72 characters

    **Complexity + * @property {string} [virtualMachineProfile.osProfile.adminPassword] + * Specifies the password of the administrator account.

    + * **Minimum-length (Windows):** 8 characters

    **Minimum-length + * (Linux):** 6 characters

    **Max-length (Windows):** 123 characters + *

    **Max-length (Linux):** 72 characters

    **Complexity * requirements:** 3 out of 4 conditions below need to be fulfilled
    Has * lower characters
    Has upper characters
    Has a digit
    Has a * special character (Regex match [\W_])

    **Disallowed values:** @@ -123,40 +123,40 @@ class VirtualMachineScaleSet extends models['Resource'] { *

    For resetting root password, see [Manage users, SSH, and check or * repair disks on Azure Linux VMs using the VMAccess * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [virtualMachineProfile.osProfile.customData] Specifies a - * base-64 encoded string of custom data. The base-64 encoded string is + * @property {string} [virtualMachineProfile.osProfile.customData] Specifies + * a base-64 encoded string of custom data. The base-64 encoded string is * decoded to a binary array that is saved as a file on the Virtual Machine. * The maximum length of the binary array is 65535 bytes.

    For using * cloud-init for your VM, see [Using cloud-init to customize a Linux VM * during * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [virtualMachineProfile.osProfile.windowsConfiguration] + * @property {object} [virtualMachineProfile.osProfile.windowsConfiguration] * Specifies Windows operating system settings on the virtual machine. - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.osProfile.windowsConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.osProfile.windowsConfiguration.enableAutomaticUpdates] * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} + * @property {string} * [virtualMachineProfile.osProfile.windowsConfiguration.timeZone] Specifies * the time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} + * @property {array} * [virtualMachineProfile.osProfile.windowsConfiguration.additionalUnattendContent] * Specifies additional base-64 encoded XML formatted information that can be * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} + * @property {object} * [virtualMachineProfile.osProfile.windowsConfiguration.winRM] Specifies the * Windows Remote Management listeners. This enables remote Windows * PowerShell. - * @member {array} + * @property {array} * [virtualMachineProfile.osProfile.windowsConfiguration.winRM.listeners] The * list of Windows Remote Management listeners - * @member {object} [virtualMachineProfile.osProfile.linuxConfiguration] + * @property {object} [virtualMachineProfile.osProfile.linuxConfiguration] * Specifies the Linux operating system settings on the virtual machine. *

    For a list of supported Linux distributions, see [Linux on * Azure-Endorsed @@ -164,42 +164,43 @@ class VirtualMachineScaleSet extends models['Resource'] { *

    For running non-endorsed distributions, see [Information for * Non-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.osProfile.linuxConfiguration.disablePasswordAuthentication] * Specifies whether password authentication should be disabled. - * @member {object} [virtualMachineProfile.osProfile.linuxConfiguration.ssh] - * Specifies the ssh key configuration for a Linux OS. - * @member {array} + * @property {object} + * [virtualMachineProfile.osProfile.linuxConfiguration.ssh] Specifies the ssh + * key configuration for a Linux OS. + * @property {array} * [virtualMachineProfile.osProfile.linuxConfiguration.ssh.publicKeys] The * list of SSH public keys used to authenticate with linux based VMs. - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.osProfile.linuxConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {array} [virtualMachineProfile.osProfile.secrets] Specifies set of - * certificates that should be installed onto the virtual machines in the + * @property {array} [virtualMachineProfile.osProfile.secrets] Specifies set + * of certificates that should be installed onto the virtual machines in the * scale set. - * @member {object} [virtualMachineProfile.storageProfile] Specifies the + * @property {object} [virtualMachineProfile.storageProfile] Specifies the * storage settings for the virtual machine disks. - * @member {object} [virtualMachineProfile.storageProfile.imageReference] + * @property {object} [virtualMachineProfile.storageProfile.imageReference] * Specifies information about the image to use. You can specify information * about platform images, marketplace images, or virtual machine images. This * element is required when you want to use a platform image, marketplace * image, or virtual machine image, but is not used in other creation * operations. - * @member {string} + * @property {string} * [virtualMachineProfile.storageProfile.imageReference.publisher] The image * publisher. - * @member {string} + * @property {string} * [virtualMachineProfile.storageProfile.imageReference.offer] Specifies the * offer of the platform image or marketplace image used to create the * virtual machine. - * @member {string} [virtualMachineProfile.storageProfile.imageReference.sku] - * The image SKU. - * @member {string} + * @property {string} + * [virtualMachineProfile.storageProfile.imageReference.sku] The image SKU. + * @property {string} * [virtualMachineProfile.storageProfile.imageReference.version] Specifies * the version of the platform image or marketplace image used to create the * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. @@ -207,23 +208,23 @@ class VirtualMachineScaleSet extends models['Resource'] { * latest version of an image available at deploy time. Even if you use * 'latest', the VM image will not automatically update after deploy time * even if a new version becomes available. - * @member {object} [virtualMachineProfile.storageProfile.osDisk] Specifies + * @property {object} [virtualMachineProfile.storageProfile.osDisk] Specifies * information about the operating system disk used by the virtual machines * in the scale set.

    For more information about disks, see [About * disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [virtualMachineProfile.storageProfile.osDisk.name] The + * @property {string} [virtualMachineProfile.storageProfile.osDisk.name] The * disk name. - * @member {string} [virtualMachineProfile.storageProfile.osDisk.caching] + * @property {string} [virtualMachineProfile.storageProfile.osDisk.caching] * Specifies the caching requirements.

    Possible values are:

    * **None**

    **ReadOnly**

    **ReadWrite**

    Default: * **None for Standard storage. ReadOnly for Premium storage**. Possible * values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.storageProfile.osDisk.writeAcceleratorEnabled] * Specifies whether writeAccelerator should be enabled or disabled on the * disk. - * @member {string} + * @property {string} * [virtualMachineProfile.storageProfile.osDisk.createOption] Specifies how * the virtual machines in the scale set should be created.

    The only * allowed value is: **FromImage** \u2013 This value is used when you are @@ -231,91 +232,94 @@ class VirtualMachineScaleSet extends models['Resource'] { * image, you also use the imageReference element described above. If you are * using a marketplace image, you also use the plan element previously * described. Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {object} + * @property {object} * [virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] Specifies - * the differencing Disk Settings for the operating system disk used by the + * the ephemeral disk Settings for the operating system disk used by the * virtual machine scale set. - * @member {string} + * @property {string} * [virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. - * Possible values include: 'Local' - * @member {number} [virtualMachineProfile.storageProfile.osDisk.diskSizeGB] - * Specifies the size of the operating system disk in gigabytes. This element - * can be used to overwrite the size of the disk in a virtual machine image. - *

    This value cannot be larger than 1023 GB - * @member {string} [virtualMachineProfile.storageProfile.osDisk.osType] This - * property allows you to specify the type of the OS that is included in the - * disk if creating a VM from user-image or a specialized VHD.

    + * Specifies the ephemeral disk settings for operating system disk. Possible + * values include: 'Local' + * @property {number} + * [virtualMachineProfile.storageProfile.osDisk.diskSizeGB] Specifies the + * size of the operating system disk in gigabytes. This element can be used + * to overwrite the size of the disk in a virtual machine image.

    + * This value cannot be larger than 1023 GB + * @property {string} [virtualMachineProfile.storageProfile.osDisk.osType] + * This property allows you to specify the type of the OS that is included in + * the disk if creating a VM from user-image or a specialized VHD.

    * Possible values are:

    **Windows**

    **Linux**. Possible * values include: 'Windows', 'Linux' - * @member {object} [virtualMachineProfile.storageProfile.osDisk.image] + * @property {object} [virtualMachineProfile.storageProfile.osDisk.image] * Specifies information about the unmanaged user image to base the scale set * on. - * @member {string} [virtualMachineProfile.storageProfile.osDisk.image.uri] + * @property {string} [virtualMachineProfile.storageProfile.osDisk.image.uri] * Specifies the virtual hard disk's uri. - * @member {array} + * @property {array} * [virtualMachineProfile.storageProfile.osDisk.vhdContainers] Specifies the * container urls that are used to store operating system disks for the scale * set. - * @member {object} [virtualMachineProfile.storageProfile.osDisk.managedDisk] - * The managed disk parameters. - * @member {string} + * @property {object} + * [virtualMachineProfile.storageProfile.osDisk.managedDisk] The managed disk + * parameters. + * @property {string} * [virtualMachineProfile.storageProfile.osDisk.managedDisk.storageAccountType] * Specifies the storage account type for the managed disk. NOTE: * UltraSSD_LRS can only be used with data disks, it cannot be used with OS * Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [virtualMachineProfile.storageProfile.dataDisks] Specifies - * the parameters that are used to add data disks to the virtual machines in - * the scale set.

    For more information about disks, see [About disks - * and VHDs for Azure virtual + * @property {array} [virtualMachineProfile.storageProfile.dataDisks] + * Specifies the parameters that are used to add data disks to the virtual + * machines in the scale set.

    For more information about disks, see + * [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [virtualMachineProfile.additionalCapabilities] Specifies - * additional capabilities enabled or disabled on the virtual machine in the - * scale set. For instance: whether the virtual machine has the capability to - * support attaching managed data disks with UltraSSD_LRS storage account - * type. - * @member {boolean} + * @property {object} [virtualMachineProfile.additionalCapabilities] + * Specifies additional capabilities enabled or disabled on the virtual + * machine in the scale set. For instance: whether the virtual machine has + * the capability to support attaching managed data disks with UltraSSD_LRS + * storage account type. + * @property {boolean} * [virtualMachineProfile.additionalCapabilities.ultraSSDEnabled] The flag * that enables or disables a capability to have one or more managed data * disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed * disks with storage account type UltraSSD_LRS can be added to a virtual * machine or virtual machine scale set only if this property is enabled. - * @member {object} [virtualMachineProfile.networkProfile] Specifies + * @property {object} [virtualMachineProfile.networkProfile] Specifies * properties of the network interfaces of the virtual machines in the scale * set. - * @member {object} [virtualMachineProfile.networkProfile.healthProbe] A + * @property {object} [virtualMachineProfile.networkProfile.healthProbe] A * reference to a load balancer probe used to determine the health of an * instance in the virtual machine scale set. The reference will be in the * form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - * @member {string} [virtualMachineProfile.networkProfile.healthProbe.id] The - * ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {array} + * @property {string} [virtualMachineProfile.networkProfile.healthProbe.id] + * The ARM resource id in the form of + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + * @property {array} * [virtualMachineProfile.networkProfile.networkInterfaceConfigurations] The * list of network configurations. - * @member {object} [virtualMachineProfile.diagnosticsProfile] Specifies the - * boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - * @member {object} + * @property {object} [virtualMachineProfile.diagnosticsProfile] Specifies + * the boot diagnostic settings state.

    Minimum api-version: + * 2015-06-15. + * @property {object} * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics] Boot * Diagnostics is a debugging feature which allows you to view Console Output * and Screenshot to diagnose VM status.

    You can easily view the * output of your console log.

    Azure also enables you to see a * screenshot of the VM from the hypervisor. - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics.enabled] Whether * boot diagnostics should be enabled on the Virtual Machine. - * @member {string} + * @property {string} * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics.storageUri] Uri * of the storage account to use for placing the console output and * screenshot. - * @member {object} [virtualMachineProfile.extensionProfile] Specifies a + * @property {object} [virtualMachineProfile.extensionProfile] Specifies a * collection of settings for extensions installed on virtual machines in the * scale set. - * @member {array} [virtualMachineProfile.extensionProfile.extensions] The + * @property {array} [virtualMachineProfile.extensionProfile.extensions] The * virtual machine scale set child extension resources. - * @member {string} [virtualMachineProfile.licenseType] Specifies that the + * @property {string} [virtualMachineProfile.licenseType] Specifies that the * image or disk that is being used was licensed on-premises. This element is * only used for images that contain the Windows Server operating system. *

    Possible values are:

    Windows_Client

    @@ -325,44 +329,44 @@ class VirtualMachineScaleSet extends models['Resource'] { * Windows * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Minimum api-version: 2015-06-15 - * @member {string} [virtualMachineProfile.priority] Specifies the priority + * @property {string} [virtualMachineProfile.priority] Specifies the priority * for the virtual machines in the scale set.

    Minimum api-version: * 2017-10-30-preview. Possible values include: 'Regular', 'Low' - * @member {string} [virtualMachineProfile.evictionPolicy] Specifies the + * @property {string} [virtualMachineProfile.evictionPolicy] Specifies the * eviction policy for virtual machines in a low priority scale set. *

    Minimum api-version: 2017-10-30-preview. Possible values include: * 'Deallocate', 'Delete' - * @member {string} [provisioningState] The provisioning state, which only + * @property {string} [provisioningState] The provisioning state, which only * appears in the response. - * @member {boolean} [overprovision] Specifies whether the Virtual Machine + * @property {boolean} [overprovision] Specifies whether the Virtual Machine * Scale Set should be overprovisioned. - * @member {string} [uniqueId] Specifies the ID which uniquely identifies a + * @property {string} [uniqueId] Specifies the ID which uniquely identifies a * Virtual Machine Scale Set. - * @member {boolean} [singlePlacementGroup] When true this limits the scale + * @property {boolean} [singlePlacementGroup] When true this limits the scale * set to a single placement group, of max size 100 virtual machines. - * @member {boolean} [zoneBalance] Whether to force stictly even Virtual + * @property {boolean} [zoneBalance] Whether to force strictly even Virtual * Machine distribution cross x-zones in case there is zone outage. - * @member {number} [platformFaultDomainCount] Fault Domain count for each + * @property {number} [platformFaultDomainCount] Fault Domain count for each * placement group. - * @member {object} [identity] The identity of the virtual machine scale set, - * if configured. - * @member {string} [identity.principalId] The principal id of virtual + * @property {object} [identity] The identity of the virtual machine scale + * set, if configured. + * @property {string} [identity.principalId] The principal id of virtual * machine scale set identity. This property will only be provided for a * system assigned identity. - * @member {string} [identity.tenantId] The tenant id associated with the + * @property {string} [identity.tenantId] The tenant id associated with the * virtual machine scale set. This property will only be provided for a * system assigned identity. - * @member {string} [identity.type] The type of identity used for the virtual - * machine scale set. The type 'SystemAssigned, UserAssigned' includes both - * an implicitly created identity and a set of user assigned identities. The - * type 'None' will remove any identities from the virtual machine scale set. - * Possible values include: 'SystemAssigned', 'UserAssigned', - * 'SystemAssigned, UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user + * @property {string} [identity.type] The type of identity used for the + * virtual machine scale set. The type 'SystemAssigned, UserAssigned' + * includes both an implicitly created identity and a set of user assigned + * identities. The type 'None' will remove any identities from the virtual + * machine scale set. Possible values include: 'SystemAssigned', + * 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + * @property {object} [identity.userAssignedIdentities] The list of user * identities associated with the virtual machine scale set. The user * identity dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - * @member {array} [zones] The virtual machine scale set zones. + * @property {array} [zones] The virtual machine scale set zones. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetDataDisk.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetDataDisk.js index 3354ee641a..4ca9de471e 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetDataDisk.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetDataDisk.js @@ -17,24 +17,25 @@ class VirtualMachineScaleSetDataDisk { /** * Create a VirtualMachineScaleSetDataDisk. - * @member {string} [name] The disk name. - * @member {number} lun Specifies the logical unit number of the data disk. + * @property {string} [name] The disk name. + * @property {number} lun Specifies the logical unit number of the data disk. * This value is used to identify data disks within the VM and therefore must * be unique for each data disk attached to a VM. - * @member {string} [caching] Specifies the caching requirements.

    + * @property {string} [caching] Specifies the caching requirements.

    * Possible values are:

    **None**

    **ReadOnly**

    * **ReadWrite**

    Default: **None for Standard storage. ReadOnly for * Premium storage**. Possible values include: 'None', 'ReadOnly', * 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether + * @property {boolean} [writeAcceleratorEnabled] Specifies whether * writeAccelerator should be enabled or disabled on the disk. - * @member {string} createOption The create option. Possible values include: - * 'FromImage', 'Empty', 'Attach' - * @member {number} [diskSizeGB] Specifies the size of an empty data disk in - * gigabytes. This element can be used to overwrite the size of the disk in a - * virtual machine image.

    This value cannot be larger than 1023 GB - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage + * @property {string} createOption The create option. Possible values + * include: 'FromImage', 'Empty', 'Attach' + * @property {number} [diskSizeGB] Specifies the size of an empty data disk + * in gigabytes. This element can be used to overwrite the size of the disk + * in a virtual machine image.

    This value cannot be larger than 1023 + * GB + * @property {object} [managedDisk] The managed disk parameters. + * @property {string} [managedDisk.storageAccountType] Specifies the storage * account type for the managed disk. NOTE: UltraSSD_LRS can only be used * with data disks, it cannot be used with OS Disk. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtension.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtension.js index 039e6fa071..88706f3db1 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtension.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtension.js @@ -20,26 +20,29 @@ const models = require('./index'); class VirtualMachineScaleSetExtension extends models['SubResourceReadOnly'] { /** * Create a VirtualMachineScaleSetExtension. - * @member {string} [name] The name of the extension. - * @member {string} [forceUpdateTag] If a value is provided and is different - * from the previous value, the extension handler will be forced to update - * even if the extension configuration has not changed. - * @member {string} [publisher] The name of the extension handler publisher. - * @member {string} [type] Specifies the type of the extension; an example is - * "CustomScriptExtension". - * @member {string} [typeHandlerVersion] Specifies the version of the script - * handler. - * @member {boolean} [autoUpgradeMinorVersion] Indicates whether the + * @property {string} [name] The name of the extension. + * @property {string} [forceUpdateTag] If a value is provided and is + * different from the previous value, the extension handler will be forced to + * update even if the extension configuration has not changed. + * @property {string} [publisher] The name of the extension handler + * publisher. + * @property {string} [type] Specifies the type of the extension; an example + * is "CustomScriptExtension". + * @property {string} [typeHandlerVersion] Specifies the version of the + * script handler. + * @property {boolean} [autoUpgradeMinorVersion] Indicates whether the * extension should use a newer minor version if one is available at * deployment time. Once deployed, however, the extension will not upgrade * minor versions unless redeployed, even with this property set to true. - * @member {object} [settings] Json formatted public settings for the + * @property {object} [settings] Json formatted public settings for the * extension. - * @member {object} [protectedSettings] The extension can contain either + * @property {object} [protectedSettings] The extension can contain either * protectedSettings or protectedSettingsFromKeyVault or no protected * settings at all. - * @member {string} [provisioningState] The provisioning state, which only + * @property {string} [provisioningState] The provisioning state, which only * appears in the response. + * @property {array} [provisionAfterExtensions] Collection of extension names + * after which this extension needs to be provisioned. */ constructor() { super(); @@ -130,6 +133,20 @@ class VirtualMachineScaleSetExtension extends models['SubResourceReadOnly'] { type: { name: 'String' } + }, + provisionAfterExtensions: { + required: false, + serializedName: 'properties.provisionAfterExtensions', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } } } } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtensionListResult.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtensionListResult.js index 1b2b603469..efb69bb498 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtensionListResult.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtensionListResult.js @@ -16,9 +16,9 @@ class VirtualMachineScaleSetExtensionListResult extends Array { /** * Create a VirtualMachineScaleSetExtensionListResult. - * @member {string} [nextLink] The uri to fetch the next page of VM scale set - * extensions. Call ListNext() with this to fetch the next page of VM scale - * set extensions. + * @property {string} [nextLink] The uri to fetch the next page of VM scale + * set extensions. Call ListNext() with this to fetch the next page of VM + * scale set extensions. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtensionProfile.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtensionProfile.js index d27660bf3a..18d04c0570 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtensionProfile.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetExtensionProfile.js @@ -17,8 +17,8 @@ class VirtualMachineScaleSetExtensionProfile { /** * Create a VirtualMachineScaleSetExtensionProfile. - * @member {array} [extensions] The virtual machine scale set child extension - * resources. + * @property {array} [extensions] The virtual machine scale set child + * extension resources. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIPConfiguration.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIPConfiguration.js index 35be769b56..8691cd145e 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIPConfiguration.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIPConfiguration.js @@ -20,45 +20,45 @@ const models = require('./index'); class VirtualMachineScaleSetIPConfiguration extends models['SubResource'] { /** * Create a VirtualMachineScaleSetIPConfiguration. - * @member {string} name The IP configuration name. - * @member {object} [subnet] Specifies the identifier of the subnet. - * @member {string} [subnet.id] The ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {boolean} [primary] Specifies the primary network interface in + * @property {string} name The IP configuration name. + * @property {object} [subnet] Specifies the identifier of the subnet. + * @property {string} [subnet.id] The ARM resource id in the form of + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + * @property {boolean} [primary] Specifies the primary network interface in * case the virtual machine has more than 1 network interface. - * @member {object} [publicIPAddressConfiguration] The + * @property {object} [publicIPAddressConfiguration] The * publicIPAddressConfiguration. - * @member {string} [publicIPAddressConfiguration.name] The publicIP address - * configuration name. - * @member {number} [publicIPAddressConfiguration.idleTimeoutInMinutes] The + * @property {string} [publicIPAddressConfiguration.name] The publicIP + * address configuration name. + * @property {number} [publicIPAddressConfiguration.idleTimeoutInMinutes] The * idle timeout of the public IP address. - * @member {object} [publicIPAddressConfiguration.dnsSettings] The dns + * @property {object} [publicIPAddressConfiguration.dnsSettings] The dns * settings to be applied on the publicIP addresses . - * @member {string} + * @property {string} * [publicIPAddressConfiguration.dnsSettings.domainNameLabel] The Domain name * label.The concatenation of the domain name label and vm index will be the * domain name labels of the PublicIPAddress resources that will be created - * @member {array} [publicIPAddressConfiguration.ipTags] The list of IP tags - * associated with the public IP address. - * @member {object} [publicIPAddressConfiguration.publicIPPrefix] The + * @property {array} [publicIPAddressConfiguration.ipTags] The list of IP + * tags associated with the public IP address. + * @property {object} [publicIPAddressConfiguration.publicIPPrefix] The * PublicIPPrefix from which to allocate publicIP addresses. - * @member {string} [publicIPAddressConfiguration.publicIPPrefix.id] Resource - * Id - * @member {string} [privateIPAddressVersion] Available from Api-Version + * @property {string} [publicIPAddressConfiguration.publicIPPrefix.id] + * Resource Id + * @property {string} [privateIPAddressVersion] Available from Api-Version * 2017-03-30 onwards, it represents whether the specific ipconfiguration is * IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and * 'IPv6'. Possible values include: 'IPv4', 'IPv6' - * @member {array} [applicationGatewayBackendAddressPools] Specifies an array - * of references to backend address pools of application gateways. A scale - * set can reference backend address pools of multiple application gateways. - * Multiple scale sets cannot use the same application gateway. - * @member {array} [applicationSecurityGroups] Specifies an array of + * @property {array} [applicationGatewayBackendAddressPools] Specifies an + * array of references to backend address pools of application gateways. A + * scale set can reference backend address pools of multiple application + * gateways. Multiple scale sets cannot use the same application gateway. + * @property {array} [applicationSecurityGroups] Specifies an array of * references to application security group. - * @member {array} [loadBalancerBackendAddressPools] Specifies an array of + * @property {array} [loadBalancerBackendAddressPools] Specifies an array of * references to backend address pools of load balancers. A scale set can * reference backend address pools of one public and one internal load * balancer. Multiple scale sets cannot use the same load balancer. - * @member {array} [loadBalancerInboundNatPools] Specifies an array of + * @property {array} [loadBalancerInboundNatPools] Specifies an array of * references to inbound Nat pools of the load balancers. A scale set can * reference inbound nat pools of one public and one internal load balancer. * Multiple scale sets cannot use the same load balancer diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIdentity.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIdentity.js index c57257efe5..32d486a7c7 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIdentity.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIdentity.js @@ -17,19 +17,19 @@ class VirtualMachineScaleSetIdentity { /** * Create a VirtualMachineScaleSetIdentity. - * @member {string} [principalId] The principal id of virtual machine scale + * @property {string} [principalId] The principal id of virtual machine scale * set identity. This property will only be provided for a system assigned * identity. - * @member {string} [tenantId] The tenant id associated with the virtual + * @property {string} [tenantId] The tenant id associated with the virtual * machine scale set. This property will only be provided for a system * assigned identity. - * @member {string} [type] The type of identity used for the virtual machine - * scale set. The type 'SystemAssigned, UserAssigned' includes both an - * implicitly created identity and a set of user assigned identities. The + * @property {string} [type] The type of identity used for the virtual + * machine scale set. The type 'SystemAssigned, UserAssigned' includes both + * an implicitly created identity and a set of user assigned identities. The * type 'None' will remove any identities from the virtual machine scale set. * Possible values include: 'SystemAssigned', 'UserAssigned', * 'SystemAssigned, UserAssigned', 'None' - * @member {object} [userAssignedIdentities] The list of user identities + * @property {object} [userAssignedIdentities] The list of user identities * associated with the virtual machine scale set. The user identity * dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIdentityUserAssignedIdentitiesValue.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIdentityUserAssignedIdentitiesValue.js index 0752bf5253..390b6dd814 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIdentityUserAssignedIdentitiesValue.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIdentityUserAssignedIdentitiesValue.js @@ -16,8 +16,9 @@ class VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue { /** * Create a VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue. - * @member {string} [principalId] The principal id of user assigned identity. - * @member {string} [clientId] The client id of user assigned identity. + * @property {string} [principalId] The principal id of user assigned + * identity. + * @property {string} [clientId] The client id of user assigned identity. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetInstanceView.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetInstanceView.js index 9229eec790..f5f22cd56a 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetInstanceView.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetInstanceView.js @@ -17,12 +17,12 @@ class VirtualMachineScaleSetInstanceView { /** * Create a VirtualMachineScaleSetInstanceView. - * @member {object} [virtualMachine] The instance view status summary for the - * virtual machine scale set. - * @member {array} [virtualMachine.statusesSummary] The extensions + * @property {object} [virtualMachine] The instance view status summary for + * the virtual machine scale set. + * @property {array} [virtualMachine.statusesSummary] The extensions * information. - * @member {array} [extensions] The extensions information. - * @member {array} [statuses] The resource status information. + * @property {array} [extensions] The extensions information. + * @property {array} [statuses] The resource status information. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetInstanceViewStatusesSummary.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetInstanceViewStatusesSummary.js index c852cb303e..e51c691e91 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetInstanceViewStatusesSummary.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetInstanceViewStatusesSummary.js @@ -18,7 +18,7 @@ class VirtualMachineScaleSetInstanceViewStatusesSummary { /** * Create a VirtualMachineScaleSetInstanceViewStatusesSummary. - * @member {array} [statusesSummary] The extensions information. + * @property {array} [statusesSummary] The extensions information. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIpTag.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIpTag.js index f133b20ed3..ebc3281f3d 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIpTag.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetIpTag.js @@ -17,9 +17,9 @@ class VirtualMachineScaleSetIpTag { /** * Create a VirtualMachineScaleSetIpTag. - * @member {string} [ipTagType] IP tag type. Example: FirstPartyUsage. - * @member {string} [tag] IP tag associated with the public IP. Example: SQL, - * Storage etc. + * @property {string} [ipTagType] IP tag type. Example: FirstPartyUsage. + * @property {string} [tag] IP tag associated with the public IP. Example: + * SQL, Storage etc. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListOSUpgradeHistory.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListOSUpgradeHistory.js index 67be7c8893..7c606d31c1 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListOSUpgradeHistory.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListOSUpgradeHistory.js @@ -16,7 +16,7 @@ class VirtualMachineScaleSetListOSUpgradeHistory extends Array { /** * Create a VirtualMachineScaleSetListOSUpgradeHistory. - * @member {string} [nextLink] The uri to fetch the next page of OS Upgrade + * @property {string} [nextLink] The uri to fetch the next page of OS Upgrade * History. Call ListNext() with this to fetch the next page of history of * upgrades. */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListResult.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListResult.js index 7da6f67de9..1a46a39cb9 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListResult.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListResult.js @@ -16,7 +16,7 @@ class VirtualMachineScaleSetListResult extends Array { /** * Create a VirtualMachineScaleSetListResult. - * @member {string} [nextLink] The uri to fetch the next page of Virtual + * @property {string} [nextLink] The uri to fetch the next page of Virtual * Machine Scale Sets. Call ListNext() with this to fetch the next page of * VMSS. */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListSkusResult.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListSkusResult.js index 9ef34f3c99..f2577b15ea 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListSkusResult.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListSkusResult.js @@ -16,7 +16,7 @@ class VirtualMachineScaleSetListSkusResult extends Array { /** * Create a VirtualMachineScaleSetListSkusResult. - * @member {string} [nextLink] The uri to fetch the next page of Virtual + * @property {string} [nextLink] The uri to fetch the next page of Virtual * Machine Scale Set Skus. Call ListNext() with this to fetch the next page * of VMSS Skus. */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListWithLinkResult.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListWithLinkResult.js index 18582e2a55..45c2a3fb5e 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListWithLinkResult.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetListWithLinkResult.js @@ -16,7 +16,7 @@ class VirtualMachineScaleSetListWithLinkResult extends Array { /** * Create a VirtualMachineScaleSetListWithLinkResult. - * @member {string} [nextLink] The uri to fetch the next page of Virtual + * @property {string} [nextLink] The uri to fetch the next page of Virtual * Machine Scale Sets. Call ListNext() with this to fetch the next page of * Virtual Machine Scale Sets. */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetManagedDiskParameters.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetManagedDiskParameters.js index 6ffd999d31..dd9fb6dd6d 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetManagedDiskParameters.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetManagedDiskParameters.js @@ -17,7 +17,7 @@ class VirtualMachineScaleSetManagedDiskParameters { /** * Create a VirtualMachineScaleSetManagedDiskParameters. - * @member {string} [storageAccountType] Specifies the storage account type + * @property {string} [storageAccountType] Specifies the storage account type * for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, * it cannot be used with OS Disk. Possible values include: 'Standard_LRS', * 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkConfiguration.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkConfiguration.js index 2bd1cfb512..f5fd11bfb5 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkConfiguration.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkConfiguration.js @@ -21,19 +21,20 @@ const models = require('./index'); class VirtualMachineScaleSetNetworkConfiguration extends models['SubResource'] { /** * Create a VirtualMachineScaleSetNetworkConfiguration. - * @member {string} name The network configuration name. - * @member {boolean} [primary] Specifies the primary network interface in + * @property {string} name The network configuration name. + * @property {boolean} [primary] Specifies the primary network interface in * case the virtual machine has more than 1 network interface. - * @member {boolean} [enableAcceleratedNetworking] Specifies whether the + * @property {boolean} [enableAcceleratedNetworking] Specifies whether the * network interface is accelerated networking-enabled. - * @member {object} [networkSecurityGroup] The network security group. - * @member {string} [networkSecurityGroup.id] Resource Id - * @member {object} [dnsSettings] The dns settings to be applied on the + * @property {object} [networkSecurityGroup] The network security group. + * @property {string} [networkSecurityGroup.id] Resource Id + * @property {object} [dnsSettings] The dns settings to be applied on the * network interfaces. - * @member {array} [dnsSettings.dnsServers] List of DNS servers IP addresses - * @member {array} ipConfigurations Specifies the IP configurations of the + * @property {array} [dnsSettings.dnsServers] List of DNS servers IP + * addresses + * @property {array} ipConfigurations Specifies the IP configurations of the * network interface. - * @member {boolean} [enableIPForwarding] Whether IP forwarding enabled on + * @property {boolean} [enableIPForwarding] Whether IP forwarding enabled on * this NIC. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkConfigurationDnsSettings.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkConfigurationDnsSettings.js index cf26dfa1c9..1bc733a566 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkConfigurationDnsSettings.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkConfigurationDnsSettings.js @@ -18,7 +18,7 @@ class VirtualMachineScaleSetNetworkConfigurationDnsSettings { /** * Create a VirtualMachineScaleSetNetworkConfigurationDnsSettings. - * @member {array} [dnsServers] List of DNS servers IP addresses + * @property {array} [dnsServers] List of DNS servers IP addresses */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkProfile.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkProfile.js index 6b069ffceb..cc5716589b 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkProfile.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetNetworkProfile.js @@ -17,13 +17,13 @@ class VirtualMachineScaleSetNetworkProfile { /** * Create a VirtualMachineScaleSetNetworkProfile. - * @member {object} [healthProbe] A reference to a load balancer probe used + * @property {object} [healthProbe] A reference to a load balancer probe used * to determine the health of an instance in the virtual machine scale set. * The reference will be in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - * @member {string} [healthProbe.id] The ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {array} [networkInterfaceConfigurations] The list of network + * @property {string} [healthProbe.id] The ARM resource id in the form of + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + * @property {array} [networkInterfaceConfigurations] The list of network * configurations. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetOSDisk.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetOSDisk.js index d1cbfc3320..d3c075d61b 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetOSDisk.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetOSDisk.js @@ -17,41 +17,41 @@ class VirtualMachineScaleSetOSDisk { /** * Create a VirtualMachineScaleSetOSDisk. - * @member {string} [name] The disk name. - * @member {string} [caching] Specifies the caching requirements.

    + * @property {string} [name] The disk name. + * @property {string} [caching] Specifies the caching requirements.

    * Possible values are:

    **None**

    **ReadOnly**

    * **ReadWrite**

    Default: **None for Standard storage. ReadOnly for * Premium storage**. Possible values include: 'None', 'ReadOnly', * 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether + * @property {boolean} [writeAcceleratorEnabled] Specifies whether * writeAccelerator should be enabled or disabled on the disk. - * @member {string} createOption Specifies how the virtual machines in the + * @property {string} createOption Specifies how the virtual machines in the * scale set should be created.

    The only allowed value is: * **FromImage** \u2013 This value is used when you are using an image to * create the virtual machine. If you are using a platform image, you also * use the imageReference element described above. If you are using a * marketplace image, you also use the plan element previously described. * Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {object} [diffDiskSettings] Specifies the differencing Disk + * @property {object} [diffDiskSettings] Specifies the ephemeral disk * Settings for the operating system disk used by the virtual machine scale * set. - * @member {string} [diffDiskSettings.option] Specifies the differencing disk + * @property {string} [diffDiskSettings.option] Specifies the ephemeral disk * settings for operating system disk. Possible values include: 'Local' - * @member {number} [diskSizeGB] Specifies the size of the operating system + * @property {number} [diskSizeGB] Specifies the size of the operating system * disk in gigabytes. This element can be used to overwrite the size of the * disk in a virtual machine image.

    This value cannot be larger than * 1023 GB - * @member {string} [osType] This property allows you to specify the type of - * the OS that is included in the disk if creating a VM from user-image or a - * specialized VHD.

    Possible values are:

    **Windows** + * @property {string} [osType] This property allows you to specify the type + * of the OS that is included in the disk if creating a VM from user-image or + * a specialized VHD.

    Possible values are:

    **Windows** *

    **Linux**. Possible values include: 'Windows', 'Linux' - * @member {object} [image] Specifies information about the unmanaged user + * @property {object} [image] Specifies information about the unmanaged user * image to base the scale set on. - * @member {string} [image.uri] Specifies the virtual hard disk's uri. - * @member {array} [vhdContainers] Specifies the container urls that are used - * to store operating system disks for the scale set. - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage + * @property {string} [image.uri] Specifies the virtual hard disk's uri. + * @property {array} [vhdContainers] Specifies the container urls that are + * used to store operating system disks for the scale set. + * @property {object} [managedDisk] The managed disk parameters. + * @property {string} [managedDisk.storageAccountType] Specifies the storage * account type for the managed disk. NOTE: UltraSSD_LRS can only be used * with data disks, it cannot be used with OS Disk. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetOSProfile.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetOSProfile.js index 5520c6f135..af6eee9a0e 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetOSProfile.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetOSProfile.js @@ -17,10 +17,10 @@ class VirtualMachineScaleSetOSProfile { /** * Create a VirtualMachineScaleSetOSProfile. - * @member {string} [computerNamePrefix] Specifies the computer name prefix + * @property {string} [computerNamePrefix] Specifies the computer name prefix * for all of the virtual machines in the scale set. Computer name prefixes * must be 1 to 15 characters long. - * @member {string} [adminUsername] Specifies the name of the administrator + * @property {string} [adminUsername] Specifies the name of the administrator * account.

    **Windows-only restriction:** Cannot end in "."

    * **Disallowed values:** "administrator", "admin", "user", "user1", "test", * "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", @@ -34,7 +34,7 @@ class VirtualMachineScaleSetOSProfile { * For a list of built-in system users on Linux that should not be used in * this field, see [Selecting User Names for Linux on * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [adminPassword] Specifies the password of the + * @property {string} [adminPassword] Specifies the password of the * administrator account.

    **Minimum-length (Windows):** 8 characters *

    **Minimum-length (Linux):** 6 characters

    **Max-length * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters @@ -49,49 +49,49 @@ class VirtualMachineScaleSetOSProfile { *

    For resetting root password, see [Manage users, SSH, and check or * repair disks on Azure Linux VMs using the VMAccess * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [customData] Specifies a base-64 encoded string of custom - * data. The base-64 encoded string is decoded to a binary array that is - * saved as a file on the Virtual Machine. The maximum length of the binary - * array is 65535 bytes.

    For using cloud-init for your VM, see - * [Using cloud-init to customize a Linux VM during + * @property {string} [customData] Specifies a base-64 encoded string of + * custom data. The base-64 encoded string is decoded to a binary array that + * is saved as a file on the Virtual Machine. The maximum length of the + * binary array is 65535 bytes.

    For using cloud-init for your VM, + * see [Using cloud-init to customize a Linux VM during * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [windowsConfiguration] Specifies Windows operating system - * settings on the virtual machine. - * @member {boolean} [windowsConfiguration.provisionVMAgent] Indicates + * @property {object} [windowsConfiguration] Specifies Windows operating + * system settings on the virtual machine. + * @property {boolean} [windowsConfiguration.provisionVMAgent] Indicates * whether virtual machine agent should be provisioned on the virtual * machine.

    When this property is not specified in the request body, * default behavior is to set it to true. This will ensure that VM Agent is * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} [windowsConfiguration.enableAutomaticUpdates] Indicates - * whether virtual machine is enabled for automatic updates. - * @member {string} [windowsConfiguration.timeZone] Specifies the time zone + * @property {boolean} [windowsConfiguration.enableAutomaticUpdates] + * Indicates whether virtual machine is enabled for automatic updates. + * @property {string} [windowsConfiguration.timeZone] Specifies the time zone * of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [windowsConfiguration.additionalUnattendContent] Specifies - * additional base-64 encoded XML formatted information that can be included - * in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [windowsConfiguration.winRM] Specifies the Windows Remote - * Management listeners. This enables remote Windows PowerShell. - * @member {array} [windowsConfiguration.winRM.listeners] The list of Windows - * Remote Management listeners - * @member {object} [linuxConfiguration] Specifies the Linux operating system - * settings on the virtual machine.

    For a list of supported Linux - * distributions, see [Linux on Azure-Endorsed + * @property {array} [windowsConfiguration.additionalUnattendContent] + * Specifies additional base-64 encoded XML formatted information that can be + * included in the Unattend.xml file, which is used by Windows Setup. + * @property {object} [windowsConfiguration.winRM] Specifies the Windows + * Remote Management listeners. This enables remote Windows PowerShell. + * @property {array} [windowsConfiguration.winRM.listeners] The list of + * Windows Remote Management listeners + * @property {object} [linuxConfiguration] Specifies the Linux operating + * system settings on the virtual machine.

    For a list of supported + * Linux distributions, see [Linux on Azure-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) *

    For running non-endorsed distributions, see [Information for * Non-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} [linuxConfiguration.disablePasswordAuthentication] + * @property {boolean} [linuxConfiguration.disablePasswordAuthentication] * Specifies whether password authentication should be disabled. - * @member {object} [linuxConfiguration.ssh] Specifies the ssh key + * @property {object} [linuxConfiguration.ssh] Specifies the ssh key * configuration for a Linux OS. - * @member {array} [linuxConfiguration.ssh.publicKeys] The list of SSH public - * keys used to authenticate with linux based VMs. - * @member {boolean} [linuxConfiguration.provisionVMAgent] Indicates whether - * virtual machine agent should be provisioned on the virtual machine. - *

    When this property is not specified in the request body, default - * behavior is to set it to true. This will ensure that VM Agent is + * @property {array} [linuxConfiguration.ssh.publicKeys] The list of SSH + * public keys used to authenticate with linux based VMs. + * @property {boolean} [linuxConfiguration.provisionVMAgent] Indicates + * whether virtual machine agent should be provisioned on the virtual + * machine.

    When this property is not specified in the request body, + * default behavior is to set it to true. This will ensure that VM Agent is * installed on the VM so that extensions can be added to the VM later. - * @member {array} [secrets] Specifies set of certificates that should be + * @property {array} [secrets] Specifies set of certificates that should be * installed onto the virtual machines in the scale set. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetPublicIPAddressConfiguration.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetPublicIPAddressConfiguration.js index d46e68fd16..8a42a76be0 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetPublicIPAddressConfiguration.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetPublicIPAddressConfiguration.js @@ -18,19 +18,19 @@ class VirtualMachineScaleSetPublicIPAddressConfiguration { /** * Create a VirtualMachineScaleSetPublicIPAddressConfiguration. - * @member {string} name The publicIP address configuration name. - * @member {number} [idleTimeoutInMinutes] The idle timeout of the public IP - * address. - * @member {object} [dnsSettings] The dns settings to be applied on the + * @property {string} name The publicIP address configuration name. + * @property {number} [idleTimeoutInMinutes] The idle timeout of the public + * IP address. + * @property {object} [dnsSettings] The dns settings to be applied on the * publicIP addresses . - * @member {string} [dnsSettings.domainNameLabel] The Domain name label.The + * @property {string} [dnsSettings.domainNameLabel] The Domain name label.The * concatenation of the domain name label and vm index will be the domain * name labels of the PublicIPAddress resources that will be created - * @member {array} [ipTags] The list of IP tags associated with the public IP - * address. - * @member {object} [publicIPPrefix] The PublicIPPrefix from which to + * @property {array} [ipTags] The list of IP tags associated with the public + * IP address. + * @property {object} [publicIPPrefix] The PublicIPPrefix from which to * allocate publicIP addresses. - * @member {string} [publicIPPrefix.id] Resource Id + * @property {string} [publicIPPrefix.id] Resource Id */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetPublicIPAddressConfigurationDnsSettings.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetPublicIPAddressConfigurationDnsSettings.js index e3fe9b5390..4d7fa7f0db 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetPublicIPAddressConfigurationDnsSettings.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetPublicIPAddressConfigurationDnsSettings.js @@ -18,7 +18,7 @@ class VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings { /** * Create a VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings. - * @member {string} domainNameLabel The Domain name label.The concatenation + * @property {string} domainNameLabel The Domain name label.The concatenation * of the domain name label and vm index will be the domain name labels of * the PublicIPAddress resources that will be created */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetReimageParameters.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetReimageParameters.js index 277bce4353..c03246e5a9 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetReimageParameters.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetReimageParameters.js @@ -20,10 +20,10 @@ const models = require('./index'); class VirtualMachineScaleSetReimageParameters extends models['VirtualMachineScaleSetVMReimageParameters'] { /** * Create a VirtualMachineScaleSetReimageParameters. - * @member {array} [instanceIds] The virtual machine scale set instance ids. - * Omitting the virtual machine scale set instance ids will result in the - * operation being performed on all virtual machines in the virtual machine - * scale set. + * @property {array} [instanceIds] The virtual machine scale set instance + * ids. Omitting the virtual machine scale set instance ids will result in + * the operation being performed on all virtual machines in the virtual + * machine scale set. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetSku.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetSku.js index 9f9719323c..7bef2eeacb 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetSku.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetSku.js @@ -17,20 +17,21 @@ class VirtualMachineScaleSetSku { /** * Create a VirtualMachineScaleSetSku. - * @member {string} [resourceType] The type of resource the sku applies to. - * @member {object} [sku] The Sku. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a + * @property {string} [resourceType] The type of resource the sku applies to. + * @property {object} [sku] The Sku. + * @property {string} [sku.name] The sku name. + * @property {string} [sku.tier] Specifies the tier of virtual machines in a * scale set.

    Possible Values:

    **Standard**

    **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines + * @property {number} [sku.capacity] Specifies the number of virtual machines * in the scale set. - * @member {object} [capacity] Specifies the number of virtual machines in + * @property {object} [capacity] Specifies the number of virtual machines in * the scale set. - * @member {number} [capacity.minimum] The minimum capacity. - * @member {number} [capacity.maximum] The maximum capacity that can be set. - * @member {number} [capacity.defaultCapacity] The default capacity. - * @member {string} [capacity.scaleType] The scale type applicable to the + * @property {number} [capacity.minimum] The minimum capacity. + * @property {number} [capacity.maximum] The maximum capacity that can be + * set. + * @property {number} [capacity.defaultCapacity] The default capacity. + * @property {string} [capacity.scaleType] The scale type applicable to the * sku. Possible values include: 'Automatic', 'None' */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetSkuCapacity.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetSkuCapacity.js index 2f59fba9c6..f342617b4e 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetSkuCapacity.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetSkuCapacity.js @@ -17,10 +17,10 @@ class VirtualMachineScaleSetSkuCapacity { /** * Create a VirtualMachineScaleSetSkuCapacity. - * @member {number} [minimum] The minimum capacity. - * @member {number} [maximum] The maximum capacity that can be set. - * @member {number} [defaultCapacity] The default capacity. - * @member {string} [scaleType] The scale type applicable to the sku. + * @property {number} [minimum] The minimum capacity. + * @property {number} [maximum] The maximum capacity that can be set. + * @property {number} [defaultCapacity] The default capacity. + * @property {string} [scaleType] The scale type applicable to the sku. * Possible values include: 'Automatic', 'None' */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetStorageProfile.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetStorageProfile.js index 9baa4fc435..5d1215fb02 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetStorageProfile.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetStorageProfile.js @@ -17,68 +17,69 @@ class VirtualMachineScaleSetStorageProfile { /** * Create a VirtualMachineScaleSetStorageProfile. - * @member {object} [imageReference] Specifies information about the image to - * use. You can specify information about platform images, marketplace + * @property {object} [imageReference] Specifies information about the image + * to use. You can specify information about platform images, marketplace * images, or virtual machine images. This element is required when you want * to use a platform image, marketplace image, or virtual machine image, but * is not used in other creation operations. - * @member {string} [imageReference.publisher] The image publisher. - * @member {string} [imageReference.offer] Specifies the offer of the + * @property {string} [imageReference.publisher] The image publisher. + * @property {string} [imageReference.offer] Specifies the offer of the * platform image or marketplace image used to create the virtual machine. - * @member {string} [imageReference.sku] The image SKU. - * @member {string} [imageReference.version] Specifies the version of the + * @property {string} [imageReference.sku] The image SKU. + * @property {string} [imageReference.version] Specifies the version of the * platform image or marketplace image used to create the virtual machine. * The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and * Build are decimal numbers. Specify 'latest' to use the latest version of * an image available at deploy time. Even if you use 'latest', the VM image * will not automatically update after deploy time even if a new version * becomes available. - * @member {object} [osDisk] Specifies information about the operating system - * disk used by the virtual machines in the scale set.

    For more - * information about disks, see [About disks and VHDs for Azure virtual + * @property {object} [osDisk] Specifies information about the operating + * system disk used by the virtual machines in the scale set.

    For + * more information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [osDisk.name] The disk name. - * @member {string} [osDisk.caching] Specifies the caching requirements. + * @property {string} [osDisk.name] The disk name. + * @property {string} [osDisk.caching] Specifies the caching requirements. *

    Possible values are:

    **None**

    **ReadOnly** *

    **ReadWrite**

    Default: **None for Standard storage. * ReadOnly for Premium storage**. Possible values include: 'None', * 'ReadOnly', 'ReadWrite' - * @member {boolean} [osDisk.writeAcceleratorEnabled] Specifies whether + * @property {boolean} [osDisk.writeAcceleratorEnabled] Specifies whether * writeAccelerator should be enabled or disabled on the disk. - * @member {string} [osDisk.createOption] Specifies how the virtual machines - * in the scale set should be created.

    The only allowed value is: - * **FromImage** \u2013 This value is used when you are using an image to - * create the virtual machine. If you are using a platform image, you also - * use the imageReference element described above. If you are using a - * marketplace image, you also use the plan element previously described. + * @property {string} [osDisk.createOption] Specifies how the virtual + * machines in the scale set should be created.

    The only allowed + * value is: **FromImage** \u2013 This value is used when you are using an + * image to create the virtual machine. If you are using a platform image, + * you also use the imageReference element described above. If you are using + * a marketplace image, you also use the plan element previously described. * Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {object} [osDisk.diffDiskSettings] Specifies the differencing Disk + * @property {object} [osDisk.diffDiskSettings] Specifies the ephemeral disk * Settings for the operating system disk used by the virtual machine scale * set. - * @member {string} [osDisk.diffDiskSettings.option] Specifies the - * differencing disk settings for operating system disk. Possible values + * @property {string} [osDisk.diffDiskSettings.option] Specifies the + * ephemeral disk settings for operating system disk. Possible values * include: 'Local' - * @member {number} [osDisk.diskSizeGB] Specifies the size of the operating + * @property {number} [osDisk.diskSizeGB] Specifies the size of the operating * system disk in gigabytes. This element can be used to overwrite the size * of the disk in a virtual machine image.

    This value cannot be * larger than 1023 GB - * @member {string} [osDisk.osType] This property allows you to specify the + * @property {string} [osDisk.osType] This property allows you to specify the * type of the OS that is included in the disk if creating a VM from * user-image or a specialized VHD.

    Possible values are:

    * **Windows**

    **Linux**. Possible values include: 'Windows', * 'Linux' - * @member {object} [osDisk.image] Specifies information about the unmanaged - * user image to base the scale set on. - * @member {string} [osDisk.image.uri] Specifies the virtual hard disk's uri. - * @member {array} [osDisk.vhdContainers] Specifies the container urls that + * @property {object} [osDisk.image] Specifies information about the + * unmanaged user image to base the scale set on. + * @property {string} [osDisk.image.uri] Specifies the virtual hard disk's + * uri. + * @property {array} [osDisk.vhdContainers] Specifies the container urls that * are used to store operating system disks for the scale set. - * @member {object} [osDisk.managedDisk] The managed disk parameters. - * @member {string} [osDisk.managedDisk.storageAccountType] Specifies the + * @property {object} [osDisk.managedDisk] The managed disk parameters. + * @property {string} [osDisk.managedDisk.storageAccountType] Specifies the * storage account type for the managed disk. NOTE: UltraSSD_LRS can only be * used with data disks, it cannot be used with OS Disk. Possible values * include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [dataDisks] Specifies the parameters that are used to add - * data disks to the virtual machines in the scale set.

    For more + * @property {array} [dataDisks] Specifies the parameters that are used to + * add data disks to the virtual machines in the scale set.

    For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdate.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdate.js index 9479f32f11..08be590a8c 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdate.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdate.js @@ -20,39 +20,39 @@ const models = require('./index'); class VirtualMachineScaleSetUpdate extends models['UpdateResource'] { /** * Create a VirtualMachineScaleSetUpdate. - * @member {object} [sku] The virtual machine scale set sku. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a + * @property {object} [sku] The virtual machine scale set sku. + * @property {string} [sku.name] The sku name. + * @property {string} [sku.tier] Specifies the tier of virtual machines in a * scale set.

    Possible Values:

    **Standard**

    **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines + * @property {number} [sku.capacity] Specifies the number of virtual machines * in the scale set. - * @member {object} [plan] The purchase plan when deploying a virtual machine - * scale set from VM Marketplace images. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from + * @property {object} [plan] The purchase plan when deploying a virtual + * machine scale set from VM Marketplace images. + * @property {string} [plan.name] The plan ID. + * @property {string} [plan.publisher] The publisher ID. + * @property {string} [plan.product] Specifies the product of the image from * the marketplace. This is the same value as Offer under the imageReference * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {object} [upgradePolicy] The upgrade policy. - * @member {string} [upgradePolicy.mode] Specifies the mode of an upgrade to - * virtual machines in the scale set.

    Possible values are:

    Possible values are:

    **Manual** - You control the application of updates to virtual * machines in the scale set. You do this by using the manualUpgrade * action.

    **Automatic** - All virtual machines in the scale set * are automatically updated at the same time. Possible values include: * 'Automatic', 'Manual', 'Rolling' - * @member {object} [upgradePolicy.rollingUpgradePolicy] The configuration + * @property {object} [upgradePolicy.rollingUpgradePolicy] The configuration * parameters used while performing a rolling upgrade. - * @member {number} + * @property {number} * [upgradePolicy.rollingUpgradePolicy.maxBatchInstancePercent] The maximum * percent of total virtual machine instances that will be upgraded * simultaneously by the rolling upgrade in one batch. As this is a maximum, * unhealthy instances in previous or future batches can cause the percentage * of instances in a batch to decrease to ensure higher reliability. The * default value for this parameter is 20%. - * @member {number} + * @property {number} * [upgradePolicy.rollingUpgradePolicy.maxUnhealthyInstancePercent] The * maximum percentage of the total virtual machine instances in the scale set * that can be simultaneously unhealthy, either as a result of being @@ -60,91 +60,92 @@ class VirtualMachineScaleSetUpdate extends models['UpdateResource'] { * health checks before the rolling upgrade aborts. This constraint will be * checked prior to starting any batch. The default value for this parameter * is 20%. - * @member {number} + * @property {number} * [upgradePolicy.rollingUpgradePolicy.maxUnhealthyUpgradedInstancePercent] * The maximum percentage of upgraded virtual machine instances that can be * found to be in an unhealthy state. This check will happen after each batch * is upgraded. If this percentage is ever exceeded, the rolling update * aborts. The default value for this parameter is 20%. - * @member {string} + * @property {string} * [upgradePolicy.rollingUpgradePolicy.pauseTimeBetweenBatches] The wait time * between completing the update for all virtual machines in one batch and * starting the next batch. The time duration should be specified in ISO 8601 * format. The default value is 0 seconds (PT0S). - * @member {object} [upgradePolicy.automaticOSUpgradePolicy] Configuration + * @property {object} [upgradePolicy.automaticOSUpgradePolicy] Configuration * parameters used for performing automatic OS Upgrade. - * @member {boolean} + * @property {boolean} * [upgradePolicy.automaticOSUpgradePolicy.enableAutomaticOSUpgrade] Whether * OS upgrades should automatically be applied to scale set instances in a * rolling fashion when a newer version of the image becomes available. * Default value is false. - * @member {boolean} + * @property {boolean} * [upgradePolicy.automaticOSUpgradePolicy.disableAutomaticRollback] Whether * OS image rollback feature should be disabled. Default value is false. - * @member {object} [virtualMachineProfile] The virtual machine profile. - * @member {object} [virtualMachineProfile.osProfile] The virtual machine + * @property {object} [virtualMachineProfile] The virtual machine profile. + * @property {object} [virtualMachineProfile.osProfile] The virtual machine * scale set OS profile. - * @member {string} [virtualMachineProfile.osProfile.customData] A base-64 + * @property {string} [virtualMachineProfile.osProfile.customData] A base-64 * encoded string of custom data. - * @member {object} [virtualMachineProfile.osProfile.windowsConfiguration] + * @property {object} [virtualMachineProfile.osProfile.windowsConfiguration] * The Windows Configuration of the OS profile. - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.osProfile.windowsConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.osProfile.windowsConfiguration.enableAutomaticUpdates] * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} + * @property {string} * [virtualMachineProfile.osProfile.windowsConfiguration.timeZone] Specifies * the time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} + * @property {array} * [virtualMachineProfile.osProfile.windowsConfiguration.additionalUnattendContent] * Specifies additional base-64 encoded XML formatted information that can be * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} + * @property {object} * [virtualMachineProfile.osProfile.windowsConfiguration.winRM] Specifies the * Windows Remote Management listeners. This enables remote Windows * PowerShell. - * @member {array} + * @property {array} * [virtualMachineProfile.osProfile.windowsConfiguration.winRM.listeners] The * list of Windows Remote Management listeners - * @member {object} [virtualMachineProfile.osProfile.linuxConfiguration] The - * Linux Configuration of the OS profile. - * @member {boolean} + * @property {object} [virtualMachineProfile.osProfile.linuxConfiguration] + * The Linux Configuration of the OS profile. + * @property {boolean} * [virtualMachineProfile.osProfile.linuxConfiguration.disablePasswordAuthentication] * Specifies whether password authentication should be disabled. - * @member {object} [virtualMachineProfile.osProfile.linuxConfiguration.ssh] - * Specifies the ssh key configuration for a Linux OS. - * @member {array} + * @property {object} + * [virtualMachineProfile.osProfile.linuxConfiguration.ssh] Specifies the ssh + * key configuration for a Linux OS. + * @property {array} * [virtualMachineProfile.osProfile.linuxConfiguration.ssh.publicKeys] The * list of SSH public keys used to authenticate with linux based VMs. - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.osProfile.linuxConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {array} [virtualMachineProfile.osProfile.secrets] The List of + * @property {array} [virtualMachineProfile.osProfile.secrets] The List of * certificates for addition to the VM. - * @member {object} [virtualMachineProfile.storageProfile] The virtual + * @property {object} [virtualMachineProfile.storageProfile] The virtual * machine scale set storage profile. - * @member {object} [virtualMachineProfile.storageProfile.imageReference] The - * image reference. - * @member {string} + * @property {object} [virtualMachineProfile.storageProfile.imageReference] + * The image reference. + * @property {string} * [virtualMachineProfile.storageProfile.imageReference.publisher] The image * publisher. - * @member {string} + * @property {string} * [virtualMachineProfile.storageProfile.imageReference.offer] Specifies the * offer of the platform image or marketplace image used to create the * virtual machine. - * @member {string} [virtualMachineProfile.storageProfile.imageReference.sku] - * The image SKU. - * @member {string} + * @property {string} + * [virtualMachineProfile.storageProfile.imageReference.sku] The image SKU. + * @property {string} * [virtualMachineProfile.storageProfile.imageReference.version] Specifies * the version of the platform image or marketplace image used to create the * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. @@ -152,82 +153,84 @@ class VirtualMachineScaleSetUpdate extends models['UpdateResource'] { * latest version of an image available at deploy time. Even if you use * 'latest', the VM image will not automatically update after deploy time * even if a new version becomes available. - * @member {object} [virtualMachineProfile.storageProfile.osDisk] The OS + * @property {object} [virtualMachineProfile.storageProfile.osDisk] The OS * disk. - * @member {string} [virtualMachineProfile.storageProfile.osDisk.caching] The - * caching type. Possible values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} + * @property {string} [virtualMachineProfile.storageProfile.osDisk.caching] + * The caching type. Possible values include: 'None', 'ReadOnly', 'ReadWrite' + * @property {boolean} * [virtualMachineProfile.storageProfile.osDisk.writeAcceleratorEnabled] * Specifies whether writeAccelerator should be enabled or disabled on the * disk. - * @member {number} [virtualMachineProfile.storageProfile.osDisk.diskSizeGB] - * Specifies the size of the operating system disk in gigabytes. This element - * can be used to overwrite the size of the disk in a virtual machine image. - *

    This value cannot be larger than 1023 GB - * @member {object} [virtualMachineProfile.storageProfile.osDisk.image] The + * @property {number} + * [virtualMachineProfile.storageProfile.osDisk.diskSizeGB] Specifies the + * size of the operating system disk in gigabytes. This element can be used + * to overwrite the size of the disk in a virtual machine image.

    + * This value cannot be larger than 1023 GB + * @property {object} [virtualMachineProfile.storageProfile.osDisk.image] The * Source User Image VirtualHardDisk. This VirtualHardDisk will be copied * before using it to attach to the Virtual Machine. If SourceImage is * provided, the destination VirtualHardDisk should not exist. - * @member {string} [virtualMachineProfile.storageProfile.osDisk.image.uri] + * @property {string} [virtualMachineProfile.storageProfile.osDisk.image.uri] * Specifies the virtual hard disk's uri. - * @member {array} + * @property {array} * [virtualMachineProfile.storageProfile.osDisk.vhdContainers] The list of * virtual hard disk container uris. - * @member {object} [virtualMachineProfile.storageProfile.osDisk.managedDisk] - * The managed disk parameters. - * @member {string} + * @property {object} + * [virtualMachineProfile.storageProfile.osDisk.managedDisk] The managed disk + * parameters. + * @property {string} * [virtualMachineProfile.storageProfile.osDisk.managedDisk.storageAccountType] * Specifies the storage account type for the managed disk. NOTE: * UltraSSD_LRS can only be used with data disks, it cannot be used with OS * Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [virtualMachineProfile.storageProfile.dataDisks] The data - * disks. - * @member {object} [virtualMachineProfile.networkProfile] The virtual + * @property {array} [virtualMachineProfile.storageProfile.dataDisks] The + * data disks. + * @property {object} [virtualMachineProfile.networkProfile] The virtual * machine scale set network profile. - * @member {array} + * @property {array} * [virtualMachineProfile.networkProfile.networkInterfaceConfigurations] The * list of network configurations. - * @member {object} [virtualMachineProfile.diagnosticsProfile] The virtual + * @property {object} [virtualMachineProfile.diagnosticsProfile] The virtual * machine scale set diagnostics profile. - * @member {object} + * @property {object} * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics] Boot * Diagnostics is a debugging feature which allows you to view Console Output * and Screenshot to diagnose VM status.

    You can easily view the * output of your console log.

    Azure also enables you to see a * screenshot of the VM from the hypervisor. - * @member {boolean} + * @property {boolean} * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics.enabled] Whether * boot diagnostics should be enabled on the Virtual Machine. - * @member {string} + * @property {string} * [virtualMachineProfile.diagnosticsProfile.bootDiagnostics.storageUri] Uri * of the storage account to use for placing the console output and * screenshot. - * @member {object} [virtualMachineProfile.extensionProfile] The virtual + * @property {object} [virtualMachineProfile.extensionProfile] The virtual * machine scale set extension profile. - * @member {array} [virtualMachineProfile.extensionProfile.extensions] The + * @property {array} [virtualMachineProfile.extensionProfile.extensions] The * virtual machine scale set child extension resources. - * @member {string} [virtualMachineProfile.licenseType] The license type, + * @property {string} [virtualMachineProfile.licenseType] The license type, * which is for bring your own license scenario. - * @member {boolean} [overprovision] Specifies whether the Virtual Machine + * @property {boolean} [overprovision] Specifies whether the Virtual Machine * Scale Set should be overprovisioned. - * @member {boolean} [singlePlacementGroup] When true this limits the scale + * @property {boolean} [singlePlacementGroup] When true this limits the scale * set to a single placement group, of max size 100 virtual machines. - * @member {object} [identity] The identity of the virtual machine scale set, - * if configured. - * @member {string} [identity.principalId] The principal id of virtual + * @property {object} [identity] The identity of the virtual machine scale + * set, if configured. + * @property {string} [identity.principalId] The principal id of virtual * machine scale set identity. This property will only be provided for a * system assigned identity. - * @member {string} [identity.tenantId] The tenant id associated with the + * @property {string} [identity.tenantId] The tenant id associated with the * virtual machine scale set. This property will only be provided for a * system assigned identity. - * @member {string} [identity.type] The type of identity used for the virtual - * machine scale set. The type 'SystemAssigned, UserAssigned' includes both - * an implicitly created identity and a set of user assigned identities. The - * type 'None' will remove any identities from the virtual machine scale set. - * Possible values include: 'SystemAssigned', 'UserAssigned', - * 'SystemAssigned, UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user + * @property {string} [identity.type] The type of identity used for the + * virtual machine scale set. The type 'SystemAssigned, UserAssigned' + * includes both an implicitly created identity and a set of user assigned + * identities. The type 'None' will remove any identities from the virtual + * machine scale set. Possible values include: 'SystemAssigned', + * 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + * @property {object} [identity.userAssignedIdentities] The list of user * identities associated with the virtual machine scale set. The user * identity dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateIPConfiguration.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateIPConfiguration.js index 602dae90fc..8b3909b122 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateIPConfiguration.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateIPConfiguration.js @@ -20,35 +20,35 @@ const models = require('./index'); class VirtualMachineScaleSetUpdateIPConfiguration extends models['SubResource'] { /** * Create a VirtualMachineScaleSetUpdateIPConfiguration. - * @member {string} [name] The IP configuration name. - * @member {object} [subnet] The subnet. - * @member {string} [subnet.id] The ARM resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {boolean} [primary] Specifies the primary IP Configuration in case - * the network interface has more than one IP Configuration. - * @member {object} [publicIPAddressConfiguration] The + * @property {string} [name] The IP configuration name. + * @property {object} [subnet] The subnet. + * @property {string} [subnet.id] The ARM resource id in the form of + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + * @property {boolean} [primary] Specifies the primary IP Configuration in + * case the network interface has more than one IP Configuration. + * @property {object} [publicIPAddressConfiguration] The * publicIPAddressConfiguration. - * @member {string} [publicIPAddressConfiguration.name] The publicIP address - * configuration name. - * @member {number} [publicIPAddressConfiguration.idleTimeoutInMinutes] The + * @property {string} [publicIPAddressConfiguration.name] The publicIP + * address configuration name. + * @property {number} [publicIPAddressConfiguration.idleTimeoutInMinutes] The * idle timeout of the public IP address. - * @member {object} [publicIPAddressConfiguration.dnsSettings] The dns + * @property {object} [publicIPAddressConfiguration.dnsSettings] The dns * settings to be applied on the publicIP addresses . - * @member {string} + * @property {string} * [publicIPAddressConfiguration.dnsSettings.domainNameLabel] The Domain name * label.The concatenation of the domain name label and vm index will be the * domain name labels of the PublicIPAddress resources that will be created - * @member {string} [privateIPAddressVersion] Available from Api-Version + * @property {string} [privateIPAddressVersion] Available from Api-Version * 2017-03-30 onwards, it represents whether the specific ipconfiguration is * IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and * 'IPv6'. Possible values include: 'IPv4', 'IPv6' - * @member {array} [applicationGatewayBackendAddressPools] The application + * @property {array} [applicationGatewayBackendAddressPools] The application * gateway backend address pools. - * @member {array} [applicationSecurityGroups] Specifies an array of + * @property {array} [applicationSecurityGroups] Specifies an array of * references to application security group. - * @member {array} [loadBalancerBackendAddressPools] The load balancer + * @property {array} [loadBalancerBackendAddressPools] The load balancer * backend address pools. - * @member {array} [loadBalancerInboundNatPools] The load balancer inbound + * @property {array} [loadBalancerInboundNatPools] The load balancer inbound * nat pools. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateNetworkConfiguration.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateNetworkConfiguration.js index 873e9ce870..27aa99abba 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateNetworkConfiguration.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateNetworkConfiguration.js @@ -21,19 +21,20 @@ const models = require('./index'); class VirtualMachineScaleSetUpdateNetworkConfiguration extends models['SubResource'] { /** * Create a VirtualMachineScaleSetUpdateNetworkConfiguration. - * @member {string} [name] The network configuration name. - * @member {boolean} [primary] Whether this is a primary NIC on a virtual + * @property {string} [name] The network configuration name. + * @property {boolean} [primary] Whether this is a primary NIC on a virtual * machine. - * @member {boolean} [enableAcceleratedNetworking] Specifies whether the + * @property {boolean} [enableAcceleratedNetworking] Specifies whether the * network interface is accelerated networking-enabled. - * @member {object} [networkSecurityGroup] The network security group. - * @member {string} [networkSecurityGroup.id] Resource Id - * @member {object} [dnsSettings] The dns settings to be applied on the + * @property {object} [networkSecurityGroup] The network security group. + * @property {string} [networkSecurityGroup.id] Resource Id + * @property {object} [dnsSettings] The dns settings to be applied on the * network interfaces. - * @member {array} [dnsSettings.dnsServers] List of DNS servers IP addresses - * @member {array} [ipConfigurations] The virtual machine scale set IP + * @property {array} [dnsSettings.dnsServers] List of DNS servers IP + * addresses + * @property {array} [ipConfigurations] The virtual machine scale set IP * Configuration. - * @member {boolean} [enableIPForwarding] Whether IP forwarding enabled on + * @property {boolean} [enableIPForwarding] Whether IP forwarding enabled on * this NIC. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateNetworkProfile.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateNetworkProfile.js index cddb45cbfe..53e3f1e903 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateNetworkProfile.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateNetworkProfile.js @@ -17,7 +17,7 @@ class VirtualMachineScaleSetUpdateNetworkProfile { /** * Create a VirtualMachineScaleSetUpdateNetworkProfile. - * @member {array} [networkInterfaceConfigurations] The list of network + * @property {array} [networkInterfaceConfigurations] The list of network * configurations. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateOSDisk.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateOSDisk.js index df462dd2c8..ab7751a897 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateOSDisk.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateOSDisk.js @@ -18,23 +18,23 @@ class VirtualMachineScaleSetUpdateOSDisk { /** * Create a VirtualMachineScaleSetUpdateOSDisk. - * @member {string} [caching] The caching type. Possible values include: + * @property {string} [caching] The caching type. Possible values include: * 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [writeAcceleratorEnabled] Specifies whether + * @property {boolean} [writeAcceleratorEnabled] Specifies whether * writeAccelerator should be enabled or disabled on the disk. - * @member {number} [diskSizeGB] Specifies the size of the operating system + * @property {number} [diskSizeGB] Specifies the size of the operating system * disk in gigabytes. This element can be used to overwrite the size of the * disk in a virtual machine image.

    This value cannot be larger than * 1023 GB - * @member {object} [image] The Source User Image VirtualHardDisk. This + * @property {object} [image] The Source User Image VirtualHardDisk. This * VirtualHardDisk will be copied before using it to attach to the Virtual * Machine. If SourceImage is provided, the destination VirtualHardDisk * should not exist. - * @member {string} [image.uri] Specifies the virtual hard disk's uri. - * @member {array} [vhdContainers] The list of virtual hard disk container + * @property {string} [image.uri] Specifies the virtual hard disk's uri. + * @property {array} [vhdContainers] The list of virtual hard disk container * uris. - * @member {object} [managedDisk] The managed disk parameters. - * @member {string} [managedDisk.storageAccountType] Specifies the storage + * @property {object} [managedDisk] The managed disk parameters. + * @property {string} [managedDisk.storageAccountType] Specifies the storage * account type for the managed disk. NOTE: UltraSSD_LRS can only be used * with data disks, it cannot be used with OS Disk. Possible values include: * 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateOSProfile.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateOSProfile.js index 90c31f219f..153a6bb58d 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateOSProfile.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateOSProfile.js @@ -17,39 +17,40 @@ class VirtualMachineScaleSetUpdateOSProfile { /** * Create a VirtualMachineScaleSetUpdateOSProfile. - * @member {string} [customData] A base-64 encoded string of custom data. - * @member {object} [windowsConfiguration] The Windows Configuration of the + * @property {string} [customData] A base-64 encoded string of custom data. + * @property {object} [windowsConfiguration] The Windows Configuration of the * OS profile. - * @member {boolean} [windowsConfiguration.provisionVMAgent] Indicates + * @property {boolean} [windowsConfiguration.provisionVMAgent] Indicates * whether virtual machine agent should be provisioned on the virtual * machine.

    When this property is not specified in the request body, * default behavior is to set it to true. This will ensure that VM Agent is * installed on the VM so that extensions can be added to the VM later. - * @member {boolean} [windowsConfiguration.enableAutomaticUpdates] Indicates - * whether virtual machine is enabled for automatic updates. - * @member {string} [windowsConfiguration.timeZone] Specifies the time zone + * @property {boolean} [windowsConfiguration.enableAutomaticUpdates] + * Indicates whether virtual machine is enabled for automatic updates. + * @property {string} [windowsConfiguration.timeZone] Specifies the time zone * of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [windowsConfiguration.additionalUnattendContent] Specifies - * additional base-64 encoded XML formatted information that can be included - * in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [windowsConfiguration.winRM] Specifies the Windows Remote - * Management listeners. This enables remote Windows PowerShell. - * @member {array} [windowsConfiguration.winRM.listeners] The list of Windows - * Remote Management listeners - * @member {object} [linuxConfiguration] The Linux Configuration of the OS + * @property {array} [windowsConfiguration.additionalUnattendContent] + * Specifies additional base-64 encoded XML formatted information that can be + * included in the Unattend.xml file, which is used by Windows Setup. + * @property {object} [windowsConfiguration.winRM] Specifies the Windows + * Remote Management listeners. This enables remote Windows PowerShell. + * @property {array} [windowsConfiguration.winRM.listeners] The list of + * Windows Remote Management listeners + * @property {object} [linuxConfiguration] The Linux Configuration of the OS * profile. - * @member {boolean} [linuxConfiguration.disablePasswordAuthentication] + * @property {boolean} [linuxConfiguration.disablePasswordAuthentication] * Specifies whether password authentication should be disabled. - * @member {object} [linuxConfiguration.ssh] Specifies the ssh key + * @property {object} [linuxConfiguration.ssh] Specifies the ssh key * configuration for a Linux OS. - * @member {array} [linuxConfiguration.ssh.publicKeys] The list of SSH public - * keys used to authenticate with linux based VMs. - * @member {boolean} [linuxConfiguration.provisionVMAgent] Indicates whether - * virtual machine agent should be provisioned on the virtual machine. - *

    When this property is not specified in the request body, default - * behavior is to set it to true. This will ensure that VM Agent is + * @property {array} [linuxConfiguration.ssh.publicKeys] The list of SSH + * public keys used to authenticate with linux based VMs. + * @property {boolean} [linuxConfiguration.provisionVMAgent] Indicates + * whether virtual machine agent should be provisioned on the virtual + * machine.

    When this property is not specified in the request body, + * default behavior is to set it to true. This will ensure that VM Agent is * installed on the VM so that extensions can be added to the VM later. - * @member {array} [secrets] The List of certificates for addition to the VM. + * @property {array} [secrets] The List of certificates for addition to the + * VM. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdatePublicIPAddressConfiguration.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdatePublicIPAddressConfiguration.js index 840a0afbf0..c62f0e5e5b 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdatePublicIPAddressConfiguration.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdatePublicIPAddressConfiguration.js @@ -18,12 +18,12 @@ class VirtualMachineScaleSetUpdatePublicIPAddressConfiguration { /** * Create a VirtualMachineScaleSetUpdatePublicIPAddressConfiguration. - * @member {string} [name] The publicIP address configuration name. - * @member {number} [idleTimeoutInMinutes] The idle timeout of the public IP - * address. - * @member {object} [dnsSettings] The dns settings to be applied on the + * @property {string} [name] The publicIP address configuration name. + * @property {number} [idleTimeoutInMinutes] The idle timeout of the public + * IP address. + * @property {object} [dnsSettings] The dns settings to be applied on the * publicIP addresses . - * @member {string} [dnsSettings.domainNameLabel] The Domain name label.The + * @property {string} [dnsSettings.domainNameLabel] The Domain name label.The * concatenation of the domain name label and vm index will be the domain * name labels of the PublicIPAddress resources that will be created */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateStorageProfile.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateStorageProfile.js index f2cbc4aa8f..24bb16dd4b 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateStorageProfile.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateStorageProfile.js @@ -17,40 +17,41 @@ class VirtualMachineScaleSetUpdateStorageProfile { /** * Create a VirtualMachineScaleSetUpdateStorageProfile. - * @member {object} [imageReference] The image reference. - * @member {string} [imageReference.publisher] The image publisher. - * @member {string} [imageReference.offer] Specifies the offer of the + * @property {object} [imageReference] The image reference. + * @property {string} [imageReference.publisher] The image publisher. + * @property {string} [imageReference.offer] Specifies the offer of the * platform image or marketplace image used to create the virtual machine. - * @member {string} [imageReference.sku] The image SKU. - * @member {string} [imageReference.version] Specifies the version of the + * @property {string} [imageReference.sku] The image SKU. + * @property {string} [imageReference.version] Specifies the version of the * platform image or marketplace image used to create the virtual machine. * The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and * Build are decimal numbers. Specify 'latest' to use the latest version of * an image available at deploy time. Even if you use 'latest', the VM image * will not automatically update after deploy time even if a new version * becomes available. - * @member {object} [osDisk] The OS disk. - * @member {string} [osDisk.caching] The caching type. Possible values + * @property {object} [osDisk] The OS disk. + * @property {string} [osDisk.caching] The caching type. Possible values * include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [osDisk.writeAcceleratorEnabled] Specifies whether + * @property {boolean} [osDisk.writeAcceleratorEnabled] Specifies whether * writeAccelerator should be enabled or disabled on the disk. - * @member {number} [osDisk.diskSizeGB] Specifies the size of the operating + * @property {number} [osDisk.diskSizeGB] Specifies the size of the operating * system disk in gigabytes. This element can be used to overwrite the size * of the disk in a virtual machine image.

    This value cannot be * larger than 1023 GB - * @member {object} [osDisk.image] The Source User Image VirtualHardDisk. + * @property {object} [osDisk.image] The Source User Image VirtualHardDisk. * This VirtualHardDisk will be copied before using it to attach to the * Virtual Machine. If SourceImage is provided, the destination * VirtualHardDisk should not exist. - * @member {string} [osDisk.image.uri] Specifies the virtual hard disk's uri. - * @member {array} [osDisk.vhdContainers] The list of virtual hard disk + * @property {string} [osDisk.image.uri] Specifies the virtual hard disk's + * uri. + * @property {array} [osDisk.vhdContainers] The list of virtual hard disk * container uris. - * @member {object} [osDisk.managedDisk] The managed disk parameters. - * @member {string} [osDisk.managedDisk.storageAccountType] Specifies the + * @property {object} [osDisk.managedDisk] The managed disk parameters. + * @property {string} [osDisk.managedDisk.storageAccountType] Specifies the * storage account type for the managed disk. NOTE: UltraSSD_LRS can only be * used with data disks, it cannot be used with OS Disk. Possible values * include: 'Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [dataDisks] The data disks. + * @property {array} [dataDisks] The data disks. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateVMProfile.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateVMProfile.js index 6894c64882..6a5d882c05 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateVMProfile.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetUpdateVMProfile.js @@ -17,108 +17,110 @@ class VirtualMachineScaleSetUpdateVMProfile { /** * Create a VirtualMachineScaleSetUpdateVMProfile. - * @member {object} [osProfile] The virtual machine scale set OS profile. - * @member {string} [osProfile.customData] A base-64 encoded string of custom - * data. - * @member {object} [osProfile.windowsConfiguration] The Windows + * @property {object} [osProfile] The virtual machine scale set OS profile. + * @property {string} [osProfile.customData] A base-64 encoded string of + * custom data. + * @property {object} [osProfile.windowsConfiguration] The Windows * Configuration of the OS profile. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] + * @property {boolean} [osProfile.windowsConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the + * @property {boolean} + * [osProfile.windowsConfiguration.enableAutomaticUpdates] Indicates whether + * virtual machine is enabled for automatic updates. + * @property {string} [osProfile.windowsConfiguration.timeZone] Specifies the * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the + * @property {array} + * [osProfile.windowsConfiguration.additionalUnattendContent] Specifies + * additional base-64 encoded XML formatted information that can be included + * in the Unattend.xml file, which is used by Windows Setup. + * @property {object} [osProfile.windowsConfiguration.winRM] Specifies the * Windows Remote Management listeners. This enables remote Windows * PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list - * of Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] The Linux Configuration of - * the OS profile. - * @member {boolean} + * @property {array} [osProfile.windowsConfiguration.winRM.listeners] The + * list of Windows Remote Management listeners + * @property {object} [osProfile.linuxConfiguration] The Linux Configuration + * of the OS profile. + * @property {boolean} * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] + * @property {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh + * key configuration for a Linux OS. + * @property {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list + * of SSH public keys used to authenticate with linux based VMs. + * @property {boolean} [osProfile.linuxConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {array} [osProfile.secrets] The List of certificates for addition - * to the VM. - * @member {object} [storageProfile] The virtual machine scale set storage + * @property {array} [osProfile.secrets] The List of certificates for + * addition to the VM. + * @property {object} [storageProfile] The virtual machine scale set storage * profile. - * @member {object} [storageProfile.imageReference] The image reference. - * @member {string} [storageProfile.imageReference.publisher] The image + * @property {object} [storageProfile.imageReference] The image reference. + * @property {string} [storageProfile.imageReference.publisher] The image * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the + * @property {string} [storageProfile.imageReference.offer] Specifies the + * offer of the platform image or marketplace image used to create the + * virtual machine. + * @property {string} [storageProfile.imageReference.sku] The image SKU. + * @property {string} [storageProfile.imageReference.version] Specifies the * version of the platform image or marketplace image used to create the * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the * latest version of an image available at deploy time. Even if you use * 'latest', the VM image will not automatically update after deploy time * even if a new version becomes available. - * @member {object} [storageProfile.osDisk] The OS disk. - * @member {string} [storageProfile.osDisk.caching] The caching type. + * @property {object} [storageProfile.osDisk] The OS disk. + * @property {string} [storageProfile.osDisk.caching] The caching type. * Possible values include: 'None', 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] + * @property {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] * Specifies whether writeAccelerator should be enabled or disabled on the * disk. - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * the operating system disk in gigabytes. This element can be used to + * @property {number} [storageProfile.osDisk.diskSizeGB] Specifies the size + * of the operating system disk in gigabytes. This element can be used to * overwrite the size of the disk in a virtual machine image.

    This * value cannot be larger than 1023 GB - * @member {object} [storageProfile.osDisk.image] The Source User Image + * @property {object} [storageProfile.osDisk.image] The Source User Image * VirtualHardDisk. This VirtualHardDisk will be copied before using it to * attach to the Virtual Machine. If SourceImage is provided, the destination * VirtualHardDisk should not exist. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual + * @property {string} [storageProfile.osDisk.image.uri] Specifies the virtual * hard disk's uri. - * @member {array} [storageProfile.osDisk.vhdContainers] The list of virtual - * hard disk container uris. - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk + * @property {array} [storageProfile.osDisk.vhdContainers] The list of + * virtual hard disk container uris. + * @property {object} [storageProfile.osDisk.managedDisk] The managed disk * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] + * @property {string} [storageProfile.osDisk.managedDisk.storageAccountType] * Specifies the storage account type for the managed disk. NOTE: * UltraSSD_LRS can only be used with data disks, it cannot be used with OS * Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] The data disks. - * @member {object} [networkProfile] The virtual machine scale set network + * @property {array} [storageProfile.dataDisks] The data disks. + * @property {object} [networkProfile] The virtual machine scale set network * profile. - * @member {array} [networkProfile.networkInterfaceConfigurations] The list + * @property {array} [networkProfile.networkInterfaceConfigurations] The list * of network configurations. - * @member {object} [diagnosticsProfile] The virtual machine scale set + * @property {object} [diagnosticsProfile] The virtual machine scale set * diagnostics profile. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is - * a debugging feature which allows you to view Console Output and Screenshot - * to diagnose VM status.

    You can easily view the output of your - * console log.

    Azure also enables you to see a screenshot of the VM - * from the hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether + * @property {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics + * is a debugging feature which allows you to view Console Output and + * Screenshot to diagnose VM status.

    You can easily view the output + * of your console log.

    Azure also enables you to see a screenshot + * of the VM from the hypervisor. + * @property {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether * boot diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of + * @property {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of * the storage account to use for placing the console output and screenshot. - * @member {object} [extensionProfile] The virtual machine scale set + * @property {object} [extensionProfile] The virtual machine scale set * extension profile. - * @member {array} [extensionProfile.extensions] The virtual machine scale + * @property {array} [extensionProfile.extensions] The virtual machine scale * set child extension resources. - * @member {string} [licenseType] The license type, which is for bring your + * @property {string} [licenseType] The license type, which is for bring your * own license scenario. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVM.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVM.js index 0c7b259f9a..3e4d141ea9 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVM.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVM.js @@ -20,98 +20,102 @@ const models = require('./index'); class VirtualMachineScaleSetVM extends models['Resource'] { /** * Create a VirtualMachineScaleSetVM. - * @member {string} [instanceId] The virtual machine instance ID. - * @member {object} [sku] The virtual machine SKU. - * @member {string} [sku.name] The sku name. - * @member {string} [sku.tier] Specifies the tier of virtual machines in a + * @property {string} [instanceId] The virtual machine instance ID. + * @property {object} [sku] The virtual machine SKU. + * @property {string} [sku.name] The sku name. + * @property {string} [sku.tier] Specifies the tier of virtual machines in a * scale set.

    Possible Values:

    **Standard**

    **Basic** - * @member {number} [sku.capacity] Specifies the number of virtual machines + * @property {number} [sku.capacity] Specifies the number of virtual machines * in the scale set. - * @member {boolean} [latestModelApplied] Specifies whether the latest model - * has been applied to the virtual machine. - * @member {string} [vmId] Azure VM unique ID. - * @member {object} [instanceView] The virtual machine instance view. - * @member {number} [instanceView.platformUpdateDomain] The Update Domain + * @property {boolean} [latestModelApplied] Specifies whether the latest + * model has been applied to the virtual machine. + * @property {boolean} [protectFromScaleIn] Specifies whether the virtual + * machine instance shouldn't be considered for deletion during a scale-in + * operation + * @property {string} [vmId] Azure VM unique ID. + * @property {object} [instanceView] The virtual machine instance view. + * @property {number} [instanceView.platformUpdateDomain] The Update Domain * count. - * @member {number} [instanceView.platformFaultDomain] The Fault Domain + * @property {number} [instanceView.platformFaultDomain] The Fault Domain * count. - * @member {string} [instanceView.rdpThumbPrint] The Remote desktop + * @property {string} [instanceView.rdpThumbPrint] The Remote desktop * certificate thumbprint. - * @member {object} [instanceView.vmAgent] The VM Agent running on the + * @property {object} [instanceView.vmAgent] The VM Agent running on the * virtual machine. - * @member {string} [instanceView.vmAgent.vmAgentVersion] The VM Agent full + * @property {string} [instanceView.vmAgent.vmAgentVersion] The VM Agent full * version. - * @member {array} [instanceView.vmAgent.extensionHandlers] The virtual + * @property {array} [instanceView.vmAgent.extensionHandlers] The virtual * machine extension handler instance view. - * @member {array} [instanceView.vmAgent.statuses] The resource status + * @property {array} [instanceView.vmAgent.statuses] The resource status * information. - * @member {object} [instanceView.maintenanceRedeployStatus] The Maintenance - * Operation status on the virtual machine. - * @member {boolean} + * @property {object} [instanceView.maintenanceRedeployStatus] The + * Maintenance Operation status on the virtual machine. + * @property {boolean} * [instanceView.maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] * True, if customer is allowed to perform Maintenance. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowStartTime] * Start Time for the Pre Maintenance Window. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowEndTime] End * Time for the Pre Maintenance Window. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.maintenanceWindowStartTime] Start * Time for the Maintenance Window. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.maintenanceWindowEndTime] End Time * for the Maintenance Window. - * @member {string} + * @property {string} * [instanceView.maintenanceRedeployStatus.lastOperationResultCode] The Last * Maintenance Operation Result Code. Possible values include: 'None', * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} + * @property {string} * [instanceView.maintenanceRedeployStatus.lastOperationMessage] Message * returned for the last Maintenance Operation. - * @member {array} [instanceView.disks] The disks information. - * @member {array} [instanceView.extensions] The extensions information. - * @member {object} [instanceView.vmHealth] The health status for the VM. - * @member {object} [instanceView.vmHealth.status] The health status + * @property {array} [instanceView.disks] The disks information. + * @property {array} [instanceView.extensions] The extensions information. + * @property {object} [instanceView.vmHealth] The health status for the VM. + * @property {object} [instanceView.vmHealth.status] The health status * information for the VM. - * @member {string} [instanceView.vmHealth.status.code] The status code. - * @member {string} [instanceView.vmHealth.status.level] The level code. + * @property {string} [instanceView.vmHealth.status.code] The status code. + * @property {string} [instanceView.vmHealth.status.level] The level code. * Possible values include: 'Info', 'Warning', 'Error' - * @member {string} [instanceView.vmHealth.status.displayStatus] The short + * @property {string} [instanceView.vmHealth.status.displayStatus] The short * localizable label for the status. - * @member {string} [instanceView.vmHealth.status.message] The detailed + * @property {string} [instanceView.vmHealth.status.message] The detailed * status message, including for alerts and error messages. - * @member {date} [instanceView.vmHealth.status.time] The time of the status. - * @member {object} [instanceView.bootDiagnostics] Boot Diagnostics is a + * @property {date} [instanceView.vmHealth.status.time] The time of the + * status. + * @property {object} [instanceView.bootDiagnostics] Boot Diagnostics is a * debugging feature which allows you to view Console Output and Screenshot * to diagnose VM status.

    You can easily view the output of your * console log.

    Azure also enables you to see a screenshot of the VM * from the hypervisor. - * @member {string} [instanceView.bootDiagnostics.consoleScreenshotBlobUri] + * @property {string} [instanceView.bootDiagnostics.consoleScreenshotBlobUri] * The console screenshot blob URI. - * @member {string} [instanceView.bootDiagnostics.serialConsoleLogBlobUri] + * @property {string} [instanceView.bootDiagnostics.serialConsoleLogBlobUri] * The Linux serial console log blob Uri. - * @member {object} [instanceView.bootDiagnostics.status] The boot + * @property {object} [instanceView.bootDiagnostics.status] The boot * diagnostics status information for the VM.

    NOTE: It will be set * only if there are errors encountered in enabling boot diagnostics. - * @member {string} [instanceView.bootDiagnostics.status.code] The status + * @property {string} [instanceView.bootDiagnostics.status.code] The status * code. - * @member {string} [instanceView.bootDiagnostics.status.level] The level + * @property {string} [instanceView.bootDiagnostics.status.level] The level * code. Possible values include: 'Info', 'Warning', 'Error' - * @member {string} [instanceView.bootDiagnostics.status.displayStatus] The + * @property {string} [instanceView.bootDiagnostics.status.displayStatus] The * short localizable label for the status. - * @member {string} [instanceView.bootDiagnostics.status.message] The + * @property {string} [instanceView.bootDiagnostics.status.message] The * detailed status message, including for alerts and error messages. - * @member {date} [instanceView.bootDiagnostics.status.time] The time of the - * status. - * @member {array} [instanceView.statuses] The resource status information. - * @member {string} [instanceView.placementGroupId] The placement group in + * @property {date} [instanceView.bootDiagnostics.status.time] The time of + * the status. + * @property {array} [instanceView.statuses] The resource status information. + * @property {string} [instanceView.placementGroupId] The placement group in * which the VM is running. If the VM is deallocated it will not have a * placementGroupId. - * @member {object} [hardwareProfile] Specifies the hardware settings for the - * virtual machine. - * @member {string} [hardwareProfile.vmSize] Specifies the size of the + * @property {object} [hardwareProfile] Specifies the hardware settings for + * the virtual machine. + * @property {string} [hardwareProfile.vmSize] Specifies the size of the * virtual machine. For more information about virtual machine sizes, see * [Sizes for virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). @@ -169,90 +173,90 @@ class VirtualMachineScaleSetVM extends models['Resource'] { * 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', * 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', * 'Standard_NV12', 'Standard_NV24' - * @member {object} [storageProfile] Specifies the storage settings for the + * @property {object} [storageProfile] Specifies the storage settings for the * virtual machine disks. - * @member {object} [storageProfile.imageReference] Specifies information + * @property {object} [storageProfile.imageReference] Specifies information * about the image to use. You can specify information about platform images, * marketplace images, or virtual machine images. This element is required * when you want to use a platform image, marketplace image, or virtual * machine image, but is not used in other creation operations. - * @member {string} [storageProfile.imageReference.publisher] The image + * @property {string} [storageProfile.imageReference.publisher] The image * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the + * @property {string} [storageProfile.imageReference.offer] Specifies the + * offer of the platform image or marketplace image used to create the + * virtual machine. + * @property {string} [storageProfile.imageReference.sku] The image SKU. + * @property {string} [storageProfile.imageReference.version] Specifies the * version of the platform image or marketplace image used to create the * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the * latest version of an image available at deploy time. Even if you use * 'latest', the VM image will not automatically update after deploy time * even if a new version becomes available. - * @member {object} [storageProfile.osDisk] Specifies information about the + * @property {object} [storageProfile.osDisk] Specifies information about the * operating system disk used by the virtual machine.

    For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you + * @property {string} [storageProfile.osDisk.osType] This property allows you * to specify the type of the OS that is included in the disk if creating a * VM from user-image or a specialized VHD.

    Possible values are: *

    **Windows**

    **Linux**. Possible values include: * 'Windows', 'Linux' - * @member {object} [storageProfile.osDisk.encryptionSettings] Specifies the - * encryption settings for the OS Disk.

    Minimum api-version: + * @property {object} [storageProfile.osDisk.encryptionSettings] Specifies + * the encryption settings for the OS Disk.

    Minimum api-version: * 2015-06-15 - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey] Specifies the * location of the disk encryption key, which is a Key Vault Secret. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.secretUrl] The * URL referencing a secret in a Key Vault. - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault] * The relative URL of the Key Vault containing the secret. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault.id] * Resource Id - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey] Specifies the * location of the key encryption key in Key Vault. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.keyUrl] The URL * referencing a key encryption key in Key Vault. - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault] * The relative URL of the Key Vault containing the key. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault.id] * Resource Id - * @member {boolean} [storageProfile.osDisk.encryptionSettings.enabled] + * @property {boolean} [storageProfile.osDisk.encryptionSettings.enabled] * Specifies whether disk encryption should be enabled on the virtual * machine. - * @member {string} [storageProfile.osDisk.name] The disk name. - * @member {object} [storageProfile.osDisk.vhd] The virtual hard disk. - * @member {string} [storageProfile.osDisk.vhd.uri] Specifies the virtual + * @property {string} [storageProfile.osDisk.name] The disk name. + * @property {object} [storageProfile.osDisk.vhd] The virtual hard disk. + * @property {string} [storageProfile.osDisk.vhd.uri] Specifies the virtual * hard disk's uri. - * @member {object} [storageProfile.osDisk.image] The source user image + * @property {object} [storageProfile.osDisk.image] The source user image * virtual hard disk. The virtual hard disk will be copied before being * attached to the virtual machine. If SourceImage is provided, the * destination virtual hard drive must not exist. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual + * @property {string} [storageProfile.osDisk.image.uri] Specifies the virtual * hard disk's uri. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching + * @property {string} [storageProfile.osDisk.caching] Specifies the caching * requirements.

    Possible values are:

    **None**

    * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard * storage. ReadOnly for Premium storage**. Possible values include: 'None', * 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] + * @property {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] * Specifies whether writeAccelerator should be enabled or disabled on the * disk. - * @member {object} [storageProfile.osDisk.diffDiskSettings] Specifies the - * differencing Disk Settings for the operating system disk used by the - * virtual machine. - * @member {string} [storageProfile.osDisk.diffDiskSettings.option] Specifies - * the differencing disk settings for operating system disk. Possible values - * include: 'Local' - * @member {string} [storageProfile.osDisk.createOption] Specifies how the + * @property {object} [storageProfile.osDisk.diffDiskSettings] Specifies the + * ephemeral Disk Settings for the operating system disk used by the virtual + * machine. + * @property {string} [storageProfile.osDisk.diffDiskSettings.option] + * Specifies the ephemeral disk settings for operating system disk. Possible + * values include: 'Local' + * @property {string} [storageProfile.osDisk.createOption] Specifies how the * virtual machine should be created.

    Possible values are:

    * **Attach** \u2013 This value is used when you are using a specialized disk * to create the virtual machine.

    **FromImage** \u2013 This value is @@ -261,39 +265,39 @@ class VirtualMachineScaleSetVM extends models['Resource'] { * above. If you are using a marketplace image, you also use the plan * element previously described. Possible values include: 'FromImage', * 'Empty', 'Attach' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * an empty data disk in gigabytes. This element can be used to overwrite the - * size of the disk in a virtual machine image.

    This value cannot be - * larger than 1023 GB - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk + * @property {number} [storageProfile.osDisk.diskSizeGB] Specifies the size + * of an empty data disk in gigabytes. This element can be used to overwrite + * the size of the disk in a virtual machine image.

    This value + * cannot be larger than 1023 GB + * @property {object} [storageProfile.osDisk.managedDisk] The managed disk * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] + * @property {string} [storageProfile.osDisk.managedDisk.storageAccountType] * Specifies the storage account type for the managed disk. NOTE: * UltraSSD_LRS can only be used with data disks, it cannot be used with OS * Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that + * @property {array} [storageProfile.dataDisks] Specifies the parameters that * are used to add a data disk to a virtual machine.

    For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [additionalCapabilities] Specifies additional + * @property {object} [additionalCapabilities] Specifies additional * capabilities enabled or disabled on the virtual machine in the scale set. * For instance: whether the virtual machine has the capability to support * attaching managed data disks with UltraSSD_LRS storage account type. - * @member {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that + * @property {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that * enables or disables a capability to have one or more managed data disks * with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks * with storage account type UltraSSD_LRS can be added to a virtual machine * or virtual machine scale set only if this property is enabled. - * @member {object} [osProfile] Specifies the operating system settings for + * @property {object} [osProfile] Specifies the operating system settings for * the virtual machine. - * @member {string} [osProfile.computerName] Specifies the host OS name of - * the virtual machine.

    **Max-length (Windows):** 15 characters - *

    **Max-length (Linux):** 64 characters.

    For naming - * conventions and restrictions see [Azure infrastructure services - * implementation + * @property {string} [osProfile.computerName] Specifies the host OS name of + * the virtual machine.

    This name cannot be updated after the VM is + * created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). - * @member {string} [osProfile.adminUsername] Specifies the name of the + * @property {string} [osProfile.adminUsername] Specifies the name of the * administrator account.

    **Windows-only restriction:** Cannot end * in "."

    **Disallowed values:** "administrator", "admin", "user", * "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", @@ -308,7 +312,7 @@ class VirtualMachineScaleSetVM extends models['Resource'] { * For a list of built-in system users on Linux that should not be used in * this field, see [Selecting User Names for Linux on * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [osProfile.adminPassword] Specifies the password of the + * @property {string} [osProfile.adminPassword] Specifies the password of the * administrator account.

    **Minimum-length (Windows):** 8 characters *

    **Minimum-length (Linux):** 6 characters

    **Max-length * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters @@ -323,89 +327,91 @@ class VirtualMachineScaleSetVM extends models['Resource'] { *

    For resetting root password, see [Manage users, SSH, and check or * repair disks on Azure Linux VMs using the VMAccess * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [osProfile.customData] Specifies a base-64 encoded string - * of custom data. The base-64 encoded string is decoded to a binary array - * that is saved as a file on the Virtual Machine. The maximum length of the - * binary array is 65535 bytes.

    For using cloud-init for your VM, - * see [Using cloud-init to customize a Linux VM during + * @property {string} [osProfile.customData] Specifies a base-64 encoded + * string of custom data. The base-64 encoded string is decoded to a binary + * array that is saved as a file on the Virtual Machine. The maximum length + * of the binary array is 65535 bytes.

    For using cloud-init for your + * VM, see [Using cloud-init to customize a Linux VM during * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [osProfile.windowsConfiguration] Specifies Windows + * @property {object} [osProfile.windowsConfiguration] Specifies Windows * operating system settings on the virtual machine. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] + * @property {boolean} [osProfile.windowsConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the + * @property {boolean} + * [osProfile.windowsConfiguration.enableAutomaticUpdates] Indicates whether + * virtual machine is enabled for automatic updates. + * @property {string} [osProfile.windowsConfiguration.timeZone] Specifies the * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the + * @property {array} + * [osProfile.windowsConfiguration.additionalUnattendContent] Specifies + * additional base-64 encoded XML formatted information that can be included + * in the Unattend.xml file, which is used by Windows Setup. + * @property {object} [osProfile.windowsConfiguration.winRM] Specifies the * Windows Remote Management listeners. This enables remote Windows * PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list - * of Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] Specifies the Linux + * @property {array} [osProfile.windowsConfiguration.winRM.listeners] The + * list of Windows Remote Management listeners + * @property {object} [osProfile.linuxConfiguration] Specifies the Linux * operating system settings on the virtual machine.

    For a list of * supported Linux distributions, see [Linux on Azure-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) *

    For running non-endorsed distributions, see [Information for * Non-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} + * @property {boolean} * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] + * @property {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh + * key configuration for a Linux OS. + * @property {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list + * of SSH public keys used to authenticate with linux based VMs. + * @property {boolean} [osProfile.linuxConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {array} [osProfile.secrets] Specifies set of certificates that + * @property {array} [osProfile.secrets] Specifies set of certificates that * should be installed onto the virtual machine. - * @member {boolean} [osProfile.allowExtensionOperations] Specifies whether + * @property {boolean} [osProfile.allowExtensionOperations] Specifies whether * extension operations should be allowed on the virtual machine. *

    This may only be set to False when no extensions are present on * the virtual machine. - * @member {object} [networkProfile] Specifies the network interfaces of the - * virtual machine. - * @member {array} [networkProfile.networkInterfaces] Specifies the list of + * @property {object} [networkProfile] Specifies the network interfaces of + * the virtual machine. + * @property {array} [networkProfile.networkInterfaces] Specifies the list of * resource Ids for the network interfaces associated with the virtual * machine. - * @member {object} [diagnosticsProfile] Specifies the boot diagnostic + * @property {object} [diagnosticsProfile] Specifies the boot diagnostic * settings state.

    Minimum api-version: 2015-06-15. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is - * a debugging feature which allows you to view Console Output and Screenshot - * to diagnose VM status.

    You can easily view the output of your - * console log.

    Azure also enables you to see a screenshot of the VM - * from the hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether + * @property {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics + * is a debugging feature which allows you to view Console Output and + * Screenshot to diagnose VM status.

    You can easily view the output + * of your console log.

    Azure also enables you to see a screenshot + * of the VM from the hypervisor. + * @property {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether * boot diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of + * @property {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of * the storage account to use for placing the console output and screenshot. - * @member {object} [availabilitySet] Specifies information about the + * @property {object} [availabilitySet] Specifies information about the * availability set that the virtual machine should be assigned to. Virtual * machines specified in the same availability set are allocated to different * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation * time. An existing VM cannot be added to an availability set. - * @member {string} [availabilitySet.id] Resource Id - * @member {string} [provisioningState] The provisioning state, which only + * @property {string} [availabilitySet.id] Resource Id + * @property {string} [provisioningState] The provisioning state, which only * appears in the response. - * @member {string} [licenseType] Specifies that the image or disk that is + * @property {string} [licenseType] Specifies that the image or disk that is * being used was licensed on-premises. This element is only used for images * that contain the Windows Server operating system.

    Possible values * are:

    Windows_Client

    Windows_Server

    If this @@ -414,21 +420,22 @@ class VirtualMachineScaleSetVM extends models['Resource'] { * information, see [Azure Hybrid Use Benefit for Windows * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Minimum api-version: 2015-06-15 - * @member {object} [plan] Specifies information about the marketplace image - * used to create the virtual machine. This element is only used for + * @property {object} [plan] Specifies information about the marketplace + * image used to create the virtual machine. This element is only used for * marketplace images. Before you can use a marketplace image from an API, * you must enable the image for programmatic use. In the Azure portal, find * the marketplace image that you want to use and then click **Want to deploy * programmatically, Get Started ->**. Enter any required information and * then click **Save**. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from + * @property {string} [plan.name] The plan ID. + * @property {string} [plan.publisher] The publisher ID. + * @property {string} [plan.product] Specifies the product of the image from * the marketplace. This is the same value as Offer under the imageReference * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {array} [resources] The virtual machine child extension resources. - * @member {array} [zones] The virtual machine zones. + * @property {string} [plan.promotionCode] The promotion code. + * @property {array} [resources] The virtual machine child extension + * resources. + * @property {array} [zones] The virtual machine zones. */ constructor() { super(); @@ -518,6 +525,13 @@ class VirtualMachineScaleSetVM extends models['Resource'] { name: 'Boolean' } }, + protectFromScaleIn: { + required: false, + serializedName: 'properties.protectFromScaleIn', + type: { + name: 'Boolean' + } + }, vmId: { required: false, readOnly: true, diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMExtensionsSummary.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMExtensionsSummary.js index ddeedbc348..21d94a99eb 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMExtensionsSummary.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMExtensionsSummary.js @@ -17,8 +17,8 @@ class VirtualMachineScaleSetVMExtensionsSummary { /** * Create a VirtualMachineScaleSetVMExtensionsSummary. - * @member {string} [name] The extension name. - * @member {array} [statusesSummary] The extensions information. + * @property {string} [name] The extension name. + * @property {array} [statusesSummary] The extensions information. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceIDs.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceIDs.js index 529a4928f7..6191b0e842 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceIDs.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceIDs.js @@ -17,10 +17,10 @@ class VirtualMachineScaleSetVMInstanceIDs { /** * Create a VirtualMachineScaleSetVMInstanceIDs. - * @member {array} [instanceIds] The virtual machine scale set instance ids. - * Omitting the virtual machine scale set instance ids will result in the - * operation being performed on all virtual machines in the virtual machine - * scale set. + * @property {array} [instanceIds] The virtual machine scale set instance + * ids. Omitting the virtual machine scale set instance ids will result in + * the operation being performed on all virtual machines in the virtual + * machine scale set. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceRequiredIDs.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceRequiredIDs.js index f11c98b3d6..856a9980a5 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceRequiredIDs.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceRequiredIDs.js @@ -17,7 +17,7 @@ class VirtualMachineScaleSetVMInstanceRequiredIDs { /** * Create a VirtualMachineScaleSetVMInstanceRequiredIDs. - * @member {array} instanceIds The virtual machine scale set instance ids. + * @property {array} instanceIds The virtual machine scale set instance ids. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceView.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceView.js index e786396ccb..cc89e4688a 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceView.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMInstanceView.js @@ -17,69 +17,69 @@ class VirtualMachineScaleSetVMInstanceView { /** * Create a VirtualMachineScaleSetVMInstanceView. - * @member {number} [platformUpdateDomain] The Update Domain count. - * @member {number} [platformFaultDomain] The Fault Domain count. - * @member {string} [rdpThumbPrint] The Remote desktop certificate + * @property {number} [platformUpdateDomain] The Update Domain count. + * @property {number} [platformFaultDomain] The Fault Domain count. + * @property {string} [rdpThumbPrint] The Remote desktop certificate * thumbprint. - * @member {object} [vmAgent] The VM Agent running on the virtual machine. - * @member {string} [vmAgent.vmAgentVersion] The VM Agent full version. - * @member {array} [vmAgent.extensionHandlers] The virtual machine extension - * handler instance view. - * @member {array} [vmAgent.statuses] The resource status information. - * @member {object} [maintenanceRedeployStatus] The Maintenance Operation + * @property {object} [vmAgent] The VM Agent running on the virtual machine. + * @property {string} [vmAgent.vmAgentVersion] The VM Agent full version. + * @property {array} [vmAgent.extensionHandlers] The virtual machine + * extension handler instance view. + * @property {array} [vmAgent.statuses] The resource status information. + * @property {object} [maintenanceRedeployStatus] The Maintenance Operation * status on the virtual machine. - * @member {boolean} + * @property {boolean} * [maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] True, if * customer is allowed to perform Maintenance. - * @member {date} [maintenanceRedeployStatus.preMaintenanceWindowStartTime] + * @property {date} [maintenanceRedeployStatus.preMaintenanceWindowStartTime] * Start Time for the Pre Maintenance Window. - * @member {date} [maintenanceRedeployStatus.preMaintenanceWindowEndTime] End - * Time for the Pre Maintenance Window. - * @member {date} [maintenanceRedeployStatus.maintenanceWindowStartTime] + * @property {date} [maintenanceRedeployStatus.preMaintenanceWindowEndTime] + * End Time for the Pre Maintenance Window. + * @property {date} [maintenanceRedeployStatus.maintenanceWindowStartTime] * Start Time for the Maintenance Window. - * @member {date} [maintenanceRedeployStatus.maintenanceWindowEndTime] End + * @property {date} [maintenanceRedeployStatus.maintenanceWindowEndTime] End * Time for the Maintenance Window. - * @member {string} [maintenanceRedeployStatus.lastOperationResultCode] The + * @property {string} [maintenanceRedeployStatus.lastOperationResultCode] The * Last Maintenance Operation Result Code. Possible values include: 'None', * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} [maintenanceRedeployStatus.lastOperationMessage] Message - * returned for the last Maintenance Operation. - * @member {array} [disks] The disks information. - * @member {array} [extensions] The extensions information. - * @member {object} [vmHealth] The health status for the VM. - * @member {object} [vmHealth.status] The health status information for the + * @property {string} [maintenanceRedeployStatus.lastOperationMessage] + * Message returned for the last Maintenance Operation. + * @property {array} [disks] The disks information. + * @property {array} [extensions] The extensions information. + * @property {object} [vmHealth] The health status for the VM. + * @property {object} [vmHealth.status] The health status information for the * VM. - * @member {string} [vmHealth.status.code] The status code. - * @member {string} [vmHealth.status.level] The level code. Possible values + * @property {string} [vmHealth.status.code] The status code. + * @property {string} [vmHealth.status.level] The level code. Possible values * include: 'Info', 'Warning', 'Error' - * @member {string} [vmHealth.status.displayStatus] The short localizable + * @property {string} [vmHealth.status.displayStatus] The short localizable * label for the status. - * @member {string} [vmHealth.status.message] The detailed status message, + * @property {string} [vmHealth.status.message] The detailed status message, * including for alerts and error messages. - * @member {date} [vmHealth.status.time] The time of the status. - * @member {object} [bootDiagnostics] Boot Diagnostics is a debugging feature - * which allows you to view Console Output and Screenshot to diagnose VM - * status.

    You can easily view the output of your console log. + * @property {date} [vmHealth.status.time] The time of the status. + * @property {object} [bootDiagnostics] Boot Diagnostics is a debugging + * feature which allows you to view Console Output and Screenshot to diagnose + * VM status.

    You can easily view the output of your console log. *

    Azure also enables you to see a screenshot of the VM from the * hypervisor. - * @member {string} [bootDiagnostics.consoleScreenshotBlobUri] The console + * @property {string} [bootDiagnostics.consoleScreenshotBlobUri] The console * screenshot blob URI. - * @member {string} [bootDiagnostics.serialConsoleLogBlobUri] The Linux + * @property {string} [bootDiagnostics.serialConsoleLogBlobUri] The Linux * serial console log blob Uri. - * @member {object} [bootDiagnostics.status] The boot diagnostics status + * @property {object} [bootDiagnostics.status] The boot diagnostics status * information for the VM.

    NOTE: It will be set only if there are * errors encountered in enabling boot diagnostics. - * @member {string} [bootDiagnostics.status.code] The status code. - * @member {string} [bootDiagnostics.status.level] The level code. Possible + * @property {string} [bootDiagnostics.status.code] The status code. + * @property {string} [bootDiagnostics.status.level] The level code. Possible * values include: 'Info', 'Warning', 'Error' - * @member {string} [bootDiagnostics.status.displayStatus] The short + * @property {string} [bootDiagnostics.status.displayStatus] The short * localizable label for the status. - * @member {string} [bootDiagnostics.status.message] The detailed status + * @property {string} [bootDiagnostics.status.message] The detailed status * message, including for alerts and error messages. - * @member {date} [bootDiagnostics.status.time] The time of the status. - * @member {array} [statuses] The resource status information. - * @member {string} [placementGroupId] The placement group in which the VM is - * running. If the VM is deallocated it will not have a placementGroupId. + * @property {date} [bootDiagnostics.status.time] The time of the status. + * @property {array} [statuses] The resource status information. + * @property {string} [placementGroupId] The placement group in which the VM + * is running. If the VM is deallocated it will not have a placementGroupId. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMListResult.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMListResult.js index 2a5488100e..ae32f32c8b 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMListResult.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMListResult.js @@ -16,7 +16,7 @@ class VirtualMachineScaleSetVMListResult extends Array { /** * Create a VirtualMachineScaleSetVMListResult. - * @member {string} [nextLink] The uri to fetch the next page of Virtual + * @property {string} [nextLink] The uri to fetch the next page of Virtual * Machine Scale Set VMs. Call ListNext() with this to fetch the next page of * VMSS VMs */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMProfile.js b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMProfile.js index c03ebe43d0..4df3980dc3 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMProfile.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineScaleSetVMProfile.js @@ -17,12 +17,12 @@ class VirtualMachineScaleSetVMProfile { /** * Create a VirtualMachineScaleSetVMProfile. - * @member {object} [osProfile] Specifies the operating system settings for + * @property {object} [osProfile] Specifies the operating system settings for * the virtual machines in the scale set. - * @member {string} [osProfile.computerNamePrefix] Specifies the computer + * @property {string} [osProfile.computerNamePrefix] Specifies the computer * name prefix for all of the virtual machines in the scale set. Computer * name prefixes must be 1 to 15 characters long. - * @member {string} [osProfile.adminUsername] Specifies the name of the + * @property {string} [osProfile.adminUsername] Specifies the name of the * administrator account.

    **Windows-only restriction:** Cannot end * in "."

    **Disallowed values:** "administrator", "admin", "user", * "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", @@ -37,7 +37,7 @@ class VirtualMachineScaleSetVMProfile { * For a list of built-in system users on Linux that should not be used in * this field, see [Selecting User Names for Linux on * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [osProfile.adminPassword] Specifies the password of the + * @property {string} [osProfile.adminPassword] Specifies the password of the * administrator account.

    **Minimum-length (Windows):** 8 characters *

    **Minimum-length (Linux):** 6 characters

    **Max-length * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters @@ -52,165 +52,167 @@ class VirtualMachineScaleSetVMProfile { *

    For resetting root password, see [Manage users, SSH, and check or * repair disks on Azure Linux VMs using the VMAccess * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [osProfile.customData] Specifies a base-64 encoded string - * of custom data. The base-64 encoded string is decoded to a binary array - * that is saved as a file on the Virtual Machine. The maximum length of the - * binary array is 65535 bytes.

    For using cloud-init for your VM, - * see [Using cloud-init to customize a Linux VM during + * @property {string} [osProfile.customData] Specifies a base-64 encoded + * string of custom data. The base-64 encoded string is decoded to a binary + * array that is saved as a file on the Virtual Machine. The maximum length + * of the binary array is 65535 bytes.

    For using cloud-init for your + * VM, see [Using cloud-init to customize a Linux VM during * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [osProfile.windowsConfiguration] Specifies Windows + * @property {object} [osProfile.windowsConfiguration] Specifies Windows * operating system settings on the virtual machine. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] + * @property {boolean} [osProfile.windowsConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the + * @property {boolean} + * [osProfile.windowsConfiguration.enableAutomaticUpdates] Indicates whether + * virtual machine is enabled for automatic updates. + * @property {string} [osProfile.windowsConfiguration.timeZone] Specifies the * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the + * @property {array} + * [osProfile.windowsConfiguration.additionalUnattendContent] Specifies + * additional base-64 encoded XML formatted information that can be included + * in the Unattend.xml file, which is used by Windows Setup. + * @property {object} [osProfile.windowsConfiguration.winRM] Specifies the * Windows Remote Management listeners. This enables remote Windows * PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list - * of Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] Specifies the Linux + * @property {array} [osProfile.windowsConfiguration.winRM.listeners] The + * list of Windows Remote Management listeners + * @property {object} [osProfile.linuxConfiguration] Specifies the Linux * operating system settings on the virtual machine.

    For a list of * supported Linux distributions, see [Linux on Azure-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) *

    For running non-endorsed distributions, see [Information for * Non-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} + * @property {boolean} * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] + * @property {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh + * key configuration for a Linux OS. + * @property {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list + * of SSH public keys used to authenticate with linux based VMs. + * @property {boolean} [osProfile.linuxConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {array} [osProfile.secrets] Specifies set of certificates that + * @property {array} [osProfile.secrets] Specifies set of certificates that * should be installed onto the virtual machines in the scale set. - * @member {object} [storageProfile] Specifies the storage settings for the + * @property {object} [storageProfile] Specifies the storage settings for the * virtual machine disks. - * @member {object} [storageProfile.imageReference] Specifies information + * @property {object} [storageProfile.imageReference] Specifies information * about the image to use. You can specify information about platform images, * marketplace images, or virtual machine images. This element is required * when you want to use a platform image, marketplace image, or virtual * machine image, but is not used in other creation operations. - * @member {string} [storageProfile.imageReference.publisher] The image + * @property {string} [storageProfile.imageReference.publisher] The image * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the + * @property {string} [storageProfile.imageReference.offer] Specifies the + * offer of the platform image or marketplace image used to create the + * virtual machine. + * @property {string} [storageProfile.imageReference.sku] The image SKU. + * @property {string} [storageProfile.imageReference.version] Specifies the * version of the platform image or marketplace image used to create the * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the * latest version of an image available at deploy time. Even if you use * 'latest', the VM image will not automatically update after deploy time * even if a new version becomes available. - * @member {object} [storageProfile.osDisk] Specifies information about the + * @property {object} [storageProfile.osDisk] Specifies information about the * operating system disk used by the virtual machines in the scale set. *

    For more information about disks, see [About disks and VHDs for * Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.name] The disk name. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching + * @property {string} [storageProfile.osDisk.name] The disk name. + * @property {string} [storageProfile.osDisk.caching] Specifies the caching * requirements.

    Possible values are:

    **None**

    * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard * storage. ReadOnly for Premium storage**. Possible values include: 'None', * 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] + * @property {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] * Specifies whether writeAccelerator should be enabled or disabled on the * disk. - * @member {string} [storageProfile.osDisk.createOption] Specifies how the + * @property {string} [storageProfile.osDisk.createOption] Specifies how the * virtual machines in the scale set should be created.

    The only * allowed value is: **FromImage** \u2013 This value is used when you are * using an image to create the virtual machine. If you are using a platform * image, you also use the imageReference element described above. If you are * using a marketplace image, you also use the plan element previously * described. Possible values include: 'FromImage', 'Empty', 'Attach' - * @member {object} [storageProfile.osDisk.diffDiskSettings] Specifies the - * differencing Disk Settings for the operating system disk used by the - * virtual machine scale set. - * @member {string} [storageProfile.osDisk.diffDiskSettings.option] Specifies - * the differencing disk settings for operating system disk. Possible values - * include: 'Local' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * the operating system disk in gigabytes. This element can be used to + * @property {object} [storageProfile.osDisk.diffDiskSettings] Specifies the + * ephemeral disk Settings for the operating system disk used by the virtual + * machine scale set. + * @property {string} [storageProfile.osDisk.diffDiskSettings.option] + * Specifies the ephemeral disk settings for operating system disk. Possible + * values include: 'Local' + * @property {number} [storageProfile.osDisk.diskSizeGB] Specifies the size + * of the operating system disk in gigabytes. This element can be used to * overwrite the size of the disk in a virtual machine image.

    This * value cannot be larger than 1023 GB - * @member {string} [storageProfile.osDisk.osType] This property allows you + * @property {string} [storageProfile.osDisk.osType] This property allows you * to specify the type of the OS that is included in the disk if creating a * VM from user-image or a specialized VHD.

    Possible values are: *

    **Windows**

    **Linux**. Possible values include: * 'Windows', 'Linux' - * @member {object} [storageProfile.osDisk.image] Specifies information about - * the unmanaged user image to base the scale set on. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual + * @property {object} [storageProfile.osDisk.image] Specifies information + * about the unmanaged user image to base the scale set on. + * @property {string} [storageProfile.osDisk.image.uri] Specifies the virtual * hard disk's uri. - * @member {array} [storageProfile.osDisk.vhdContainers] Specifies the + * @property {array} [storageProfile.osDisk.vhdContainers] Specifies the * container urls that are used to store operating system disks for the scale * set. - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk + * @property {object} [storageProfile.osDisk.managedDisk] The managed disk * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] + * @property {string} [storageProfile.osDisk.managedDisk.storageAccountType] * Specifies the storage account type for the managed disk. NOTE: * UltraSSD_LRS can only be used with data disks, it cannot be used with OS * Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that + * @property {array} [storageProfile.dataDisks] Specifies the parameters that * are used to add data disks to the virtual machines in the scale set. *

    For more information about disks, see [About disks and VHDs for * Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [additionalCapabilities] Specifies additional + * @property {object} [additionalCapabilities] Specifies additional * capabilities enabled or disabled on the virtual machine in the scale set. * For instance: whether the virtual machine has the capability to support * attaching managed data disks with UltraSSD_LRS storage account type. - * @member {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that + * @property {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that * enables or disables a capability to have one or more managed data disks * with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks * with storage account type UltraSSD_LRS can be added to a virtual machine * or virtual machine scale set only if this property is enabled. - * @member {object} [networkProfile] Specifies properties of the network + * @property {object} [networkProfile] Specifies properties of the network * interfaces of the virtual machines in the scale set. - * @member {object} [networkProfile.healthProbe] A reference to a load + * @property {object} [networkProfile.healthProbe] A reference to a load * balancer probe used to determine the health of an instance in the virtual * machine scale set. The reference will be in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - * @member {string} [networkProfile.healthProbe.id] The ARM resource id in + * @property {string} [networkProfile.healthProbe.id] The ARM resource id in * the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... - * @member {array} [networkProfile.networkInterfaceConfigurations] The list + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + * @property {array} [networkProfile.networkInterfaceConfigurations] The list * of network configurations. - * @member {object} [diagnosticsProfile] Specifies the boot diagnostic + * @property {object} [diagnosticsProfile] Specifies the boot diagnostic * settings state.

    Minimum api-version: 2015-06-15. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is - * a debugging feature which allows you to view Console Output and Screenshot - * to diagnose VM status.

    You can easily view the output of your - * console log.

    Azure also enables you to see a screenshot of the VM - * from the hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether + * @property {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics + * is a debugging feature which allows you to view Console Output and + * Screenshot to diagnose VM status.

    You can easily view the output + * of your console log.

    Azure also enables you to see a screenshot + * of the VM from the hypervisor. + * @property {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether * boot diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of + * @property {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of * the storage account to use for placing the console output and screenshot. - * @member {object} [extensionProfile] Specifies a collection of settings for - * extensions installed on virtual machines in the scale set. - * @member {array} [extensionProfile.extensions] The virtual machine scale + * @property {object} [extensionProfile] Specifies a collection of settings + * for extensions installed on virtual machines in the scale set. + * @property {array} [extensionProfile.extensions] The virtual machine scale * set child extension resources. - * @member {string} [licenseType] Specifies that the image or disk that is + * @property {string} [licenseType] Specifies that the image or disk that is * being used was licensed on-premises. This element is only used for images * that contain the Windows Server operating system.

    Possible values * are:

    Windows_Client

    Windows_Server

    If this @@ -219,10 +221,10 @@ class VirtualMachineScaleSetVMProfile { * information, see [Azure Hybrid Use Benefit for Windows * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Minimum api-version: 2015-06-15 - * @member {string} [priority] Specifies the priority for the virtual + * @property {string} [priority] Specifies the priority for the virtual * machines in the scale set.

    Minimum api-version: * 2017-10-30-preview. Possible values include: 'Regular', 'Low' - * @member {string} [evictionPolicy] Specifies the eviction policy for + * @property {string} [evictionPolicy] Specifies the eviction policy for * virtual machines in a low priority scale set.

    Minimum api-version: * 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete' */ diff --git a/lib/services/computeManagement2/lib/models/virtualMachineSize.js b/lib/services/computeManagement2/lib/models/virtualMachineSize.js index 8d6ccb6b23..a71ed7f580 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineSize.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineSize.js @@ -17,17 +17,17 @@ class VirtualMachineSize { /** * Create a VirtualMachineSize. - * @member {string} [name] The name of the virtual machine size. - * @member {number} [numberOfCores] The number of cores supported by the + * @property {string} [name] The name of the virtual machine size. + * @property {number} [numberOfCores] The number of cores supported by the * virtual machine size. - * @member {number} [osDiskSizeInMB] The OS disk size, in MB, allowed by the - * virtual machine size. - * @member {number} [resourceDiskSizeInMB] The resource disk size, in MB, + * @property {number} [osDiskSizeInMB] The OS disk size, in MB, allowed by + * the virtual machine size. + * @property {number} [resourceDiskSizeInMB] The resource disk size, in MB, * allowed by the virtual machine size. - * @member {number} [memoryInMB] The amount of memory, in MB, supported by + * @property {number} [memoryInMB] The amount of memory, in MB, supported by * the virtual machine size. - * @member {number} [maxDataDiskCount] The maximum number of data disks that - * can be attached to the virtual machine size. + * @property {number} [maxDataDiskCount] The maximum number of data disks + * that can be attached to the virtual machine size. */ constructor() { } diff --git a/lib/services/computeManagement2/lib/models/virtualMachineStatusCodeCount.js b/lib/services/computeManagement2/lib/models/virtualMachineStatusCodeCount.js index 4058991735..7452a7bdd3 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineStatusCodeCount.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineStatusCodeCount.js @@ -18,8 +18,8 @@ class VirtualMachineStatusCodeCount { /** * Create a VirtualMachineStatusCodeCount. - * @member {string} [code] The instance view status code. - * @member {number} [count] The number of instances having a particular + * @property {string} [code] The instance view status code. + * @property {number} [count] The number of instances having a particular * status code. */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/virtualMachineUpdate.js b/lib/services/computeManagement2/lib/models/virtualMachineUpdate.js index 0bc64c4604..95447465a4 100644 --- a/lib/services/computeManagement2/lib/models/virtualMachineUpdate.js +++ b/lib/services/computeManagement2/lib/models/virtualMachineUpdate.js @@ -20,22 +20,22 @@ const models = require('./index'); class VirtualMachineUpdate extends models['UpdateResource'] { /** * Create a VirtualMachineUpdate. - * @member {object} [plan] Specifies information about the marketplace image - * used to create the virtual machine. This element is only used for + * @property {object} [plan] Specifies information about the marketplace + * image used to create the virtual machine. This element is only used for * marketplace images. Before you can use a marketplace image from an API, * you must enable the image for programmatic use. In the Azure portal, find * the marketplace image that you want to use and then click **Want to deploy * programmatically, Get Started ->**. Enter any required information and * then click **Save**. - * @member {string} [plan.name] The plan ID. - * @member {string} [plan.publisher] The publisher ID. - * @member {string} [plan.product] Specifies the product of the image from + * @property {string} [plan.name] The plan ID. + * @property {string} [plan.publisher] The publisher ID. + * @property {string} [plan.product] Specifies the product of the image from * the marketplace. This is the same value as Offer under the imageReference * element. - * @member {string} [plan.promotionCode] The promotion code. - * @member {object} [hardwareProfile] Specifies the hardware settings for the - * virtual machine. - * @member {string} [hardwareProfile.vmSize] Specifies the size of the + * @property {string} [plan.promotionCode] The promotion code. + * @property {object} [hardwareProfile] Specifies the hardware settings for + * the virtual machine. + * @property {string} [hardwareProfile.vmSize] Specifies the size of the * virtual machine. For more information about virtual machine sizes, see * [Sizes for virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). @@ -93,90 +93,90 @@ class VirtualMachineUpdate extends models['UpdateResource'] { * 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', * 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', * 'Standard_NV12', 'Standard_NV24' - * @member {object} [storageProfile] Specifies the storage settings for the + * @property {object} [storageProfile] Specifies the storage settings for the * virtual machine disks. - * @member {object} [storageProfile.imageReference] Specifies information + * @property {object} [storageProfile.imageReference] Specifies information * about the image to use. You can specify information about platform images, * marketplace images, or virtual machine images. This element is required * when you want to use a platform image, marketplace image, or virtual * machine image, but is not used in other creation operations. - * @member {string} [storageProfile.imageReference.publisher] The image + * @property {string} [storageProfile.imageReference.publisher] The image * publisher. - * @member {string} [storageProfile.imageReference.offer] Specifies the offer - * of the platform image or marketplace image used to create the virtual - * machine. - * @member {string} [storageProfile.imageReference.sku] The image SKU. - * @member {string} [storageProfile.imageReference.version] Specifies the + * @property {string} [storageProfile.imageReference.offer] Specifies the + * offer of the platform image or marketplace image used to create the + * virtual machine. + * @property {string} [storageProfile.imageReference.sku] The image SKU. + * @property {string} [storageProfile.imageReference.version] Specifies the * version of the platform image or marketplace image used to create the * virtual machine. The allowed formats are Major.Minor.Build or 'latest'. * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the * latest version of an image available at deploy time. Even if you use * 'latest', the VM image will not automatically update after deploy time * even if a new version becomes available. - * @member {object} [storageProfile.osDisk] Specifies information about the + * @property {object} [storageProfile.osDisk] Specifies information about the * operating system disk used by the virtual machine.

    For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {string} [storageProfile.osDisk.osType] This property allows you + * @property {string} [storageProfile.osDisk.osType] This property allows you * to specify the type of the OS that is included in the disk if creating a * VM from user-image or a specialized VHD.

    Possible values are: *

    **Windows**

    **Linux**. Possible values include: * 'Windows', 'Linux' - * @member {object} [storageProfile.osDisk.encryptionSettings] Specifies the - * encryption settings for the OS Disk.

    Minimum api-version: + * @property {object} [storageProfile.osDisk.encryptionSettings] Specifies + * the encryption settings for the OS Disk.

    Minimum api-version: * 2015-06-15 - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey] Specifies the * location of the disk encryption key, which is a Key Vault Secret. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.secretUrl] The * URL referencing a secret in a Key Vault. - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault] * The relative URL of the Key Vault containing the secret. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.diskEncryptionKey.sourceVault.id] * Resource Id - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey] Specifies the * location of the key encryption key in Key Vault. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.keyUrl] The URL * referencing a key encryption key in Key Vault. - * @member {object} + * @property {object} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault] * The relative URL of the Key Vault containing the key. - * @member {string} + * @property {string} * [storageProfile.osDisk.encryptionSettings.keyEncryptionKey.sourceVault.id] * Resource Id - * @member {boolean} [storageProfile.osDisk.encryptionSettings.enabled] + * @property {boolean} [storageProfile.osDisk.encryptionSettings.enabled] * Specifies whether disk encryption should be enabled on the virtual * machine. - * @member {string} [storageProfile.osDisk.name] The disk name. - * @member {object} [storageProfile.osDisk.vhd] The virtual hard disk. - * @member {string} [storageProfile.osDisk.vhd.uri] Specifies the virtual + * @property {string} [storageProfile.osDisk.name] The disk name. + * @property {object} [storageProfile.osDisk.vhd] The virtual hard disk. + * @property {string} [storageProfile.osDisk.vhd.uri] Specifies the virtual * hard disk's uri. - * @member {object} [storageProfile.osDisk.image] The source user image + * @property {object} [storageProfile.osDisk.image] The source user image * virtual hard disk. The virtual hard disk will be copied before being * attached to the virtual machine. If SourceImage is provided, the * destination virtual hard drive must not exist. - * @member {string} [storageProfile.osDisk.image.uri] Specifies the virtual + * @property {string} [storageProfile.osDisk.image.uri] Specifies the virtual * hard disk's uri. - * @member {string} [storageProfile.osDisk.caching] Specifies the caching + * @property {string} [storageProfile.osDisk.caching] Specifies the caching * requirements.

    Possible values are:

    **None**

    * **ReadOnly**

    **ReadWrite**

    Default: **None for Standard * storage. ReadOnly for Premium storage**. Possible values include: 'None', * 'ReadOnly', 'ReadWrite' - * @member {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] + * @property {boolean} [storageProfile.osDisk.writeAcceleratorEnabled] * Specifies whether writeAccelerator should be enabled or disabled on the * disk. - * @member {object} [storageProfile.osDisk.diffDiskSettings] Specifies the - * differencing Disk Settings for the operating system disk used by the - * virtual machine. - * @member {string} [storageProfile.osDisk.diffDiskSettings.option] Specifies - * the differencing disk settings for operating system disk. Possible values - * include: 'Local' - * @member {string} [storageProfile.osDisk.createOption] Specifies how the + * @property {object} [storageProfile.osDisk.diffDiskSettings] Specifies the + * ephemeral Disk Settings for the operating system disk used by the virtual + * machine. + * @property {string} [storageProfile.osDisk.diffDiskSettings.option] + * Specifies the ephemeral disk settings for operating system disk. Possible + * values include: 'Local' + * @property {string} [storageProfile.osDisk.createOption] Specifies how the * virtual machine should be created.

    Possible values are:

    * **Attach** \u2013 This value is used when you are using a specialized disk * to create the virtual machine.

    **FromImage** \u2013 This value is @@ -185,37 +185,37 @@ class VirtualMachineUpdate extends models['UpdateResource'] { * above. If you are using a marketplace image, you also use the plan * element previously described. Possible values include: 'FromImage', * 'Empty', 'Attach' - * @member {number} [storageProfile.osDisk.diskSizeGB] Specifies the size of - * an empty data disk in gigabytes. This element can be used to overwrite the - * size of the disk in a virtual machine image.

    This value cannot be - * larger than 1023 GB - * @member {object} [storageProfile.osDisk.managedDisk] The managed disk + * @property {number} [storageProfile.osDisk.diskSizeGB] Specifies the size + * of an empty data disk in gigabytes. This element can be used to overwrite + * the size of the disk in a virtual machine image.

    This value + * cannot be larger than 1023 GB + * @property {object} [storageProfile.osDisk.managedDisk] The managed disk * parameters. - * @member {string} [storageProfile.osDisk.managedDisk.storageAccountType] + * @property {string} [storageProfile.osDisk.managedDisk.storageAccountType] * Specifies the storage account type for the managed disk. NOTE: * UltraSSD_LRS can only be used with data disks, it cannot be used with OS * Disk. Possible values include: 'Standard_LRS', 'Premium_LRS', * 'StandardSSD_LRS', 'UltraSSD_LRS' - * @member {array} [storageProfile.dataDisks] Specifies the parameters that + * @property {array} [storageProfile.dataDisks] Specifies the parameters that * are used to add a data disk to a virtual machine.

    For more * information about disks, see [About disks and VHDs for Azure virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - * @member {object} [additionalCapabilities] Specifies additional + * @property {object} [additionalCapabilities] Specifies additional * capabilities enabled or disabled on the virtual machine. - * @member {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that + * @property {boolean} [additionalCapabilities.ultraSSDEnabled] The flag that * enables or disables a capability to have one or more managed data disks * with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks * with storage account type UltraSSD_LRS can be added to a virtual machine * or virtual machine scale set only if this property is enabled. - * @member {object} [osProfile] Specifies the operating system settings for + * @property {object} [osProfile] Specifies the operating system settings for * the virtual machine. - * @member {string} [osProfile.computerName] Specifies the host OS name of - * the virtual machine.

    **Max-length (Windows):** 15 characters - *

    **Max-length (Linux):** 64 characters.

    For naming - * conventions and restrictions see [Azure infrastructure services - * implementation + * @property {string} [osProfile.computerName] Specifies the host OS name of + * the virtual machine.

    This name cannot be updated after the VM is + * created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). - * @member {string} [osProfile.adminUsername] Specifies the name of the + * @property {string} [osProfile.adminUsername] Specifies the name of the * administrator account.

    **Windows-only restriction:** Cannot end * in "."

    **Disallowed values:** "administrator", "admin", "user", * "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", @@ -230,7 +230,7 @@ class VirtualMachineUpdate extends models['UpdateResource'] { * For a list of built-in system users on Linux that should not be used in * this field, see [Selecting User Names for Linux on * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {string} [osProfile.adminPassword] Specifies the password of the + * @property {string} [osProfile.adminPassword] Specifies the password of the * administrator account.

    **Minimum-length (Windows):** 8 characters *

    **Minimum-length (Linux):** 6 characters

    **Max-length * (Windows):** 123 characters

    **Max-length (Linux):** 72 characters @@ -245,159 +245,162 @@ class VirtualMachineUpdate extends models['UpdateResource'] { *

    For resetting root password, see [Manage users, SSH, and check or * repair disks on Azure Linux VMs using the VMAccess * Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) - * @member {string} [osProfile.customData] Specifies a base-64 encoded string - * of custom data. The base-64 encoded string is decoded to a binary array - * that is saved as a file on the Virtual Machine. The maximum length of the - * binary array is 65535 bytes.

    For using cloud-init for your VM, - * see [Using cloud-init to customize a Linux VM during + * @property {string} [osProfile.customData] Specifies a base-64 encoded + * string of custom data. The base-64 encoded string is decoded to a binary + * array that is saved as a file on the Virtual Machine. The maximum length + * of the binary array is 65535 bytes.

    For using cloud-init for your + * VM, see [Using cloud-init to customize a Linux VM during * creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) - * @member {object} [osProfile.windowsConfiguration] Specifies Windows + * @property {object} [osProfile.windowsConfiguration] Specifies Windows * operating system settings on the virtual machine. - * @member {boolean} [osProfile.windowsConfiguration.provisionVMAgent] + * @property {boolean} [osProfile.windowsConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {boolean} [osProfile.windowsConfiguration.enableAutomaticUpdates] - * Indicates whether virtual machine is enabled for automatic updates. - * @member {string} [osProfile.windowsConfiguration.timeZone] Specifies the + * @property {boolean} + * [osProfile.windowsConfiguration.enableAutomaticUpdates] Indicates whether + * virtual machine is enabled for automatic updates. + * @property {string} [osProfile.windowsConfiguration.timeZone] Specifies the * time zone of the virtual machine. e.g. "Pacific Standard Time" - * @member {array} [osProfile.windowsConfiguration.additionalUnattendContent] - * Specifies additional base-64 encoded XML formatted information that can be - * included in the Unattend.xml file, which is used by Windows Setup. - * @member {object} [osProfile.windowsConfiguration.winRM] Specifies the + * @property {array} + * [osProfile.windowsConfiguration.additionalUnattendContent] Specifies + * additional base-64 encoded XML formatted information that can be included + * in the Unattend.xml file, which is used by Windows Setup. + * @property {object} [osProfile.windowsConfiguration.winRM] Specifies the * Windows Remote Management listeners. This enables remote Windows * PowerShell. - * @member {array} [osProfile.windowsConfiguration.winRM.listeners] The list - * of Windows Remote Management listeners - * @member {object} [osProfile.linuxConfiguration] Specifies the Linux + * @property {array} [osProfile.windowsConfiguration.winRM.listeners] The + * list of Windows Remote Management listeners + * @property {object} [osProfile.linuxConfiguration] Specifies the Linux * operating system settings on the virtual machine.

    For a list of * supported Linux distributions, see [Linux on Azure-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) *

    For running non-endorsed distributions, see [Information for * Non-Endorsed * Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - * @member {boolean} + * @property {boolean} * [osProfile.linuxConfiguration.disablePasswordAuthentication] Specifies * whether password authentication should be disabled. - * @member {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh key - * configuration for a Linux OS. - * @member {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list of - * SSH public keys used to authenticate with linux based VMs. - * @member {boolean} [osProfile.linuxConfiguration.provisionVMAgent] + * @property {object} [osProfile.linuxConfiguration.ssh] Specifies the ssh + * key configuration for a Linux OS. + * @property {array} [osProfile.linuxConfiguration.ssh.publicKeys] The list + * of SSH public keys used to authenticate with linux based VMs. + * @property {boolean} [osProfile.linuxConfiguration.provisionVMAgent] * Indicates whether virtual machine agent should be provisioned on the * virtual machine.

    When this property is not specified in the * request body, default behavior is to set it to true. This will ensure * that VM Agent is installed on the VM so that extensions can be added to * the VM later. - * @member {array} [osProfile.secrets] Specifies set of certificates that + * @property {array} [osProfile.secrets] Specifies set of certificates that * should be installed onto the virtual machine. - * @member {boolean} [osProfile.allowExtensionOperations] Specifies whether + * @property {boolean} [osProfile.allowExtensionOperations] Specifies whether * extension operations should be allowed on the virtual machine. *

    This may only be set to False when no extensions are present on * the virtual machine. - * @member {object} [networkProfile] Specifies the network interfaces of the - * virtual machine. - * @member {array} [networkProfile.networkInterfaces] Specifies the list of + * @property {object} [networkProfile] Specifies the network interfaces of + * the virtual machine. + * @property {array} [networkProfile.networkInterfaces] Specifies the list of * resource Ids for the network interfaces associated with the virtual * machine. - * @member {object} [diagnosticsProfile] Specifies the boot diagnostic + * @property {object} [diagnosticsProfile] Specifies the boot diagnostic * settings state.

    Minimum api-version: 2015-06-15. - * @member {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics is - * a debugging feature which allows you to view Console Output and Screenshot - * to diagnose VM status.

    You can easily view the output of your - * console log.

    Azure also enables you to see a screenshot of the VM - * from the hypervisor. - * @member {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether + * @property {object} [diagnosticsProfile.bootDiagnostics] Boot Diagnostics + * is a debugging feature which allows you to view Console Output and + * Screenshot to diagnose VM status.

    You can easily view the output + * of your console log.

    Azure also enables you to see a screenshot + * of the VM from the hypervisor. + * @property {boolean} [diagnosticsProfile.bootDiagnostics.enabled] Whether * boot diagnostics should be enabled on the Virtual Machine. - * @member {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of + * @property {string} [diagnosticsProfile.bootDiagnostics.storageUri] Uri of * the storage account to use for placing the console output and screenshot. - * @member {object} [availabilitySet] Specifies information about the + * @property {object} [availabilitySet] Specifies information about the * availability set that the virtual machine should be assigned to. Virtual * machines specified in the same availability set are allocated to different * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation * time. An existing VM cannot be added to an availability set. - * @member {string} [availabilitySet.id] Resource Id - * @member {string} [provisioningState] The provisioning state, which only + * @property {string} [availabilitySet.id] Resource Id + * @property {string} [provisioningState] The provisioning state, which only * appears in the response. - * @member {object} [instanceView] The virtual machine instance view. - * @member {number} [instanceView.platformUpdateDomain] Specifies the update + * @property {object} [instanceView] The virtual machine instance view. + * @property {number} [instanceView.platformUpdateDomain] Specifies the + * update domain of the virtual machine. + * @property {number} [instanceView.platformFaultDomain] Specifies the fault * domain of the virtual machine. - * @member {number} [instanceView.platformFaultDomain] Specifies the fault - * domain of the virtual machine. - * @member {string} [instanceView.computerName] The computer name assigned to + * @property {string} [instanceView.computerName] The computer name assigned + * to the virtual machine. + * @property {string} [instanceView.osName] The Operating System running on * the virtual machine. - * @member {string} [instanceView.osName] The Operating System running on the - * virtual machine. - * @member {string} [instanceView.osVersion] The version of Operating System - * running on the virtual machine. - * @member {string} [instanceView.rdpThumbPrint] The Remote desktop + * @property {string} [instanceView.osVersion] The version of Operating + * System running on the virtual machine. + * @property {string} [instanceView.rdpThumbPrint] The Remote desktop * certificate thumbprint. - * @member {object} [instanceView.vmAgent] The VM Agent running on the + * @property {object} [instanceView.vmAgent] The VM Agent running on the * virtual machine. - * @member {string} [instanceView.vmAgent.vmAgentVersion] The VM Agent full + * @property {string} [instanceView.vmAgent.vmAgentVersion] The VM Agent full * version. - * @member {array} [instanceView.vmAgent.extensionHandlers] The virtual + * @property {array} [instanceView.vmAgent.extensionHandlers] The virtual * machine extension handler instance view. - * @member {array} [instanceView.vmAgent.statuses] The resource status + * @property {array} [instanceView.vmAgent.statuses] The resource status * information. - * @member {object} [instanceView.maintenanceRedeployStatus] The Maintenance - * Operation status on the virtual machine. - * @member {boolean} + * @property {object} [instanceView.maintenanceRedeployStatus] The + * Maintenance Operation status on the virtual machine. + * @property {boolean} * [instanceView.maintenanceRedeployStatus.isCustomerInitiatedMaintenanceAllowed] * True, if customer is allowed to perform Maintenance. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowStartTime] * Start Time for the Pre Maintenance Window. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.preMaintenanceWindowEndTime] End * Time for the Pre Maintenance Window. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.maintenanceWindowStartTime] Start * Time for the Maintenance Window. - * @member {date} + * @property {date} * [instanceView.maintenanceRedeployStatus.maintenanceWindowEndTime] End Time * for the Maintenance Window. - * @member {string} + * @property {string} * [instanceView.maintenanceRedeployStatus.lastOperationResultCode] The Last * Maintenance Operation Result Code. Possible values include: 'None', * 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted' - * @member {string} + * @property {string} * [instanceView.maintenanceRedeployStatus.lastOperationMessage] Message * returned for the last Maintenance Operation. - * @member {array} [instanceView.disks] The virtual machine disk information. - * @member {array} [instanceView.extensions] The extensions information. - * @member {object} [instanceView.bootDiagnostics] Boot Diagnostics is a + * @property {array} [instanceView.disks] The virtual machine disk + * information. + * @property {array} [instanceView.extensions] The extensions information. + * @property {object} [instanceView.bootDiagnostics] Boot Diagnostics is a * debugging feature which allows you to view Console Output and Screenshot * to diagnose VM status.

    You can easily view the output of your * console log.

    Azure also enables you to see a screenshot of the VM * from the hypervisor. - * @member {string} [instanceView.bootDiagnostics.consoleScreenshotBlobUri] + * @property {string} [instanceView.bootDiagnostics.consoleScreenshotBlobUri] * The console screenshot blob URI. - * @member {string} [instanceView.bootDiagnostics.serialConsoleLogBlobUri] + * @property {string} [instanceView.bootDiagnostics.serialConsoleLogBlobUri] * The Linux serial console log blob Uri. - * @member {object} [instanceView.bootDiagnostics.status] The boot + * @property {object} [instanceView.bootDiagnostics.status] The boot * diagnostics status information for the VM.

    NOTE: It will be set * only if there are errors encountered in enabling boot diagnostics. - * @member {string} [instanceView.bootDiagnostics.status.code] The status + * @property {string} [instanceView.bootDiagnostics.status.code] The status * code. - * @member {string} [instanceView.bootDiagnostics.status.level] The level + * @property {string} [instanceView.bootDiagnostics.status.level] The level * code. Possible values include: 'Info', 'Warning', 'Error' - * @member {string} [instanceView.bootDiagnostics.status.displayStatus] The + * @property {string} [instanceView.bootDiagnostics.status.displayStatus] The * short localizable label for the status. - * @member {string} [instanceView.bootDiagnostics.status.message] The + * @property {string} [instanceView.bootDiagnostics.status.message] The * detailed status message, including for alerts and error messages. - * @member {date} [instanceView.bootDiagnostics.status.time] The time of the - * status. - * @member {array} [instanceView.statuses] The resource status information. - * @member {string} [licenseType] Specifies that the image or disk that is + * @property {date} [instanceView.bootDiagnostics.status.time] The time of + * the status. + * @property {array} [instanceView.statuses] The resource status information. + * @property {string} [licenseType] Specifies that the image or disk that is * being used was licensed on-premises. This element is only used for images * that contain the Windows Server operating system.

    Possible values * are:

    Windows_Client

    Windows_Server

    If this @@ -406,28 +409,28 @@ class VirtualMachineUpdate extends models['UpdateResource'] { * information, see [Azure Hybrid Use Benefit for Windows * Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Minimum api-version: 2015-06-15 - * @member {string} [vmId] Specifies the VM unique ID which is a 128-bits + * @property {string} [vmId] Specifies the VM unique ID which is a 128-bits * identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can * be read using platform BIOS commands. - * @member {object} [identity] The identity of the virtual machine, if + * @property {object} [identity] The identity of the virtual machine, if * configured. - * @member {string} [identity.principalId] The principal id of virtual + * @property {string} [identity.principalId] The principal id of virtual * machine identity. This property will only be provided for a system * assigned identity. - * @member {string} [identity.tenantId] The tenant id associated with the + * @property {string} [identity.tenantId] The tenant id associated with the * virtual machine. This property will only be provided for a system assigned * identity. - * @member {string} [identity.type] The type of identity used for the virtual - * machine. The type 'SystemAssigned, UserAssigned' includes both an + * @property {string} [identity.type] The type of identity used for the + * virtual machine. The type 'SystemAssigned, UserAssigned' includes both an * implicitly created identity and a set of user assigned identities. The * type 'None' will remove any identities from the virtual machine. Possible * values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, * UserAssigned', 'None' - * @member {object} [identity.userAssignedIdentities] The list of user + * @property {object} [identity.userAssignedIdentities] The list of user * identities associated with the Virtual Machine. The user identity * dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - * @member {array} [zones] The virtual machine zones. + * @property {array} [zones] The virtual machine zones. */ constructor() { super(); diff --git a/lib/services/computeManagement2/lib/models/winRMConfiguration.js b/lib/services/computeManagement2/lib/models/winRMConfiguration.js index a3f2d1ba8d..ab68053810 100644 --- a/lib/services/computeManagement2/lib/models/winRMConfiguration.js +++ b/lib/services/computeManagement2/lib/models/winRMConfiguration.js @@ -17,7 +17,7 @@ class WinRMConfiguration { /** * Create a WinRMConfiguration. - * @member {array} [listeners] The list of Windows Remote Management + * @property {array} [listeners] The list of Windows Remote Management * listeners */ constructor() { diff --git a/lib/services/computeManagement2/lib/models/winRMListener.js b/lib/services/computeManagement2/lib/models/winRMListener.js index cf839b3671..c3d0aa6bf8 100644 --- a/lib/services/computeManagement2/lib/models/winRMListener.js +++ b/lib/services/computeManagement2/lib/models/winRMListener.js @@ -17,10 +17,10 @@ class WinRMListener { /** * Create a WinRMListener. - * @member {string} [protocol] Specifies the protocol of listener.

    + * @property {string} [protocol] Specifies the protocol of listener.

    * Possible values are:
    **http**

    **https**. Possible values * include: 'Http', 'Https' - * @member {string} [certificateUrl] This is the URL of a certificate that + * @property {string} [certificateUrl] This is the URL of a certificate that * has been uploaded to Key Vault as a secret. For adding a secret to the Key * Vault, see [Add a key or secret to the key * vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). diff --git a/lib/services/computeManagement2/lib/models/windowsConfiguration.js b/lib/services/computeManagement2/lib/models/windowsConfiguration.js index 5d2cb0544a..2f0bf33e80 100644 --- a/lib/services/computeManagement2/lib/models/windowsConfiguration.js +++ b/lib/services/computeManagement2/lib/models/windowsConfiguration.js @@ -17,21 +17,21 @@ class WindowsConfiguration { /** * Create a WindowsConfiguration. - * @member {boolean} [provisionVMAgent] Indicates whether virtual machine + * @property {boolean} [provisionVMAgent] Indicates whether virtual machine * agent should be provisioned on the virtual machine.

    When this * property is not specified in the request body, default behavior is to set * it to true. This will ensure that VM Agent is installed on the VM so that * extensions can be added to the VM later. - * @member {boolean} [enableAutomaticUpdates] Indicates whether virtual + * @property {boolean} [enableAutomaticUpdates] Indicates whether virtual * machine is enabled for automatic updates. - * @member {string} [timeZone] Specifies the time zone of the virtual + * @property {string} [timeZone] Specifies the time zone of the virtual * machine. e.g. "Pacific Standard Time" - * @member {array} [additionalUnattendContent] Specifies additional base-64 + * @property {array} [additionalUnattendContent] Specifies additional base-64 * encoded XML formatted information that can be included in the Unattend.xml * file, which is used by Windows Setup. - * @member {object} [winRM] Specifies the Windows Remote Management + * @property {object} [winRM] Specifies the Windows Remote Management * listeners. This enables remote Windows PowerShell. - * @member {array} [winRM.listeners] The list of Windows Remote Management + * @property {array} [winRM.listeners] The list of Windows Remote Management * listeners */ constructor() { diff --git a/lib/services/computeManagement2/lib/operations/disks.js b/lib/services/computeManagement2/lib/operations/disks.js index d6f0e0ed24..6487c52018 100644 --- a/lib/services/computeManagement2/lib/operations/disks.js +++ b/lib/services/computeManagement2/lib/operations/disks.js @@ -38,12 +38,16 @@ const WebResource = msRest.WebResource; * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -71,35 +75,18 @@ const WebResource = msRest.WebResource; * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -206,35 +193,18 @@ function _createOrUpdate(resourceGroupName, diskName, disk, options, callback) { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -359,7 +329,7 @@ function _get(resourceGroupName, diskName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -566,7 +536,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -701,7 +671,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -816,7 +786,7 @@ function _list(options, callback) { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -980,12 +950,16 @@ function _revokeAccess(resourceGroupName, diskName, options, callback) { * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -1013,35 +987,18 @@ function _revokeAccess(resourceGroupName, diskName, options, callback) { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -1083,7 +1040,7 @@ function _beginCreateOrUpdate(resourceGroupName, diskName, disk, options, callba if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1247,35 +1204,18 @@ function _beginCreateOrUpdate(resourceGroupName, diskName, disk, options, callba * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -1320,7 +1260,7 @@ function _beginUpdate(resourceGroupName, diskName, disk, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1499,7 +1439,7 @@ function _beginDeleteMethod(resourceGroupName, diskName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1604,7 +1544,7 @@ function _beginDeleteMethod(resourceGroupName, diskName, options, callback) { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -1637,7 +1577,7 @@ function _beginGrantAccess(resourceGroupName, diskName, grantAccessData, options if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1799,7 +1739,7 @@ function _beginRevokeAccess(resourceGroupName, diskName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -2192,12 +2132,16 @@ class Disks { * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -2225,35 +2169,18 @@ class Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -2315,12 +2242,16 @@ class Disks { * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -2348,35 +2279,18 @@ class Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -2459,35 +2373,18 @@ class Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -2551,35 +2448,18 @@ class Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -3000,7 +2880,7 @@ class Disks { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -3044,7 +2924,7 @@ class Disks { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -3210,12 +3090,16 @@ class Disks { * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -3243,35 +3127,18 @@ class Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -3333,12 +3200,16 @@ class Disks { * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -3366,35 +3237,18 @@ class Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -3477,35 +3331,18 @@ class Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -3569,35 +3406,18 @@ class Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -3766,7 +3586,7 @@ class Disks { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -3810,7 +3630,7 @@ class Disks { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. diff --git a/lib/services/computeManagement2/lib/operations/galleries.js b/lib/services/computeManagement2/lib/operations/galleries.js index f06a95e924..5159871c59 100644 --- a/lib/services/computeManagement2/lib/operations/galleries.js +++ b/lib/services/computeManagement2/lib/operations/galleries.js @@ -28,7 +28,7 @@ const WebResource = msRest.WebResource; * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * @@ -594,7 +594,7 @@ function _list(options, callback) { * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * @@ -1201,7 +1201,7 @@ class Galleries { * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * @@ -1247,7 +1247,7 @@ class Galleries { * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * @@ -1648,7 +1648,7 @@ class Galleries { * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * @@ -1694,7 +1694,7 @@ class Galleries { * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * diff --git a/lib/services/computeManagement2/lib/operations/galleryImageVersions.js b/lib/services/computeManagement2/lib/operations/galleryImageVersions.js index d38aff799c..23bace3111 100644 --- a/lib/services/computeManagement2/lib/operations/galleryImageVersions.js +++ b/lib/services/computeManagement2/lib/operations/galleryImageVersions.js @@ -39,7 +39,7 @@ const WebResource = msRest.WebResource; * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -47,11 +47,11 @@ const WebResource = msRest.WebResource; * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * @@ -548,7 +548,7 @@ function _listByGalleryImage(resourceGroupName, galleryName, galleryImageName, o * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -556,11 +556,11 @@ function _listByGalleryImage(resourceGroupName, galleryName, galleryImageName, o * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * @@ -1077,7 +1077,7 @@ class GalleryImageVersions { * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -1085,11 +1085,11 @@ class GalleryImageVersions { * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * @@ -1151,7 +1151,7 @@ class GalleryImageVersions { * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -1159,11 +1159,11 @@ class GalleryImageVersions { * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * @@ -1547,7 +1547,7 @@ class GalleryImageVersions { * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -1555,11 +1555,11 @@ class GalleryImageVersions { * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * @@ -1621,7 +1621,7 @@ class GalleryImageVersions { * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -1629,11 +1629,11 @@ class GalleryImageVersions { * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * diff --git a/lib/services/computeManagement2/lib/operations/galleryImages.js b/lib/services/computeManagement2/lib/operations/galleryImages.js index 2fe4846efb..8327785ed8 100644 --- a/lib/services/computeManagement2/lib/operations/galleryImages.js +++ b/lib/services/computeManagement2/lib/operations/galleryImages.js @@ -32,7 +32,7 @@ const WebResource = msRest.WebResource; * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -52,7 +52,7 @@ const WebResource = msRest.WebResource; * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * @@ -542,7 +542,7 @@ function _listByGallery(resourceGroupName, galleryName, options, callback) { * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -562,7 +562,7 @@ function _listByGallery(resourceGroupName, galleryName, options, callback) { * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * @@ -1088,7 +1088,7 @@ class GalleryImages { * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -1108,7 +1108,7 @@ class GalleryImages { * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * @@ -1191,7 +1191,7 @@ class GalleryImages { * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -1211,7 +1211,7 @@ class GalleryImages { * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * @@ -1591,7 +1591,7 @@ class GalleryImages { * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -1611,7 +1611,7 @@ class GalleryImages { * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * @@ -1694,7 +1694,7 @@ class GalleryImages { * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -1714,7 +1714,7 @@ class GalleryImages { * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * diff --git a/lib/services/computeManagement2/lib/operations/index.d.ts b/lib/services/computeManagement2/lib/operations/index.d.ts index 775363b57e..78fb753060 100644 --- a/lib/services/computeManagement2/lib/operations/index.d.ts +++ b/lib/services/computeManagement2/lib/operations/index.d.ts @@ -2584,11 +2584,11 @@ export interface VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -2637,10 +2637,10 @@ export interface VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -2772,7 +2772,7 @@ export interface VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -3009,11 +3009,11 @@ export interface VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -3062,10 +3062,10 @@ export interface VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -3197,7 +3197,7 @@ export interface VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -3453,11 +3453,11 @@ export interface VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -3506,10 +3506,10 @@ export interface VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -3641,7 +3641,7 @@ export interface VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -3876,11 +3876,11 @@ export interface VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -3929,10 +3929,10 @@ export interface VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -4064,7 +4064,7 @@ export interface VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -4907,8 +4907,8 @@ export interface VirtualMachines { /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -4916,7 +4916,7 @@ export interface VirtualMachines { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -4931,8 +4931,8 @@ export interface VirtualMachines { reimageWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: { tempDisk? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -4940,7 +4940,7 @@ export interface VirtualMachines { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -5380,11 +5380,11 @@ export interface VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -5433,10 +5433,10 @@ export interface VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -5568,7 +5568,7 @@ export interface VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -5805,11 +5805,11 @@ export interface VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -5858,10 +5858,10 @@ export interface VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -5993,7 +5993,7 @@ export interface VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -6249,11 +6249,11 @@ export interface VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -6302,10 +6302,10 @@ export interface VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -6437,7 +6437,7 @@ export interface VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -6672,11 +6672,11 @@ export interface VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -6725,10 +6725,10 @@ export interface VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -6860,7 +6860,7 @@ export interface VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -7344,8 +7344,8 @@ export interface VirtualMachines { /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -7353,7 +7353,7 @@ export interface VirtualMachines { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -7368,8 +7368,8 @@ export interface VirtualMachines { beginReimageWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: { tempDisk? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -7377,7 +7377,7 @@ export interface VirtualMachines { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -9236,12 +9236,12 @@ export interface VirtualMachineScaleSets { * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -9313,7 +9313,7 @@ export interface VirtualMachineScaleSets { * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -9373,7 +9373,7 @@ export interface VirtualMachineScaleSets { * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -9695,12 +9695,12 @@ export interface VirtualMachineScaleSets { * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -9772,7 +9772,7 @@ export interface VirtualMachineScaleSets { * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -9832,7 +9832,7 @@ export interface VirtualMachineScaleSets { * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -11496,7 +11496,8 @@ export interface VirtualMachineScaleSets { /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -11525,7 +11526,8 @@ export interface VirtualMachineScaleSets { /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -11989,12 +11991,12 @@ export interface VirtualMachineScaleSets { * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -12066,7 +12068,7 @@ export interface VirtualMachineScaleSets { * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -12126,7 +12128,7 @@ export interface VirtualMachineScaleSets { * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -12448,12 +12450,12 @@ export interface VirtualMachineScaleSets { * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -12525,7 +12527,7 @@ export interface VirtualMachineScaleSets { * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -12585,7 +12587,7 @@ export interface VirtualMachineScaleSets { * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -13893,7 +13895,8 @@ export interface VirtualMachineScaleSets { /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -13922,7 +13925,8 @@ export interface VirtualMachineScaleSets { /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -14326,6 +14330,9 @@ export interface VirtualMachineScaleSetExtensions { * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -14379,6 +14386,9 @@ export interface VirtualMachineScaleSetExtensions { * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -14650,6 +14660,9 @@ export interface VirtualMachineScaleSetExtensions { * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -14703,6 +14716,9 @@ export interface VirtualMachineScaleSetExtensions { * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -15312,7 +15328,7 @@ export interface VirtualMachineScaleSetVMs { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -15338,7 +15354,7 @@ export interface VirtualMachineScaleSetVMs { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -15515,6 +15531,10 @@ export interface VirtualMachineScaleSetVMs { * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -15672,11 +15692,11 @@ export interface VirtualMachineScaleSetVMs { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -15727,10 +15747,10 @@ export interface VirtualMachineScaleSetVMs { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -15862,7 +15882,7 @@ export interface VirtualMachineScaleSetVMs { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -15928,6 +15948,10 @@ export interface VirtualMachineScaleSetVMs { * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -16085,11 +16109,11 @@ export interface VirtualMachineScaleSetVMs { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -16140,10 +16164,10 @@ export interface VirtualMachineScaleSetVMs { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -16275,7 +16299,7 @@ export interface VirtualMachineScaleSetVMs { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -17021,7 +17045,7 @@ export interface VirtualMachineScaleSetVMs { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -17047,7 +17071,7 @@ export interface VirtualMachineScaleSetVMs { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -17224,6 +17248,10 @@ export interface VirtualMachineScaleSetVMs { * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -17381,11 +17409,11 @@ export interface VirtualMachineScaleSetVMs { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -17436,10 +17464,10 @@ export interface VirtualMachineScaleSetVMs { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -17571,7 +17599,7 @@ export interface VirtualMachineScaleSetVMs { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -17637,6 +17665,10 @@ export interface VirtualMachineScaleSetVMs { * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -17794,11 +17826,11 @@ export interface VirtualMachineScaleSetVMs { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -17849,10 +17881,10 @@ export interface VirtualMachineScaleSetVMs { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -17984,7 +18016,7 @@ export interface VirtualMachineScaleSetVMs { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -18604,7 +18636,7 @@ export interface LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -18647,7 +18679,7 @@ export interface LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -18706,7 +18738,7 @@ export interface LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -18745,7 +18777,7 @@ export interface LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -18808,7 +18840,7 @@ export interface LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -18851,7 +18883,7 @@ export interface LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -18910,7 +18942,7 @@ export interface LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -18949,7 +18981,7 @@ export interface LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -19320,12 +19352,16 @@ export interface Disks { * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -19353,35 +19389,18 @@ export interface Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -19431,12 +19450,16 @@ export interface Disks { * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -19464,35 +19487,18 @@ export interface Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -19560,35 +19566,18 @@ export interface Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -19640,35 +19629,18 @@ export interface Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -19966,7 +19938,7 @@ export interface Disks { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -19998,7 +19970,7 @@ export interface Disks { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -20122,12 +20094,16 @@ export interface Disks { * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -20155,35 +20131,18 @@ export interface Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -20233,12 +20192,16 @@ export interface Disks { * @param {string} [disk.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [disk.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} disk.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} disk.creationData.createOption This enumerates the possible * sources of a disk's creation. Possible values include: 'Empty', 'Attach', - * 'FromImage', 'Import', 'Copy', 'Restore' + * 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [disk.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -20266,35 +20229,18 @@ export interface Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used for Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -20362,35 +20308,18 @@ export interface Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -20442,35 +20371,18 @@ export interface Disks { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [disk.encryptionSettings] Encryption settings for disk or - * snapshot + * @param {object} [disk.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [disk.encryptionSettings.enabled] Set this flag to true and - * provide DiskEncryptionKey and optional KeyEncryptionKey to enable + * @param {boolean} disk.encryptionSettingsCollection.enabled Set this flag to + * true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable * encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [disk.encryptionSettings.diskEncryptionKey] Key Vault Secret - * Url and vault id of the disk encryption key - * - * @param {object} disk.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} disk.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [disk.encryptionSettings.keyEncryptionKey] Key Vault Key Url - * and vault id of the key encryption key - * - * @param {object} disk.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} [disk.encryptionSettings.keyEncryptionKey.sourceVault.id] - * Resource Id - * - * @param {string} disk.encryptionSettings.keyEncryptionKey.keyUrl Url pointing - * to a key or secret in KeyVault + * @param {array} [disk.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {number} [disk.diskIOPSReadWrite] The number of IOPS allowed for this * disk; only settable for UltraSSD disks. One operation can transfer between @@ -20597,7 +20509,7 @@ export interface Disks { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -20629,7 +20541,7 @@ export interface Disks { * the get disk access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -20874,12 +20786,16 @@ export interface Snapshots { * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -20908,35 +20824,18 @@ export interface Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -20976,12 +20875,16 @@ export interface Snapshots { * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -21010,35 +20913,18 @@ export interface Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -21098,35 +20984,18 @@ export interface Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -21170,35 +21039,18 @@ export interface Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -21488,7 +21340,7 @@ export interface Snapshots { * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -21520,7 +21372,7 @@ export interface Snapshots { * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -21642,12 +21494,16 @@ export interface Snapshots { * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -21676,35 +21532,18 @@ export interface Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -21744,12 +21583,16 @@ export interface Snapshots { * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -21778,35 +21621,18 @@ export interface Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -21866,35 +21692,18 @@ export interface Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -21938,35 +21747,18 @@ export interface Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -22085,7 +21877,7 @@ export interface Snapshots { * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -22117,7 +21909,7 @@ export interface Snapshots { * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -22354,7 +22146,7 @@ export interface Galleries { * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * @@ -22388,7 +22180,7 @@ export interface Galleries { * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * @@ -22666,7 +22458,7 @@ export interface Galleries { * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * @@ -22700,7 +22492,7 @@ export interface Galleries { * Image Gallery operation. * * @param {string} [gallery.description] The description of this Shared Image - * Gallery resource. This property is updateable. + * Gallery resource. This property is updatable. * * @param {object} [gallery.identifier] * @@ -22940,7 +22732,7 @@ export interface GalleryImages { * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -22960,7 +22752,7 @@ export interface GalleryImages { * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * @@ -23031,7 +22823,7 @@ export interface GalleryImages { * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -23051,7 +22843,7 @@ export interface GalleryImages { * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * @@ -23335,7 +23127,7 @@ export interface GalleryImages { * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -23355,7 +23147,7 @@ export interface GalleryImages { * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * @@ -23426,7 +23218,7 @@ export interface GalleryImages { * gallery image operation. * * @param {string} [galleryImage.description] The description of this gallery - * Image Definition resource. This property is updateable. + * Image Definition resource. This property is updatable. * * @param {string} [galleryImage.eula] The Eula agreement for the gallery Image * Definition. @@ -23446,7 +23238,7 @@ export interface GalleryImages { * * @param {date} [galleryImage.endOfLifeDate] The end of life date of the * gallery Image Definition. This property can be used for decommissioning - * purposes. This property is updateable. + * purposes. This property is updatable. * * @param {object} galleryImage.identifier * @@ -23675,7 +23467,7 @@ export interface GalleryImageVersions { * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -23683,11 +23475,11 @@ export interface GalleryImageVersions { * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * @@ -23737,7 +23529,7 @@ export interface GalleryImageVersions { * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -23745,11 +23537,11 @@ export interface GalleryImageVersions { * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * @@ -24037,7 +23829,7 @@ export interface GalleryImageVersions { * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -24045,11 +23837,11 @@ export interface GalleryImageVersions { * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * @@ -24099,7 +23891,7 @@ export interface GalleryImageVersions { * @param {number} [galleryImageVersion.publishingProfile.replicaCount] The * number of replicas of the Image Version to be created per region. This * property would take effect for a region when regionalReplicaCount is not - * specified. This property is updateable. + * specified. This property is updatable. * * @param {boolean} [galleryImageVersion.publishingProfile.excludeFromLatest] * If set to true, Virtual Machines deployed from the latest version of the @@ -24107,11 +23899,11 @@ export interface GalleryImageVersions { * * @param {date} [galleryImageVersion.publishingProfile.endOfLifeDate] The end * of life date of the gallery Image Version. This property can be used for - * decommissioning purposes. This property is updateable. + * decommissioning purposes. This property is updatable. * * @param {array} [galleryImageVersion.publishingProfile.targetRegions] The * target regions where the Image Version is going to be replicated to. This - * property is updateable. + * property is updatable. * * @param {object} galleryImageVersion.publishingProfile.source * diff --git a/lib/services/computeManagement2/lib/operations/logAnalytics.js b/lib/services/computeManagement2/lib/operations/logAnalytics.js index 73ce657a69..b350dda704 100644 --- a/lib/services/computeManagement2/lib/operations/logAnalytics.js +++ b/lib/services/computeManagement2/lib/operations/logAnalytics.js @@ -36,7 +36,7 @@ const WebResource = msRest.WebResource; * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -134,7 +134,7 @@ function _exportRequestRateByInterval(parameters, location, options, callback) { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -235,7 +235,7 @@ function _exportThrottledRequests(parameters, location, options, callback) { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -417,7 +417,7 @@ function _beginExportRequestRateByInterval(parameters, location, options, callba * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -614,7 +614,7 @@ class LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -669,7 +669,7 @@ class LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -743,7 +743,7 @@ class LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -794,7 +794,7 @@ class LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -872,7 +872,7 @@ class LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -927,7 +927,7 @@ class LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -1001,7 +1001,7 @@ class LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by @@ -1052,7 +1052,7 @@ class LogAnalytics { * @param {boolean} [parameters.groupByThrottlePolicy] Group query result by * Throttle Policy applied. * - * @param {boolean} [parameters.groupByOperationName] Group query result by by + * @param {boolean} [parameters.groupByOperationName] Group query result by * Operation Name. * * @param {boolean} [parameters.groupByResourceName] Group query result by diff --git a/lib/services/computeManagement2/lib/operations/snapshots.js b/lib/services/computeManagement2/lib/operations/snapshots.js index 499e46f8d1..f4bb692c24 100644 --- a/lib/services/computeManagement2/lib/operations/snapshots.js +++ b/lib/services/computeManagement2/lib/operations/snapshots.js @@ -36,12 +36,16 @@ const WebResource = msRest.WebResource; * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -70,35 +74,18 @@ const WebResource = msRest.WebResource; * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -197,35 +184,18 @@ function _createOrUpdate(resourceGroupName, snapshotName, snapshot, options, cal * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -342,7 +312,7 @@ function _get(resourceGroupName, snapshotName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -549,7 +519,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -684,7 +654,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -799,7 +769,7 @@ function _list(options, callback) { * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -961,12 +931,16 @@ function _revokeAccess(resourceGroupName, snapshotName, options, callback) { * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -995,35 +969,18 @@ function _revokeAccess(resourceGroupName, snapshotName, options, callback) { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -1057,7 +1014,7 @@ function _beginCreateOrUpdate(resourceGroupName, snapshotName, snapshot, options if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1221,35 +1178,18 @@ function _beginCreateOrUpdate(resourceGroupName, snapshotName, snapshot, options * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -1286,7 +1226,7 @@ function _beginUpdate(resourceGroupName, snapshotName, snapshot, options, callba if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1465,7 +1405,7 @@ function _beginDeleteMethod(resourceGroupName, snapshotName, options, callback) if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1570,7 +1510,7 @@ function _beginDeleteMethod(resourceGroupName, snapshotName, options, callback) * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -1603,7 +1543,7 @@ function _beginGrantAccess(resourceGroupName, snapshotName, grantAccessData, opt if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1765,7 +1705,7 @@ function _beginRevokeAccess(resourceGroupName, snapshotName, options, callback) if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-06-01'; + let apiVersion = '2018-09-30'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -2156,12 +2096,16 @@ class Snapshots { * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -2190,35 +2134,18 @@ class Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -2270,12 +2197,16 @@ class Snapshots { * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -2304,35 +2235,18 @@ class Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -2407,35 +2321,18 @@ class Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -2491,35 +2388,18 @@ class Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -2932,7 +2812,7 @@ class Snapshots { * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -2976,7 +2856,7 @@ class Snapshots { * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -3140,12 +3020,16 @@ class Snapshots { * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -3174,35 +3058,18 @@ class Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -3254,12 +3121,16 @@ class Snapshots { * @param {string} [snapshot.osType] The Operating System type. Possible values * include: 'Windows', 'Linux' * + * @param {string} [snapshot.hyperVGeneration] The hypervisor generation of the + * Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', + * 'V2' + * * @param {object} snapshot.creationData Disk source information. CreationData * information cannot be changed after the disk has been created. * * @param {string} snapshot.creationData.createOption This enumerates the * possible sources of a disk's creation. Possible values include: 'Empty', - * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore' + * 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload' * * @param {string} [snapshot.creationData.storageAccountId] If createOption is * Import, the Azure Resource Manager identifier of the storage account @@ -3288,35 +3159,18 @@ class Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {string} snapshot.location Resource location * @@ -3391,35 +3245,18 @@ class Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -3475,35 +3312,18 @@ class Snapshots { * indicates a resize. Resizes are only allowed if the disk is not attached to * a running VM, and can only increase the disk's size. * - * @param {object} [snapshot.encryptionSettings] Encryption settings for disk - * or snapshot + * @param {object} [snapshot.encryptionSettingsCollection] Encryption settings + * collection used be Azure Disk Encryption, can contain multiple encryption + * settings per disk or snapshot. * - * @param {boolean} [snapshot.encryptionSettings.enabled] Set this flag to true - * and provide DiskEncryptionKey and optional KeyEncryptionKey to enable - * encryption. Set this flag to false and remove DiskEncryptionKey and + * @param {boolean} snapshot.encryptionSettingsCollection.enabled Set this flag + * to true and provide DiskEncryptionKey and optional KeyEncryptionKey to + * enable encryption. Set this flag to false and remove DiskEncryptionKey and * KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the * request object, the existing settings remain unchanged. * - * @param {object} [snapshot.encryptionSettings.diskEncryptionKey] Key Vault - * Secret Url and vault id of the disk encryption key - * - * @param {object} snapshot.encryptionSettings.diskEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} snapshot.encryptionSettings.diskEncryptionKey.secretUrl Url - * pointing to a key or secret in KeyVault - * - * @param {object} [snapshot.encryptionSettings.keyEncryptionKey] Key Vault Key - * Url and vault id of the key encryption key - * - * @param {object} snapshot.encryptionSettings.keyEncryptionKey.sourceVault - * Resource id of the KeyVault containing the key or secret - * - * @param {string} - * [snapshot.encryptionSettings.keyEncryptionKey.sourceVault.id] Resource Id - * - * @param {string} snapshot.encryptionSettings.keyEncryptionKey.keyUrl Url - * pointing to a key or secret in KeyVault + * @param {array} [snapshot.encryptionSettingsCollection.encryptionSettings] A + * collection of encryption settings, one for each disk volume. * * @param {object} [snapshot.tags] Resource tags * @@ -3664,7 +3484,7 @@ class Snapshots { * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. @@ -3708,7 +3528,7 @@ class Snapshots { * the get snapshot access operation. * * @param {string} grantAccessData.access Possible values include: 'None', - * 'Read' + * 'Read', 'Write' * * @param {number} grantAccessData.durationInSeconds Time duration in seconds * until the SAS access expires. diff --git a/lib/services/computeManagement2/lib/operations/virtualMachineScaleSetExtensions.js b/lib/services/computeManagement2/lib/operations/virtualMachineScaleSetExtensions.js index 0904d03501..a59b9e0c61 100644 --- a/lib/services/computeManagement2/lib/operations/virtualMachineScaleSetExtensions.js +++ b/lib/services/computeManagement2/lib/operations/virtualMachineScaleSetExtensions.js @@ -55,6 +55,9 @@ const WebResource = msRest.WebResource; * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -538,6 +541,9 @@ function _list(resourceGroupName, vmScaleSetName, options, callback) { * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -1030,6 +1036,9 @@ class VirtualMachineScaleSetExtensions { * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -1095,6 +1104,9 @@ class VirtualMachineScaleSetExtensions { * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -1462,6 +1474,9 @@ class VirtualMachineScaleSetExtensions { * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -1527,6 +1542,9 @@ class VirtualMachineScaleSetExtensions { * contain either protectedSettings or protectedSettingsFromKeyVault or no * protected settings at all. * + * @param {array} [extensionParameters.provisionAfterExtensions] Collection of + * extension names after which this extension needs to be provisioned. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the diff --git a/lib/services/computeManagement2/lib/operations/virtualMachineScaleSetVMs.js b/lib/services/computeManagement2/lib/operations/virtualMachineScaleSetVMs.js index 05d4b7e55a..58cac2e68c 100644 --- a/lib/services/computeManagement2/lib/operations/virtualMachineScaleSetVMs.js +++ b/lib/services/computeManagement2/lib/operations/virtualMachineScaleSetVMs.js @@ -27,7 +27,7 @@ const WebResource = msRest.WebResource; * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -231,6 +231,10 @@ function _deallocate(resourceGroupName, vmScaleSetName, instanceId, options, cal * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -388,11 +392,11 @@ function _deallocate(resourceGroupName, vmScaleSetName, instanceId, options, cal * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -443,10 +447,10 @@ function _deallocate(resourceGroupName, vmScaleSetName, instanceId, options, cal * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -578,7 +582,7 @@ function _deallocate(resourceGroupName, vmScaleSetName, instanceId, options, cal * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -1655,7 +1659,7 @@ function _runCommand(resourceGroupName, vmScaleSetName, instanceId, parameters, * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -2080,6 +2084,10 @@ function _beginDeallocate(resourceGroupName, vmScaleSetName, instanceId, options * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -2237,11 +2245,11 @@ function _beginDeallocate(resourceGroupName, vmScaleSetName, instanceId, options * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -2292,10 +2300,10 @@ function _beginDeallocate(resourceGroupName, vmScaleSetName, instanceId, options * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -2427,7 +2435,7 @@ function _beginDeallocate(resourceGroupName, vmScaleSetName, instanceId, options * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -3782,7 +3790,7 @@ class VirtualMachineScaleSetVMs { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -3820,7 +3828,7 @@ class VirtualMachineScaleSetVMs { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -4066,6 +4074,10 @@ class VirtualMachineScaleSetVMs { * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -4223,11 +4235,11 @@ class VirtualMachineScaleSetVMs { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -4278,10 +4290,10 @@ class VirtualMachineScaleSetVMs { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -4413,7 +4425,7 @@ class VirtualMachineScaleSetVMs { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -4491,6 +4503,10 @@ class VirtualMachineScaleSetVMs { * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -4648,11 +4664,11 @@ class VirtualMachineScaleSetVMs { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -4703,10 +4719,10 @@ class VirtualMachineScaleSetVMs { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -4838,7 +4854,7 @@ class VirtualMachineScaleSetVMs { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -5869,7 +5885,7 @@ class VirtualMachineScaleSetVMs { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -5907,7 +5923,7 @@ class VirtualMachineScaleSetVMs { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -6153,6 +6169,10 @@ class VirtualMachineScaleSetVMs { * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -6310,11 +6330,11 @@ class VirtualMachineScaleSetVMs { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -6365,10 +6385,10 @@ class VirtualMachineScaleSetVMs { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -6500,7 +6520,7 @@ class VirtualMachineScaleSetVMs { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -6578,6 +6598,10 @@ class VirtualMachineScaleSetVMs { * @param {object} parameters Parameters supplied to the Update Virtual Machine * Scale Sets VM operation. * + * @param {boolean} [parameters.protectFromScaleIn] Specifies whether the + * virtual machine instance shouldn't be considered for deletion during a + * scale-in operation + * * @param {object} [parameters.hardwareProfile] Specifies the hardware settings * for the virtual machine. * @@ -6735,11 +6759,11 @@ class VirtualMachineScaleSetVMs { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -6790,10 +6814,10 @@ class VirtualMachineScaleSetVMs { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -6925,7 +6949,7 @@ class VirtualMachineScaleSetVMs { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation diff --git a/lib/services/computeManagement2/lib/operations/virtualMachineScaleSets.js b/lib/services/computeManagement2/lib/operations/virtualMachineScaleSets.js index aad8f6b533..8fae72f2e6 100644 --- a/lib/services/computeManagement2/lib/operations/virtualMachineScaleSets.js +++ b/lib/services/computeManagement2/lib/operations/virtualMachineScaleSets.js @@ -297,12 +297,12 @@ const WebResource = msRest.WebResource; * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -374,7 +374,7 @@ const WebResource = msRest.WebResource; * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -434,7 +434,7 @@ const WebResource = msRest.WebResource; * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -2363,7 +2363,8 @@ function _updateInstances(resourceGroupName, vmScaleSetName, instanceIds, option /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -2934,12 +2935,12 @@ function _forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName, * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -3011,7 +3012,7 @@ function _forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName, * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -3071,7 +3072,7 @@ function _forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName, * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -5105,7 +5106,8 @@ function _beginUpdateInstances(resourceGroupName, vmScaleSetName, instanceIds, o /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -6255,12 +6257,12 @@ class VirtualMachineScaleSets { * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -6332,7 +6334,7 @@ class VirtualMachineScaleSets { * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -6392,7 +6394,7 @@ class VirtualMachineScaleSets { * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -6726,12 +6728,12 @@ class VirtualMachineScaleSets { * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -6803,7 +6805,7 @@ class VirtualMachineScaleSets { * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -6863,7 +6865,7 @@ class VirtualMachineScaleSets { * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -8974,7 +8976,8 @@ class VirtualMachineScaleSets { /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -9015,7 +9018,8 @@ class VirtualMachineScaleSets { /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -9548,12 +9552,12 @@ class VirtualMachineScaleSets { * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -9625,7 +9629,7 @@ class VirtualMachineScaleSets { * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -9685,7 +9689,7 @@ class VirtualMachineScaleSets { * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -10019,12 +10023,12 @@ class VirtualMachineScaleSets { * * @param {object} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine scale set. + * Specifies the ephemeral disk Settings for the operating system disk used by + * the virtual machine scale set. * * @param {string} * [parameters.virtualMachineProfile.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {number} @@ -10096,7 +10100,7 @@ class VirtualMachineScaleSets { * @param {string} * [parameters.virtualMachineProfile.networkProfile.healthProbe.id] The ARM * resource id in the form of - * /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * * @param {array} * [parameters.virtualMachineProfile.networkProfile.networkInterfaceConfigurations] @@ -10156,7 +10160,7 @@ class VirtualMachineScaleSets { * @param {boolean} [parameters.singlePlacementGroup] When true this limits the * scale set to a single placement group, of max size 100 virtual machines. * - * @param {boolean} [parameters.zoneBalance] Whether to force stictly even + * @param {boolean} [parameters.zoneBalance] Whether to force strictly even * Virtual Machine distribution cross x-zones in case there is zone outage. * * @param {number} [parameters.platformFaultDomainCount] Fault Domain count for @@ -11749,7 +11753,8 @@ class VirtualMachineScaleSets { /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -11790,7 +11795,8 @@ class VirtualMachineScaleSets { /** * Reimages (upgrade the operating system) one or more virtual machines in a VM - * scale set. + * scale set which don't have a ephemeral OS disk, for virtual machines who + * have a ephemeral OS disk the virtual machine is reset to initial state. * * @param {string} resourceGroupName The name of the resource group. * diff --git a/lib/services/computeManagement2/lib/operations/virtualMachines.js b/lib/services/computeManagement2/lib/operations/virtualMachines.js index d79de46871..77d335d5f3 100644 --- a/lib/services/computeManagement2/lib/operations/virtualMachines.js +++ b/lib/services/computeManagement2/lib/operations/virtualMachines.js @@ -438,11 +438,11 @@ function _capture(resourceGroupName, vmName, parameters, options, callback) { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -491,10 +491,10 @@ function _capture(resourceGroupName, vmName, parameters, options, callback) { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -626,7 +626,7 @@ function _capture(resourceGroupName, vmName, parameters, options, callback) { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -921,11 +921,11 @@ function _createOrUpdate(resourceGroupName, vmName, parameters, options, callbac * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -974,10 +974,10 @@ function _createOrUpdate(resourceGroupName, vmName, parameters, options, callbac * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -1109,7 +1109,7 @@ function _createOrUpdate(resourceGroupName, vmName, parameters, options, callbac * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -2506,8 +2506,8 @@ function _redeploy(resourceGroupName, vmName, options, callback) { /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -2515,7 +2515,7 @@ function _redeploy(resourceGroupName, vmName, options, callback) { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -3081,11 +3081,11 @@ function _beginCapture(resourceGroupName, vmName, parameters, options, callback) * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -3134,10 +3134,10 @@ function _beginCapture(resourceGroupName, vmName, parameters, options, callback) * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -3269,7 +3269,7 @@ function _beginCapture(resourceGroupName, vmName, parameters, options, callback) * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -3663,11 +3663,11 @@ function _beginCreateOrUpdate(resourceGroupName, vmName, parameters, options, ca * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -3716,10 +3716,10 @@ function _beginCreateOrUpdate(resourceGroupName, vmName, parameters, options, ca * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -3851,7 +3851,7 @@ function _beginCreateOrUpdate(resourceGroupName, vmName, parameters, options, ca * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -4938,8 +4938,8 @@ function _beginRedeploy(resourceGroupName, vmName, options, callback) { } /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -4947,7 +4947,7 @@ function _beginRedeploy(resourceGroupName, vmName, options, callback) { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -6202,11 +6202,11 @@ class VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -6255,10 +6255,10 @@ class VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -6390,7 +6390,7 @@ class VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -6639,11 +6639,11 @@ class VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -6692,10 +6692,10 @@ class VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -6827,7 +6827,7 @@ class VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -7098,11 +7098,11 @@ class VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -7151,10 +7151,10 @@ class VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -7286,7 +7286,7 @@ class VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -7533,11 +7533,11 @@ class VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -7586,10 +7586,10 @@ class VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -7721,7 +7721,7 @@ class VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -8930,8 +8930,8 @@ class VirtualMachines { } /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -8939,7 +8939,7 @@ class VirtualMachines { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -8966,8 +8966,8 @@ class VirtualMachines { } /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -8975,7 +8975,7 @@ class VirtualMachines { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -9511,11 +9511,11 @@ class VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -9564,10 +9564,10 @@ class VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -9699,7 +9699,7 @@ class VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -9948,11 +9948,11 @@ class VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -10001,10 +10001,10 @@ class VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -10136,7 +10136,7 @@ class VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -10407,11 +10407,11 @@ class VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -10460,10 +10460,10 @@ class VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -10595,7 +10595,7 @@ class VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -10842,11 +10842,11 @@ class VirtualMachines { * disk. * * @param {object} [parameters.storageProfile.osDisk.diffDiskSettings] - * Specifies the differencing Disk Settings for the operating system disk used - * by the virtual machine. + * Specifies the ephemeral Disk Settings for the operating system disk used by + * the virtual machine. * * @param {string} [parameters.storageProfile.osDisk.diffDiskSettings.option] - * Specifies the differencing disk settings for operating system disk. Possible + * Specifies the ephemeral disk settings for operating system disk. Possible * values include: 'Local' * * @param {string} parameters.storageProfile.osDisk.createOption Specifies how @@ -10895,10 +10895,10 @@ class VirtualMachines { * settings for the virtual machine. * * @param {string} [parameters.osProfile.computerName] Specifies the host OS - * name of the virtual machine.

    **Max-length (Windows):** 15 - * characters

    **Max-length (Linux):** 64 characters.

    For - * naming conventions and restrictions see [Azure infrastructure services - * implementation + * name of the virtual machine.

    This name cannot be updated after the + * VM is created.

    **Max-length (Windows):** 15 characters

    + * **Max-length (Linux):** 64 characters.

    For naming conventions and + * restrictions see [Azure infrastructure services implementation * guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). * * @param {string} [parameters.osProfile.adminUsername] Specifies the name of @@ -11030,7 +11030,7 @@ class VirtualMachines { * nodes to maximize availability. For more information about availability * sets, see [Manage the availability of virtual * machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - *

    For more information on Azure planned maintainance, see [Planned + *

    For more information on Azure planned maintenance, see [Planned * maintenance for virtual machines in * Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) *

    Currently, a VM can only be added to availability set at creation @@ -11718,8 +11718,8 @@ class VirtualMachines { } /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -11727,7 +11727,7 @@ class VirtualMachines { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -11754,8 +11754,8 @@ class VirtualMachines { } /** - * Reimages (upgrade the operating system) virtual machine. This operation is - * only supported for differencing OS disks. + * Reimages the virtual machine which has an ephemeral OS disk back to its + * initial state. * * @param {string} resourceGroupName The name of the resource group. * @@ -11763,7 +11763,7 @@ class VirtualMachines { * * @param {object} [options] Optional Parameters. * - * @param {boolean} [options.tempDisk] Specified whether to reimage temp disk. + * @param {boolean} [options.tempDisk] Specifies whether to reimage temp disk. * Default value: false. * * @param {object} [options.customHeaders] Headers that will be added to the diff --git a/lib/services/computeManagement2/package.json b/lib/services/computeManagement2/package.json index 2eb23074c3..53cff521a8 100644 --- a/lib/services/computeManagement2/package.json +++ b/lib/services/computeManagement2/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}