Sdílet prostřednictvím

Microsoft.Compute virtualMachineScaleSets/virtualMachines/extensions 2023-09-01

  • Článek

Definice prostředku Bicep

Typ prostředku virtualMachineScaleSets/virtualMachines/extensions je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-09-01' = {
  name: 'string'
  location: 'string'
  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'
  }
}

Hodnoty vlastností

virtualMachineScaleSets/virtualMachines/extensions

Název Description Hodnota
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep.		 string (povinné)
location Umístění rozšíření řetězec
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu : virtualMachines
properties Popisuje vlastnosti rozšíření virtuálního počítače. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Název Description Hodnota
autoUpgradeMinorVersion Určuje, jestli by rozšíření mělo používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení ale rozšíření neupgraduje podverze, pokud se nenasadí znovu, a to ani s touto vlastností nastavenou na true. bool
enableAutomaticUpgrade Určuje, jestli má být rozšíření automaticky upgradováno platformou, pokud je k dispozici novější verze rozšíření. bool
forceUpdateTag Způsob vynucení aktualizace obslužné rutiny rozšíření i v případě, že se konfigurace rozšíření nezměnila. řetězec
instanceView Zobrazení instance rozšíření virtuálního počítače VirtualMachineExtensionInstanceView
protectedSettings Rozšíření může obsahovat buď protectedSettings, nebo protectedSettingsFromKeyVault nebo vůbec žádné chráněné nastavení. Pro Bicep můžete použít funkci any().
protectedSettingsFromKeyVault Rozšíření chrání nastavení, která se předávají odkazem a využívají se z trezoru klíčů. KeyVaultSecretReference
provisionAfterExtensions Kolekce názvů rozšíření, po jejichž uplynutí je potřeba toto rozšíření zřídit. string[]
vydavatel Název vydavatele obslužné rutiny rozšíření. řetězec
nastavení Veřejná nastavení rozšíření ve formátu JSON Pro Bicep můžete použít funkci any().
suppressFailures Určuje, jestli se potlačí selhání vyplývající z rozšíření (provozní selhání, jako je nepřipojení k virtuálnímu počítači, nebudou potlačeny bez ohledu na tuto hodnotu). Výchozí hodnotou je hodnota false. bool
typ Určuje typ rozšíření; Příkladem je CustomScriptExtension. řetězec
typeHandlerVersion Určuje verzi obslužné rutiny skriptu. řetězec

VirtualMachineExtensionInstanceView

Název Description Hodnota
name Název rozšíření virtuálního počítače. řetězec
Stavy Informace o stavu zdroje. InstanceViewStatus[]
dílčí stav Informace o stavu zdroje. InstanceViewStatus[]
typ Určuje typ rozšíření; Příkladem je CustomScriptExtension. řetězec
typeHandlerVersion Určuje verzi obslužné rutiny skriptu. řetězec

InstanceViewStatus

Název Description Hodnota
kód Stavový kód. řetězec
displayStatus Krátký lokalizovatelný popisek stavu. řetězec
úroveň Kód úrovně. 'Chyba'
'Informace'
'Upozornění'
zpráva Podrobná stavová zpráva, včetně výstrah a chybových zpráv. řetězec
time Čas stavu. řetězec

KeyVaultSecretReference

Název Description Hodnota
adresa URL tajného kódu Adresa URL odkazující na tajný kód v Key Vault. string (povinné)
sourceVault Relativní adresa URL Key Vault obsahující tajný kód. Dílčí zdroj (povinné)

Dílčí zdroj

Název Description Hodnota
id ID prostředku řetězec

Definice prostředku šablony ARM

Typ prostředku virtualMachineScaleSets/virtualMachines/extensions je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions, přidejte do šablony následující kód JSON.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "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"
  }
}

Hodnoty vlastností

virtualMachineScaleSets/virtualMachines/extensions

Název Description Hodnota
typ Typ prostředku Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions
apiVersion Verze rozhraní API prostředku '2023-09-01'
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)
location Umístění rozšíření řetězec
properties Popisuje vlastnosti rozšíření virtuálního počítače. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Název Description Hodnota
autoUpgradeMinorVersion Určuje, jestli by rozšíření mělo používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení ale rozšíření neupgraduje podverze, pokud se nenasadí znovu, a to ani s touto vlastností nastavenou na true. bool
enableAutomaticUpgrade Určuje, jestli má být rozšíření automaticky upgradováno platformou, pokud je k dispozici novější verze rozšíření. bool
forceUpdateTag Způsob vynucení aktualizace obslužné rutiny rozšíření i v případě, že se konfigurace rozšíření nezměnila. řetězec
instanceView Zobrazení instance rozšíření virtuálního počítače VirtualMachineExtensionInstanceView
protectedSettings Rozšíření může obsahovat buď protectedSettings, nebo protectedSettingsFromKeyVault nebo vůbec žádné chráněné nastavení.
protectedSettingsFromKeyVault Rozšíření chrání nastavení, která se předávají odkazem a využívají se z trezoru klíčů. KeyVaultSecretReference
provisionAfterExtensions Kolekce názvů rozšíření, po jejichž uplynutí je potřeba toto rozšíření zřídit. string[]
vydavatel Název vydavatele obslužné rutiny rozšíření. řetězec
nastavení Veřejná nastavení rozšíření ve formátu JSON
suppressFailures Určuje, jestli se potlačí selhání vyplývající z rozšíření (provozní selhání, jako je nepřipojení k virtuálnímu počítači, nebudou potlačeny bez ohledu na tuto hodnotu). Výchozí hodnotou je hodnota false. bool
typ Určuje typ rozšíření; Příkladem je CustomScriptExtension. řetězec
typeHandlerVersion Určuje verzi obslužné rutiny skriptu. řetězec

