Virtual Machine Scale Set Extensions - Update
Der Vorgang zum Aktualisieren einer Erweiterung.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}?api-version=2025-11-01
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet. |
|
subscription
|
path | True |
string minLength: 1 |
Die ID des Zielabonnements. |
|
vm
|
path | True |
string |
Der Name des VM-Skalierungssatzes. |
|
vmss
|
path | True |
string |
Der Name der VM-Skalierungsgruppenerweiterung. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
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 |
Wenn ein Wert bereitgestellt wird und sich vom vorherigen Wert unterscheidet, wird der Erweiterungshandler gezwungen, zu aktualisieren, auch wenn sich die Erweiterungskonfiguration nicht geändert hat. |
| properties.protectedSettings |
Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. |
|
| properties.protectedSettingsFromKeyVault |
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.publisher |
string |
Der Name des Herausgebers des Erweiterungshandlers. |
| properties.settings |
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). Die Standardeinstellung ist „false“. |
| properties.type |
string |
Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension". |
| properties.typeHandlerVersion |
string |
Gibt die Version des Skripthandlers an. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Azure-Operation erfolgreich abgeschlossen. |
|
| 201 Created |
Der Erstellungsvorgang der Ressource "VirtualMachineScaleSetExtension" war erfolgreich Header
|
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
|
Virtual |
|
Virtual |
VirtualMachineScaleSetExtension_Update_MaximumSet_Gen
Beispielanforderung
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaa?api-version=2025-11-01
{
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
}
}
Beispiel für eine Antwort
{
"name": "{extension-name}",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisioningState": "aaa",
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
},
"type": "aaaaaaaaaaaaaaaaaaaaaaaa",
"id": "aaaaaaaa"
}
location: https://foo.com/operationstatus
{
"name": "{extension-name}",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisioningState": "aaa",
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
},
"type": "aaaaaaaaaaaaaaaaaaaaaaaa",
"id": "aaaaaaaa"
}
VirtualMachineScaleSetExtension_Update_MinimumSet_Gen
Beispielanforderung
Beispiel für eine Antwort
{}
location: https://foo.com/operationstatus
{}
Definitionen
| Name | Beschreibung |
|---|---|
|
Api |
API-Fehler. |
|
Api |
API-Fehlerbasis. |
|
Cloud |
Eine Fehlerantwort vom Compute-Dienst. |
|
Inner |
Innere Fehlerdetails. |
|
Key |
Beschreibt einen Verweis auf Key Vault Secret |
|
Sub |
|
|
Virtual |
Beschreibt eine Erweiterung des Skalierungssatzes für virtuelle Computer. |
|
Virtual |
Beschreibt eine Erweiterung des Skalierungssatzes für virtuelle Computer. |
ApiError
API-Fehler.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Der Fehlercode. |
| details |
Die Details zum API-Fehler |
|
| innererror |
Der innere 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 vom Compute-Dienst.
| Name | Typ | Beschreibung |
|---|---|---|
| error |
API-Fehler. |
InnerError
Innere Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| errordetail |
string |
Die interne Fehlermeldung oder der Ausnahmedump. |
| exceptiontype |
string |
Der Ausnahmetyp. |
KeyVaultSecretReference
Beschreibt einen Verweis auf Key Vault Secret
| Name | Typ | Beschreibung |
|---|---|---|
| secretUrl |
string |
Die URL bezieht sich auf ein Geheimnis in einem Key Vault. |
| sourceVault |
Die relative URL des Key Vault, der das Geheimnis enthält. |
SubResource
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string |
Ressourcen-ID |
VirtualMachineScaleSetExtension
Beschreibt eine Erweiterung des Skalierungssatzes für virtuelle Computer.
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string |
Ressourcen-ID |
| 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 |
Wenn ein Wert bereitgestellt wird und sich vom vorherigen Wert unterscheidet, wird der Erweiterungshandler gezwungen, zu aktualisieren, auch wenn sich die Erweiterungskonfiguration nicht geändert hat. |
| properties.protectedSettings |
Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. |
|
| properties.protectedSettingsFromKeyVault |
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 |
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). Die Standardeinstellung ist „false“. |
| properties.type |
string |
Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension". |
| properties.typeHandlerVersion |
string |
Gibt die Version des Skripthandlers an. |
| type |
string |
Ressourcentyp |
VirtualMachineScaleSetExtensionUpdate
Beschreibt eine Erweiterung des Skalierungssatzes für virtuelle Computer.
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string |
Ressourcen-ID |
| name |
string |
Der Name der Erweiterung. |
| 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 |
Wenn ein Wert bereitgestellt wird und sich vom vorherigen Wert unterscheidet, wird der Erweiterungshandler gezwungen, zu aktualisieren, auch wenn sich die Erweiterungskonfiguration nicht geändert hat. |
| properties.protectedSettings |
Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. |
|
| properties.protectedSettingsFromKeyVault |
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 |
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). Die Standardeinstellung ist „false“. |
| properties.type |
string |
Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension". |
| properties.typeHandlerVersion |
string |
Gibt die Version des Skripthandlers an. |
| type |
string |
Ressourcentyp |