Habilitar extensões de VM do Azure usando um modelo ARM

Artigo
01/17/2025

Este artigo mostra como usar um modelo do Azure Resource Manager (modelo ARM) para implantar extensões de máquina virtual (VM) do Azure que são suportadas por servidores habilitados para Azure Arc.

Você pode adicionar extensões de VM a um modelo ARM e executá-las com a implantação do modelo. Com as extensões de VM suportadas pelos servidores habilitados para Azure Arc, você pode implantar as extensões em máquinas Linux ou Windows usando o Azure PowerShell. Cada exemplo a seguir inclui um arquivo de modelo e um arquivo de parâmetro com valores de exemplo para fornecer ao modelo.

Nota

Embora você possa agrupar várias extensões em lote e processá-las juntas, elas são instaladas em série. Após a conclusão da instalação da primeira extensão, a próxima extensão é instalada.

Os servidores habilitados para Azure Arc não oferecem suporte à implantação e ao gerenciamento de extensões de VM em máquinas virtuais do Azure. Para VMs do Azure, consulte o artigo de visão geral da extensão de VM.

Implantar a extensão de VM do Log Analytics

Para implantar facilmente o agente do Log Analytics, use um dos exemplos a seguir para instalar o agente no Linux ou no Windows.

Arquivo de modelo para Linux

{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "workspaceId": {
            "type": "string"
        },
        "workspaceKey": {
            "type": "string"
        }
    },
    "resources": [
        {
            "name": "[concat(parameters('vmName'),'/OMSAgentForLinux')]",
            "type": "Microsoft.HybridCompute/machines/extensions",
            "location": "[parameters('location')]",
            "apiVersion": "2022-03-10",
            "properties": {
                "publisher": "Microsoft.EnterpriseCloud.Monitoring",
                "type": "OmsAgentForLinux",
                "enableAutomaticUpgrade": true,
                "settings": {
                    "workspaceId": "[parameters('workspaceId')]"
                },
                "protectedSettings": {
                    "workspaceKey": "[parameters('workspaceKey')]"
                }
            }
        }
    ]
}

Arquivo de modelo para Windows

{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "workspaceId": {
            "type": "string"
        },
        "workspaceKey": {
            "type": "string"
        }
    },
    "resources": [
        {
            "name": "[concat(parameters('vmName'),'/MicrosoftMonitoringAgent')]",
            "type": "Microsoft.HybridCompute/machines/extensions",
            "location": "[parameters('location')]",
            "apiVersion": "2022-03-10",
            "properties": {
                "publisher": "Microsoft.EnterpriseCloud.Monitoring",
                "type": "MicrosoftMonitoringAgent",
                "autoUpgradeMinorVersion": true,
                "enableAutomaticUpgrade": true,
                "settings": {
                    "workspaceId": "[parameters('workspaceId')]"
                },
                "protectedSettings": {
                    "workspaceKey": "[parameters('workspaceKey')]"
                }
            }
        }
    ]
}

Arquivo de parâmetros

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "value": "<vmName>"
        },
        "location": {
            "value": "<region>"
        },
        "workspaceId": {
            "value": "<MyWorkspaceID>"
        },
        "workspaceKey": {
            "value": "<MyWorkspaceKey>"
        }
    }
}

Salve o modelo e o arquivo de parâmetro no disco e edite o arquivo de parâmetros com os valores apropriados para sua implantação. Em seguida, você pode instalar a extensão em todas as máquinas conectadas dentro de um grupo de recursos usando o seguinte comando. O comando usa o TemplateFile parâmetro para especificar o modelo e o TemplateParameterFile parâmetro para especificar um arquivo que contém parâmetros e valores de parâmetro.

New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\LogAnalyticsAgent.json" -TemplateParameterFile "D:\Azure\Templates\LogAnalyticsAgentParms.json"

Implantar a extensão de script personalizada

