Microsoft.Compute virtualMachines/extensions

[アーティクル]
08/17/2024

Bicep リソース定義

virtualMachines/extensions リソースの種類は、次を対象とする操作と共にデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Compute/virtualMachines/extensions リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2024-07-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    instanceView: {
      name: 'string'
      statuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      substatuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      type: 'string'
      typeHandlerVersion: 'string'
    }
    protectedSettings: any()
    protectedSettingsFromKeyVault: {
      secretUrl: 'string'
      sourceVault: {
        id: 'string'
      }
    }
    provisionAfterExtensions: [
      'string'
    ]
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

プロパティ値

virtualMachines/extensions

名前	形容	価値
名前	リソース名 Bicepで子リソースの名前と種類設定する方法を参照してください。	string (必須)
場所	リソースの場所	糸
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
親	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部子リソース」を参照してください。	種類のリソースのシンボリック名: virtualMachines
プロパティ	仮想マシン拡張機能のプロパティについて説明します。	VirtualMachineExtensionProperties の

VirtualMachineExtensionProperties

名前	形容	価値
autoUpgradeMinorVersion	展開時に使用可能な場合に、拡張機能で新しいマイナーバージョンを使用する必要があるかどうかを示します。ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナーバージョンをアップグレードしません。	bool
enableAutomaticUpgrade	使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。	bool
forceUpdateTag	拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。	糸
instanceView	仮想マシン拡張機能インスタンスビュー。	VirtualMachineExtensionInstanceView
protectedSettings	拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。	Bicep の場合は、any() 関数を使用できます。
protectedSettingsFromKeyVault	参照によって渡され、キーコンテナーから使用される、拡張機能で保護された設定	KeyVaultSecretReference
provisionAfterExtensions	この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。	string[]
発行者	拡張ハンドラーの発行元の名前。	糸
設定	拡張機能の Json 形式のパブリック設定。	Bicep の場合は、any() 関数を使用できます。
suppressFailures	拡張機能に起因するエラーを抑制するかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。既定値は false です。	bool
種類	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。	糸
typeHandlerVersion	スクリプトハンドラーのバージョンを指定します。	糸

VirtualMachineExtensionInstanceView

名前	形容	価値
名前	仮想マシン拡張機能の名前。	糸
ステータス	リソースの状態情報。	InstanceViewStatus[]
substatuses	リソースの状態情報。	InstanceViewStatus[]
種類	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。	糸
typeHandlerVersion	スクリプトハンドラーのバージョンを指定します。	糸

InstanceViewStatus

名前	形容	価値
コード	状態コード。	糸
displayStatus	状態の短いローカライズ可能なラベル。	糸
レベル	レベルコード。	'Error' 'Info' 'Warning'
メッセージ	アラートやエラーメッセージを含む詳細なステータスメッセージ。	糸
時間	状態の時刻。	糸

KeyVaultSecretReference

名前	形容	価値
secretUrl	Key Vault 内のシークレットを参照する URL。	string (必須)
sourceVault	シークレットを含む Key Vault の相対 URL。	SubResource (必須)

SubResource

