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

Bicep-resursdefinition

Resurstypen virtualMachines/extensions kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Compute/virtualMachines/extensions-resurs lägger du till följande Bicep i mallen.

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'
  }
}

Egenskapsvärden

virtualMachines/extensions

Namn	Beskrivning	Värde
Namn	Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep.	sträng (krävs)
plats	Resursplats	sträng
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
förälder	I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen.	Symboliskt namn för resurs av typen: virtualMachines
Egenskaper	Beskriver egenskaperna för ett tillägg för virtuell dator.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Namn	Beskrivning	Värde
autoUpgradeMinorVersion	Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true.	Bool
enableAutomaticUpgrade	Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version av tillägget tillgängligt.	Bool
forceUpdateTag	Hur tilläggshanteraren ska tvingas uppdatera även om tilläggskonfigurationen inte har ändrats.	sträng
instanceView	Instansvyn för tillägget för virtuella datorer.	VirtualMachineExtensionInstanceView
protectedSettings	Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls.	För Bicep kan du använda funktionen any().
protectedSettingsFromKeyVault	Tilläggsskyddade inställningar som skickas av referens och som används från nyckelvalvet	KeyVaultSecretReference
provisionAfterExtensions	Samling tilläggsnamn varefter tillägget måste etableras.	string[]
förläggare	Namnet på tilläggshanterarens utgivare.	sträng
Inställningar	Json har formaterat offentliga inställningar för tillägget.	För Bicep kan du använda funktionen any().
suppressFailures	Anger om fel som härrör från tillägget kommer att ignoreras (Driftfel som att inte ansluta till den virtuella datorn ignoreras inte oavsett det här värdet). Standardvärdet är falskt.	Bool
typ	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".	sträng
typeHandlerVersion	Anger versionen av skripthanteraren.	sträng

VirtualMachineExtensionInstanceView

Namn	Beskrivning	Värde
Namn	Namnet på det virtuella datortillägget.	sträng
Status	Information om resursstatus.	InstanceViewStatus[]
understatusar	Information om resursstatus.	InstanceViewStatus[]
typ	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".	sträng
typeHandlerVersion	Anger versionen av skripthanteraren.	sträng

InstanceViewStatus

Namn	Beskrivning	Värde
kod	Statuskoden.	sträng
displayStatus	Den korta localizable-etiketten för statusen.	sträng
nivå	Nivåkoden.	"Fel" "Info" "Varning"
meddelande	Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.	sträng
Tid	Tidpunkten för statusen.	sträng

KeyVaultSecretReference

Namn	Beskrivning	Värde
secretUrl	URL:en som refererar till en hemlighet i ett Nyckelvalv.	sträng (krävs)
sourceVault	Den relativa URL:en för nyckelvalvet som innehåller hemligheten.	SubResource (krävs)

SubResource

Namn	Beskrivning	Värde
Id	Resurs-ID	sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
Skapa en virtuell Windows-dator med tillägget Skydd mot skadlig kod aktiverat	Den här mallen skapar en virtuell Windows-dator och konfigurerar skydd mot skadlig kod
IIS Server med DSC-tillägget på en virtuell Windows-dator	Den här mallen skapar en virtuell Windows-dator och konfigurerar en IIS-server med hjälp av DSC-tillägget. Observera att DSC-konfigurationsmodulen behöver en SAS-token för att skickas om du använder Azure Storage. För DSC-modullänk från GitHub (standard i den här mallen) behövs inte detta.
ESET VM-tillägg	Skapar en virtuell dator med ESET-tillägg
McAfee Endpoint Security (utvärderingslicens) på virtuella Windows-datorer	Den här mallen skapar en virtuell Windows-dator och konfigurerar en utvärderingsversion av McAfee Endpoint Security
Distribuera en virtuell Ubuntu-dator med OMS-tillägget	Med den här mallen kan du distribuera en virtuell Ubuntu-dator med OMS-tillägget installerat och registrerat på en angiven arbetsyta
Distribuera en virtuell Windows-dator med OMS-tillägget	Med den här mallen kan du distribuera en virtuell Windows-dator med OMS-tillägget installerat och registrerat på en angiven arbetsyta
utvärderingsversion av Symantec Endpoint Protection-tillägget på en virtuell Windows-dator	Den här mallen skapar en virtuell Windows-dator och konfigurerar en utvärderingsversion av Symantec Endpoint Protection
tillägg för anpassat skript på en virtuell Ubuntu-dator	Den här mallen skapar en virtuell Ubuntu-dator och installerar CustomScript-tillägget
OS-korrigeringstillägg på en virtuell Ubuntu-dator	Den här mallen skapar en virtuell Ubuntu-dator och installerar OSPatching-tillägget
Distribuera en virtuell Premium Windows-dator med diagnostik	Med den här mallen kan du distribuera en virtuell Premium Windows-dator med några olika alternativ för Windows-versionen med den senaste korrigerade versionen.
Distribuera en enkel virtuell Windows-dator med övervakning och diagnostik	Med den här mallen kan du distribuera en enkel virtuell Windows-dator tillsammans med diagnostiktillägget som möjliggör övervakning och diagnostik för den virtuella datorn
Använd skripttillägg för att installera Mongo DB på den virtuella Ubuntu-datorn	Den här mallen distribuerar Konfigurerar och installerar Mongo DB på en virtuell Ubuntu-dator i två separata skript. Den här mallen är ett bra exempel som visar hur du uttrycker beroenden mellan två skript som körs på samma virtuella dator. Den här mallen distribuerar även ett lagringskonto, ett virtuellt nätverk, offentliga IP-adresser och ett nätverksgränssnitt.

