Udostępnij za pośrednictwem


Virtual Machine Scale Set Extensions - Update

Operacja aktualizowania rozszerzenia.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}?api-version=2024-07-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
path True

string

Nazwa grupy zasobów.

subscriptionId
path True

string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

vmScaleSetName
path True

string

Nazwa zestawu skalowania maszyn wirtualnych, w którym należy zaktualizować rozszerzenie.

vmssExtensionName
path True

string

Nazwa rozszerzenia zestawu skalowania maszyn wirtualnych.

api-version
query True

string

Wersja interfejsu API klienta.

Treść żądania

Nazwa Typ Opis
properties.autoUpgradeMinorVersion

boolean

Wskazuje, czy rozszerzenie powinno używać nowszej wersji pomocniczej, jeśli jest ona dostępna w czasie wdrażania. Po wdrożeniu rozszerzenie nie uaktualni wersji pomocniczych, chyba że zostanie ponownie wdrożone, nawet jeśli ta właściwość ma wartość true.

properties.enableAutomaticUpgrade

boolean

Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli jest dostępna nowsza wersja rozszerzenia.

properties.forceUpdateTag

string

Jeśli podano wartość i różni się od poprzedniej wartości, program obsługi rozszerzeń zostanie zmuszony do aktualizacji, nawet jeśli konfiguracja rozszerzenia nie uległa zmianie.

properties.protectedSettings

object

Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Rozszerzenia chronione ustawienia, które są przekazywane przez odwołanie i używane z magazynu kluczy

properties.provisionAfterExtensions

string[]

Kolekcja nazw rozszerzeń, po których należy aprowizować to rozszerzenie.

properties.publisher

string

Nazwa wydawcy programu obsługi rozszerzeń.

properties.settings

object

Ustawienia publiczne w formacie Json dla rozszerzenia.

properties.suppressFailures

boolean

Wskazuje, czy awarie wynikające z rozszerzenia zostaną pominięte (błędy operacyjne, takie jak brak nawiązywania połączenia z maszyną wirtualną, nie zostaną pominięte niezależnie od tej wartości). Wartość domyślna to false.

properties.type

string

Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".

properties.typeHandlerVersion

string

Określa wersję programu obsługi skryptów.

Odpowiedzi

Nazwa Typ Opis
200 OK

VirtualMachineScaleSetExtension

OK

201 Created

VirtualMachineScaleSetExtension

Utworzono

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

VirtualMachineScaleSetExtension_Update_MaximumSet_Gen
VirtualMachineScaleSetExtension_Update_MinimumSet_Gen

VirtualMachineScaleSetExtension_Update_MaximumSet_Gen

Przykładowe żądanie

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaa?api-version=2024-07-01

{
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "{extension-Publisher}",
    "type": "{extension-Type}",
    "typeHandlerVersion": "{handler-version}",
    "settings": {},
    "forceUpdateTag": "aaaaaaaaa",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "provisionAfterExtensions": [
      "aa"
    ],
    "suppressFailures": true
  }
}

Przykładowa odpowiedź

{
  "name": "{extension-name}",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "{extension-Publisher}",
    "type": "{extension-Type}",
    "typeHandlerVersion": "{handler-version}",
    "settings": {},
    "forceUpdateTag": "aaaaaaaaa",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "provisioningState": "aaa",
    "provisionAfterExtensions": [
      "aa"
    ],
    "suppressFailures": true
  },
  "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
  "id": "aaaaaaaa"
}
location: https://foo.com/operationstatus
{
  "name": "{extension-name}",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "{extension-Publisher}",
    "type": "{extension-Type}",
    "typeHandlerVersion": "{handler-version}",
    "settings": {},
    "forceUpdateTag": "aaaaaaaaa",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "provisioningState": "aaa",
    "provisionAfterExtensions": [
      "aa"
    ],
    "suppressFailures": true
  },
  "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
  "id": "aaaaaaaa"
}

VirtualMachineScaleSetExtension_Update_MinimumSet_Gen

Przykładowe żądanie

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aa?api-version=2024-07-01

{}

Przykładowa odpowiedź

{}
location: https://foo.com/operationstatus
{}

Definicje

Nazwa Opis
ApiError

Błąd interfejsu API.

ApiErrorBase

Baza błędów interfejsu API.

CloudError

Odpowiedź na błąd z usługi Obliczeniowej.

InnerError

Szczegóły błędu wewnętrznego.

KeyVaultSecretReference

Opisuje odwołanie do wpisu tajnego usługi Key Vault

SubResource
VirtualMachineScaleSetExtension

Opisuje rozszerzenie zestawu skalowania maszyn wirtualnych.

VirtualMachineScaleSetExtensionUpdate

Opisuje rozszerzenie zestawu skalowania maszyn wirtualnych.

ApiError

Błąd interfejsu API.

Nazwa Typ Opis
code

string

Kod błędu.

details

ApiErrorBase[]

Szczegóły błędu interfejsu API