名前	形容	価値
身分証明書	リソース ID	糸

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
マルウェア対策拡張機能を有効にした Windows VM を作成 Azure にデプロイする	このテンプレートは、Windows VM を作成し、マルウェア対策保護を設定します
Windows VM で DSC 拡張機能を使用して IIS サーバーをする Azure にデプロイする	このテンプレートでは、Windows VM を作成し、DSC 拡張機能を使用して IIS サーバーを設定します。 Azure Storage を使用している場合は、DSC 構成モジュールに SAS トークンを渡す必要があることに注意してください。 GitHub からの DSC モジュールリンク (このテンプレートでは既定) の場合、これは必要ありません。
ESET VM 拡張機能の Azure にデプロイする	ESET 拡張機能を使用して VM を作成します
Windows VM で McAfee Endpoint Security (試用版ライセンス) をする Azure にデプロイする	このテンプレートでは、Windows VM を作成し、McAfee Endpoint Security の試用版を設定します
OMS 拡張機能を使用して Ubuntu VM をデプロイ Azure にデプロイする	このテンプレートを使用すると、OMS 拡張機能がインストールされ、指定されたワークスペースにオンボードされた Ubuntu VM をデプロイできます。
OMS 拡張機能を使用して Windows VM をデプロイ Azure にデプロイする	このテンプレートを使用すると、OMS 拡張機能がインストールされ、指定されたワークスペースにオンボードされた Windows VM をデプロイできます。
Windows VM での Symantec Endpoint Protection 拡張機能試用版の Azure にデプロイする	このテンプレートでは、Windows VM を作成し、Symantec Endpoint Protection の試用版を設定します
Ubuntu VM でカスタムスクリプト拡張機能をする Azure にデプロイする	このテンプレートでは、Ubuntu VM が作成され、CustomScript 拡張機能がインストールされます
Ubuntu VM での OS 修正プログラムの適用拡張機能の Azure にデプロイする	このテンプレートは、Ubuntu VM を作成し、OSPatching 拡張機能をインストールします
診断を使用して Premium Windows VM をデプロイする Azure にデプロイする	このテンプレートを使用すると、最新の修正プログラムが適用されたバージョンを使用して、Windows バージョンに対していくつかの異なるオプションを使用して Premium Windows VM をデプロイできます。
監視と診断を使用して単純な Windows VM をデプロイする Azure にデプロイする	このテンプレートを使用すると、VM の監視と診断を可能にする診断拡張機能と共に単純な Windows VM をデプロイできます。
スクリプト拡張機能を使用して、Ubuntu VM に Mongo DB をインストールする Azure にデプロイする	このテンプレートでは、2 つの個別のスクリプトで Mongo DB を構成して Ubuntu 仮想マシンにインストールします。このテンプレートは、同じ仮想マシンで実行されている 2 つのスクリプト間の依存関係を表現する方法を示す良い例です。このテンプレートでは、ストレージアカウント、仮想ネットワーク、パブリック IP アドレス、ネットワークインターフェイスもデプロイされます。

ARM テンプレートリソース定義

virtualMachines/extensions リソースの種類は、次を対象とする操作と共にデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Compute/virtualMachines/extensions リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2024-07-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "instanceView": {
      "name": "string",
      "statuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "substatuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "type": "string",
      "typeHandlerVersion": "string"
    },
    "protectedSettings": {},
    "protectedSettingsFromKeyVault": {
      "secretUrl": "string",
      "sourceVault": {
        "id": "string"
      }
    },
    "provisionAfterExtensions": [ "string" ],
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

プロパティ値

virtualMachines/extensions

名前	形容	価値
種類	リソースの種類	'Microsoft.Compute/virtualMachines/extensions'
apiVersion	リソース API のバージョン	'2024-07-01'
名前	リソース名 JSON ARM テンプレートで子リソースの名前と型設定する方法を参照してください。	string (必須)
場所	リソースの場所	糸
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
プロパティ	仮想マシン拡張機能のプロパティについて説明します。	VirtualMachineExtensionProperties の

VirtualMachineExtensionProperties

名前	形容	価値
autoUpgradeMinorVersion	展開時に使用可能な場合に、拡張機能で新しいマイナーバージョンを使用する必要があるかどうかを示します。ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナーバージョンをアップグレードしません。	bool
enableAutomaticUpgrade	使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。	bool
forceUpdateTag	拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。	糸
instanceView	仮想マシン拡張機能インスタンスビュー。	VirtualMachineExtensionInstanceView
protectedSettings	拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。
protectedSettingsFromKeyVault	参照によって渡され、キーコンテナーから使用される、拡張機能で保護された設定	KeyVaultSecretReference
provisionAfterExtensions	この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。	string[]
発行者	拡張ハンドラーの発行元の名前。	糸
設定	拡張機能の Json 形式のパブリック設定。
suppressFailures	拡張機能に起因するエラーを抑制するかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。既定値は false です。	bool
種類	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。	糸
typeHandlerVersion	スクリプトハンドラーのバージョンを指定します。	糸

