Skip to content

Commit dcd1438

Browse files
committed
add manuall install examples
1 parent 9541ac0 commit dcd1438

File tree

1 file changed

+93
-2
lines changed

1 file changed

+93
-2
lines changed

articles/virtual-machines/workloads/sap/vm-extension-for-sap-new.md

Lines changed: 93 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,15 @@ Before deploying the VM Extension for SAP, please make sure to assign a user or
146146
* [Configure managed identities for Azure resources on an Azure VM using templates](/azure/active-directory/managed-identities-azure-resources/qs-configure-template-windows-vm)
147147
* [Terraform VM Identity](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/linux_virtual_machine#identity)
148148

149-
After assigning an identity to the virtual machine, give the VM read access to either the resource group or the individual resources associated to the virtual machine (VM, Network Interfaces, OS Disks and Data Disks). It is recommended to use the built-in Reader role to grant the acceess to these resources. You can also grant this access by adding the VM identity to an Azure Active Directory group that already has read access to the required resources.
149+
After assigning an identity to the virtual machine, give the VM read access to either the resource group or the individual resources associated to the virtual machine (VM, Network Interfaces, OS Disks and Data Disks). It is recommended to use the built-in Reader role to grant the access to these resources. You can also grant this access by adding the VM identity to an Azure Active Directory group that already has read access to the required resources. It is then no longer needed to have Owner privileges when deploying the VM Extension for SAP if you use a user assigned identity that already has the required permissions.
150150

151151
There are different ways how to deploy the VM Extension for SAP manually. Please find a few examples in the next chapters.
152152

153+
The extension currently supports the following configuration keys. In the example below, the msi_res_id is shown.
154+
155+
* msi_res_id: ID of the user assigned identity the extension should use to get the required information about the VM and its resources
156+
* proxy: URL of the proxy the extension should use to connect to the internet, for example to retrieve information about the virtual machine and its resources.
157+
153158
### Deploy manually with Azure PowerShell
154159

155160
The following code contains four examples. It shows how to deploy the extension on Windows and Linux, using a system or user assigned identity. Make sure to replace the name of the resource group, the location and VM name in the example.
@@ -174,6 +179,8 @@ Set-AzVMExtension -Publisher "Microsoft.AzureCAT.AzureEnhancedMonitoring" -Exten
174179

175180
### Deploy manually with Azure CLI
176181

182+
The following code contains four examples. It shows how to deploy the extension on Windows and Linux, using a system or user assigned identity. Make sure to replace the name of the resource group, the location and VM name in the example.
183+
177184
``` bash
178185
# Windows VM - user assigned identity
179186
az vm extension set --publisher "Microsoft.AzureCAT.AzureEnhancedMonitoring" --name "MonitorX64Windows" --resource-group "<rg name>" --vm-name "<vm name>" \
@@ -192,9 +199,93 @@ az vm extension set --publisher "Microsoft.AzureCAT.AzureEnhancedMonitoring" --n
192199
--extension-instance-name "MonitorX64Linux" --settings '{"cfg":[]}'
193200
```
194201

195-
### Deploy manually with Azure Resource Manager Templates
196202
### Deploy manually with Terraform
197203

204+
The following manifest contains four examples. It shows how to deploy the extension on Windows and Linux, using a system or user assigned identity. Make sure to replace the ID of the VM and ID of the user assigned identity in the example.
205+
206+
```terraform
207+
208+
# Windows VM - user assigned identity
209+
210+
resource "azurerm_virtual_machine_extension" "example" {
211+
name = "MonitorX64Windows"
212+
virtual_machine_id = "<vm id>"
213+
publisher = "Microsoft.AzureCAT.AzureEnhancedMonitoring"
214+
type = "MonitorX64Windows"
215+
type_handler_version = "1.0"
216+
auto_upgrade_minor_version = true
217+
218+
settings = <<SETTINGS
219+
{
220+
"cfg":[
221+
{
222+
"key":"msi_res_id",
223+
"value":"<user assigned resource id>"
224+
}
225+
]
226+
}
227+
SETTINGS
228+
}
229+
230+
# Windows VM - system assigned identity
231+
232+
resource "azurerm_virtual_machine_extension" "example" {
233+
name = "MonitorX64Windows"
234+
virtual_machine_id = "<vm id>"
235+
publisher = "Microsoft.AzureCAT.AzureEnhancedMonitoring"
236+
type = "MonitorX64Windows"
237+
type_handler_version = "1.0"
238+
auto_upgrade_minor_version = true
239+
240+
settings = <<SETTINGS
241+
{
242+
"cfg":[
243+
]
244+
}
245+
SETTINGS
246+
}
247+
248+
# Linux VM - user assigned identity
249+
250+
resource "azurerm_virtual_machine_extension" "example" {
251+
name = "MonitorX64Linux"
252+
virtual_machine_id = "<vm id>"
253+
publisher = "Microsoft.AzureCAT.AzureEnhancedMonitoring"
254+
type = "MonitorX64Linux"
255+
type_handler_version = "1.0"
256+
auto_upgrade_minor_version = true
257+
258+
settings = <<SETTINGS
259+
{
260+
"cfg":[
261+
{
262+
"key":"msi_res_id",
263+
"value":"<user assigned resource id>"
264+
}
265+
]
266+
}
267+
SETTINGS
268+
}
269+
270+
# Linux VM - system assigned identity
271+
272+
resource "azurerm_virtual_machine_extension" "example" {
273+
name = "MonitorX64Linux"
274+
virtual_machine_id = "<vm id>"
275+
publisher = "Microsoft.AzureCAT.AzureEnhancedMonitoring"
276+
type = "MonitorX64Linux"
277+
type_handler_version = "1.0"
278+
auto_upgrade_minor_version = true
279+
280+
settings = <<SETTINGS
281+
{
282+
"cfg":[
283+
]
284+
}
285+
SETTINGS
286+
}
287+
```
288+
198289
### Versions of the VM Extension for SAP
199290

200291
If you want to disable automatic updates for the VM extension or want to deploy a specific version of the extension, you can retrieve the available versions with Azure CLI or Azure PowerShell.

0 commit comments

Comments
 (0)