Para usar a extensão de script personalizado, execute um dos seguintes exemplos para Linux e Windows. Se você não estiver familiarizado com a Extensão de Script Personalizada, consulte Extensão de Script Personalizada para Linux ou Extensão de Script Personalizada para Windows. Existem algumas características diferentes que você deve entender quando estiver usando esta extensão com máquinas híbridas:

A lista de sistemas operacionais com suporte com a Extensão de Script Personalizado da VM do Azure não é aplicável aos servidores habilitados para Azure Arc. Consulte a lista de sistemas operacionais com suporte para servidores habilitados para Azure Arc.
Os detalhes de configuração relativos aos conjuntos de dimensionamento de máquinas virtuais do Azure ou VMs criadas através do modelo de implementação clássico não são aplicáveis.
Se suas máquinas precisarem baixar um script externamente e puderem se comunicar somente por meio de um servidor proxy, você precisará configurar o agente de Máquina Conectada para definir a variável de ambiente do servidor proxy.

A configuração da Extensão de Script Personalizada especifica coisas como o local do script e o comando a ser executado. Essa configuração é especificada nos modelos a seguir.

Arquivo de modelo para Linux

{
  "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string"
    },
    "location": {
      "type": "string"
    },
    "fileUris": {
      "type": "array"
    },
    "commandToExecute": {
      "type": "securestring"
    }
  },
  "resources": [
    {
      "name": "[concat(parameters('vmName'),'/CustomScript')]",
      "type": "Microsoft.HybridCompute/machines/extensions",
      "location": "[parameters('location')]",
      "apiVersion": "2022-03-10",
      "properties": {
        "publisher": "Microsoft.Azure.Extensions",
        "type": "CustomScript",
        "autoUpgradeMinorVersion": true,
        "settings": {},
        "protectedSettings": {
          "commandToExecute": "[parameters('commandToExecute')]",
          "fileUris": "[parameters('fileUris')]"
        }
      }
    }
  ]
}

Arquivo de modelo para Windows

{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "fileUris": {
            "type": "string"
        },
        "arguments": {
            "type": "securestring",
            "defaultValue": " "
        }
    },
    "variables": {
        "UriFileNamePieces": "[split(parameters('fileUris'), '/')]",
        "firstFileNameString": "[variables('UriFileNamePieces')[sub(length(variables('UriFileNamePieces')), 1)]]",
        "firstFileNameBreakString": "[split(variables('firstFileNameString'), '?')]",
        "firstFileName": "[variables('firstFileNameBreakString')[0]]"
    },
    "resources": [
        {
            "name": "[concat(parameters('vmName'),'/CustomScriptExtension')]",
            "type": "Microsoft.HybridCompute/machines/extensions",
            "location": "[parameters('location')]",
            "apiVersion": "2022-03-10",
            "properties": {
                "publisher": "Microsoft.Compute",
                "type": "CustomScriptExtension",
                "autoUpgradeMinorVersion": true,
                "settings": {
                    "fileUris": "[split(parameters('fileUris'), ' ')]"
                },
                "protectedSettings": {
                    "commandToExecute": "[concat ('powershell -ExecutionPolicy Unrestricted -File ', variables('firstFileName'), ' ', parameters('arguments'))]"
                }
            }
        }
    ]
}

Arquivo de parâmetros

{
  "$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
  "handler": "Microsoft.Azure.CreateUIDef",
  "version": "0.1.2-preview",
  "parameters": {
    "basics": [
      {}
    ],
    "steps": [
      {
        "name": "customScriptExt",
        "label": "Add Custom Script Extension",
        "elements": [
          {
            "name": "fileUris",
            "type": "Microsoft.Common.FileUpload",
            "label": "Script files",
            "toolTip": "The script files that will be downloaded to the virtual machine.",
            "constraints": {
              "required": false
            },
            "options": {
              "multiple": true,
              "uploadMode": "url"
            },
            "visible": true
          },
          {
            "name": "commandToExecute",
            "type": "Microsoft.Common.TextBox",
            "label": "Command",
            "defaultValue": "sh script.sh",
            "toolTip": "The command to execute, for example: sh script.sh",
            "constraints": {
              "required": true
            },
            "visible": true
          }
        ]
      }
    ],
    "outputs": {
      "vmName": "[vmName()]",
      "location": "[location()]",
      "fileUris": "[steps('customScriptExt').fileUris]",
      "commandToExecute": "[steps('customScriptExt').commandToExecute]"
    }
  }
}

