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=2024-03-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. |
subscription
|
path | True |
string |
Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf. |
vm
|
path | True |
string |
Der Name des VM-Skalierungssatzes, in dem die Erweiterung aktualisiert werden soll. |
vmss
|
path | True |
string |
Der Name der VM-Skalierungssatzerweiterung. |
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 |
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 |
object |
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 |
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. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OKAY |
|
201 Created |
Erstellt |
|
Other Status Codes |
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
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=2024-03-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 des Computediensts. |
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 API-Fehlerdetails |
|
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 |
API-Fehler. |
InnerError
Innere Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
errordetail |
string |
Die interne Fehlermeldung oder das Ausnahmeabbild. |
exceptiontype |
string |
Der Ausnahmetyp. |
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 |
Die relative URL des Schlüsseltresors, der den geheimen Schlüssel 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 |
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 |
object |
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 |
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. |
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 |
object |
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 |
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. |
type |
string |
Ressourcentyp |