Włączanie rozszerzeń maszyn wirtualnych platformy Azure przy użyciu szablonu usługi ARM

Artykuł
01/17/2025

W tym artykule pokazano, jak używać szablonu usługi Azure Resource Manager (szablonu arm) do wdrażania rozszerzeń maszyn wirtualnych platformy Azure obsługiwanych przez serwery z obsługą usługi Azure Arc.

Rozszerzenia maszyn wirtualnych można dodać do szablonu usługi ARM i wykonać je przy użyciu wdrożenia szablonu. Rozszerzenia maszyn wirtualnych obsługiwane przez serwery z obsługą usługi Azure Arc umożliwiają wdrażanie rozszerzeń na maszynach z systemem Linux lub Windows przy użyciu programu Azure PowerShell. Każdy z poniższych przykładów zawiera plik szablonu i plik parametrów z przykładowymi wartościami, które mają być udostępniane szablonowi.

Uwaga

Mimo że można wsadować wiele rozszerzeń i przetwarzać je razem, są one instalowane szeregowo. Po zakończeniu instalacji pierwszego rozszerzenia zostanie zainstalowane następne rozszerzenie.

Serwery z obsługą usługi Azure Arc nie obsługują wdrażania rozszerzeń maszyn wirtualnych platformy Azure i zarządzania nimi na maszynach wirtualnych platformy Azure. Aby zapoznać się z maszynami wirtualnymi platformy Azure, zobacz artykuł Omówienie rozszerzenia maszyny wirtualnej.

Wdrażanie rozszerzenia maszyny wirtualnej usługi Log Analytics

Aby łatwo wdrożyć agenta usługi Log Analytics, użyj jednego z poniższych przykładów, aby zainstalować agenta w systemie Linux lub Windows.

Plik szablonu dla systemu 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')]"
                }
            }
        }
    ]
}

Plik szablonu dla systemu 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')]"
                }
            }
        }
    ]
}

Plik parametrów

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

Zapisz plik szablonu i parametrów na dysku, a następnie zmodyfikuj plik parametrów przy użyciu odpowiednich wartości dla wdrożenia. Następnie można zainstalować rozszerzenie na wszystkich połączonych maszynach w grupie zasobów przy użyciu następującego polecenia. Polecenie używa parametru TemplateFile do określenia szablonu i parametru TemplateParameterFile w celu określenia pliku zawierającego parametry i wartości parametrów.

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

Wdrażanie rozszerzenia niestandardowego skryptu

Aby użyć rozszerzenia niestandardowego skryptu, uruchom jedną z następujących przykładów dla systemów Linux i Windows. Jeśli nie znasz rozszerzenia niestandardowego skryptu, zobacz Niestandardowe rozszerzenie skryptu dla systemu Linux lub niestandardowe rozszerzenie skryptu dla systemu Windows. Istnieje kilka różnych cech, które należy zrozumieć, gdy używasz tego rozszerzenia z maszynami hybrydowymi:

Lista obsługiwanych systemów operacyjnych z rozszerzeniem niestandardowego skryptu maszyny wirtualnej platformy Azure nie ma zastosowania do serwerów z obsługą usługi Azure Arc. Zobacz listę obsługiwanych systemów operacyjnych dla serwerów z obsługą usługi Azure Arc.
Szczegóły konfiguracji dotyczące zestawów skalowania maszyn wirtualnych platformy Azure lub maszyn wirtualnych utworzonych za pomocą klasycznego modelu wdrażania nie mają zastosowania.
Jeśli maszyny muszą pobrać skrypt zewnętrznie i mogą komunikować się tylko za pośrednictwem serwera proxy, należy skonfigurować agenta połączonej maszyny, aby ustawić zmienną środowiskową serwera proxy.

Konfiguracja rozszerzenia niestandardowego skryptu określa elementy, takie jak lokalizacja skryptu i polecenie do uruchomienia. Ta konfiguracja jest określona w następujących szablonach.

Plik szablonu dla systemu 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')]"
        }
      }
    }
  ]
}

Plik szablonu dla systemu 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'))]"
                }
            }
        }
    ]
}

Plik parametrów

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

Wdrażanie rozszerzenia agenta zależności

Aby użyć rozszerzenia agenta zależności usługi Azure Monitor, uruchom jedną z następujących przykładów dla systemów Linux i Windows. Jeśli nie znasz agenta zależności, zobacz Omówienie agentów usługi Azure Monitor.

