Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating description text for Create/Update virtual machines APIs documentation. No changes to specs. #7823

Merged
merged 5 commits into from
Dec 23, 2019
Merged

Updating description text for Create/Update virtual machines APIs documentation. No changes to specs. #7823

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b06f348
Updating documentation comments for Create/Update virtual machines.
avinashakka09 Nov 21, 2019
27761ab
Review changes.
avinashakka09 Dec 9, 2019
35a81ed
More Documentation updates.
avinashakka09 Dec 11, 2019
47c855b
Review comments addressed.
avinashakka09 Dec 19, 2019
4e1e17f
Highlighting text to bold.
avinashakka09 Dec 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2294,7 +2294,7 @@
"VirtualMachines"
],
"operationId": "VirtualMachines_CreateOrUpdate",
"description": "The operation to create or update a virtual machine.",
"description": "The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.",
"parameters": [
{
"name": "resourceGroupName",
Expand Down Expand Up @@ -7244,7 +7244,7 @@
"properties": {
"protocol": {
"type": "string",
"description": "Specifies the protocol of listener. <br><br> Possible values are: <br>**http** <br><br> **https**",
"description": "Specifies the protocol of WinRM listener. <br><br> Possible values are: <br>**http** <br><br> **https**",
"enum": [
"Http",
"Https"
Expand Down Expand Up @@ -7285,7 +7285,7 @@
},
"timeZone": {
"type": "string",
"description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\""
"description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\". <br><br> Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.getsystemtimezones)."
},
"additionalUnattendContent": {
"type": "array",
Expand Down Expand Up @@ -7380,15 +7380,15 @@
},
"adminUsername": {
"type": "string",
"description": "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)"
"description": "Specifies the name of the administrator account. <br><br> This property cannot be updated after the VM is created. <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)"
},
"adminPassword": {
"type": "string",
"description": "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)"
},
"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. <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)"
"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. <br><br> This property cannot be updated after the VM is created. <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)"
avinashakka marked this conversation as resolved.
Show resolved Hide resolved
avinashakka marked this conversation as resolved.
Show resolved Hide resolved
},
"windowsConfiguration": {
"$ref": "#/definitions/WindowsConfiguration",
Expand All @@ -7411,10 +7411,10 @@
},
"requireGuestProvisionSignal": {
"type": "boolean",
"description": "Specifies whether the guest provision signal is required from the virtual machine."
"description": "Specifies whether the guest provision signal is required to infer provision success of the virtual machine."
}
},
"description": "Specifies the operating system settings for the virtual machine."
"description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned."
},
"AutomaticRepairsPolicy": {
"properties": {
Expand Down Expand Up @@ -7770,7 +7770,7 @@
},
"osProfile": {
"$ref": "#/definitions/OSProfile",
"description": "Specifies the operating system settings for the virtual machine."
"description": "Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned."
avinashakka marked this conversation as resolved.
Show resolved Hide resolved
},
"networkProfile": {
"$ref": "#/definitions/NetworkProfile",
Expand Down