Resursdefinition för ARM-mall

Resurstypen virtualMachines/extensions kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Compute/virtualMachines/extensions-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

virtualMachines/extensions

Namn	Beskrivning	Värde
typ	Resurstypen	"Microsoft.Compute/virtualMachines/extensions"
apiVersion	Resurs-API-versionen	'2024-07-01'
Namn	Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.	sträng (krävs)
plats	Resursplats	sträng
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
Egenskaper	Beskriver egenskaperna för ett tillägg för virtuell dator.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Namn	Beskrivning	Värde
autoUpgradeMinorVersion	Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true.	Bool
enableAutomaticUpgrade	Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version av tillägget tillgängligt.	Bool
forceUpdateTag	Hur tilläggshanteraren ska tvingas uppdatera även om tilläggskonfigurationen inte har ändrats.	sträng
instanceView	Instansvyn för tillägget för virtuella datorer.	VirtualMachineExtensionInstanceView
protectedSettings	Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls.
protectedSettingsFromKeyVault	Tilläggsskyddade inställningar som skickas av referens och som används från nyckelvalvet	KeyVaultSecretReference
provisionAfterExtensions	Samling tilläggsnamn varefter tillägget måste etableras.	string[]
förläggare	Namnet på tilläggshanterarens utgivare.	sträng
Inställningar	Json har formaterat offentliga inställningar för tillägget.
suppressFailures	Anger om fel som härrör från tillägget kommer att ignoreras (Driftfel som att inte ansluta till den virtuella datorn ignoreras inte oavsett det här värdet). Standardvärdet är falskt.	Bool
typ	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".	sträng
typeHandlerVersion	Anger versionen av skripthanteraren.	sträng

VirtualMachineExtensionInstanceView

Namn	Beskrivning	Värde
Namn	Namnet på det virtuella datortillägget.	sträng
Status	Information om resursstatus.	InstanceViewStatus[]
understatusar	Information om resursstatus.	InstanceViewStatus[]
typ	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".	sträng
typeHandlerVersion	Anger versionen av skripthanteraren.	sträng

InstanceViewStatus

Namn	Beskrivning	Värde
kod	Statuskoden.	sträng
displayStatus	Den korta localizable-etiketten för statusen.	sträng
nivå	Nivåkoden.	"Fel" "Info" "Varning"
meddelande	Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.	sträng
Tid	Tidpunkten för statusen.	sträng

KeyVaultSecretReference

Namn	Beskrivning	Värde
secretUrl	URL:en som refererar till en hemlighet i ett Nyckelvalv.	sträng (krävs)
sourceVault	Den relativa URL:en för nyckelvalvet som innehåller hemligheten.	SubResource (krävs)

SubResource

