Sdílet prostřednictvím

Virtual Machine Extensions - Create Or Update

Služba:
Compute
Verze rozhraní API:
2025-04-01

Operace vytvoření nebo aktualizace rozšíření.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId
 path True

string

minLength: 1

ID cílového předplatného.
vmExtensionName
 path True

string

Název rozšíření virtuálního počítače
vmName
 path True

string

Název virtuálního počítače.
api-version
 query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Vyžadováno Typ Description
location True

string

Geografické umístění, ve kterém se nachází zdroj
properties.autoUpgradeMinorVersion

boolean

Určuje, jestli má rozšíření používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení však rozšíření neupgraduje podverze, pokud se znovu nenasadí, a to ani s touto vlastností nastavenou na true.
properties.enableAutomaticUpgrade

boolean

Určuje, jestli má být rozšíření automaticky upgradováno platformou, pokud je k dispozici novější verze rozšíření.
properties.forceUpdateTag

string

Způsob vynucení aktualizace obslužné rutiny rozšíření i v případě, že se konfigurace rozšíření nezměnila.
properties.instanceView

VirtualMachineExtensionInstanceView

Zobrazení instance rozšíření virtuálního počítače.
properties.protectedSettings

Rozšíření může obsahovat buď protectedSettings, nebo protectedSettingsFromKeyVault, nebo vůbec žádná chráněná nastavení.
properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Nastavení chráněná rozšířeními, která jsou předána odkazem, a spotřebovaná z trezoru klíčů
properties.provisionAfterExtensions

string[]

Kolekce názvů rozšíření, po kterých je potřeba toto rozšíření zřídit.
properties.publisher

string

Název vydavatele obslužné rutiny rozšíření.
properties.settings

Veřejná nastavení formátovaná json pro rozšíření
properties.suppressFailures

boolean

Určuje, jestli se potlačí selhání vyplývající z rozšíření (provozní selhání, jako je například nepřipojování k virtuálnímu počítači, nebudou potlačována bez ohledu na tuto hodnotu). Výchozí hodnota je false.
properties.type

string

Určuje typ rozšíření; Příkladem je CustomScriptExtension.
properties.typeHandlerVersion

string

Určuje verzi obslužné rutiny skriptu.
tags

object

Značky prostředků

Odpovědi

Name Typ Description
200 OK

VirtualMachineExtension

Operace aktualizace prostředku VirtualMachineExtension byla úspěšná
201 Created

VirtualMachineExtension

Operace vytvoření prostředku VirtualMachineExtension byla úspěšná

Hlavičky

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

CloudError

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
200 
{
  "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"
  }
}
Stavový kód:
201 
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

Ukázkový požadavek

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

{
  "location": "westus"
}

Ukázková odpověď

