Skip to content

Commit 1e99a69

Browse files
Merge pull request #229045 from mattmcinnes/patch-42
Freshness Pass on user-data.md
2 parents 3963736 + cf7b3f9 commit 1e99a69

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

articles/virtual-machines/user-data.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ author: ningk
66
manager: rogardle
77
ms.topic: how-to
88
ms.workload: infrastructure-services
9-
ms.date: 04/30/2021
9+
ms.date: 02/28/2023
1010
ms.author: ningk
11-
ms.reviewer: azmetadata
11+
ms.reviewer: azmetadata, mattmcinnes
1212
---
1313

1414
# User Data for Azure Virtual Machine
@@ -17,7 +17,7 @@ User data allows you to pass your own scripts or metadata to your virtual machin
1717

1818
## What is "user data"
1919

20-
User data is a set of scripts or other metadata, that will be inserted to an Azure virtual machine at provision time. Any application on the virtual machine can access the user data from the Azure Instance Metadata Service (IMDS) after provision.
20+
User data is a set of scripts or other metadata that's inserted to an Azure virtual machine at provision time. Any application on the virtual machine can access the user data from the Azure Instance Metadata Service (IMDS) after provision.
2121

2222
User data is a new version of [custom data](./custom-data.md) and it offers added benefits:
2323

@@ -29,21 +29,21 @@ User data is a new version of [custom data](./custom-data.md) and it offers add
2929

3030
* User data can be queried via GET VM/VMSS API with $expand option.
3131

32-
In addition, if user data is not added at provision time, you can still add it after provision.
32+
In addition, if user data isn't added at provision time, you can still add it after provision.
3333

3434
**Security warning**
3535

3636
> [!WARNING]
3737
> User data will not be encrypted, and any process on the VM can query this data. You should not store confidential information in user data.
3838
39-
Make sure you get the latest Azure Resource Manager API to use the new user data features. The contents should be base64 encoded before passed to the API. The size cannot exceed 64 KB.
39+
Make sure you get the latest Azure Resource Manager API to use the new user data features. The contents should be base64 encoded before passed to the API. The size can't exceed 64 KB.
4040

4141
## Create user data for Azure VM/VMSS
4242

4343
**Adding user data when creating new VM**
4444

4545
Use [this Azure Resource Manager template](https://aka.ms/ImdsUserDataArmTemplate) to create a new VM with user data.
46-
If you are using rest API, for single VMs, add 'UserData' to the "properties" section with the PUT request to create the VM.
46+
If you're using rest API, for single VMs, add 'UserData' to the "properties" section with the PUT request to create the VM.
4747

4848
```json
4949
{
@@ -69,9 +69,9 @@ If you are using rest API, for single VMs, add 'UserData' to the "properties" se
6969
}
7070
```
7171

72-
**Adding user data when you create new virtual machine scale set**
72+
**Adding user data when you create new Virtual Machine Scale Set**
7373

74-
Using rest API, add 'UserData' to the "virtualMachineProfile" section with the PUT request when creating the virtual machine scale set.
74+
Using rest API, add 'UserData' to the "virtualMachineProfile" section with the PUT request when creating the Virtual Machine Scale Set.
7575
```json
7676
{
7777
"location": "West US",
@@ -132,17 +132,17 @@ Single VMs:
132132

133133
`GET "/subscriptions/{guid}/resourceGroups/{RGName}/providers/Microsoft.Compute/virtualMachines/{VMName}?$expand=userData"`
134134

135-
Virtual machine scale set:
135+
Virtual Machine Scale Set:
136136

137137
`GET "/subscriptions/{guid}/resourceGroups/{RGName}/providers/Microsoft.Compute/virtualMachineScaleSets/{VMSSName}?$expand=userData"`
138138

139-
Virtual machine scale set VM:
139+
Virtual Machine Scale Set VM:
140140

141141
` GET "/subscriptions/{guid}/resourceGroups/{RGName}/providers/Microsoft.Compute/virtualMachineScaleSets/{VMSSName}/virtualmachines/{vmss instance id}?$expand=userData" `
142142

143143
## Updating user data
144144

145-
With REST API, you can use a normal PUT or PATCH request to update the user data. The user data will be updated without the need to stop or reboot the VM.
145+
With REST API, you can use a normal PUT or PATCH request to update the user data. The user data is updated without the need to stop or reboot the VM.
146146

147147
`PUT
148148
"/subscriptions/{guid}/resourceGroups/{RGName}/providers/Microsoft.Compute/ virtualMachines/{VMName}
@@ -200,11 +200,11 @@ The VM.Properties in these requests should contain your desired UserData field,
200200
}
201201
```
202202
> [!NOTE]
203-
> If you pass in an empty string for "userData" in this case, the user data will be deleted.
203+
> If you pass in an empty string for "userData" in this case, the user data is deleted.
204204
205205
## User data and custom data
206206

207-
Custom data will continue to work the same way as today. Note you cannot retrieve custom data from IMDS.
207+
Custom data continues to work the same way as today. Note you can't retrieve custom data from IMDS.
208208

209209
## Adding user data to an existing VM
210210

0 commit comments

Comments
 (0)