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

Add UserData properties for VM and VMSS for stable 2021-03-01 #13220

Merged
merged 49 commits into from
Apr 26, 2021
Merged

Add UserData properties for VM and VMSS for stable 2021-03-01 #13220

Show file tree
Hide file tree
Changes from 44 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
cd6edc2
added
roipmsft Feb 12, 2021
211fa72
Merge branch 'master' of github.com:roipmsft/azure-rest-api-specs
roipmsft Feb 12, 2021
e089b2c
remove hello
roipmsft Feb 12, 2021
847584f
add userData to VM properties and VMSS vm profile
roipmsft Mar 1, 2021
422291f
update enums
roipmsft Mar 1, 2021
8e86bee
update $expand;
roipmsft Mar 1, 2021
18410f4
update
roipmsft Mar 1, 2021
42dba15
add json files
roipmsft Mar 1, 2021
15d18f3
reference the json files
roipmsft Mar 1, 2021
012bb52
update examples
roipmsft Mar 4, 2021
2cbbd60
addressing comments from PR
roipmsft Mar 4, 2021
2f47052
document min api versions
roipmsft Mar 4, 2021
2149339
revert changes to 2020 12 1
roipmsft Mar 4, 2021
c2f8370
remove two files
roipmsft Mar 4, 2021
c5a7d04
undo changes to computejosn
roipmsft Mar 4, 2021
c547733
fix json
roipmsft Mar 5, 2021
38df514
try fix descrition
roipmsft Mar 7, 2021
54c2ee1
revert descrition
roipmsft Mar 7, 2021
9a55b7e
addressing comments from PR
roipmsft Mar 13, 2021
a46e2a9
addressing comments from PR
roipmsft Mar 13, 2021
30e5123
change modelAsString to false
roipmsft Apr 6, 2021
4f99c20
update json
roipmsft Apr 6, 2021
5e5c84d
remove userdata from enum
roipmsft Apr 6, 2021
59c5477
add UserData to enum
roipmsft Apr 7, 2021
eea58e0
update userdata enum for breaking change intentionally
roipmsft Apr 9, 2021
2e1f890
rename enum names
roipmsft Apr 9, 2021
d56e7ab
update
roipmsft Apr 12, 2021
968ab4a
use modelAsString false
roipmsft Apr 12, 2021
98dcd11
updated desc
roipmsft Apr 12, 2021
599a668
add UserData for InstanceViewTypes enum
roipmsft Apr 12, 2021
74972d9
udpate api versin
roipmsft Apr 13, 2021
a4abd8a
add userData to 2020-08-02/HybridCompute.json
roipmsft Apr 14, 2021
8a94873
Merge remote-tracking branch 'origin' into dev/roip/UserData_2021_03_01
roipmsft Apr 14, 2021
5fbab14
Merge branch 'compute-2021-03' into dev/roip/UserData_2021_03_01
roipmsft Apr 14, 2021
15f1af4
add userData to cloudService.json
roipmsft Apr 14, 2021
209f844
update
roipmsft Apr 15, 2021
4f56301
add userdata to get vm example
roipmsft Apr 15, 2021
5a86fa1
add two new example jsons
roipmsft Apr 15, 2021
ef4162f
update examples
roipmsft Apr 15, 2021
302c520
prettier fix
roipmsft Apr 15, 2021
8dbba48
modify examples
roipmsft Apr 19, 2021
53c2518
remove userData
roipmsft Apr 21, 2021
f44cc71
remove userData from cloudService
roipmsft Apr 21, 2021
4938656
explain userData in comments
roipmsft Apr 23, 2021
56298e5
addressing comments from PR
roipmsft Apr 23, 2021
95cfa24
resolve conflict
roipmsft Apr 23, 2021
86e355b
resolve conflict
roipmsft Apr 23, 2021
8f41534
update comment
roipmsft Apr 23, 2021
6ea5d6e
update
roipmsft Apr 23, 2021
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
6 changes: 4 additions & 2 deletions specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/cloudService.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@
"description": "The expand expression to apply to the operation.",
"type": "string",
"enum": [
"instanceView"
"instanceView",
"userData"
roipmsft marked this conversation as resolved.
Show resolved Hide resolved
roipmsft marked this conversation as resolved.
Show resolved Hide resolved
],
"x-ms-enum": {
"name": "InstanceViewTypes",
Expand Down Expand Up @@ -222,7 +223,8 @@
"description": "The expand expression to apply to the operation.",
"type": "string",
"enum": [
"instanceView"
"instanceView",
"userData"
],
"x-ms-enum": {
"name": "InstanceViewTypes",
Expand Down
78 changes: 63 additions & 15 deletions specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -787,9 +787,10 @@
"in": "query",
"required": false,
"type": "string",
"description": "The expand expression to apply on the operation. The response shows the list of instance view of the dedicated hosts under the dedicated host group.",
"description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group.",
"enum": [
"instanceView"
"instanceView",
"userData"
],
"x-ms-enum": {
"name": "InstanceViewTypes",
Expand Down Expand Up @@ -1082,9 +1083,10 @@
"in": "query",
"required": false,
"type": "string",
"description": "The expand expression to apply on the operation.",
"description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host.",
"enum": [
"instanceView"
"instanceView",
"userData"
],
"x-ms-enum": {
"name": "InstanceViewTypes",
Expand Down Expand Up @@ -3108,6 +3110,9 @@
},
"Create a VM with Uefi Settings of secureBoot and vTPM.": {
"$ref": "./examples/CreateAVmWithUefiSettings.json"
},
"Create a VM with UserData": {
"$ref": "./examples/CreateOrUpdateAVmWithUserData.json"
}
}
},
Expand Down Expand Up @@ -3245,9 +3250,10 @@
"in": "query",
"required": false,
"type": "string",
"description": "The expand expression to apply on the operation.",
"description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations.
'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation

"enum": [
"instanceView"
"instanceView",
"userData"
],
"x-ms-enum": {
"name": "InstanceViewTypes",
Expand Down Expand Up @@ -4220,6 +4226,9 @@
},
"Create a scale set with Uefi Settings of secureBoot and vTPM.": {
"$ref": "./examples/CreateAScaleSetWithUefiSettings.json"
},
"Create a scale set with userData.": {
"$ref": "./examples/CreateOrUpdateAScaleSetWithUserData.json"
}
}
},
Expand Down Expand Up @@ -4349,6 +4358,20 @@
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "The expand expression to apply on the operation. 'UserData' will retrieve the UserData of the virtual machine.",
"enum": [
"userData"
],
"x-ms-enum": {
"name": "ExpandTypesForGetVMScaleSets",
"modelAsString": true
}
}
],
"responses": {
Expand All @@ -4362,6 +4385,9 @@
"x-ms-examples": {
"Get a virtual machine scale set placed on a dedicated host group through automatic placement.": {
"$ref": "./examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json"
},
"Get a virtual machine scale set with UserData": {
"$ref": "./examples/GetVirtualMachineScaleSetWithUserData.json"
}
}
}
Expand Down Expand Up @@ -6279,9 +6305,10 @@
"in": "query",
"required": false,
"type": "string",
"description": "The expand expression to apply on the operation.",
"description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.",
"enum": [
"instanceView"
"instanceView",
"userData"
],
"x-ms-enum": {
"name": "InstanceViewTypes",
Expand All @@ -6302,6 +6329,11 @@
"$ref": "#/definitions/VirtualMachineScaleSetVM"
}
}
},
"x-ms-examples": {
"Get VM scale set VM with UserData": {
"$ref": "./examples/GetVirtualMachineScaleSetVMWithUserData.json"
}
}
}
},
Expand Down Expand Up @@ -9066,7 +9098,7 @@
"required": [
"createOption"
],
"description": "Specifies information about the operating system disk used by the virtual machine. <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)."
"description": "Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
},
"DataDisk": {
"properties": {
Expand Down Expand Up @@ -9143,14 +9175,14 @@
},
"osDisk": {
"$ref": "#/definitions/OSDisk",
"description": "Specifies information about the operating system disk used by the virtual machine. <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)."
"description": "Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
},
"dataDisks": {
"type": "array",
"items": {
"$ref": "#/definitions/DataDisk"
},
"description": "Specifies the parameters that are used to add a data disk to a virtual machine. <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)."
"description": "Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
}
},
"description": "Specifies the storage settings for the virtual machine disks."
Expand Down Expand Up @@ -9891,6 +9923,10 @@
"type": "integer",
"format": "int32",
"description": "Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01"
},
"userData": {
"type": "string",
"description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01"
}
},
"description": "Describes the properties of a Virtual Machine."
Expand Down Expand Up @@ -10225,14 +10261,14 @@
"properties": {
"osDisk": {
"$ref": "#/definitions/ImageOSDisk",
"description": "Specifies information about the operating system disk used by the virtual machine. <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)."
"description": "Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
},
"dataDisks": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageDataDisk"
},
"description": "Specifies the parameters that are used to add a data disk to a virtual machine. <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)."
"description": "Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
},
"zoneResilient": {
"type": "boolean",
Expand Down Expand Up @@ -10586,14 +10622,14 @@
},
"osDisk": {
"$ref": "#/definitions/VirtualMachineScaleSetOSDisk",
"description": "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)."
"description": "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/managed-disks-overview)."
},
"dataDisks": {
"type": "array",
"items": {
"$ref": "#/definitions/VirtualMachineScaleSetDataDisk"
},
"description": "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)."
"description": "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/managed-disks-overview)."
}
},
"description": "Describes a virtual machine scale set storage profile."
Expand Down Expand Up @@ -11219,6 +11255,10 @@
"scheduledEventsProfile": {
"$ref": "#/definitions/ScheduledEventsProfile",
"description": "Specifies Scheduled Event related configurations."
},
"userData": {
"type": "string",
"description": "UserData (which must be base-64 encoded) for the virtual machine scale set. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01"
roipmsft marked this conversation as resolved.
Show resolved Hide resolved
}
},
"description": "Describes a virtual machine scale set virtual machine profile."
Expand Down Expand Up @@ -11260,6 +11300,10 @@
"scheduledEventsProfile": {
"$ref": "#/definitions/ScheduledEventsProfile",
"description": "Specifies Scheduled Event related configurations."
},
"userData": {
"type": "string",
"description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01"
}
},
"description": "Describes a virtual machine scale set virtual machine profile."
Expand Down Expand Up @@ -11919,6 +11963,10 @@
"protectionPolicy": {
"$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy",
"description": "Specifies the protection policy of the virtual machine."
},
"userData": {
"type": "string",
"description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01"
}
},
"description": "Describes the properties of a virtual machine scale set virtual machine."
Expand Down
Loading