Freigeben über


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

Bicep-Ressourcendefinition

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

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

Ressourcenformat

Um eine Ressource "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" zu erstellen, fügen Sie Der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-03-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'
  }
}

Eigenschaftswerte

virtualMachineScaleSets/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 Die Position der Erweiterung. Schnur
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.
protectedSettingsFromKeyVault Die durch Verweis übergebenen Erweiterungen geschützten Einstellungen und vom Key Vault genutzt werden KeyVaultSecretReference
provisionAfterExtensions Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss. string[]
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

KeyVaultSecretReference

Name Beschreibung Wert
secretUrl Die URL, die auf einen geheimen Schlüssel in einem Key Vault verweist. Zeichenfolge (erforderlich)
sourceVault Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält. SubResource- (erforderlich)

Unterressource

Name Beschreibung Wert
id Ressourcen-ID Schnur

ARM-Vorlagenressourcendefinition

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

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

Ressourcenformat

Um eine Ressource "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" zu erstellen, fügen Sie ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "apiVersion": "2023-03-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"
  }
}

Eigenschaftswerte

virtualMachineScaleSets/virtualMachines/extensions

Name Beschreibung Wert
Art Der Ressourcentyp "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions"
apiVersion Die Ressourcen-API-Version '2023-03-01'
Name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON ARM-Vorlagenfestlegen.
Zeichenfolge (erforderlich)
Ort Die Position der Erweiterung. Schnur
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.
protectedSettingsFromKeyVault Die durch Verweis übergebenen Erweiterungen geschützten Einstellungen und vom Key Vault genutzt werden KeyVaultSecretReference
provisionAfterExtensions Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss. string[]
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

KeyVaultSecretReference

Name Beschreibung Wert
secretUrl Die URL, die auf einen geheimen Schlüssel in einem Key Vault verweist. Zeichenfolge (erforderlich)
sourceVault Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält. SubResource- (erforderlich)

Unterressource

Name Beschreibung Wert
id Ressourcen-ID Schnur

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "virtualMachineScaleSets/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/virtualMachineScaleSets/virtualMachines/extensions" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-03-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"
    }
  })
}

Eigenschaftswerte

virtualMachineScaleSets/virtualMachines/extensions

Name Beschreibung Wert
Art Der Ressourcentyp "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-03-01"
Name Der Ressourcenname Zeichenfolge (erforderlich)
Ort Die Position der Erweiterung. Schnur
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: 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.
protectedSettingsFromKeyVault Die durch Verweis übergebenen Erweiterungen geschützten Einstellungen und vom Key Vault genutzt werden KeyVaultSecretReference
provisionAfterExtensions Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss. string[]
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

KeyVaultSecretReference

Name Beschreibung Wert
secretUrl Die URL, die auf einen geheimen Schlüssel in einem Key Vault verweist. Zeichenfolge (erforderlich)
sourceVault Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält. SubResource- (erforderlich)

Unterressource

Name Beschreibung Wert
id Ressourcen-ID Schnur