Включение расширений виртуальной машины Azure с помощью шаблона ARM

Статья
01/17/2025

В этой статье показано, как использовать шаблон Azure Resource Manager (шаблон ARM) для развертывания расширений виртуальной машины Azure, поддерживаемых серверами с поддержкой Azure Arc.

Расширения виртуальных машин можно добавить в шаблон ARM и выполнить с развертыванием шаблона. С помощью расширений виртуальных машин, поддерживаемых серверами с поддержкой Azure Arc, можно развернуть расширения на компьютерах Linux или Windows с помощью Azure PowerShell. Каждый пример, приведенный ниже, включает файл шаблона и файл параметров с примерами значений для предоставления шаблона.

Примечание.

Хотя вы можете пакетировать несколько расширений и обработать их вместе, они устанавливаются последовательно. После завершения установки первого расширения устанавливается следующее расширение.

Серверы с поддержкой Azure Arc не поддерживают развертывание расширений виртуальных машин и управление ими на виртуальных машинах Azure. Сведения о виртуальных машинах Azure см. в статье об расширении виртуальной машины.

Включение расширения виртуальной машины Log Analytics

Чтобы легко развернуть агент Log Analytics, используйте один из следующих примеров для установки агента в Linux или Windows.

Файл шаблона для 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')]"
                }
            }
        }
    ]
}

Файл шаблона для 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')]"
                }
            }
        }
    ]
}

Файл параметров

{
    "$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>"
        }
    }
}

Сохраните шаблон и файл параметров на диск и измените файл параметров с соответствующими значениями для развертывания. Затем можно установить расширение на всех подключенных компьютерах в группе ресурсов с помощью следующей команды. Команда использует TemplateFile параметр для указания шаблона и TemplateParameterFile параметра, чтобы указать файл, содержащий параметры и значения параметров.

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

Развертывание расширения пользовательского скрипта

Чтобы использовать расширение пользовательского скрипта, выполните один из следующих примеров для Linux и Windows. Если вы не знакомы с расширением пользовательского скрипта, ознакомьтесь с расширением настраиваемых скриптов для Linux или расширения пользовательских скриптов для Windows. Существует несколько различных характеристик, которые следует понимать при использовании этого расширения с гибридными компьютерами:

Список поддерживаемых операционных систем с расширением пользовательского скрипта виртуальной машины Azure неприменимо к серверам с поддержкой Azure Arc. См. список поддерживаемых операционных систем для серверов с поддержкой Azure Arc.
Сведения о конфигурации масштабируемых наборов виртуальных машин Azure или виртуальных машин, созданных с помощью классической модели развертывания, не применимы.
Если компьютеры должны скачать скрипт внешне и обмениваться данными только через прокси-сервер, необходимо настроить агент подключенного компьютера, чтобы задать переменную среды прокси-сервера.

В конфигурации расширения пользовательских сценариев указываются такие параметры, как расположение сценария и команда для его выполнения. Эта конфигурация указана в следующих шаблонах.

Файл шаблона для 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')]"
        }
      }
    }
  ]
}

Файл шаблона для 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'))]"
                }
            }
        }
    ]
}

Файл параметров

{
  "$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]"
    }
  }
}

Развертывание расширения агента зависимостей

Чтобы использовать расширение агента зависимостей Azure Monitor, выполните один из следующих примеров для Linux и Windows. Если вы не знакомы с агентом зависимостей, ознакомьтесь с обзором агентов Azure Monitor.

Файл шаблона для 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": {
  }
}

Файл шаблона для 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": {
  }
}

Развертывание шаблона

Сохраните файл шаблона на диск. Затем можно развернуть расширение на подключенном компьютере с помощью следующей команды:

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

Развертывание расширения виртуальной машины Azure Key Vault (предварительная версия)

В следующем JSON-файле показана схема для расширения виртуальной машины хранилища ключей (предварительная версия). Расширение не требует защищенных параметров, так как все его параметры считаются общедоступными сведениями. Для расширения требуется список отслеживаемых сертификатов, частота опроса и целевое хранилище сертификатов.

Файл шаблона для 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"
        }
      }
    }
  }
 ]
}

Файл шаблона для 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"
        }
      }
    }
  }
 ]
}

Примечание.

Url-адреса наблюдаемого сертификата должны иметь форму https://myVaultName.vault.azure.net/secrets/myCertName. Причина заключается в том, что /secrets путь возвращает полный сертификат, включая закрытый ключ, в то время как /certificates путь не выполняется. Дополнительные сведения о сертификатах см. в разделе "Ключи, секреты и сертификаты Azure Key Vault".

Развертывание шаблона

Сохраните файл шаблона на диск. Затем можно развернуть расширение на подключенном компьютере с помощью следующей команды.

Примечание.

Расширение виртуальной машины требует назначаемого системой удостоверения для проверки подлинности в Key Vault. Ознакомьтесь с проверкой подлинности ресурсов Azure с серверами с поддержкой Azure Arc для серверов с поддержкой Linux и Windows Azure Arc.

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

Вы можете развертывать, управлять и удалять расширения виртуальных машин с помощью Azure PowerShell, портал Azure или Azure CLI.
Сведения об устранении неполадок см. в руководстве по устранению неполадок с расширениями виртуальных машин.

Поделиться через

Включение расширений виртуальной машины Azure с помощью шаблона ARM

Включение расширения виртуальной машины Log Analytics

Файл шаблона для Linux

Файл шаблона для Windows

Файл параметров

Развертывание расширения пользовательского скрипта

Файл шаблона для Linux

Файл шаблона для Windows

Файл параметров

Развертывание расширения агента зависимостей

Файл шаблона для Linux

Файл шаблона для Windows

Развертывание шаблона

Развертывание расширения виртуальной машины Azure Key Vault (предварительная версия)

Файл шаблона для Linux

Файл шаблона для Windows

Развертывание шаблона

Обратная связь

Дополнительные ресурсы

Поделиться через

Включение расширений виртуальной машины Azure с помощью шаблона ARM

Включение расширения виртуальной машины Log Analytics

Файл шаблона для Linux

Файл шаблона для Windows

Файл параметров

Развертывание расширения пользовательского скрипта

Файл шаблона для Linux

Файл шаблона для Windows

Файл параметров

Развертывание расширения агента зависимостей

Файл шаблона для Linux

Файл шаблона для Windows

Развертывание шаблона

Развертывание расширения виртуальной машины Azure Key Vault (предварительная версия)

Файл шаблона для Linux

Файл шаблона для Windows

Развертывание шаблона

Связанный контент

Обратная связь

Дополнительные ресурсы