Virtual Machine Extensions - Create Or Update
Der Vorgang zum Erstellen oder Aktualisieren der Erweiterung.
PUT 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 |
---|---|---|---|---|
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 der VM-Erweiterung. |
vm
|
path | True |
string |
Der Name des virtuellen Computers, auf dem die Erweiterung erstellt oder aktualisiert werden soll. |
api-version
|
query | True |
string |
Client-API-Version. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
location |
string |
Ressourcenspeicherort |
properties.autoUpgradeMinorVersion |
boolean |
Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zum Zeitpunkt der Bereitstellung verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst 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 zum Aktualisieren gezwungen werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat. |
properties.instanceView |
Die VM-Erweiterung instance Ansicht. |
|
properties.protectedSettings |
object |
Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. |
properties.protectedSettingsFromKeyVault |
Die durch Erweiterungen geschützten Einstellungen, die als Verweis übergeben und vom Schlüsseltresor verwendet werden |
|
properties.provisionAfterExtensions |
string[] |
Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss. |
properties.publisher |
string |
Der Name des Erweiterungshandlerherausgebers. |
properties.settings |
object |
Im Json-Format formatierte öffentliche Einstellungen für die Erweiterung. |
properties.suppressFailures |
boolean |
Gibt an, ob Fehler, die von der Erweiterung stammen, unterdrückt werden (Betriebsfehler, z. B. keine Verbindung mit dem virtuellen Computer herzustellen, 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. |
tags |
object |
Ressourcentags |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
|
201 Created |
Erstellt |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Virtual |
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaaaaaaaa?api-version=2024-03-01
{
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
Sample Response
{
"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": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
location: https://foo.com/operationstatus
{
"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": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension?api-version=2024-03-01
{
"location": "westus"
}
Sample Response
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
location: https://foo.com/operationstatus
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
Definitionen
Name | Beschreibung |
---|---|
Api |
API-Fehler. |
Api |
API-Fehlerbasis. |
Cloud |
Eine Fehlerantwort des Computediensts. |
Inner |
Details zu inneren Fehlern. |
Instance |
Instanzansicht status. |
Key |
Beschreibt einen Verweis auf Key Vault Geheimnis. |
Status |
Der Ebenencode. |
Sub |
|
Virtual |
Beschreibt eine VM-Erweiterung. |
Virtual |
Die instance Ansicht einer VM-Erweiterung. |
ApiError
API-Fehler.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
details |
Details zu API-Fehlern |
|
innererror |
Innerer 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
Details zu inneren Fehlern.
Name | Typ | Beschreibung |
---|---|---|
errordetail |
string |
Die interne Fehlermeldung oder das Ausnahmeabbild. |
exceptiontype |
string |
Der Ausnahmetyp. |
InstanceViewStatus
Instanzansicht status.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Statuscode. |
displayStatus |
string |
Die kurze lokalisierbare Bezeichnung für die status. |
level |
Der Ebenencode. |
|
message |
string |
Die detaillierte status Meldung, einschließlich Warnungen und Fehlermeldungen. |
time |
string |
Die Zeit der status. |
KeyVaultSecretReference
Beschreibt einen Verweis auf Key Vault Geheimnis.
Name | Typ | Beschreibung |
---|---|---|
secretUrl |
string |
Die URL, die auf ein Geheimnis in einem Key Vault verweist. |
sourceVault |
Die relative URL der Key Vault, die das Geheimnis 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 VM-Erweiterung.
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 zum Zeitpunkt der Bereitstellung verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst 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 zum Aktualisieren gezwungen werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat. |
properties.instanceView |
Die VM-Erweiterung instance Ansicht. |
|
properties.protectedSettings |
object |
Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. |
properties.protectedSettingsFromKeyVault |
Die durch Erweiterungen geschützten Einstellungen, die als Verweis übergeben und vom Schlüsseltresor verwendet 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 Erweiterungshandlerherausgebers. |
properties.settings |
object |
Im Json-Format formatierte öffentliche Einstellungen für die Erweiterung. |
properties.suppressFailures |
boolean |
Gibt an, ob Fehler, die von der Erweiterung stammen, unterdrückt werden (Betriebsfehler, z. B. keine Verbindung mit dem virtuellen Computer herzustellen, 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. |
tags |
object |
Ressourcentags |
type |
string |
Ressourcentyp |
VirtualMachineExtensionInstanceView
Die instance Ansicht einer VM-Erweiterung.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name der VM-Erweiterung. |
statuses |
Die Ressource status Informationen. |
|
substatuses |
Die Ressource status Informationen. |
|
type |
string |
Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension". |
typeHandlerVersion |
string |
Gibt die Version des Skripthandlers an. |