Plik szablonu dla systemu 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": {
  }
}

Plik szablonu dla systemu 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": {
  }
}

Wdrażanie na podstawie szablonu

Zapisz plik szablonu na dysku. Następnie można wdrożyć rozszerzenie na połączonej maszynie przy użyciu następującego polecenia:

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

Wdrażanie rozszerzenia maszyny wirtualnej usługi Azure Key Vault (wersja zapoznawcza)

Poniższy kod JSON przedstawia schemat rozszerzenia maszyny wirtualnej usługi Key Vault (wersja zapoznawcza). Rozszerzenie nie wymaga ustawień chronionych, ponieważ wszystkie jego ustawienia są uznawane za informacje publiczne. Rozszerzenie wymaga listy monitorowanych certyfikatów, częstotliwości sondowania i docelowego magazynu certyfikatów.

Plik szablonu dla systemu 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"
        }
      }
    }
  }
 ]
}

Plik szablonu dla systemu 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"
        }
      }
    }
  }
 ]
}

Uwaga

Obserwowane adresy URL certyfikatów powinny mieć postać https://myVaultName.vault.azure.net/secrets/myCertName. Przyczyną /secrets jest to, że ścieżka zwraca pełny certyfikat, w tym klucz prywatny, podczas gdy /certificates ścieżka nie. Więcej informacji na temat certyfikatów można znaleźć w temacie Omówienie kluczy, wpisów tajnych i certyfikatów usługi Azure Key Vault.

Wdrażanie na podstawie szablonu

Zapisz plik szablonu na dysku. Następnie można wdrożyć rozszerzenie na połączonej maszynie przy użyciu następującego polecenia.

Uwaga

Rozszerzenie maszyny wirtualnej wymaga przypisania tożsamości przypisanej przez system do uwierzytelniania w usłudze Key Vault. Zobacz Uwierzytelnianie w odniesieniu do zasobów platformy Azure przy użyciu serwerów z obsługą usługi Azure Arc dla serwerów z systemem Linux i Windows Azure Arc.

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

Rozszerzenia maszyn wirtualnych można wdrażać, zarządzać nimi i usuwać za pomocą programu Azure PowerShell, witryny Azure Portal lub interfejsu wiersza polecenia platformy Azure.
Informacje dotyczące rozwiązywania problemów można znaleźć w przewodniku rozwiązywania problemów z rozszerzeniami maszyn wirtualnych.

Udostępnij za pośrednictwem

Włączanie rozszerzeń maszyn wirtualnych platformy Azure przy użyciu szablonu usługi ARM

Wdrażanie rozszerzenia maszyny wirtualnej usługi Log Analytics

Plik szablonu dla systemu Linux

Plik szablonu dla systemu Windows

Plik parametrów

Wdrażanie rozszerzenia niestandardowego skryptu

Plik szablonu dla systemu Linux

Plik szablonu dla systemu Windows

Plik parametrów

Wdrażanie rozszerzenia agenta zależności

Plik szablonu dla systemu Linux

Plik szablonu dla systemu Windows

Wdrażanie na podstawie szablonu

Wdrażanie rozszerzenia maszyny wirtualnej usługi Azure Key Vault (wersja zapoznawcza)

Plik szablonu dla systemu Linux

Plik szablonu dla systemu Windows

Wdrażanie na podstawie szablonu

Opinia

Dodatkowe zasoby

Udostępnij za pośrednictwem

Włączanie rozszerzeń maszyn wirtualnych platformy Azure przy użyciu szablonu usługi ARM

Wdrażanie rozszerzenia maszyny wirtualnej usługi Log Analytics

Plik szablonu dla systemu Linux

Plik szablonu dla systemu Windows

Plik parametrów

Wdrażanie rozszerzenia niestandardowego skryptu

Plik szablonu dla systemu Linux

Plik szablonu dla systemu Windows

Plik parametrów

Wdrażanie rozszerzenia agenta zależności

Plik szablonu dla systemu Linux

Plik szablonu dla systemu Windows

Wdrażanie na podstawie szablonu

Wdrażanie rozszerzenia maszyny wirtualnej usługi Azure Key Vault (wersja zapoznawcza)

Plik szablonu dla systemu Linux

Plik szablonu dla systemu Windows

Wdrażanie na podstawie szablonu

Powiązana zawartość

Opinia

Dodatkowe zasoby