innererror

InnerError

Błąd wewnętrzny interfejsu API

message

string

Komunikat o błędzie.

target

string

Element docelowy określonego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Nazwa Typ Opis
code

string

Kod błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy określonego błędu.

CloudError

Odpowiedź na błąd z usługi Obliczeniowej.

Nazwa Typ Opis
error

ApiError

Błąd interfejsu API.

InnerError

Szczegóły błędu wewnętrznego.

Nazwa Typ Opis
errordetail

string

Wewnętrzny komunikat o błędzie lub zrzut wyjątku.

exceptiontype

string

Typ wyjątku.

KeyVaultSecretReference

Opisuje odwołanie do wpisu tajnego usługi Key Vault

Nazwa Typ Opis
secretUrl

string

Adres URL odwołujący się do wpisu tajnego w usłudze Key Vault.

sourceVault

SubResource

Względny adres URL usługi Key Vault zawierający wpis tajny.

SubResource

Nazwa Typ Opis
id

string

Identyfikator zasobu

VirtualMachineScaleSetExtension

Opisuje rozszerzenie zestawu skalowania maszyn wirtualnych.

Nazwa Typ Opis
id

string

Identyfikator zasobu

name

string

Nazwa rozszerzenia.

properties.autoUpgradeMinorVersion

boolean

Wskazuje, czy rozszerzenie powinno używać nowszej wersji pomocniczej, jeśli jest ona dostępna w czasie wdrażania. Po wdrożeniu rozszerzenie nie uaktualni wersji pomocniczych, chyba że zostanie ponownie wdrożone, nawet jeśli ta właściwość ma wartość true.

properties.enableAutomaticUpgrade

boolean

Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli jest dostępna nowsza wersja rozszerzenia.

properties.forceUpdateTag

string

Jeśli podano wartość i różni się od poprzedniej wartości, program obsługi rozszerzeń zostanie zmuszony do aktualizacji, nawet jeśli konfiguracja rozszerzenia nie uległa zmianie.

properties.protectedSettings

object

Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Rozszerzenia chronione ustawienia, które są przekazywane przez odwołanie i używane z magazynu kluczy

properties.provisionAfterExtensions

string[]

Kolekcja nazw rozszerzeń, po których należy aprowizować to rozszerzenie.

properties.provisioningState

string

Stan aprowizacji, który pojawia się tylko w odpowiedzi.

properties.publisher

string

Nazwa wydawcy programu obsługi rozszerzeń.

properties.settings

object

Ustawienia publiczne w formacie Json dla rozszerzenia.

properties.suppressFailures

boolean

Wskazuje, czy awarie wynikające z rozszerzenia zostaną pominięte (błędy operacyjne, takie jak brak nawiązywania połączenia z maszyną wirtualną, nie zostaną pominięte niezależnie od tej wartości). Wartość domyślna to false.

properties.type

string

Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".

properties.typeHandlerVersion

string

Określa wersję programu obsługi skryptów.

type

string

Typ zasobu

VirtualMachineScaleSetExtensionUpdate

Opisuje rozszerzenie zestawu skalowania maszyn wirtualnych.

Nazwa Typ Opis
id

string

Identyfikator zasobu

name

string

Nazwa rozszerzenia.

properties.autoUpgradeMinorVersion

boolean

Wskazuje, czy rozszerzenie powinno używać nowszej wersji pomocniczej, jeśli jest ona dostępna w czasie wdrażania. Po wdrożeniu rozszerzenie nie uaktualni wersji pomocniczych, chyba że zostanie ponownie wdrożone, nawet jeśli ta właściwość ma wartość true.

properties.enableAutomaticUpgrade

boolean

Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli jest dostępna nowsza wersja rozszerzenia.

properties.forceUpdateTag

string

Jeśli podano wartość i różni się od poprzedniej wartości, program obsługi rozszerzeń zostanie zmuszony do aktualizacji, nawet jeśli konfiguracja rozszerzenia nie uległa zmianie.

properties.protectedSettings

object

Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Rozszerzenia chronione ustawienia, które są przekazywane przez odwołanie i używane z magazynu kluczy

properties.provisionAfterExtensions

string[]

Kolekcja nazw rozszerzeń, po których należy aprowizować to rozszerzenie.

properties.provisioningState

string

Stan aprowizacji, który pojawia się tylko w odpowiedzi.

properties.publisher

string

Nazwa wydawcy programu obsługi rozszerzeń.

properties.settings

object

Ustawienia publiczne w formacie Json dla rozszerzenia.

properties.suppressFailures

boolean

Wskazuje, czy awarie wynikające z rozszerzenia zostaną pominięte (błędy operacyjne, takie jak brak nawiązywania połączenia z maszyną wirtualną, nie zostaną pominięte niezależnie od tej wartości). Wartość domyślna to false.

properties.type

string

Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".

properties.typeHandlerVersion

string

Określa wersję programu obsługi skryptów.

type

string

Typ zasobu