تمكين ملحقات Azure VM باستخدام قالب ARM

مقالة
05/13/2022
قراءة خلال 7 دقائق

توضح لك هذه المقالة كيفية استخدام قالب Azure Resource Manager (قالب ARM) لنشر ملحقات Azure VM، التي تدعمها الخوادم التي تدعم Azure Arc.

يمكن إضافة ملحقات VM إلى قالب Azure Resource Manager وتنفيذها مع نشر القالب. باستخدام ملحقات الأجهزة الظاهرية التي تدعمها الخوادم التي تدعم Azure Arc، يمكنك نشر ملحق الجهاز الظاهري المدعوم على أجهزة Linux أو Windows باستخدام Azure PowerShell. يتضمن كل نموذج أدناه ملف قالب وملف معلمات مع قيم عينة لتوفيرها للقالب.

ملاحظة

على الرغم من أنه يمكن تجميع ملحقات متعددة معا ومعالجتها ، إلا أنه يتم تثبيتها بشكل متسلسل. بمجرد اكتمال تثبيت الملحق الأول ، تتم محاولة تثبيت الملحق التالي.

ملاحظة

لا تدعم الخوادم التي تدعم Azure Arc نشر ملحقات الأجهزة الظاهرية وإدارتها على أجهزة Azure الظاهرية. بالنسبة إلى الأجهزة الظاهرية ل Azure، راجع مقالة نظرة عامة على ملحق الجهاز الظاهري التالية.

نشر ملحق الجهاز الظاهري ل Log Analytics

لنشر وكيل Log Analytics بسهولة، يتم توفير النموذج التالي لتثبيت العامل على 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": "2019-08-02-preview",
            "properties": {
                "publisher": "Microsoft.EnterpriseCloud.Monitoring",
                "type": "OmsAgentForLinux",
                "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": "2019-08-02-preview",
            "properties": {
                "publisher": "Microsoft.EnterpriseCloud.Monitoring",
                "type": "MicrosoftMonitoringAgent",
                "autoUpgradeMinorVersion": 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"

نشر ملحق البرنامج النصي المخصص

لاستخدام ملحق البرنامج النصي المخصص، يتم توفير النموذج التالي للتشغيل على Windows وLinux. إذا لم تكن معتادا على ملحق البرنامج النصي المخصص، فراجع ملحق البرنامج النصي المخصص Windows أو ملحق البرنامج النصي المخصص لنظام التشغيل Linux. هناك نوعان من الخصائص المختلفة التي يجب أن تفهمها عند استخدام هذا الامتداد مع الآلات الهجينة:

لا تنطبق قائمة أنظمة التشغيل المدعومة مع ملحق Azure VM Custom Script على الخوادم التي تدعم Azure Arc. يمكن العثور على قائمة أنظمة التشغيل المدعومة للخوادم التي تدعم Azure Arc هنا.
لا تنطبق تفاصيل التكوين المتعلقة بمجموعات مقياس الجهاز الظاهري Azure أو الأجهزة الظاهرية الكلاسيكية.
إذا كانت أجهزتك بحاجة إلى تنزيل برنامج نصي خارجيا ولا يمكنها الاتصال إلا من خلال خادم وكيل، فستحتاج إلى تكوين عامل الجهاز المتصل لتعيين المتغير البيئي للخادم الوكيل.

يحدد تكوين ملحق البرنامج النصي المخصص أشياء مثل موقع البرنامج النصي والأمر المراد تشغيله. يتم تحديد هذا التكوين في قالب Azure Resource Manager، المتوفر أدناه لكل من Linux والأجهزة المختلطة 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": "array"
    },
    "commandToExecute": {
      "type": "securestring"
    }
  },
  "resources": [
    {
      "name": "[concat(parameters('vmName'),'/CustomScript')]",
      "type": "Microsoft.HybridCompute/machines/extensions",
      "location": "[parameters('location')]",
      "apiVersion": "2019-08-02-preview",
      "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": "2019-08-02-preview",
            "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، يتم توفير النموذج التالي للتشغيل على Windows وLinux. إذا لم تكن معتادا على عامل التبعية، فراجع نظرة عامة على وكلاء Azure Monitor.

ملف قالب لينكس

{
    "$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."
      }
    }
  },
  "variables": {
    "vmExtensionsApiVersion": "2017-03-30"
  },
  "resources": [
    {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/DAExtension')]",
      "apiVersion": "[variables('vmExtensionsApiVersion')]",
      "location": "[resourceGroup().location]",
      "dependsOn": [
      ],
      "properties": {
        "publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
        "type": "DependencyAgentLinux",
        "autoUpgradeMinorVersion": 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."
      }
    }
  },
  "variables": {
    "vmExtensionsApiVersion": "2017-03-30"
  },
  "resources": [
    {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/DAExtension')]",
      "apiVersion": "[variables('vmExtensionsApiVersion')]",
      "location": "[resourceGroup().location]",
      "dependsOn": [
      ],
      "properties": {
        "publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
        "type": "DependencyAgentWindows",
        "autoUpgradeMinorVersion": true
      }
    }
  ],
    "outputs": {
    }
}

توزيع القالب

احفظ ملف القالب على القرص. يمكنك بعد ذلك نشر الملحق على الجهاز المتصل باستخدام الأمر التالي.

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

Deploy Azure Key Vault VM extension (preview)

