Microsoft.Compute/virtualMachines/extensions 2021-07-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep-Ressourcendefinition

Der Ressourcentyp "virtualMachines/extensions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/virtualMachines/Extensions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2021-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()
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

Eigenschaftswerte

virtualMachines/Extensions

Name	Beschreibung	Wert
Name	Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep-festlegen.	Zeichenfolge (erforderlich)
Ort	Ressourcenspeicherort	Zeichenfolge (erforderlich)
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Elternteil	In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.	Symbolischer Name für Ressource des Typs: virtualMachines
Eigenschaften	Beschreibt die Eigenschaften einer Erweiterung des virtuellen Computers.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Name	Beschreibung	Wert
autoUpgradeMinorVersion	Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Nach der Bereitstellung aktualisiert die Erweiterung jedoch keine Nebenversionen, es sei denn, sie werden erneut bereitgestellt, auch wenn diese Eigenschaft auf "true" festgelegt ist.	Bool
enableAutomaticUpgrade	Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.	Bool
forceUpdateTag	Wie der Erweiterungshandler aktualisiert werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.	Schnur
instanceView	Die Erweiterungsinstanzansicht des virtuellen Computers.	VirtualMachineExtensionInstanceView
protectedSettings	Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten.	Für Bicep können Sie die any()-Funktion verwenden.
Verlag	Der Name des Herausgebers des Erweiterungshandlers.	Schnur
Einstellungen	Json formatierte öffentliche Einstellungen für die Erweiterung.	Für Bicep können Sie die any()-Funktion verwenden.
suppressFailures	Gibt an, ob Fehler, die aus der Erweiterung stammen, unterdrückt werden (Betriebsfehler, z. B. keine Verbindung mit dem virtuellen Computer, werden unabhängig von diesem Wert nicht unterdrückt). Der Standardwert ist "false".	Bool
Art	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".	Schnur
typeHandlerVersion	Gibt die Version des Skripthandlers an.	Schnur

VirtualMachineExtensionInstanceView

Name	Beschreibung	Wert
Name	Der Erweiterungsname des virtuellen Computers.	Schnur
Status	Die Ressourcenstatusinformationen.	InstanceViewStatus-[]
Unterstatus	Die Ressourcenstatusinformationen.	InstanceViewStatus-[]
Art	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".	Schnur
typeHandlerVersion	Gibt die Version des Skripthandlers an.	Schnur

InstanceViewStatus

Name	Beschreibung	Wert
Code	Der Statuscode.	Schnur
displayStatus	Die kurze lokalisierbare Bezeichnung für den Status.	Schnur
Niveau	Der Ebenencode.	'Fehler' 'Info' "Warnung"
Nachricht	Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.	Schnur
Zeit	Die Uhrzeit des Status.	Schnur

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Erstellen einer Windows-VM mit aktivierter Anti-Malware-Erweiterung	Diese Vorlage erstellt einen virtuellen Windows-Computer und richtet den Schutz vor Schadsoftware ein.
IIS Server unter Verwendung der DSC-Erweiterung auf einem Windows-VM-	Diese Vorlage erstellt eine Windows-VM und richtet einen IIS-Server mithilfe der DSC-Erweiterung ein. Beachten Sie, dass das DSC-Konfigurationsmodul ein SAS-Token benötigt, das übergeben werden muss, wenn Sie Azure Storage verwenden. Für den DSC-Modullink von GitHub (Standard in dieser Vorlage) ist dies nicht erforderlich.
ESET-VM-Erweiterung	Erstellt einen virtuellen Computer mit DER ESET-Erweiterung
McAfee Endpoint Security (Testlizenz) auf Windows VM	Diese Vorlage erstellt eine Windows-VM und richtet eine Testversion von McAfee Endpoint Security ein.
Bereitstellen einer Ubuntu-VM mit der OMS-Erweiterung	Mit dieser Vorlage können Sie eine Ubuntu-VM bereitstellen, auf der die OMS-Erweiterung installiert und in einen angegebenen Arbeitsbereich integriert ist.
Bereitstellen einer Windows-VM mit der OMS-Erweiterung	Mit dieser Vorlage können Sie eine Windows-VM bereitstellen, auf der die OMS-Erweiterung installiert und in einen bestimmten Arbeitsbereich integriert ist.
Testversion der Symantec Endpoint Protection-Erweiterung auf Windows VM	Diese Vorlage erstellt eine Windows-VM und richtet eine Testversion von Symantec Endpoint Protection ein.
Benutzerdefinierte Skripterweiterung auf einer Ubuntu-VM-	Diese Vorlage erstellt eine Ubuntu-VM und installiert die CustomScript-Erweiterung.
Betriebssystempatching-Erweiterung auf einem Ubuntu-VM-	Diese Vorlage erstellt eine Ubuntu-VM und installiert die OSPatching-Erweiterung.
Bereitstellen einer Premium-Windows-VM mit Diagnose	Mit dieser Vorlage können Sie eine Premium-Windows-VM mit einigen verschiedenen Optionen für die Windows-Version mithilfe der neuesten gepatchten Version bereitstellen.
Bereitstellen einer einfachen Windows-VM mit Überwachung und Diagnose	Mit dieser Vorlage können Sie eine einfache Windows-VM zusammen mit der Diagnoseerweiterung bereitstellen, die die Überwachung und Diagnose für den virtuellen Computer ermöglicht.
Verwenden von Skripterweiterungen zum Installieren von Mongo DB auf Ubuntu VM	Diese Vorlage stellt "Configures and Installs Mongo DB" auf einem virtuellen Ubuntu-Computer in zwei separaten Skripts bereit. Diese Vorlage ist ein gutes Beispiel, das zeigt, wie Abhängigkeiten zwischen zwei Skripts, die auf demselben virtuellen Computer ausgeführt werden, ausgedrückt werden. Diese Vorlage stellt außerdem ein Speicherkonto, ein virtuelles Netzwerk, öffentliche IP-Adressen und eine Netzwerkschnittstelle bereit.

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "virtualMachines/extensions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/virtualMachines/Extensions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2021-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": {},
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

