From b06f3482a5955c55b186e976bf48438d8d62a406 Mon Sep 17 00:00:00 2001 From: Avinash Akka Date: Thu, 21 Nov 2019 11:37:45 -0800 Subject: [PATCH 1/5] Updating documentation comments for Create/Update virtual machines. --- .../Microsoft.Compute/stable/2019-07-01/compute.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json index d628559d8a76..f65d48d5c788 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json @@ -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. Some properties can be set only during provisioning the virtual machine.", "parameters": [ { "name": "resourceGroupName", @@ -7380,7 +7380,7 @@ }, "adminUsername": { "type": "string", - "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)" + "description": "Specifies the name of the administrator account.

    This property cannot be updated after the VM is created.

    **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", @@ -7388,7 +7388,7 @@ }, "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.

    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.

    This property cannot be updated after the VM is created.

    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", @@ -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." }, "networkProfile": { "$ref": "#/definitions/NetworkProfile", From 27761ab0f9999475d485e111eae8429a40007f38 Mon Sep 17 00:00:00 2001 From: Avinash Akka Date: Mon, 9 Dec 2019 12:00:16 -0800 Subject: [PATCH 2/5] Review changes. --- .../Microsoft.Compute/stable/2019-07-01/compute.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json index f65d48d5c788..b41191a60241 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json @@ -2294,7 +2294,7 @@ "VirtualMachines" ], "operationId": "VirtualMachines_CreateOrUpdate", - "description": "The operation to create or update a virtual machine. Some properties can be set only during provisioning the 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", From 35a81ed45a7c03ca356119fd08e978b7133346b4 Mon Sep 17 00:00:00 2001 From: Avinash Akka Date: Wed, 11 Dec 2019 15:13:55 -0800 Subject: [PATCH 3/5] More Documentation updates. --- .../Microsoft.Compute/stable/2019-07-01/compute.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json index b41191a60241..b020958b0214 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json @@ -7244,7 +7244,7 @@ "properties": { "protocol": { "type": "string", - "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**", + "description": "Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https**", "enum": [ "Http", "Https" @@ -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\".

    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", @@ -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": { From 47c855b2cd11c4850498937b3a713f9f0c7d19de Mon Sep 17 00:00:00 2001 From: Avinash Akka Date: Thu, 19 Dec 2019 12:28:58 -0800 Subject: [PATCH 4/5] Review comments addressed. --- .../Microsoft.Compute/stable/2019-07-01/compute.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json index b020958b0214..410df4264d8c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json @@ -7388,7 +7388,7 @@ }, "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.

    This property cannot be updated after the VM is created.

    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. Do not pass any secrets or passwords in customData property.

    This property cannot be updated after the VM is created.

    customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    For using cloud-init for your Linux 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", From 4e1e17f3706be50474e4931bdee8f689c6c1567d Mon Sep 17 00:00:00 2001 From: Avinash Akka Date: Fri, 20 Dec 2019 15:07:43 -0800 Subject: [PATCH 5/5] Highlighting text to bold. --- .../Microsoft.Compute/stable/2019-07-01/compute.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json index 410df4264d8c..1da78750c4e9 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json @@ -7388,7 +7388,7 @@ }, "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. Do not pass any secrets or passwords in customData property.

    This property cannot be updated after the VM is created.

    customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    For using cloud-init for your Linux 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.

    **Note: Do not pass any secrets or passwords in customData property**

    This property cannot be updated after the VM is created.

    customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    For using cloud-init for your Linux 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",