VirtualMachineExtensionInstanceView

Název Description Hodnota
name Název rozšíření virtuálního počítače. řetězec
Stavy Informace o stavu zdroje. InstanceViewStatus[]
dílčí stav Informace o stavu zdroje. InstanceViewStatus[]
typ Určuje typ rozšíření; Příkladem je CustomScriptExtension. řetězec
typeHandlerVersion Určuje verzi obslužné rutiny skriptu. řetězec

InstanceViewStatus

Název Description Hodnota
kód Stavový kód. řetězec
displayStatus Krátký lokalizovatelný popisek stavu. řetězec
úroveň Kód úrovně. 'Chyba'
'Informace'
'Upozornění'
zpráva Podrobná stavová zpráva, včetně výstrah a chybových zpráv. řetězec
time Čas stavu. řetězec

KeyVaultSecretReference

Název Description Hodnota
adresa URL tajného kódu Adresa URL odkazující na tajný kód v Key Vault. string (povinné)
sourceVault Relativní adresa URL Key Vault obsahující tajný kód. Dílčí zdroj (povinné)

Dílčí zdroj

Název Description Hodnota
id ID prostředku řetězec

Definice prostředku Terraform (poskytovatel AzAPI)

Typ prostředku virtualMachineScaleSets/virtualMachines/extensions je možné nasadit s operacemi, které cílí na:

  • Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  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"
    }
  })
}

Hodnoty vlastností

virtualMachineScaleSets/virtualMachines/extensions

Název Description Hodnota
typ Typ prostředku Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-09-01
name Název prostředku string (povinné)
location Umístění rozšíření řetězec
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu virtualMachines
properties Popisuje vlastnosti rozšíření virtuálního počítače. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Název Description Hodnota
autoUpgradeMinorVersion Určuje, jestli by rozšíření mělo používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení ale rozšíření neupgraduje podverze, pokud se nenasadí znovu, a to ani s touto vlastností nastavenou na true. bool
enableAutomaticUpgrade Určuje, jestli má platforma rozšíření automaticky upgradovat, pokud je k dispozici novější verze rozšíření. bool
forceUpdateTag Způsob, jakým by měla být obslužná rutina rozšíření vynucena k aktualizaci, i když se konfigurace rozšíření nezměnila. řetězec
instanceView Zobrazení instance rozšíření virtuálního počítače VirtualMachineExtensionInstanceView
protectedSettings Rozšíření může obsahovat buď protectedSettings, nebo protectedSettingsFromKeyVault nebo vůbec žádné chráněné nastavení.
protectedSettingsFromKeyVault Nastavení chráněná rozšířeními, která jsou předána odkazem a využívána z trezoru klíčů KeyVaultSecretReference
provisionAfterExtensions Kolekce názvů rozšíření, po které je potřeba toto rozšíření zřídit. string[]
vydavatel Název vydavatele obslužné rutiny rozšíření. řetězec
nastavení Veřejná nastavení rozšíření ve formátu JSON
suppressFailures Označuje, jestli budou potlačena selhání vyplývající z rozšíření (provozní selhání, jako je nepřipojování k virtuálnímu počítači, nebudou potlačeny bez ohledu na tuto hodnotu). Výchozí hodnotou je hodnota false. bool
typ Určuje typ rozšíření; příkladem je CustomScriptExtension. řetězec
typeHandlerVersion Určuje verzi obslužné rutiny skriptu. řetězec

VirtualMachineExtensionInstanceView

Název Description Hodnota
name Název rozšíření virtuálního počítače. řetězec
Stavy Informace o stavu prostředku. InstanceViewStatus[]
dílčí statistiky Informace o stavu prostředku. InstanceViewStatus[]
typ Určuje typ rozšíření; příkladem je CustomScriptExtension. řetězec
typeHandlerVersion Určuje verzi obslužné rutiny skriptu. řetězec

InstanceViewStatus

Název Description Hodnota
kód Stavový kód. řetězec
displayStatus Krátký lokalizovatelný popisek stavu. řetězec
úroveň Kód úrovně. "Chyba"
"Informace"
"Upozornění"
zpráva Podrobná stavová zpráva, včetně upozornění a chybových zpráv. řetězec
time Čas stavu. řetězec

KeyVaultSecretReference

Název Description Hodnota
secretUrl Adresa URL odkazující na tajný kód v Key Vault. string (povinné)
sourceVault Relativní adresa URL Key Vault obsahující tajný klíč. SubResource (povinné)

Dílčí zdroj

Název Description Hodnota
id ID prostředku řetězec