diff --git a/specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json b/specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json index c300061b1c72..b9c3e4017185 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json @@ -3268,7 +3268,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Create or update availability set parameters." + "description": "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." }, "AvailabilitySetListResult": { "properties": { @@ -3391,7 +3391,7 @@ "additionalProperties": { "type": "string" }, - "description": "The tags attached to the resource." + "description": "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)." } }, "required": [ @@ -3413,11 +3413,11 @@ }, "type": { "type": "string", - "description": "The full type of the extension handler which includes both publisher and type." + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." }, "typeHandlerVersion": { "type": "string", - "description": "The type version of the extension handler." + "description": "Specifies the version of the script handler." }, "substatuses": { "type": "array", @@ -3448,15 +3448,15 @@ }, "type": { "type": "string", - "description": "The type of the extension handler." + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." }, "typeHandlerVersion": { "type": "string", - "description": "The type version of the extension handler." + "description": "Specifies the version of the script handler." }, "autoUpgradeMinorVersion": { "type": "boolean", - "description": "Whether the extension handler should be automatically upgraded across minor versions." + "description": "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." }, "settings": { "type": "object", @@ -3464,7 +3464,7 @@ }, "protectedSettings": { "type": "object", - "description": "Json formatted protected settings for the extension." + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." }, "provisioningState": { "readOnly": true, @@ -3504,7 +3504,7 @@ }, "product": { "type": "string", - "description": "The product ID." + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." } }, "required": [ @@ -3540,7 +3540,7 @@ "readOnly": true, "type": "integer", "format": "int32", - "description": "The LUN number for a data disk. This value is used to identify data disk image inside the VMImage and therefore it must be unique for each data disk." + "description": "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." } }, "description": "Contains the data disk images information." @@ -3705,20 +3705,20 @@ }, "product": { "type": "string", - "description": "The offer ID." + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." }, "promotionCode": { "type": "string", "description": "The promotion code." } }, - "description": "Plan for the resource." + "description": "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**." }, "HardwareProfile": { "properties": { "vmSize": { "type": "string", - "description": "The virtual machine size name.", + "description": "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](virtualmachines-list-sizes-availability-set.md)

[List all available virtual machine sizes in a region](virtualmachines-list-sizes-region.md)

[List all available virtual machine sizes for resizing](virtualmachines-list-sizes-for-resizing.md)", "enum": [ "Basic_A0", "Basic_A1", @@ -3824,7 +3824,7 @@ } } }, - "description": "Describes a hardware profile." + "description": "Specifies the hardware settings for the virtual machine." }, "ImageReference": { "properties": { @@ -3834,7 +3834,7 @@ }, "offer": { "type": "string", - "description": "The image offer." + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." }, "sku": { "type": "string", @@ -3842,7 +3842,7 @@ }, "version": { "type": "string", - "description": "The image version. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor and Build are decimal numbers. Specify 'latest' to use the latest version of the image." + "description": "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." } }, "allOf": [ @@ -3850,7 +3850,7 @@ "$ref": "#/definitions/SubResource" } ], - "description": "The image reference." + "description": "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." }, "KeyVaultSecretReference": { "properties": { @@ -3873,7 +3873,7 @@ "properties": { "keyUrl": { "type": "string", - "description": "The URL referencing a key in a Key Vault." + "description": "The URL referencing a key encryption key in Key Vault." }, "sourceVault": { "$ref": "#/definitions/SubResource", @@ -3890,11 +3890,11 @@ "properties": { "diskEncryptionKey": { "$ref": "#/definitions/KeyVaultSecretReference", - "description": "The disk encryption key which is a Key Vault Secret." + "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." }, "keyEncryptionKey": { "$ref": "#/definitions/KeyVaultKeyReference", - "description": "The key encryption key which is Key Vault Key." + "description": "Specifies the location of the key encryption key in Key Vault." }, "enabled": { "type": "boolean", @@ -3907,14 +3907,14 @@ "properties": { "uri": { "type": "string", - "description": "The virtual hard disk's URI. Must be a valid URI to a virtual hard disk." + "description": "Specifies the virtual hard disk's uri." } }, "description": "Describes the uri of a disk." }, "Caching": { "type": "string", - "description": "The caching type.", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**", "enum": [ "None", "ReadOnly", @@ -3927,7 +3927,7 @@ }, "CreateOption": { "type": "string", - "description": "The create option.", + "description": "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.", "enum": [ "fromImage", "empty", @@ -3940,7 +3940,7 @@ }, "StorageAccountType": { "type": "string", - "description": "The Storage Account type.", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.", "enum": [ "Standard_LRS", "Premium_LRS" @@ -3954,7 +3954,7 @@ "properties": { "storageAccountType": { "$ref": "#/definitions/StorageAccountType", - "description": "The Storage Account type." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." } }, "allOf": [ @@ -3968,7 +3968,7 @@ "properties": { "osType": { "type": "string", - "description": "The Operating System type.", + "description": "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**", "enum": [ "Windows", "Linux" @@ -3980,7 +3980,7 @@ }, "encryptionSettings": { "$ref": "#/definitions/DiskEncryptionSettings", - "description": "The disk encryption settings." + "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" }, "name": { "type": "string", @@ -3992,20 +3992,20 @@ }, "image": { "$ref": "#/definitions/VirtualHardDisk", - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before using it to attach to the virtual machine. If SourceImage is provided, the destination virtual hard disk must not exist." + "description": "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." }, "caching": { "$ref": "#/definitions/Caching", - "description": "The caching type." + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" }, "createOption": { "$ref": "#/definitions/CreateOption", - "description": "The create option." + "description": "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." }, "diskSizeGB": { "type": "integer", "format": "int32", - "description": "The initial disk size, in GB, for blank data disks, and the new desired size for resizing existing OS and data disks." + "description": "Specifies the size of an empty data disk 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" }, "managedDisk": { "description": "The managed disk parameters.", @@ -4015,14 +4015,14 @@ "required": [ "createOption" ], - "description": "Describes an Operating System disk." + "description": "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)." }, "DataDisk": { "properties": { "lun": { "type": "integer", "format": "int32", - "description": "The logical unit number." + "description": "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." }, "name": { "type": "string", @@ -4030,24 +4030,24 @@ }, "vhd": { "$ref": "#/definitions/VirtualHardDisk", - "description": "The virtual hard disk." + "description": "The virtual hard disk.." }, "image": { "$ref": "#/definitions/VirtualHardDisk", - "description": "The source user image virtual hard disk. This virtual hard disk will be copied before using it to attach to the virtual machine. If SourceImage is provided, the destination virtual hard disk must not exist." + "description": "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." }, "caching": { "$ref": "#/definitions/Caching", - "description": "The caching type." + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" }, "createOption": { "$ref": "#/definitions/CreateOption", - "description": "The create option." + "description": "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." }, "diskSizeGB": { "type": "integer", "format": "int32", - "description": "The initial disk size in GB for blank data disks, and the new desired size for resizing existing OS and data disks." + "description": "Specifies the size of an empty data disk 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" }, "managedDisk": { "description": "The managed disk parameters.", @@ -4064,21 +4064,21 @@ "properties": { "imageReference": { "$ref": "#/definitions/ImageReference", - "description": "The image reference." + "description": "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." }, "osDisk": { "$ref": "#/definitions/OSDisk", - "description": "The OS disk." + "description": "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)." }, "dataDisks": { "type": "array", "items": { "$ref": "#/definitions/DataDisk" }, - "description": "The data disks." + "description": "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)." } }, - "description": "Describes a storage profile." + "description": "Specifies the storage settings for the virtual machine disks." }, "AdditionalUnattendContent": { "properties": { @@ -4106,7 +4106,7 @@ }, "settingName": { "type": "string", - "description": "Setting name (e.g. FirstLogonCommands, AutoLogon )", + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", "enum": [ "AutoLogon", "FirstLogonCommands" @@ -4118,16 +4118,16 @@ }, "content": { "type": "string", - "description": "XML formatted content that is added to the unattend.xml file in the specified pass and component. The XML must be less than 4 KB and must include the root element for the setting or feature that is being inserted." + "description": "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." } }, - "description": "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 a applied." + "description": "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." }, "WinRMListener": { "properties": { "protocol": { "type": "string", - "description": "The Protocol used by the WinRM listener. Http and Https are supported.", + "description": "Specifies the protocol of listener.

Possible values are:
**http**

**https**", "enum": [ "Http", "Https" @@ -4139,7 +4139,7 @@ }, "certificateUrl": { "type": "string", - "description": "The Certificate URL in KMS for Https listeners. Should be null for Http listeners." + "description": "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\":\"\"
}" } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" @@ -4160,39 +4160,39 @@ "properties": { "provisionVMAgent": { "type": "boolean", - "description": "Indicates whether the virtual machine agent should be provisioned on the Virtual Machine. If not specified, then the default behavior is to set it to true." + "description": "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." }, "enableAutomaticUpdates": { "type": "boolean", - "description": "Indicates whether Windows updates are automatically installed on the VM." + "description": "Indicates whether virtual machine is enabled for automatic updates." }, "timeZone": { "type": "string", - "description": "The time zone of the VM" + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" }, "additionalUnattendContent": { "type": "array", "items": { "$ref": "#/definitions/AdditionalUnattendContent" }, - "description": "Additional base-64 encoded XML formatted information that can be included in the Unattend.xml file." + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." }, "winRM": { "$ref": "#/definitions/WinRMConfiguration", - "description": "The Windows Remote Management configuration of the VM" + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." } }, - "description": "Describes Windows Configuration of the OS Profile." + "description": "Specifies Windows operating system settings on the virtual machine." }, "SshPublicKey": { "properties": { "path": { "type": "string", - "description": "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." + "description": "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" }, "keyData": { "type": "string", - "description": "Certificate public key used to authenticate to the VM through SSH. The certificate must be in Pem format with or without headers." + "description": "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)." } }, "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." @@ -4217,20 +4217,20 @@ }, "ssh": { "$ref": "#/definitions/SshConfiguration", - "description": "The SSH configuration for linux VMs." + "description": "Specifies the ssh key configuration for a Linux OS." } }, - "description": "Describes Windows configuration of the OS Profile." + "description": "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)." }, "VaultCertificate": { "properties": { "certificateUrl": { "type": "string", - "description": "The URL referencing a secret in a Key Vault which contains a properly formatted certificate." + "description": "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\":\"\"
}" }, "certificateStore": { "type": "string", - "description": "The Certificate store in LocalMachine to add the certificate to on Windows, leave empty on Linux." + "description": "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." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -4239,7 +4239,7 @@ "properties": { "sourceVault": { "$ref": "#/definitions/SubResource", - "description": "The Relative URL of the Key Vault containing all of the certificates in VaultCertificates." + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." }, "vaultCertificates": { "type": "array", @@ -4255,37 +4255,37 @@ "properties": { "computerName": { "type": "string", - "description": "Specifies the host OS name of the virtual machine." + "description": "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)." }, "adminUsername": { "type": "string", - "description": "Specifies the name of the administrator account." + "description": "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)" }, "adminPassword": { "type": "string", - "description": "Specifies the password of the administrator account." + "description": "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)" }, "customData": { "type": "string", - "description": "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" + "description": "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)" }, "windowsConfiguration": { "$ref": "#/definitions/WindowsConfiguration", - "description": "The Windows configuration of the OS profile." + "description": "Specifies Windows operating system settings on the virtual machine." }, "linuxConfiguration": { "$ref": "#/definitions/LinuxConfiguration", - "description": "The Linux configuration of the OS profile." + "description": "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)." }, "secrets": { "type": "array", "items": { "$ref": "#/definitions/VaultSecretGroup" }, - "description": "The list of certificates for addition to the VM." + "description": "Specifies set of certificates that should be installed onto the virtual machine." } }, - "description": "Describes an OS profile." + "description": "Specifies the operating system settings for the virtual machine." }, "NetworkInterfaceReferenceProperties": { "properties": { @@ -4317,10 +4317,10 @@ "items": { "$ref": "#/definitions/NetworkInterfaceReference" }, - "description": "Specifies the list of resource IDs for the network interfaces associated with the virtual machine." + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." } }, - "description": "Describes a network profile." + "description": "Specifies the network interfaces of the virtual machine." }, "BootDiagnostics": { "properties": { @@ -4330,29 +4330,29 @@ }, "storageUri": { "type": "string", - "description": "URI of the storage account to use for placing the console output and screenshot." + "description": "Uri of the storage account to use for placing the console output and screenshot." } }, - "description": "Describes Boot Diagnostics." + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." }, "DiagnosticsProfile": { "properties": { "bootDiagnostics": { "$ref": "#/definitions/BootDiagnostics", - "description": "Boot Diagnostics is a debugging feature which allows the user to view console output and/or a screenshot of the virtual machine from the hypervisor." + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." } }, - "description": "Describes a diagnostics profile." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, "VirtualMachineExtensionHandlerInstanceView": { "properties": { "type": { "type": "string", - "description": "Full type of the extension handler which includes both publisher and type." + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." }, "typeHandlerVersion": { "type": "string", - "description": "The type version of the extension handler." + "description": "Specifies the version of the script handler." }, "status": { "$ref": "#/definitions/InstanceViewStatus", @@ -4395,7 +4395,7 @@ "items": { "$ref": "#/definitions/DiskEncryptionSettings" }, - "description": "The encryption settings of the disk." + "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" }, "statuses": { "type": "array", @@ -4452,22 +4452,22 @@ "type": "boolean", "description": "True, if customer is allowed to perform Maintenance." }, - "preMaintenanceWindowStartTime" : { + "preMaintenanceWindowStartTime": { "type": "string", "format": "date-time", "description": "Start Time for the Pre Maintenance Window." }, - "preMaintenanceWindowEndTime" : { + "preMaintenanceWindowEndTime": { "type": "string", "format": "date-time", "description": "End Time for the Pre Maintenance Window." }, - "maintenanceWindowStartTime" : { + "maintenanceWindowStartTime": { "type": "string", "format": "date-time", "description": "Start Time for the Maintenance Window." }, - "maintenanceWindowEndTime" : { + "maintenanceWindowEndTime": { "type": "string", "format": "date-time", "description": "End Time for the Maintenance Window." @@ -4533,7 +4533,7 @@ }, "bootDiagnostics": { "$ref": "#/definitions/BootDiagnosticsInstanceView", - "description": "The boot diagnostics." + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." }, "statuses": { "type": "array", @@ -4549,27 +4549,27 @@ "properties": { "hardwareProfile": { "$ref": "#/definitions/HardwareProfile", - "description": "The hardware profile." + "description": "Specifies the hardware settings for the virtual machine." }, "storageProfile": { "$ref": "#/definitions/StorageProfile", - "description": "The storage profile." + "description": "Specifies the storage settings for the virtual machine disks." }, "osProfile": { "$ref": "#/definitions/OSProfile", - "description": "The OS profile." + "description": "Specifies the operating system settings for the virtual machine." }, "networkProfile": { "$ref": "#/definitions/NetworkProfile", - "description": "The network profile." + "description": "Specifies the network interfaces of the virtual machine." }, "diagnosticsProfile": { "$ref": "#/definitions/DiagnosticsProfile", - "description": "The diagnostics profile." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "The reference Id of the availability set to which the virtual machine belongs." + "description": "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." }, "provisioningState": { "readOnly": true, @@ -4583,7 +4583,7 @@ }, "licenseType": { "type": "string", - "description": "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." + "description": "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" }, "vmId": { "readOnly": true, @@ -4597,7 +4597,7 @@ "properties": { "plan": { "$ref": "#/definitions/Plan", - "description": "The purchase plan when deploying virtual machine from VM Marketplace images." + "description": "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**." }, "properties": { "x-ms-client-flatten": true, @@ -4650,12 +4650,12 @@ }, "tier": { "type": "string", - "description": "The sku tier." + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" }, "capacity": { "type": "integer", "format": "int64", - "description": "The sku capacity." + "description": "Specifies the number of virtual machines in the scale set." } }, "description": "Describes a virtual machine scale set sku." @@ -4664,7 +4664,7 @@ "properties": { "mode": { "type": "string", - "description": "The upgrade mode.", + "description": "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.", "enum": [ "Automatic", "Manual" @@ -4681,7 +4681,7 @@ "properties": { "mode": { "type": "string", - "description": "The recovery mode.", + "description": "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 in [Manage all VMs in a set](manage-all-vms-in-a-set.md).

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time.", "enum": [ "None", "OverProvision", @@ -4699,7 +4699,7 @@ "properties": { "osType": { "type": "string", - "description": "The Operating System type.", + "description": "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**", "enum": [ "Windows", "Linux" @@ -4735,7 +4735,7 @@ }, "caching": { "type": "string", - "description": "The caching type.", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", "enum": [ "None", "ReadOnly", @@ -4749,11 +4749,11 @@ "diskSizeGB": { "type": "integer", "format": "int32", - "description": "The initial managed disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + "description": "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" }, "storageAccountType": { "$ref": "#/definitions/StorageAccountType", - "description": "The Storage Account type." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." } }, "required": [ @@ -4767,7 +4767,7 @@ "lun": { "type": "integer", "format": "int32", - "description": "The logical unit number." + "description": "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." }, "snapshot": { "$ref": "#/definitions/SubResource", @@ -4783,7 +4783,7 @@ }, "caching": { "type": "string", - "description": "The caching type.", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", "enum": [ "None", "ReadOnly", @@ -4797,11 +4797,11 @@ "diskSizeGB": { "type": "integer", "format": "int32", - "description": "The initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + "description": "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" }, "storageAccountType": { "$ref": "#/definitions/StorageAccountType", - "description": "The Storage Account type." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." } }, "required": [ @@ -4813,14 +4813,14 @@ "properties": { "osDisk": { "$ref": "#/definitions/ImageOSDisk", - "description": "The OS disk." + "description": "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)." }, "dataDisks": { "type": "array", "items": { "$ref": "#/definitions/ImageDataDisk" }, - "description": "The data disks." + "description": "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)." } }, "required": [ @@ -4836,7 +4836,7 @@ }, "storageProfile": { "$ref": "#/definitions/ImageStorageProfile", - "description": "The storage profile." + "description": "Specifies the storage settings for the virtual machine disks." }, "provisioningState": { "readOnly": true, @@ -4858,7 +4858,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Describes an Image." + "description": "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." }, "ImageListResult": { "properties": { @@ -4893,7 +4893,7 @@ }, "type": { "type": "string", - "description": "The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.", + "description": "The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.", "enum": [ "SystemAssigned" ], @@ -4961,7 +4961,7 @@ "description": "An invariant to show the extended unit." } }, - "description" : "Describes metadata for retrieving price info." + "description": "Describes metadata for retrieving price info." }, "ResourceSkuCapabilities": { "properties": { @@ -4976,7 +4976,7 @@ "description": "An invariant if the feature is measured by quantity." } }, - "description" : "Describes The SKU capabilites object." + "description": "Describes The SKU capabilites object." }, "ResourceSkuRestrictions": { "properties": { @@ -5031,7 +5031,7 @@ "tier": { "readOnly": true, "type": "string", - "description": "The tier of this particular SKU." + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" }, "size": { "readOnly": true, @@ -5051,7 +5051,7 @@ "capacity": { "$ref": "#/definitions/ResourceSkuCapacity", "readOnly": true, - "description": "Available scaling information." + "description": "Specifies the number of virtual machines in the scale set." }, "locations": { "type": "array", @@ -5069,7 +5069,7 @@ }, "description": "The api versions that support this SKU." }, - "costs": { + "costs": { "type": "array", "readOnly": true, "items": { @@ -5119,34 +5119,34 @@ "properties": { "computerNamePrefix": { "type": "string", - "description": "The computer name prefix." + "description": "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." }, "adminUsername": { "type": "string", - "description": "The admin user name." + "description": "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)" }, "adminPassword": { "type": "string", - "description": "The admin user password." + "description": "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)" }, "customData": { "type": "string", - "description": "A base-64 encoded string of custom data." + "description": "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)" }, "windowsConfiguration": { "$ref": "#/definitions/WindowsConfiguration", - "description": "The Windows Configuration of the OS profile." + "description": "Specifies Windows operating system settings on the virtual machine." }, "linuxConfiguration": { "$ref": "#/definitions/LinuxConfiguration", - "description": "The Linux Configuration of the OS profile." + "description": "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)." }, "secrets": { "type": "array", "items": { "$ref": "#/definitions/VaultSecretGroup" }, - "description": "The List of certificates for addition to the VM." + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." } }, "description": "Describes a virtual machine scale set OS profile." @@ -5155,7 +5155,7 @@ "properties": { "storageAccountType": { "$ref": "#/definitions/StorageAccountType", - "description": "The Storage Account type." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." } }, "description": "Describes the parameters of a ScaleSet managed disk." @@ -5168,15 +5168,15 @@ }, "caching": { "$ref": "#/definitions/Caching", - "description": "The caching type." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" }, "createOption": { "$ref": "#/definitions/CreateOption", - "description": "The create option." + "description": "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." }, "osType": { "type": "string", - "description": "The Operating System type.", + "description": "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**", "enum": [ "Windows", "Linux" @@ -5188,14 +5188,14 @@ }, "image": { "$ref": "#/definitions/VirtualHardDisk", - "description": "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." + "description": "Specifies information about the unmanaged user image to base the scale set on." }, "vhdContainers": { "type": "array", "items": { "type": "string" }, - "description": "The list of virtual hard disk container uris." + "description": "Specifies the container urls that are used to store operating system disks for the scale set." }, "managedDisk": { "description": "The managed disk parameters.", @@ -5216,11 +5216,11 @@ "lun": { "type": "integer", "format": "int32", - "description": "The logical unit number." + "description": "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." }, "caching": { "$ref": "#/definitions/Caching", - "description": "The caching type." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" }, "createOption": { "$ref": "#/definitions/CreateOption", @@ -5229,7 +5229,7 @@ "diskSizeGB": { "type": "integer", "format": "int32", - "description": "The initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + "description": "Specifies the size of an empty data disk 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" }, "managedDisk": { "description": "The managed disk parameters.", @@ -5246,18 +5246,18 @@ "properties": { "imageReference": { "$ref": "#/definitions/ImageReference", - "description": "The image reference." + "description": "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." }, "osDisk": { "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", - "description": "The OS disk." + "description": "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)." }, "dataDisks": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" }, - "description": "The data disks." + "description": "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)." } }, "description": "Describes a virtual machine scale set storage profile." @@ -5275,11 +5275,11 @@ "properties": { "subnet": { "$ref": "#/definitions/ApiEntityReference", - "description": "The subnet." + "description": "Specifies the identifier of the subnet." }, "primary": { "type": "boolean", - "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, "publicIPAddressConfiguration": { "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", @@ -5302,21 +5302,21 @@ "items": { "$ref": "#/definitions/SubResource" }, - "description": "The application gateway backend address pools." + "description": "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." }, "loadBalancerBackendAddressPools": { "type": "array", "items": { "$ref": "#/definitions/SubResource" }, - "description": "The load balancer backend address pools." + "description": "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." }, "loadBalancerInboundNatPools": { "type": "array", "items": { "$ref": "#/definitions/SubResource" }, - "description": "The load balancer inbound nat pools." + "description": "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" } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." @@ -5346,7 +5346,7 @@ "properties": { "primary": { "type": "boolean", - "description": "Whether this is a primary NIC on a virtual machine." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, "enableAcceleratedNetworking": { "type": "boolean", @@ -5365,7 +5365,7 @@ "items": { "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" }, - "description": "The virtual machine scale set IP Configuration." + "description": "Specifies the IP configurations of the network interface." } }, "required": [ @@ -5472,15 +5472,15 @@ }, "type": { "type": "string", - "description": "The type of the extension handler." + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." }, "typeHandlerVersion": { "type": "string", - "description": "The type version of the extension handler." + "description": "Specifies the version of the script handler." }, "autoUpgradeMinorVersion": { "type": "boolean", - "description": "Whether the extension handler should be automatically upgraded across minor versions." + "description": "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." }, "settings": { "type": "object", @@ -5488,7 +5488,7 @@ }, "protectedSettings": { "type": "object", - "description": "Json formatted protected settings for the extension." + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." }, "provisioningState": { "readOnly": true, @@ -5551,27 +5551,27 @@ "properties": { "osProfile": { "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", - "description": "The virtual machine scale set OS profile." + "description": "Specifies the operating system settings for the virtual machines in the scale set." }, "storageProfile": { "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", - "description": "The virtual machine scale set storage profile." + "description": "Specifies the storage settings for the virtual machine disks." }, "networkProfile": { "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", - "description": "The virtual machine scale set network profile." + "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." }, "diagnosticsProfile": { "$ref": "#/definitions/DiagnosticsProfile", - "description": "The virtual machine scale set diagnostics profile." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, "extensionProfile": { "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", - "description": "The virtual machine scale set extension profile." + "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." }, "licenseType": { "type": "string", - "description": "The license type, which is for bring your own license scenario." + "description": "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" } }, "description": "Describes a virtual machine scale set virtual machine profile." @@ -5619,7 +5619,7 @@ }, "plan": { "$ref": "#/definitions/Plan", - "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + "description": "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**." }, "properties": { "x-ms-client-flatten": true, @@ -5825,7 +5825,7 @@ "capacity": { "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", "readOnly": true, - "description": "Available scaling information." + "description": "Specifies the number of virtual machines in the scale set." } }, "description": "Describes an available virtual machine scale set sku." @@ -5868,27 +5868,27 @@ }, "hardwareProfile": { "$ref": "#/definitions/HardwareProfile", - "description": "The hardware profile." + "description": "Specifies the hardware settings for the virtual machine." }, "storageProfile": { "$ref": "#/definitions/StorageProfile", - "description": "The storage profile." + "description": "Specifies the storage settings for the virtual machine disks." }, "osProfile": { "$ref": "#/definitions/OSProfile", - "description": "The OS profile." + "description": "Specifies the operating system settings for the virtual machine." }, "networkProfile": { "$ref": "#/definitions/NetworkProfile", - "description": "The network profile." + "description": "Specifies the network interfaces of the virtual machine." }, "diagnosticsProfile": { "$ref": "#/definitions/DiagnosticsProfile", - "description": "The diagnostics profile." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "The reference Id of the availability set to which this virtual machine belongs." + "description": "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." }, "provisioningState": { "readOnly": true, @@ -5897,7 +5897,7 @@ }, "licenseType": { "type": "string", - "description": "The license type, which is for bring your own license scenario." + "description": "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" } }, "description": "Describes the properties of a virtual machine scale set virtual machine." @@ -5920,7 +5920,7 @@ }, "plan": { "$ref": "#/definitions/Plan", - "description": "The purchase plan when deploying virtual machine from VM Marketplace images." + "description": "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**." }, "resources": { "readOnly": true, @@ -5974,7 +5974,7 @@ }, "bootDiagnostics": { "$ref": "#/definitions/BootDiagnosticsInstanceView", - "description": "The boot diagnostics." + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." }, "statuses": { "type": "array", @@ -6179,4 +6179,4 @@ "description": "Client Api Version." } } -} \ No newline at end of file +}