Namn	Beskrivning	Värde
Id	Resurs-ID	sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
Skapa en virtuell Windows-dator med tillägget Skydd mot skadlig kod aktiverat	Den här mallen skapar en virtuell Windows-dator och konfigurerar skydd mot skadlig kod
IIS Server med DSC-tillägget på en virtuell Windows-dator	Den här mallen skapar en virtuell Windows-dator och konfigurerar en IIS-server med hjälp av DSC-tillägget. Observera att DSC-konfigurationsmodulen behöver en SAS-token för att skickas om du använder Azure Storage. För DSC-modullänk från GitHub (standard i den här mallen) behövs inte detta.
ESET VM-tillägg	Skapar en virtuell dator med ESET-tillägg
McAfee Endpoint Security (utvärderingslicens) på virtuella Windows-datorer	Den här mallen skapar en virtuell Windows-dator och konfigurerar en utvärderingsversion av McAfee Endpoint Security
Distribuera en virtuell Ubuntu-dator med OMS-tillägget	Med den här mallen kan du distribuera en virtuell Ubuntu-dator med OMS-tillägget installerat och registrerat på en angiven arbetsyta
Distribuera en virtuell Windows-dator med OMS-tillägget	Med den här mallen kan du distribuera en virtuell Windows-dator med OMS-tillägget installerat och registrerat på en angiven arbetsyta
utvärderingsversion av Symantec Endpoint Protection-tillägget på en virtuell Windows-dator	Den här mallen skapar en virtuell Windows-dator och konfigurerar en utvärderingsversion av Symantec Endpoint Protection
tillägg för anpassat skript på en virtuell Ubuntu-dator	Den här mallen skapar en virtuell Ubuntu-dator och installerar CustomScript-tillägget
OS-korrigeringstillägg på en virtuell Ubuntu-dator	Den här mallen skapar en virtuell Ubuntu-dator och installerar OSPatching-tillägget
Distribuera en virtuell Premium Windows-dator med diagnostik	Med den här mallen kan du distribuera en virtuell Premium Windows-dator med några olika alternativ för Windows-versionen med den senaste korrigerade versionen.
Distribuera en enkel virtuell Windows-dator med övervakning och diagnostik	Med den här mallen kan du distribuera en enkel virtuell Windows-dator tillsammans med diagnostiktillägget som möjliggör övervakning och diagnostik för den virtuella datorn
Använd skripttillägg för att installera Mongo DB på den virtuella Ubuntu-datorn	Den här mallen distribuerar Konfigurerar och installerar Mongo DB på en virtuell Ubuntu-dator i två separata skript. Den här mallen är ett bra exempel som visar hur du uttrycker beroenden mellan två skript som körs på samma virtuella dator. Den här mallen distribuerar även ett lagringskonto, ett virtuellt nätverk, offentliga IP-adresser och ett nätverksgränssnitt.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen virtualMachines/extensions kan distribueras med åtgärder som mål:

Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Compute/virtualMachines/extensions-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

virtualMachines/extensions

Namn	Beskrivning	Värde
typ	Resurstypen	"Microsoft.Compute/virtualMachines/extensions@2024-07-01"
Namn	Resursnamnet	sträng (krävs)
plats	Resursplats	sträng
parent_id	ID för resursen som är överordnad för den här resursen.	ID för resurs av typen: virtualMachines
Taggar	Resurstaggar	Ordlista med taggnamn och värden.
Egenskaper	Beskriver egenskaperna för ett tillägg för virtuell dator.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Namn	Beskrivning	Värde
autoUpgradeMinorVersion	Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true.	Bool
enableAutomaticUpgrade	Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version av tillägget tillgängligt.	Bool
forceUpdateTag	Hur tilläggshanteraren ska tvingas uppdatera även om tilläggskonfigurationen inte har ändrats.	sträng
instanceView	Instansvyn för tillägget för virtuella datorer.	VirtualMachineExtensionInstanceView
protectedSettings	Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls.
protectedSettingsFromKeyVault	Tilläggsskyddade inställningar som skickas av referens och som används från nyckelvalvet	KeyVaultSecretReference
provisionAfterExtensions	Samling tilläggsnamn varefter tillägget måste etableras.	string[]
förläggare	Namnet på tilläggshanterarens utgivare.	sträng
Inställningar	Json har formaterat offentliga inställningar för tillägget.
suppressFailures	Anger om fel som härrör från tillägget kommer att ignoreras (Driftfel som att inte ansluta till den virtuella datorn ignoreras inte oavsett det här värdet). Standardvärdet är falskt.	Bool
typ	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".	sträng
typeHandlerVersion	Anger versionen av skripthanteraren.	sträng

VirtualMachineExtensionInstanceView

Namn	Beskrivning	Värde
Namn	Namnet på det virtuella datortillägget.	sträng
Status	Information om resursstatus.	InstanceViewStatus[]
understatusar	Information om resursstatus.	InstanceViewStatus[]
typ	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".	sträng
typeHandlerVersion	Anger versionen av skripthanteraren.	sträng

InstanceViewStatus

Namn	Beskrivning	Värde
kod	Statuskoden.	sträng
displayStatus	Den korta localizable-etiketten för statusen.	sträng
nivå	Nivåkoden.	"Fel" "Info" "Varning"
meddelande	Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.	sträng
Tid	Tidpunkten för statusen.	sträng

KeyVaultSecretReference

Namn	Beskrivning	Värde
secretUrl	URL:en som refererar till en hemlighet i ett Nyckelvalv.	sträng (krävs)
sourceVault	Den relativa URL:en för nyckelvalvet som innehåller hemligheten.	SubResource (krävs)

SubResource

Namn	Beskrivning	Värde
Id	Resurs-ID	sträng

Dela via

Microsoft.Compute virtualMachines/extensions

Bicep-resursdefinition

Resursformat

Egenskapsvärden

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

Snabbstartsmallar

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

Snabbstartsmallar

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

Feedback

Ytterligare resurser