Eigenschaftswerte

virtualMachines/Extensions

Name	Beschreibung	Wert
Art	Der Ressourcentyp	"Microsoft.Compute/virtualMachines/extensions"
apiVersion	Die Ressourcen-API-Version	'2021-07-01'
Name	Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON ARM-Vorlagenfestlegen.	Zeichenfolge (erforderlich)
Ort	Ressourcenspeicherort	Zeichenfolge (erforderlich)
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Eigenschaften	Beschreibt die Eigenschaften einer Erweiterung des virtuellen Computers.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Name	Beschreibung	Wert
autoUpgradeMinorVersion	Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Nach der Bereitstellung aktualisiert die Erweiterung jedoch keine Nebenversionen, es sei denn, sie werden erneut bereitgestellt, auch wenn diese Eigenschaft auf "true" festgelegt ist.	Bool
enableAutomaticUpgrade	Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.	Bool
forceUpdateTag	Wie der Erweiterungshandler aktualisiert werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.	Schnur
instanceView	Die Erweiterungsinstanzansicht des virtuellen Computers.	VirtualMachineExtensionInstanceView
protectedSettings	Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten.
Verlag	Der Name des Herausgebers des Erweiterungshandlers.	Schnur
Einstellungen	Json formatierte öffentliche Einstellungen für die Erweiterung.
suppressFailures	Gibt an, ob Fehler, die aus der Erweiterung stammen, unterdrückt werden (Betriebsfehler, z. B. keine Verbindung mit dem virtuellen Computer, werden unabhängig von diesem Wert nicht unterdrückt). Der Standardwert ist "false".	Bool
Art	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".	Schnur
typeHandlerVersion	Gibt die Version des Skripthandlers an.	Schnur

VirtualMachineExtensionInstanceView

Name	Beschreibung	Wert
Name	Der Erweiterungsname des virtuellen Computers.	Schnur
Status	Die Ressourcenstatusinformationen.	InstanceViewStatus-[]
Unterstatus	Die Ressourcenstatusinformationen.	InstanceViewStatus-[]
Art	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".	Schnur
typeHandlerVersion	Gibt die Version des Skripthandlers an.	Schnur

InstanceViewStatus