VirtualMachineExtensionInstanceView

名前	形容	価値
名前	仮想マシン拡張機能の名前。	糸
ステータス	リソースの状態情報。	InstanceViewStatus[]
substatuses	リソースの状態情報。	InstanceViewStatus[]
種類	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。	糸
typeHandlerVersion	スクリプトハンドラーのバージョンを指定します。	糸

InstanceViewStatus

名前	形容	価値
コード	状態コード。	糸
displayStatus	状態の短いローカライズ可能なラベル。	糸
レベル	レベルコード。	'Error' 'Info' 'Warning'
メッセージ	アラートやエラーメッセージを含む詳細なステータスメッセージ。	糸
時間	状態の時刻。	糸

KeyVaultSecretReference

名前	形容	価値
secretUrl	Key Vault 内のシークレットを参照する URL。	string (必須)
sourceVault	シークレットを含む Key Vault の相対 URL。	SubResource (必須)

SubResource

名前	形容	価値
身分証明書	リソース ID	糸

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
マルウェア対策拡張機能を有効にした Windows VM を作成 Azure にデプロイする	このテンプレートは、Windows VM を作成し、マルウェア対策保護を設定します
Windows VM で DSC 拡張機能を使用して IIS サーバーをする Azure にデプロイする	このテンプレートでは、Windows VM を作成し、DSC 拡張機能を使用して IIS サーバーを設定します。 Azure Storage を使用している場合は、DSC 構成モジュールに SAS トークンを渡す必要があることに注意してください。 GitHub からの DSC モジュールリンク (このテンプレートでは既定) の場合、これは必要ありません。
ESET VM 拡張機能の Azure にデプロイする	ESET 拡張機能を使用して VM を作成します
Windows VM で McAfee Endpoint Security (試用版ライセンス) をする Azure にデプロイする	このテンプレートでは、Windows VM を作成し、McAfee Endpoint Security の試用版を設定します
OMS 拡張機能を使用して Ubuntu VM をデプロイ Azure にデプロイする	このテンプレートを使用すると、OMS 拡張機能がインストールされ、指定されたワークスペースにオンボードされた Ubuntu VM をデプロイできます。
OMS 拡張機能を使用して Windows VM をデプロイ Azure にデプロイする	このテンプレートを使用すると、OMS 拡張機能がインストールされ、指定されたワークスペースにオンボードされた Windows VM をデプロイできます。
Windows VM での Symantec Endpoint Protection 拡張機能試用版の Azure にデプロイする	このテンプレートでは、Windows VM を作成し、Symantec Endpoint Protection の試用版を設定します
Ubuntu VM でカスタムスクリプト拡張機能をする Azure にデプロイする	このテンプレートでは、Ubuntu VM が作成され、CustomScript 拡張機能がインストールされます
Ubuntu VM での OS 修正プログラムの適用拡張機能の Azure にデプロイする	このテンプレートは、Ubuntu VM を作成し、OSPatching 拡張機能をインストールします
診断を使用して Premium Windows VM をデプロイする Azure にデプロイする	このテンプレートを使用すると、最新の修正プログラムが適用されたバージョンを使用して、Windows バージョンに対していくつかの異なるオプションを使用して Premium Windows VM をデプロイできます。
監視と診断を使用して単純な Windows VM をデプロイする Azure にデプロイする	このテンプレートを使用すると、VM の監視と診断を可能にする診断拡張機能と共に単純な Windows VM をデプロイできます。
スクリプト拡張機能を使用して、Ubuntu VM に Mongo DB をインストールする Azure にデプロイする	このテンプレートでは、2 つの個別のスクリプトで Mongo DB を構成して Ubuntu 仮想マシンにインストールします。このテンプレートは、同じ仮想マシンで実行されている 2 つのスクリプト間の依存関係を表現する方法を示す良い例です。このテンプレートでは、ストレージアカウント、仮想ネットワーク、パブリック IP アドレス、ネットワークインターフェイスもデプロイされます。

