Delen via


Virtual Machine Extensions - Create Or Update

De bewerking om de extensie te maken of bij te werken.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is hoofdletterongevoelig.

subscriptionId
path True

string

minLength: 1

De id van het doelabonnement.

vmExtensionName
path True

string

De naam van de extensie van de virtuele machine.

vmName
path True

string

De naam van de virtuele machine.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Vereist Type Description
location True

string

De geografische locatie waar de resource zich bevindt

properties.autoUpgradeMinorVersion

boolean

Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie eenmaal is geïmplementeerd, worden er echter geen secundaire versies bijgewerkt, tenzij deze opnieuw wordt geïmplementeerd, zelfs niet als deze eigenschap is ingesteld op true.

properties.enableAutomaticUpgrade

boolean

Geeft aan of de extensie automatisch moet worden bijgewerkt door het platform als er een nieuwere versie van de extensie beschikbaar is.

properties.forceUpdateTag

string

Hoe de extensie-handler moet worden gedwongen om bij te werken, zelfs als de extensieconfiguratie niet is gewijzigd.

properties.instanceView

VirtualMachineExtensionInstanceView

De weergave exemplaar van de virtuele-machine-extensie.

properties.protectedSettings

De extensie kan protectedSettings of protectedSettingsFromKeyVault of helemaal geen beveiligde instellingen bevatten.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

De met extensies beveiligde instellingen die doorverwijzing worden doorgegeven en die worden gebruikt vanuit de sleutelkluis

properties.provisionAfterExtensions

string[]

Verzameling extensienamen waarna deze extensie moet worden ingericht.

properties.publisher

string

De naam van de uitgever van de extensie-handler.

properties.settings

In Json opgemaakte openbare instellingen voor de extensie.

properties.suppressFailures

boolean

Geeft aan of fouten die voortvloeien uit de extensie worden onderdrukt (operationele fouten, zoals het niet verbinden met de VIRTUELE machine, worden niet onderdrukt, ongeacht deze waarde). De standaardwaarde is onwaar.

properties.type

string

Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension.

properties.typeHandlerVersion

string

Hiermee geeft u de versie van de scripthandler.

tags

object

Resourcetags.

Antwoorden

Name Type Description
200 OK

VirtualMachineExtension

De updatebewerking van de bron 'VirtualMachineExtension' is geslaagd

201 Created

VirtualMachineExtension

Resource 'VirtualMachineExtension' create-bewerking geslaagd

Kopteksten

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaaaaaaaa?api-version=2025-04-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"
  }
}

Voorbeeldrespons

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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension?api-version=2025-04-01

{
  "location": "westus"
}

Voorbeeldrespons

{
  "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"
}

Definities

Name Description
ApiError

Api-fout.

ApiErrorBase

Api-foutbasis.

CloudError

Een foutreactie van de Compute-service.

createdByType

Het type identiteit waarmee de resource is gemaakt.

InnerError

Interne foutdetails.

InstanceViewStatus

Status van exemplaarweergave.

KeyVaultSecretReference

Beschrijft een verwijzing naar Key Vault-geheim

StatusLevelTypes

De niveaucode.

SubResource
systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

VirtualMachineExtension

Beschrijft een extensie voor een virtuele machine.

VirtualMachineExtensionInstanceView

De instantieweergave van een extensie voor een virtuele machine.

ApiError

Api-fout.

Name Type Description
code

string

De foutcode.

details

ApiErrorBase[]

Details van de Api-fout

innererror

InnerError

De innerlijke fout van de Api

message

string

Het foutbericht.

target

string

Het doel van de specifieke fout.

ApiErrorBase

Api-foutbasis.

Name Type Description
code

string

De foutcode.

message

string

Het foutbericht.

target

string

Het doel van de specifieke fout.

CloudError

Een foutreactie van de Compute-service.

Name Type Description
error

ApiError

Api-fout.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
User
Application
ManagedIdentity
Key

InnerError

Interne foutdetails.

Name Type Description
errordetail

string

De interne foutmelding of uitzonderingsdump.

exceptiontype

string

Het uitzonderingstype.

InstanceViewStatus

Status van exemplaarweergave.

Name Type Description
code

string

De statuscode.

displayStatus

string

Het korte lokaliseerbare label voor de status.

level

StatusLevelTypes

De niveaucode.

message

string

Het gedetailleerde statusbericht, inclusief voor waarschuwingen en foutberichten.

time

string (date-time)

Het tijdstip van de status.

KeyVaultSecretReference

Beschrijft een verwijzing naar Key Vault-geheim

Name Type Description
secretUrl

string

De URL die verwijst naar een geheim in een Sleutelkluis.

sourceVault

SubResource

De relatieve URL van de sleutelkluis die het geheim bevat.

StatusLevelTypes

De niveaucode.

Waarde Description
Info
Warning
Error

SubResource

Name Type Description
id

string

Resource-id

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit waarmee de resource is gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

VirtualMachineExtension

Beschrijft een extensie voor een virtuele machine.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

De geografische locatie waar de resource zich bevindt

name

string

De naam van de resource

properties.autoUpgradeMinorVersion

boolean

Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie eenmaal is geïmplementeerd, worden er echter geen secundaire versies bijgewerkt, tenzij deze opnieuw wordt geïmplementeerd, zelfs niet als deze eigenschap is ingesteld op true.

properties.enableAutomaticUpgrade

boolean

Geeft aan of de extensie automatisch moet worden bijgewerkt door het platform als er een nieuwere versie van de extensie beschikbaar is.

properties.forceUpdateTag

string

Hoe de extensie-handler moet worden gedwongen om bij te werken, zelfs als de extensieconfiguratie niet is gewijzigd.

properties.instanceView

VirtualMachineExtensionInstanceView

De weergave exemplaar van de virtuele-machine-extensie.

properties.protectedSettings

De extensie kan protectedSettings of protectedSettingsFromKeyVault of helemaal geen beveiligde instellingen bevatten.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

De met extensies beveiligde instellingen die doorverwijzing worden doorgegeven en die worden gebruikt vanuit de sleutelkluis

properties.provisionAfterExtensions

string[]

Verzameling extensienamen waarna deze extensie moet worden ingericht.

properties.provisioningState

string

De inrichtingsstatus, die alleen in het antwoord wordt weergegeven.

properties.publisher

string

De naam van de uitgever van de extensie-handler.

properties.settings

In Json opgemaakte openbare instellingen voor de extensie.

properties.suppressFailures

boolean

Geeft aan of fouten die voortvloeien uit de extensie worden onderdrukt (operationele fouten, zoals het niet verbinden met de VIRTUELE machine, worden niet onderdrukt, ongeacht deze waarde). De standaardwaarde is onwaar.

properties.type

string

Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension.

properties.typeHandlerVersion

string

Hiermee geeft u de versie van de scripthandler.

systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.

tags

object

Resourcetags.

type

string

Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

VirtualMachineExtensionInstanceView

De instantieweergave van een extensie voor een virtuele machine.

Name Type Description
name

string

De naam van de extensie van de virtuele machine.

statuses

InstanceViewStatus[]

De informatie over de resourcestatus.

substatuses

InstanceViewStatus[]

De informatie over de resourcestatus.

type

string

Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension.

typeHandlerVersion

string

Hiermee geeft u de versie van de scripthandler.