Name	Beschreibung	Wert
Code	Der Statuscode.	Schnur
displayStatus	Die kurze lokalisierbare Bezeichnung für den Status.	Schnur
Niveau	Der Ebenencode.	'Fehler' 'Info' "Warnung"
Nachricht	Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.	Schnur
Zeit	Die Uhrzeit des Status.	Schnur

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Erstellen einer Windows-VM mit aktivierter Anti-Malware-Erweiterung	Diese Vorlage erstellt einen virtuellen Windows-Computer und richtet den Schutz vor Schadsoftware ein.
IIS Server unter Verwendung der DSC-Erweiterung auf einem Windows-VM-	Diese Vorlage erstellt eine Windows-VM und richtet einen IIS-Server mithilfe der DSC-Erweiterung ein. Beachten Sie, dass das DSC-Konfigurationsmodul ein SAS-Token benötigt, das übergeben werden muss, wenn Sie Azure Storage verwenden. Für den DSC-Modullink von GitHub (Standard in dieser Vorlage) ist dies nicht erforderlich.
ESET-VM-Erweiterung	Erstellt einen virtuellen Computer mit DER ESET-Erweiterung
McAfee Endpoint Security (Testlizenz) auf Windows VM	Diese Vorlage erstellt eine Windows-VM und richtet eine Testversion von McAfee Endpoint Security ein.
Bereitstellen einer Ubuntu-VM mit der OMS-Erweiterung	Mit dieser Vorlage können Sie eine Ubuntu-VM bereitstellen, auf der die OMS-Erweiterung installiert und in einen angegebenen Arbeitsbereich integriert ist.
Bereitstellen einer Windows-VM mit der OMS-Erweiterung	Mit dieser Vorlage können Sie eine Windows-VM bereitstellen, auf der die OMS-Erweiterung installiert und in einen bestimmten Arbeitsbereich integriert ist.
Testversion der Symantec Endpoint Protection-Erweiterung auf Windows VM	Diese Vorlage erstellt eine Windows-VM und richtet eine Testversion von Symantec Endpoint Protection ein.
Benutzerdefinierte Skripterweiterung auf einer Ubuntu-VM-	Diese Vorlage erstellt eine Ubuntu-VM und installiert die CustomScript-Erweiterung.
Betriebssystempatching-Erweiterung auf einem Ubuntu-VM-	Diese Vorlage erstellt eine Ubuntu-VM und installiert die OSPatching-Erweiterung.
Bereitstellen einer Premium-Windows-VM mit Diagnose	Mit dieser Vorlage können Sie eine Premium-Windows-VM mit einigen verschiedenen Optionen für die Windows-Version mithilfe der neuesten gepatchten Version bereitstellen.
Bereitstellen einer einfachen Windows-VM mit Überwachung und Diagnose	Mit dieser Vorlage können Sie eine einfache Windows-VM zusammen mit der Diagnoseerweiterung bereitstellen, die die Überwachung und Diagnose für den virtuellen Computer ermöglicht.
Verwenden von Skripterweiterungen zum Installieren von Mongo DB auf Ubuntu VM	Diese Vorlage stellt "Configures and Installs Mongo DB" auf einem virtuellen Ubuntu-Computer in zwei separaten Skripts bereit. Diese Vorlage ist ein gutes Beispiel, das zeigt, wie Abhängigkeiten zwischen zwei Skripts, die auf demselben virtuellen Computer ausgeführt werden, ausgedrückt werden. Diese Vorlage stellt außerdem ein Speicherkonto, ein virtuelles Netzwerk, öffentliche IP-Adressen und eine Netzwerkschnittstelle bereit.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "virtualMachines/extensions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Ressource "Microsoft.Compute/virtualMachines/extensions" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/extensions@2021-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"
      }
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

Eigenschaftswerte

virtualMachines/Extensions

Name	Beschreibung	Wert
Art	Der Ressourcentyp	"Microsoft.Compute/virtualMachines/extensions@2021-07-01"
Name	Der Ressourcenname	Zeichenfolge (erforderlich)
Ort	Ressourcenspeicherort	Zeichenfolge (erforderlich)
parent_id	Die ID der Ressource, die das übergeordnete Element für diese Ressource ist.	ID für Ressource vom Typ: virtualMachines
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte.
Eigenschaften	Beschreibt die Eigenschaften einer Erweiterung des virtuellen Computers.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Name	Beschreibung	Wert
autoUpgradeMinorVersion	Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Nach der Bereitstellung aktualisiert die Erweiterung jedoch keine Nebenversionen, es sei denn, sie werden erneut bereitgestellt, auch wenn diese Eigenschaft auf "true" festgelegt ist.	Bool
enableAutomaticUpgrade	Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.	Bool
forceUpdateTag	Wie der Erweiterungshandler aktualisiert werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.	Schnur
instanceView	Die Erweiterungsinstanzansicht des virtuellen Computers.	VirtualMachineExtensionInstanceView
protectedSettings	Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten.
Verlag	Der Name des Herausgebers des Erweiterungshandlers.	Schnur
Einstellungen	Json formatierte öffentliche Einstellungen für die Erweiterung.
suppressFailures	Gibt an, ob Fehler, die aus der Erweiterung stammen, unterdrückt werden (Betriebsfehler, z. B. keine Verbindung mit dem virtuellen Computer, werden unabhängig von diesem Wert nicht unterdrückt). Der Standardwert ist "false".	Bool
Art	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".	Schnur
typeHandlerVersion	Gibt die Version des Skripthandlers an.	Schnur

VirtualMachineExtensionInstanceView

Name	Beschreibung	Wert
Name	Der Erweiterungsname des virtuellen Computers.	Schnur
Status	Die Ressourcenstatusinformationen.	InstanceViewStatus-[]
Unterstatus	Die Ressourcenstatusinformationen.	InstanceViewStatus-[]
Art	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".	Schnur
typeHandlerVersion	Gibt die Version des Skripthandlers an.	Schnur

InstanceViewStatus

Name	Beschreibung	Wert
Code	Der Statuscode.	Schnur
displayStatus	Die kurze lokalisierbare Bezeichnung für den Status.	Schnur
Niveau	Der Ebenencode.	"Fehler" "Info" "Warnung"
Nachricht	Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.	Schnur
Zeit	Die Uhrzeit des Status.	Schnur

Freigeben über

Microsoft.Compute virtualMachines/extensions 2021-07-01

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

virtualMachines/Extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

Schnellstartvorlagen

ARM-Vorlagenressourcendefinition

Ressourcenformat

Eigenschaftswerte

virtualMachines/Extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

Schnellstartvorlagen

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Ressourcenformat

Eigenschaftswerte

virtualMachines/Extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

Feedback

Zusätzliche Ressourcen