Sdílet prostřednictvím


Virtual Machine Extensions - Create Or Update

Operace pro vytvoření nebo aktualizaci rozšíření.

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

Parametry identifikátoru URI

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

string

Název skupiny prostředků.

subscriptionId
path True

string

Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.

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, kde se má rozšíření vytvořit nebo aktualizovat.

api-version
query True

string

Verze rozhraní API klienta.

Text požadavku

Name Typ Description
location

string

Umístění prostředku

properties.autoUpgradeMinorVersion

boolean

Určuje, jestli by rozšíření mělo používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení ale rozšíření neupgraduje podverze, pokud se nenasadí znovu, 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

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Rozšíření chrání nastavení, která se předávají odkazem a využívají se z trezoru klíčů.

properties.provisionAfterExtensions

string[]

Kolekce názvů rozšíření, po jejichž uplynutí je potřeba toto rozšíření zřídit.

properties.publisher

string

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

properties.settings

object

Veřejná nastavení rozšíření ve formátu JSON

properties.suppressFailures

boolean

Určuje, jestli se potlačí selhání vyplývající z rozšíření (provozní selhání, jako je nepřipojení k virtuálnímu počítači, nebudou potlačeny bez ohledu na tuto hodnotu). Výchozí hodnotou je hodnota 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

OK

201 Created

VirtualMachineExtension

Vytvořeno

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Ukázková odpověď

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

Ukázkový požadavek

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

{
  "location": "westus"
}

Ukázková odpověď

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

Definice

Name Description
ApiError

Chyba rozhraní API

ApiErrorBase

Základ chyb rozhraní API.

CloudError

Chybová odpověď ze služby Compute.

InnerError

Podrobnosti o vnitřní chybě.

InstanceViewStatus

Stav zobrazení instance.

KeyVaultSecretReference

Popisuje odkaz na tajný kód Key Vault.

StatusLevelTypes

Kód úrovně.

SubResource
VirtualMachineExtension

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

VirtualMachineExtensionInstanceView

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

ApiError

Chyba rozhraní API

Name Typ Description
code

string

Kód chyby

details

ApiErrorBase[]

Podrobnosti o chybě rozhraní API

innererror

InnerError

Vnitřní chyba rozhraní API

message

string

Chybová zpráva

target

string

Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name Typ Description
code

string

Kód chyby

message

string

Chybová zpráva

target

string

Cíl konkrétní chyby.

CloudError

Chybová odpověď ze služby Compute.

Name Typ Description
error

ApiError

Chyba rozhraní API

InnerError

Podrobnosti o vnitřní chybě.

Name Typ Description
errordetail

string

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

exceptiontype

string

Typ výjimky.

InstanceViewStatus

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

Čas stavu.

KeyVaultSecretReference

Popisuje odkaz na tajný kód Key Vault.

Name Typ Description
secretUrl

string

Adresa URL odkazující na tajný kód v Key Vault.

sourceVault

SubResource

Relativní adresa URL Key Vault obsahující tajný kód.

StatusLevelTypes

Kód úrovně.

Name Typ Description
Error

string

Info

string

Warning

string

SubResource

Name Typ Description
id

string

ID prostředku

VirtualMachineExtension

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

Name Typ Description
id

string

ID prostředku

location

string

Umístění prostředku

name

string

Název prostředku

properties.autoUpgradeMinorVersion

boolean

Určuje, jestli by rozšíření mělo používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení ale rozšíření neupgraduje podverze, pokud se nenasadí znovu, 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

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Rozšíření chrání nastavení, která se předávají odkazem a využívají se z trezoru klíčů.

properties.provisionAfterExtensions

string[]

Kolekce názvů rozšíření, po jejichž uplynutí 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

object

Veřejná nastavení rozšíření ve formátu JSON

properties.suppressFailures

boolean

Určuje, jestli se potlačí selhání vyplývající z rozšíření (provozní selhání, jako je nepřipojení k virtuálnímu počítači, nebudou potlačeny bez ohledu na tuto hodnotu). Výchozí hodnotou je hodnota 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ů

type

string

Typ prostředku

VirtualMachineExtensionInstanceView

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.