Freigeben über


Virtual Machine Extensions - Update

Der Vorgang zum Aktualisieren der Erweiterung.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2024-03-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe.

subscriptionId
path True

string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

vmExtensionName
path True

string

Der Name der Erweiterung des virtuellen Computers.

vmName
path True

string

Der Name des virtuellen Computers, auf dem die Erweiterung aktualisiert werden soll.

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Typ Beschreibung
properties.autoUpgradeMinorVersion

boolean

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.

properties.enableAutomaticUpgrade

boolean

Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.

properties.forceUpdateTag

string

Wie der Erweiterungshandler aktualisiert werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.

properties.protectedSettings

object

Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Die durch Verweis übergebenen Erweiterungen geschützten Einstellungen und vom Key Vault genutzt werden

properties.publisher

string

Der Name des Herausgebers des Erweiterungshandlers.

properties.settings

object

Json formatierte öffentliche Einstellungen für die Erweiterung.

properties.suppressFailures

boolean

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".

properties.type

string

Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".

properties.typeHandlerVersion

string

Gibt die Version des Skripthandlers an.

tags

object

Ressourcentags

Antworten

Name Typ Beschreibung
200 OK

VirtualMachineExtension

OKAY

Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

Update VM extension.

Beispielanforderung

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension?api-version=2024-03-01

{
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {
      "UserName": "xyz@microsoft.com"
    },
    "protectedSettingsFromKeyVault": {
      "sourceVault": {
        "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
      },
      "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
    }
  }
}

Beispiel für eine Antwort

{
  "name": "myVMExtension",
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
  "location": "westus",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "provisioningState": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {
      "UserName": "xyz@microsoft.com"
    },
    "protectedSettingsFromKeyVault": {
      "sourceVault": {
        "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
      },
      "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
    }
  }
}

Definitionen

Name Beschreibung
ApiError

API-Fehler.

ApiErrorBase

API-Fehlerbasis.

CloudError

Eine Fehlerantwort des Computediensts.

InnerError

Innere Fehlerdetails.

InstanceViewStatus

Instanzansichtsstatus.

KeyVaultSecretReference

Beschreibt einen Verweis auf key Vault Secret

StatusLevelTypes

Der Ebenencode.

SubResource
VirtualMachineExtension

Beschreibt eine Erweiterung des virtuellen Computers.

VirtualMachineExtensionInstanceView

Die Instanzansicht einer Erweiterung eines virtuellen Computers.

VirtualMachineExtensionUpdate

Beschreibt eine Erweiterung des virtuellen Computers.

ApiError

API-Fehler.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

ApiErrorBase[]

Die API-Fehlerdetails

innererror

InnerError

Interner API-Fehler

message

string

Die Fehlermeldung.

target

string

Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name Typ Beschreibung
code

string

Der Fehlercode.

message

string

Die Fehlermeldung.

target

string

Das Ziel des bestimmten Fehlers.

CloudError

Eine Fehlerantwort des Computediensts.

Name Typ Beschreibung
error

ApiError

API-Fehler.

InnerError

Innere Fehlerdetails.

Name Typ Beschreibung
errordetail

string

Die interne Fehlermeldung oder das Ausnahmeabbild.

exceptiontype

string

Der Ausnahmetyp.

InstanceViewStatus

Instanzansichtsstatus.

Name Typ Beschreibung
code

string

Der Statuscode.

displayStatus

string

Die kurze lokalisierbare Bezeichnung für den Status.

level

StatusLevelTypes

Der Ebenencode.

message

string

Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.

time

string

Die Uhrzeit des Status.

KeyVaultSecretReference

Beschreibt einen Verweis auf key Vault Secret

Name Typ Beschreibung
secretUrl

string

Die URL, die auf einen geheimen Schlüssel in einem Key Vault verweist.

sourceVault

SubResource

Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält.

StatusLevelTypes

Der Ebenencode.

Name Typ Beschreibung
Error

string

Info

string

Warning

string

SubResource

Name Typ Beschreibung
id

string

Ressourcen-ID

VirtualMachineExtension

Beschreibt eine Erweiterung des virtuellen Computers.

Name Typ Beschreibung
id

string

Ressourcen-ID

location

string

Ressourcenspeicherort

name

string

Ressourcenname

properties.autoUpgradeMinorVersion

boolean

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.

properties.enableAutomaticUpgrade

boolean

Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.

properties.forceUpdateTag

string

Wie der Erweiterungshandler aktualisiert werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.

properties.instanceView

VirtualMachineExtensionInstanceView

Die Erweiterungsinstanzansicht des virtuellen Computers.

properties.protectedSettings

object

Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Die durch Verweis übergebenen Erweiterungen geschützten Einstellungen und vom Key Vault genutzt werden

properties.provisionAfterExtensions

string[]

Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss.

properties.provisioningState

string

Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.

properties.publisher

string

Der Name des Herausgebers des Erweiterungshandlers.

properties.settings

object

Json formatierte öffentliche Einstellungen für die Erweiterung.

properties.suppressFailures

boolean

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".

properties.type

string

Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".

properties.typeHandlerVersion

string

Gibt die Version des Skripthandlers an.

tags

object

Ressourcentags

type

string

Ressourcentyp

VirtualMachineExtensionInstanceView

Die Instanzansicht einer Erweiterung eines virtuellen Computers.

Name Typ Beschreibung
name

string

Der Erweiterungsname des virtuellen Computers.

statuses

InstanceViewStatus[]

Die Ressourcenstatusinformationen.

substatuses

InstanceViewStatus[]

Die Ressourcenstatusinformationen.

type

string

Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".

typeHandlerVersion

string

Gibt die Version des Skripthandlers an.

VirtualMachineExtensionUpdate

Beschreibt eine Erweiterung des virtuellen Computers.

Name Typ Beschreibung
properties.autoUpgradeMinorVersion

boolean

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.

properties.enableAutomaticUpgrade

boolean

Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.

properties.forceUpdateTag

string

Wie der Erweiterungshandler aktualisiert werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.

properties.protectedSettings

object

Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Die durch Verweis übergebenen Erweiterungen geschützten Einstellungen und vom Key Vault genutzt werden

properties.publisher

string

Der Name des Herausgebers des Erweiterungshandlers.

properties.settings

object

Json formatierte öffentliche Einstellungen für die Erweiterung.

properties.suppressFailures

boolean

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".

properties.type

string

Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".

properties.typeHandlerVersion

string

Gibt die Version des Skripthandlers an.

tags

object

Ressourcentags