Stavový kód:
200 
{
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
Stavový kód:
201 
location: https://foo.com/operationstatus
{
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}

Definice

Name Description
ApiError

Chyba rozhraní API.
ApiErrorBase

Chybová základna API.
CloudError

Chybová odpověď ze služby Compute.
createdByType

Typ identity, která prostředek vytvořila.
InnerError

Podrobnosti vnitřní chyby.
InstanceViewStatus

Stav zobrazení instance
KeyVaultSecretReference

Popisuje odkaz na tajný klíč služby Key Vault.
StatusLevelTypes

Kód úrovně.
SubResource
systemData

Metadata týkající se vytvoření a poslední změny prostředku.
VirtualMachineExtension

Popisuje rozšíření virtuálního počítače.
VirtualMachineExtensionInstanceView

Zobrazení instance rozšíření virtuálního počítače.

ApiError

Objekt

Chyba rozhraní API.

Name Typ Description
code

string

Kód chyby.
details

ApiErrorBase[]

Podrobnosti o chybě rozhraní API
innererror

InnerError

Vnitřní chyba Api
message

string

Chybová zpráva.
target

string

Cíl konkrétní chyby.

ApiErrorBase

Objekt

Chybová základna API.

Name Typ Description
code

string

Kód chyby.
message

string

Chybová zpráva.
target

string

Cíl konkrétní chyby.

CloudError

Objekt

Chybová odpověď ze služby Compute.

Name Typ Description
error

ApiError

Chyba rozhraní API.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota Description
User
Application
ManagedIdentity
Key

InnerError

Objekt

Podrobnosti vnitřní chyby.

Name Typ Description
errordetail

string

Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype

string

Typ výjimky.

InstanceViewStatus

Objekt

Stav zobrazení instance

Name Typ Description
code

string

Stavový kód.
displayStatus

string

Krátký lokalizovatelný popisek stavu.
level

StatusLevelTypes

Kód úrovně.
message

string

Podrobná stavová zpráva, včetně výstrah a chybových zpráv.
time

string (date-time)

Čas stavu.

KeyVaultSecretReference

Objekt

Popisuje odkaz na tajný klíč služby Key Vault.

Name Typ Description
secretUrl

string

Adresa URL odkazující na tajný kód ve službě Key Vault.
sourceVault

SubResource

Relativní adresa URL služby Key Vault obsahující tajný klíč.

StatusLevelTypes

Výčet

Kód úrovně.

Hodnota Description
Info
Warning
Error

SubResource

Objekt
Name Typ Description
id

string

ID prostředku

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string (date-time)

Časové razítko vytvoření prostředku (UTC).
createdBy

string

Identita, která prostředek vytvořila.
createdByType

createdByType

Typ identity, která prostředek vytvořila.
lastModifiedAt

string (date-time)

Časové razítko poslední změny zdroje (UTC)
lastModifiedBy

string

Identita, která naposledy změnila prostředek.
lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

VirtualMachineExtension

Objekt

Popisuje rozšíření virtuálního počítače.

Name Typ Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Geografické umístění, ve kterém se nachází zdroj
name

string

Název prostředku
properties.autoUpgradeMinorVersion

boolean

Určuje, jestli má rozšíření používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení však rozšíření neupgraduje podverze, pokud se znovu nenasadí, a to ani s touto vlastností nastavenou na true.
properties.enableAutomaticUpgrade

boolean

Určuje, jestli má být rozšíření automaticky upgradováno platformou, pokud je k dispozici novější verze rozšíření.
properties.forceUpdateTag

string

Způsob vynucení aktualizace obslužné rutiny rozšíření i v případě, že se konfigurace rozšíření nezměnila.
properties.instanceView

VirtualMachineExtensionInstanceView

Zobrazení instance rozšíření virtuálního počítače.
properties.protectedSettings

Rozšíření může obsahovat buď protectedSettings, nebo protectedSettingsFromKeyVault, nebo vůbec žádná chráněná nastavení.
properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Nastavení chráněná rozšířeními, která jsou předána odkazem, a spotřebovaná z trezoru klíčů
properties.provisionAfterExtensions

string[]

Kolekce názvů rozšíření, po kterých je potřeba toto rozšíření zřídit.
properties.provisioningState

string

Stav zřizování, který se zobrazí pouze v odpovědi.
properties.publisher

string

Název vydavatele obslužné rutiny rozšíření.
properties.settings

Veřejná nastavení formátovaná json pro rozšíření
properties.suppressFailures

boolean

Určuje, jestli se potlačí selhání vyplývající z rozšíření (provozní selhání, jako je například nepřipojování k virtuálnímu počítači, nebudou potlačována bez ohledu na tuto hodnotu). Výchozí hodnota je false.
properties.type

string

Určuje typ rozšíření; Příkladem je CustomScriptExtension.
properties.typeHandlerVersion

string

Určuje verzi obslužné rutiny skriptu.
systemData

systemData

Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags

object

Značky prostředků
type

string

Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

VirtualMachineExtensionInstanceView

Objekt

Zobrazení instance rozšíření virtuálního počítače.

Name Typ Description
name

string

Název rozšíření virtuálního počítače.
statuses

InstanceViewStatus[]

Informace o stavu zdroje
substatuses

InstanceViewStatus[]

Informace o stavu zdroje
type

string

Určuje typ rozšíření; Příkladem je CustomScriptExtension.
typeHandlerVersion

string

Určuje verzi obslužné rutiny skriptu.