ARM テンプレートを使用して VM 拡張機能を有効にする

[アーティクル]
01/20/2025

この記事では、Azure Resource Manager テンプレート (ARM テンプレート) を使用して、Azure Arc 対応サーバーでサポートされている Azure の仮想マシン (VM) 拡張機能をデプロイする方法を示します。

ARM テンプレートに VM 拡張機能を追加して、そのテンプレートのデプロイと共に実行することができます。 Azure Arc 対応サーバーによってサポートされている VM 拡張機能の場合、その機能を Azure PowerShell を使用して Linux または Windows マシンにデプロイできます。以下に挙げた各サンプルには、テンプレートファイルと、そのテンプレートに指定するサンプル値を含むパラメーターファイルが含まれています。

Note

拡張機能では、複数をバッチして一括での処理が可能ですが、これらのはインストールは順次行います。最初の拡張機能がインストールされた後に、次の拡張機能のインストールを行います。

Azure Arc 対応サーバーでは、Azure 仮想マシンへの VM 拡張機能のデプロイと管理はサポートされていません。 Azure VM については、VM 拡張機能の概要に関する記事を参照してください。

Log Analytics VM 拡張機能をデプロイする

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 VM カスタムスクリプト拡張機能でサポートされているオペレーティングシステムの一覧は、Azure Arc 対応サーバーには適用されません。 Azure Arc 対応サーバーでサポートされているオペレーティングシステムの一覧でご確認ください。
Azure 仮想マシンスケールセット、またはクラシックデプロイモデルを使用して作成された VM に関する構成の詳細は適用されません。
ご使用のマシンで、スクリプトを外部からダウンロードする必要があり、通信できるのがプロキシサーバー経由のみである場合には、Connected Machine エージェントを構成してプロキシサーバーの環境変数を設定する必要があります。

カスタムスクリプト拡張機能の構成では、スクリプトの場所や、実行するコマンドなどを指定します。この構成は、次のテンプレート内で指定されます。

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

Dependency Agent 拡張機能をデプロイする

Azure Monitor Dependency Agent 拡張機能を使用するには、次の、Linux と Windows 用サンプルのいずれかを実行します。 Dependency Agent に詳しくない場合は、「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 VM 拡張機能 (プレビュー) をデプロイする

次の JSON は、Key Vault VM 拡張機能 (プレビュー) のスキーマを示しています。この拡張機能では、そのすべての設定がパブリック情報と見なされるため、保護された設定は必要ありません。この拡張機能には、監視対象の証明書、ポーリング頻度、および宛先の証明書ストアのリストが必要です。

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

Note

実際の証明書の URL は、https://myVaultName.vault.azure.net/secrets/myCertName の形式である必要があります。その理由は、/secrets パスは秘密キーを含む完全な証明書を返すのに対し、/certificates パスはそれを返さないためです。証明書の詳細な情報は、「Azure Key Vault のキー、シークレット、証明書の概要」でご確認になれます。

テンプレートのデプロイ

テンプレートファイルをディスクに保存します。これで、次のコマンドを使用して、接続されたコンピューターに拡張機能をデプロイできます。

Note

VM 拡張機能では、Key Vault に対する認証を行うために、システム割り当て ID が割り当てられている必要があります。 Linux および Windows 向けの Azure Arc 対応サーバーについては、「Azure Arc 対応サーバーを使用した Azure リソースに対する認証」を参照してください。

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

VM 拡張機能のデプロイ、管理、削除には、Azure PowerShell、Azure portal、または Azure CLI を使用できます。
トラブルシューティングの情報は、VM 拡張機能のトラブルシューティングに関するガイドでご確認ください。

次の方法で共有

ARM テンプレートを使用して VM 拡張機能を有効にする

Log Analytics VM 拡張機能をデプロイする

Linux 用テンプレートファイル

Windows 用テンプレートファイル

パラメーターファイル

カスタムスクリプト拡張機能をデプロイする

Linux 用テンプレートファイル

Windows 用テンプレートファイル

パラメーターファイル

Dependency Agent 拡張機能をデプロイする

Linux 用テンプレートファイル

Windows 用テンプレートファイル

テンプレートのデプロイ

Azure Key Vault VM 拡張機能 (プレビュー) をデプロイする

Linux 用テンプレートファイル

Windows 用テンプレートファイル

テンプレートのデプロイ

フィードバック

その他のリソース

次の方法で共有

ARM テンプレートを使用して VM 拡張機能を有効にする

Log Analytics VM 拡張機能をデプロイする

Linux 用テンプレート ファイル

Windows 用テンプレート ファイル

パラメーター ファイル

カスタム スクリプト拡張機能をデプロイする

Linux 用テンプレート ファイル

Windows 用テンプレート ファイル

パラメーター ファイル

Dependency Agent 拡張機能をデプロイする

Linux 用テンプレート ファイル

Windows 用テンプレート ファイル

テンプレートのデプロイ

Azure Key Vault VM 拡張機能 (プレビュー) をデプロイする

Linux 用テンプレート ファイル

Windows 用テンプレート ファイル

テンプレートのデプロイ

関連するコンテンツ

フィードバック

その他のリソース

Linux 用テンプレートファイル

Windows 用テンプレートファイル

パラメーターファイル

カスタムスクリプト拡張機能をデプロイする

Linux 用テンプレートファイル

Windows 用テンプレートファイル

パラメーターファイル

Linux 用テンプレートファイル

Windows 用テンプレートファイル

Linux 用テンプレートファイル

Windows 用テンプレートファイル