يعرض JSON التالي مخطط ملحق VM Key Vault (معاينة). لا تتطلب الإضافة إعدادات محمية - تعتبر جميع إعداداتها معلومات عامة. يتطلب الامتداد قائمة بالشهادات المراقبة وتكرار الاقتراع ومخزن الشهادات الوجهة. على وجه التحديد:

ملف قالب لينكس

{
    "$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": "2019-12-12",
      "location": "[parameters('location')]",
      "properties": {
      "publisher": "Microsoft.Azure.KeyVault",
      "type": "KeyVaultForLinux",
      "autoUpgradeMinorVersion": 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":  <MSI endpoint e.g.: "http://localhost:40342/metadata/identity">,
                "msiClientId":  <MSI identity e.g.: "c7373ae5-91c2-4165-8ab6-7381d6e75619">
        }
      }
    }
  }
 ]
}

ملف قالب 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": "2019-12-12",
      "location": "[parameters('location')]",
      "properties": {
      "publisher": "Microsoft.Azure.KeyVault",
      "type": "KeyVaultForWindows",
      "autoUpgradeMinorVersion": 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": <MSI endpoint e.g.: "http://localhost:40342/metadata/identity">,
                "msiClientId": <MSI identity e.g.: "c7373ae5-91c2-4165-8ab6-7381d6e75619">
        }
      }
    }
  }
 ]
}

ملاحظة

يجب أن تكون عناوين URL للشهادات المرصودة من النموذج https://myVaultName.vault.azure.net/secrets/myCertName.

وذلك لأن /secrets المسار بإرجاع الشهادة الكاملة، بما في ذلك المفتاح الخاص، في حين أن /certificates المسار لا يفعل ذلك. يمكن العثور على مزيد من المعلومات حول الشهادات هنا: شهادات Key Vault

توزيع القالب

احفظ ملف القالب على القرص. يمكنك بعد ذلك نشر الملحق على الجهاز المتصل باستخدام الأمر التالي.

ملاحظة

سيتطلب امتداد الجهاز الظاهري تعيين هوية معينة من قبل النظام للمصادقة على Key vault. راجع كيفية المصادقة على Key Vault باستخدام الهوية المدارة للخوادم Windows وLinux Azure Arc.

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

نشر الماسح الضوئي المتكامل ل Microsoft Defender for Cloud

لاستخدام ملحق الماسح الضوئي المتكامل Microsoft Defender for Cloud، يتم توفير النموذج التالي لتشغيله على Windows وLinux. إذا لم تكن معتادا على الماسح الضوئي المدمج، فراجع نظرة عامة على حل تقييم الثغرات الأمنية في Microsoft Defender for Cloud للأجهزة المختلطة.

ملف قالب Windows

{
  "properties": {
    "mode": "Incremental",
    "template": {
      "contentVersion": "1.0.0.0",
      "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
      "parameters": {
        "vmName": {
          "type": "string"
        },
        "apiVersionByEnv": {
          "type": "string"
        }
      },
      "resources": [
        {
          "type": "Microsoft.HybridCompute/machines/providers/serverVulnerabilityAssessments",
          "name": "[concat(parameters('vmName'), '/Microsoft.Security/default')]",
          "apiVersion": "[parameters('apiVersionByEnv')]"
        }
      ]
    },
    "parameters": {
      "vmName": {
        "value": "resourceName"
      },
      "apiVersionByEnv": {
        "value": "2015-06-01-preview"
      }
    }
  }
}

ملف قالب لينكس

{
  "properties": {
    "mode": "Incremental",
    "template": {
      "contentVersion": "1.0.0.0",
      "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
      "parameters": {
        "vmName": {
          "type": "string"
        },
        "apiVersionByEnv": {
          "type": "string"
        }
      },
      "resources": [
        {
          "type": "Microsoft.HybridCompute/machines/providers/serverVulnerabilityAssessments",
          "name": "[concat(parameters('vmName'), '/Microsoft.Security/default')]",
          "apiVersion": "[parameters('apiVersionByEnv')]"
        }
      ]
    },
    "parameters": {
      "vmName": {
        "value": "resourceName"
      },
      "apiVersionByEnv": {
        "value": "2015-06-01-preview"
      }
    }
  }
}

توزيع القالب

احفظ ملف القالب على القرص. يمكنك بعد ذلك نشر الملحق على الجهاز المتصل باستخدام الأمر التالي.

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

الخطوات التالية

يمكنك نشر ملحقات الأجهزة الظاهرية وإدارتها وإزالتها باستخدام Azure PowerShell أو من مدخل Azure أو Azure CLI.
يمكن العثور على معلومات استكشاف الأخطاء وإصلاحها في دليل استكشاف أخطاء ملحقات الأجهزة الظاهرية وإصلاحها.

تمكين ملحقات Azure VM باستخدام قالب ARM

هل هذه الصفحة مفيدة؟

نشر ملحق الجهاز الظاهري ل Log Analytics

ملف قالب لينكس

ملف قالب Windows

ملف المعلمة

نشر ملحق البرنامج النصي المخصص

ملف قالب لينكس

ملف قالب Windows

ملف المعلمة

نشر ملحق عامل التبعية

ملف قالب لينكس

ملف قالب Windows

توزيع القالب

Deploy Azure Key Vault VM extension (preview)

ملف قالب لينكس

ملف قالب Windows

توزيع القالب

نشر الماسح الضوئي المتكامل ل Microsoft Defender for Cloud

ملف قالب Windows

ملف قالب لينكس

توزيع القالب

الخطوات التالية