Implantar a extensão do agente de dependência

Para usar a extensão do agente de dependência do Azure Monitor, execute um dos seguintes exemplos para Linux e Windows. Se você não estiver familiarizado com o agente de dependência, consulte Visão geral dos agentes do Azure Monitor.

Arquivo de modelo para Linux

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string",
      "metadata": {
        "description": "The name of existing Linux machine."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/DAExtension')]",
      "apiVersion": "2022-03-10",
      "location": "[resourceGroup().location]",
      "dependsOn": [
      ],
      "properties": {
        "publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
        "type": "DependencyAgentLinux",
        "enableAutomaticUpgrade": true
      }
    }
  ],
  "outputs": {
  }
}

Arquivo de modelo para Windows

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string",
      "metadata": {
        "description": "The name of existing Windows machine."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/DAExtension')]",
      "apiVersion": "2022-03-10",
      "location": "[resourceGroup().location]",
      "dependsOn": [
      ],
      "properties": {
        "publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
        "type": "DependencyAgentWindows",
        "enableAutomaticUpgrade": true
      }
    }
  ],
  "outputs": {
  }
}

Implementação de modelos

Salve o arquivo de modelo no disco. Em seguida, você pode implantar a extensão na máquina conectada usando o seguinte comando:

New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\DependencyAgent.json"

Implantar a extensão de VM do Azure Key Vault (visualização)

O JSON a seguir mostra o esquema para a extensão de VM do Cofre da Chave (visualização). A extensão não requer configurações protegidas, porque todas as suas configurações são consideradas informações públicas. A extensão requer uma lista de certificados monitorados, a frequência de sondagem e o armazenamento de certificados de destino.

Arquivo de modelo para Linux

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "autoUpgradeMinorVersion":{
            "type": "bool"
        },
        "pollingIntervalInS":{
          "type": "int"
        },
        "certificateStoreName":{
          "type": "string"
        },
        "certificateStoreLocation":{
          "type": "string"
        },
        "observedCertificates":{
          "type": "string"
        },
        "msiEndpoint":{
          "type": "string"
        },
        "msiClientId":{
          "type": "string"
        }
},
"resources": [
   {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/KVVMExtensionForLinux')]",
      "apiVersion": "2022-03-10",
      "location": "[parameters('location')]",
      "properties": {
      "publisher": "Microsoft.Azure.KeyVault",
      "type": "KeyVaultForLinux",
      "enableAutomaticUpgrade": true,
      "settings": {
          "secretsManagementSettings": {
          "pollingIntervalInS": <polling interval in seconds, e.g. "3600">,
          "certificateStoreName": <ignored on linux>,
          "certificateStoreLocation": <disk path where certificate is stored, default: "/var/lib/waagent/Microsoft.Azure.KeyVault">,
          "observedCertificates": <list of KeyVault URIs representing monitored certificates, e.g.: "https://myvault.vault.azure.net/secrets/mycertificate"
          },
          "authenticationSettings": {
                "msiEndpoint":  "http://localhost:40342/metadata/identity"
        }
      }
    }
  }
 ]
}