Terraform (AzAPI プロバイダー) リソース定義

virtualMachines/extensions リソースの種類は、次を対象とする操作と共にデプロイできます。

リソースグループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Compute/virtualMachines/extensions リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/extensions@2024-07-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      instanceView = {
        name = "string"
        statuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        substatuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        type = "string"
        typeHandlerVersion = "string"
      }
      protectedSettingsFromKeyVault = {
        secretUrl = "string"
        sourceVault = {
          id = "string"
        }
      }
      provisionAfterExtensions = [
        "string"
      ]
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

プロパティ値

virtualMachines/extensions

名前	形容	価値
種類	リソースの種類	"Microsoft.Compute/virtualMachines/extensions@2024-07-01"
名前	リソース名	string (必須)
場所	リソースの場所	糸
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: virtualMachines
タグ	リソースタグ	タグ名と値のディクショナリ。
プロパティ	仮想マシン拡張機能のプロパティについて説明します。	VirtualMachineExtensionProperties の

VirtualMachineExtensionProperties

名前	形容	価値
autoUpgradeMinorVersion	展開時に使用可能な場合に、拡張機能で新しいマイナーバージョンを使用する必要があるかどうかを示します。ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナーバージョンをアップグレードしません。	bool
enableAutomaticUpgrade	使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。	bool
forceUpdateTag	拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。	糸
instanceView	仮想マシン拡張機能インスタンスビュー。	VirtualMachineExtensionInstanceView
protectedSettings	拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。
protectedSettingsFromKeyVault	参照によって渡され、キーコンテナーから使用される、拡張機能で保護された設定	KeyVaultSecretReference
provisionAfterExtensions	この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。	string[]
発行者	拡張ハンドラーの発行元の名前。	糸
設定	拡張機能の Json 形式のパブリック設定。
suppressFailures	拡張機能に起因するエラーを抑制するかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。既定値は false です。	bool
種類	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。	糸
typeHandlerVersion	スクリプトハンドラーのバージョンを指定します。	糸

VirtualMachineExtensionInstanceView

名前	形容	価値
名前	仮想マシン拡張機能の名前。	糸
ステータス	リソースの状態情報。	InstanceViewStatus[]
substatuses	リソースの状態情報。	InstanceViewStatus[]
種類	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。	糸
typeHandlerVersion	スクリプトハンドラーのバージョンを指定します。	糸

InstanceViewStatus

名前	形容	価値
コード	状態コード。	糸
displayStatus	状態の短いローカライズ可能なラベル。	糸
レベル	レベルコード。	"Error" "Info" "警告"
メッセージ	アラートやエラーメッセージを含む詳細なステータスメッセージ。	糸
時間	状態の時刻。	糸

KeyVaultSecretReference

名前	形容	価値
secretUrl	Key Vault 内のシークレットを参照する URL。	string (必須)
sourceVault	シークレットを含む Key Vault の相対 URL。	SubResource (必須)

SubResource

名前	形容	価値
身分証明書	リソース ID	糸

次の方法で共有

Microsoft.Compute virtualMachines/extensions

Bicep リソース定義

リソースの形式

プロパティ値

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

クイックスタートテンプレート

ARM テンプレートリソース定義

リソースの形式

プロパティ値

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

クイックスタートテンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソースの形式

プロパティ値

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

フィードバック

その他のリソース

次の方法で共有

Microsoft.Compute virtualMachines/extensions

Bicep リソース定義

リソースの形式

プロパティ値

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

クイック スタート テンプレート

ARM テンプレート リソース定義

リソースの形式

プロパティ値

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

クイック スタート テンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソースの形式

プロパティ値

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

フィードバック

その他のリソース

クイックスタートテンプレート

ARM テンプレートリソース定義

クイックスタートテンプレート