Virtual Machine Extensions - Create Or Update

De bewerking voor het maken of bijwerken van de extensie.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep.

subscriptionId
path True

string

Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.

vmExtensionName
path True

string

De naam van de extensie van de virtuele machine.

vmName
path True

string

De naam van de virtuele machine waarop de extensie moet worden gemaakt of bijgewerkt.

api-version
query True

string

Client-API-versie.

Aanvraagbody

Name Type Description
location

string

Resourcelocatie

properties.autoUpgradeMinorVersion

boolean

Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie 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 van het exemplaar van de extensie van de virtuele machine.

properties.protectedSettings

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

De met extensies beveiligde instellingen die worden doorgegeven door verwijzing 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

object

Met 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 maken van verbinding met de VM, worden niet onderdrukt, ongeacht deze waarde). De standaardwaarde is false.

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

tags

object

Resourcetags

Antwoorden

Name Type Description
200 OK

VirtualMachineExtension

OK

201 Created

VirtualMachineExtension

Gemaakt

Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

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

Definities

Name Description
ApiError

API-fout.

ApiErrorBase

API-foutbasis.

CloudError

Een foutreactie van de Compute-service.

InnerError

Details van interne fout.

InstanceViewStatus

Status van exemplaarweergave.

KeyVaultSecretReference

Beschrijft een verwijzing naar Key Vault geheim

StatusLevelTypes

De niveaucode.

SubResource
VirtualMachineExtension

Beschrijft een virtuele-machine-extensie.

VirtualMachineExtensionInstanceView

De exemplaarweergave van een virtuele-machine-extensie.

ApiError

API-fout.

Name Type Description
code

string

De foutcode.

details

ApiErrorBase[]

De API-foutdetails

innererror

InnerError

De interne api-fout

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.

InnerError

Details van interne fout.

Name Type Description
errordetail

string

Het interne foutbericht of de 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

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 Key Vault.

sourceVault

SubResource

De relatieve URL van de Key Vault die het geheim bevat.

StatusLevelTypes

De niveaucode.

Name Type Description
Error

string

Info

string

Warning

string

SubResource

Name Type Description
id

string

Resource-id

VirtualMachineExtension

Beschrijft een virtuele-machine-extensie.

Name Type Description
id

string

Resource-id

location

string

Resourcelocatie

name

string

Resourcenaam

properties.autoUpgradeMinorVersion

boolean

Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie 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 van het exemplaar van de extensie van de virtuele machine.

properties.protectedSettings

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

De met extensies beveiligde instellingen die worden doorgegeven door verwijzing 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 wordt weergegeven in het antwoord.

properties.publisher

string

De naam van de uitgever van de extensie-handler.

properties.settings

object

Met 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 maken van verbinding met de VM, worden niet onderdrukt, ongeacht deze waarde). De standaardwaarde is false.

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

tags

object

Resourcetags

type

string

Resourcetype

VirtualMachineExtensionInstanceView

De exemplaarweergave van een virtuele-machine-extensie.

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