azure-cli
Version:
Microsoft Azure Cross Platform Command Line tool
268 lines (262 loc) • 15.1 kB
JavaScript
/*
* 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.
*/
;
const models = require('./index');
/**
* Describes a virtual machine scale set virtual machine profile.
*
*/
class VirtualMachineScaleSetVMProfile {
/**
* Create a VirtualMachineScaleSetVMProfile.
* @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. <br><br> **Windows-only restriction:** Cannot end
* in "." <br><br> **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". <br><br>
* **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):**
* 64 characters <br><br> **Max-length (Windows):** 20 characters
* <br><br><li> 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)<br><li>
* 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. <br><br> **Minimum-length (Windows):** 8 characters
* <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length
* (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters
* <br><br> **Complexity requirements:** 3 out of 4 conditions below need to
* be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a
* digit <br> Has a special character (Regex match [\W_]) <br><br>
* **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123",
* "Pa$$word", "pass@word1", "Password!", "Password1", "Password22",
* "iloveyou!" <br><br> 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)
* <br><br> 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. <br><br> 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. <br><br> 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. <br><br>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)
* <br><br> 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 {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.
* <br><br> 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. <br><br> Possible values are: <br><br> **None** <br><br>
* **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard
* storage. ReadOnly for Premium storage**. Possible values include: 'None',
* 'ReadOnly', 'ReadWrite'
* @member {string} [storageProfile.osDisk.createOption] Specifies how the
* virtual machines in the scale set should be created.<br><br> 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 {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. <br><br> Possible values are:
* <br><br> **Windows** <br><br> **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. Possible values
* are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS',
* 'Premium_LRS'
* @member {array} [storageProfile.dataDisks] Specifies the parameters that
* are used to add data disks to the virtual machines in the scale set.
* <br><br> 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} [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. <br><br>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. <br><br> For Linux Virtual Machines, you can easily
* view the output of your console log. <br><br> For both Windows and Linux
* virtual machines, 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. <br><br> Possible values
* are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this
* element is included in a request for an update, the value must match the
* initial value. This value cannot be updated. <br><br> 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)
* <br><br> Minimum api-version: 2015-06-15
*/
constructor() {
}
/**
* Defines the metadata of VirtualMachineScaleSetVMProfile
*
* @returns {object} metadata of VirtualMachineScaleSetVMProfile
*
*/
mapper() {
return {
required: false,
serializedName: 'VirtualMachineScaleSetVMProfile',
type: {
name: 'Composite',
className: 'VirtualMachineScaleSetVMProfile',
modelProperties: {
osProfile: {
required: false,
serializedName: 'osProfile',
type: {
name: 'Composite',
className: 'VirtualMachineScaleSetOSProfile'
}
},
storageProfile: {
required: false,
serializedName: 'storageProfile',
type: {
name: 'Composite',
className: 'VirtualMachineScaleSetStorageProfile'
}
},
networkProfile: {
required: false,
serializedName: 'networkProfile',
type: {
name: 'Composite',
className: 'VirtualMachineScaleSetNetworkProfile'
}
},
diagnosticsProfile: {
required: false,
serializedName: 'diagnosticsProfile',
type: {
name: 'Composite',
className: 'DiagnosticsProfile'
}
},
extensionProfile: {
required: false,
serializedName: 'extensionProfile',
type: {
name: 'Composite',
className: 'VirtualMachineScaleSetExtensionProfile'
}
},
licenseType: {
required: false,
serializedName: 'licenseType',
type: {
name: 'String'
}
}
}
}
};
}
}
module.exports = VirtualMachineScaleSetVMProfile;