Dela via


Virtual Machine Extensions - Create Or Update

Åtgärden för att skapa eller uppdatera tillägget.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen.

subscriptionId
path True

string

Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

vmExtensionName
path True

string

Namnet på tillägget för den virtuella datorn.

vmName
path True

string

Namnet på den virtuella dator där tillägget ska skapas eller uppdateras.

api-version
query True

string

Klient-API-version.

Begärandetext

Name Typ Description
location

string

Resursplats

properties.autoUpgradeMinorVersion

boolean

Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true.

properties.enableAutomaticUpgrade

boolean

Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version av tillägget tillgängligt.

properties.forceUpdateTag

string

Hur tilläggshanteraren ska tvingas uppdatera även om tilläggskonfigurationen inte har ändrats.

properties.instanceView

VirtualMachineExtensionInstanceView

Instansvyn för tillägget för virtuella datorer.

properties.protectedSettings

object

Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Tilläggsskyddade inställningar som skickas av referens och som används från nyckelvalvet

properties.provisionAfterExtensions

string[]

Samling tilläggsnamn varefter tillägget måste etableras.

properties.publisher

string

Namnet på tilläggshanterarens utgivare.

properties.settings

object

Json har formaterat offentliga inställningar för tillägget.

properties.suppressFailures

boolean

Anger om fel som härrör från tillägget kommer att ignoreras (Driftfel som att inte ansluta till den virtuella datorn ignoreras inte oavsett det här värdet). Standardvärdet är falskt.

properties.type

string

Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".

properties.typeHandlerVersion

string

Anger versionen av skripthanteraren.

tags

object

Resurstaggar

Svar

Name Typ Description
200 OK

VirtualMachineExtension

OKEJ

201 Created

VirtualMachineExtension

Skapad

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

{
  "location": "westus"
}

Exempelsvar

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

Definitioner

Name Description
ApiError

Api-fel.

ApiErrorBase

Api-felbas.

CloudError

Ett felsvar från Compute-tjänsten.

InnerError

Inre felinformation.

InstanceViewStatus

Status för instansvy.

KeyVaultSecretReference

Beskriver en referens till Key Vault Secret

StatusLevelTypes

Nivåkoden.

SubResource
VirtualMachineExtension

Beskriver ett tillägg för virtuell dator.

VirtualMachineExtensionInstanceView

Instansvyn för ett tillägg för virtuella datorer.

ApiError

Api-fel.

Name Typ Description
code

string

Felkoden.

details

ApiErrorBase[]

Api-felinformationen

innererror

InnerError

Api:ets inre fel

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name Typ Description
code

string

Felkoden.

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

CloudError

Ett felsvar från Compute-tjänsten.

Name Typ Description
error

ApiError

Api-fel.

InnerError

Inre felinformation.

Name Typ Description
errordetail

string

Det interna felmeddelandet eller undantagsdumpen.

exceptiontype

string

Undantagstypen.

InstanceViewStatus

Status för instansvy.

Name Typ Description
code

string

Statuskoden.

displayStatus

string

Den korta localizable-etiketten för statusen.

level

StatusLevelTypes

Nivåkoden.

message

string

Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.

time

string

Tidpunkten för statusen.

KeyVaultSecretReference

Beskriver en referens till Key Vault Secret

Name Typ Description
secretUrl

string

URL:en som refererar till en hemlighet i ett Nyckelvalv.

sourceVault

SubResource

Den relativa URL:en för nyckelvalvet som innehåller hemligheten.

StatusLevelTypes

Nivåkoden.

Name Typ Description
Error

string

Info

string

Warning

string

SubResource

Name Typ Description
id

string

Resurs-ID

VirtualMachineExtension

Beskriver ett tillägg för virtuell dator.

Name Typ Description
id

string

Resurs-ID

location

string

Resursplats

name

string

Resursnamn

properties.autoUpgradeMinorVersion

boolean

Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true.

properties.enableAutomaticUpgrade

boolean

Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version av tillägget tillgängligt.

properties.forceUpdateTag

string

Hur tilläggshanteraren ska tvingas uppdatera även om tilläggskonfigurationen inte har ändrats.

properties.instanceView

VirtualMachineExtensionInstanceView

Instansvyn för tillägget för virtuella datorer.

properties.protectedSettings

object

Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Tilläggsskyddade inställningar som skickas av referens och som används från nyckelvalvet

properties.provisionAfterExtensions

string[]

Samling tilläggsnamn varefter tillägget måste etableras.

properties.provisioningState

string

Etableringstillståndet, som bara visas i svaret.

properties.publisher

string

Namnet på tilläggshanterarens utgivare.

properties.settings

object

Json har formaterat offentliga inställningar för tillägget.

properties.suppressFailures

boolean

Anger om fel som härrör från tillägget kommer att ignoreras (Driftfel som att inte ansluta till den virtuella datorn ignoreras inte oavsett det här värdet). Standardvärdet är falskt.

properties.type

string

Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".

properties.typeHandlerVersion

string

Anger versionen av skripthanteraren.

tags

object

Resurstaggar

type

string

Resurstyp

VirtualMachineExtensionInstanceView

Instansvyn för ett tillägg för virtuella datorer.

Name Typ Description
name

string

Namnet på det virtuella datortillägget.

statuses

InstanceViewStatus[]

Information om resursstatus.

substatuses

InstanceViewStatus[]

Information om resursstatus.

type

string

Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".

typeHandlerVersion

string

Anger versionen av skripthanteraren.