Arquivo de modelo para Windows

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "autoUpgradeMinorVersion":{
            "type": "bool"
        },
        "pollingIntervalInS":{
          "type": "int"
        },
        "certificateStoreName":{
          "type": "string"
        },
        "linkOnRenewal":{
          "type": "bool"
        },
        "certificateStoreLocation":{
          "type": "string"
        },
        "requireInitialSync":{
          "type": "bool"
        },
        "observedCertificates":{
          "type": "string"
        },
        "msiEndpoint":{
          "type": "string"
        },
        "msiClientId":{
          "type": "string"
        }
},
"resources": [
   {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/KVVMExtensionForWindows')]",
      "apiVersion": "2022-03-10",
      "location": "[parameters('location')]",
      "properties": {
      "publisher": "Microsoft.Azure.KeyVault",
      "type": "KeyVaultForWindows",
      "enableAutomaticUpgrade": true,
      "settings": {
        "secretsManagementSettings": {
          "pollingIntervalInS": "3600",
          "certificateStoreName": <certificate store name, e.g.: "MY">,
          "linkOnRenewal": <Only Windows. This feature ensures s-channel binding when certificate renews, without necessitating a re-deployment.  e.g.: false>,
          "certificateStoreLocation": <certificate store location, currently it works locally only e.g.: "LocalMachine">,
          "requireInitialSync": <initial synchronization of certificates e.g.: true>,
          "observedCertificates": <list of KeyVault URIs representing monitored certificates, e.g.: "https://myvault.vault.azure.net"
        },
        "authenticationSettings": {
                "msiEndpoint": "http://localhost:40342/metadata/identity"
        }
      }
    }
  }
 ]
}

Nota

Os URLs de certificado observados devem ter o formato https://myVaultName.vault.azure.net/secrets/myCertName. O motivo é que o /secrets caminho retorna o certificado completo, incluindo a chave privada, enquanto o /certificates caminho não. Você pode encontrar mais informações sobre certificados na visão geral de chaves, segredos e certificados do Azure Key Vault.

Implementação de modelos

Salve o arquivo de modelo no disco. Em seguida, você pode implantar a extensão na máquina conectada usando o comando a seguir.

Nota

A extensão da VM exigiria que uma identidade atribuída ao sistema fosse atribuída para autenticar no Cofre da Chave. Consulte Autenticar em recursos do Azure com servidores habilitados para ArcGIS do Azure para servidores habilitados para Linux e Windows Azure Arc.

New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\KeyVaultExtension.json"

Você pode implantar, gerenciar e remover extensões de VM usando o Azure PowerShell, o portal do Azure ou a CLI do Azure.
Você pode encontrar informações de solução de problemas no guia para solução de problemas de extensões de VM.

Partilhar via

Habilitar extensões de VM do Azure usando um modelo ARM

Implantar a extensão de VM do Log Analytics

Arquivo de modelo para Linux

Arquivo de modelo para Windows

Arquivo de parâmetros

Implantar a extensão de script personalizada

Arquivo de modelo para Linux

Arquivo de modelo para Windows

Arquivo de parâmetros

Implantar a extensão do agente de dependência

Arquivo de modelo para Linux

Arquivo de modelo para Windows

Implementação de modelos

Implantar a extensão de VM do Azure Key Vault (visualização)

Arquivo de modelo para Linux

Arquivo de modelo para Windows

Implementação de modelos

Comentários

Recursos adicionais

Partilhar via

Habilitar extensões de VM do Azure usando um modelo ARM

Implantar a extensão de VM do Log Analytics

Arquivo de modelo para Linux

Arquivo de modelo para Windows

Arquivo de parâmetros

Implantar a extensão de script personalizada

Arquivo de modelo para Linux

Arquivo de modelo para Windows

Arquivo de parâmetros

Implantar a extensão do agente de dependência

Arquivo de modelo para Linux

Arquivo de modelo para Windows

Implementação de modelos

Implantar a extensão de VM do Azure Key Vault (visualização)

Arquivo de modelo para Linux

Arquivo de modelo para Windows

Implementação de modelos

Conteúdos relacionados

Comentários

Recursos adicionais