Virtual Machine Extensions - Create Or Update
Operacja tworzenia lub aktualizowania rozszerzenia.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2024-07-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
resource
|
path | True |
string |
Nazwa grupy zasobów. |
subscription
|
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. |
vm
|
path | True |
string |
Nazwa rozszerzenia maszyny wirtualnej. |
vm
|
path | True |
string |
Nazwa maszyny wirtualnej, na której ma zostać utworzone lub zaktualizowane rozszerzenie. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
location |
string |
Lokalizacja zasobu |
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 |
Sposób, w jaki program obsługi rozszerzeń powinien zostać zmuszony do aktualizacji, nawet jeśli konfiguracja rozszerzenia nie uległa zmianie. |
properties.instanceView |
Widok wystąpienia rozszerzenia maszyny wirtualnej. |
|
properties.protectedSettings |
object |
Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione. |
properties.protectedSettingsFromKeyVault |
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. |
tags |
object |
Tagi zasobów |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
201 Created |
Utworzono |
|
Other Status Codes |
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
Virtual |
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
Przykładowe żądanie
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"
}
}
Przykładowa odpowiedź
{
"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
Przykładowe żądanie
Przykładowa odpowiedź
{
"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"
}
Definicje
Nazwa | Opis |
---|---|
Api |
Błąd interfejsu API. |
Api |
Baza błędów interfejsu API. |
Cloud |
Odpowiedź na błąd z usługi Obliczeniowej. |
Inner |
Szczegóły błędu wewnętrznego. |
Instance |
Stan widoku wystąpienia. |
Key |
Opisuje odwołanie do wpisu tajnego usługi Key Vault |
Status |
Kod poziomu. |
Sub |
|
Virtual |
Opisuje rozszerzenie maszyny wirtualnej. |
Virtual |
Widok wystąpienia rozszerzenia maszyny wirtualnej. |
ApiError
Błąd interfejsu API.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
details |
Szczegóły błędu interfejsu API |
|
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 |
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. |
InstanceViewStatus
Stan widoku wystąpienia.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod stanu. |
displayStatus |
string |
Krótka etykieta lokalizowalna dla stanu. |
level |
Kod poziomu. |
|
message |
string |
Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach. |
time |
string |
Czas stanu. |
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 |
Względny adres URL usługi Key Vault zawierający wpis tajny. |
StatusLevelTypes
Kod poziomu.
Nazwa | Typ | Opis |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
SubResource
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu |
VirtualMachineExtension
Opisuje rozszerzenie maszyny wirtualnej.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu |
location |
string |
Lokalizacja zasobu |
name |
string |
Nazwa zasobu |
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 |
Sposób, w jaki program obsługi rozszerzeń powinien zostać zmuszony do aktualizacji, nawet jeśli konfiguracja rozszerzenia nie uległa zmianie. |
properties.instanceView |
Widok wystąpienia rozszerzenia maszyny wirtualnej. |
|
properties.protectedSettings |
object |
Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione. |
properties.protectedSettingsFromKeyVault |
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. |
tags |
object |
Tagi zasobów |
type |
string |
Typ zasobu |
VirtualMachineExtensionInstanceView
Widok wystąpienia rozszerzenia maszyny wirtualnej.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa rozszerzenia maszyny wirtualnej. |
statuses |
Informacje o stanie zasobu. |
|
substatuses |
Informacje o stanie zasobu. |
|
type |
string |
Określa typ rozszerzenia; przykładem jest "CustomScriptExtension". |
typeHandlerVersion |
string |
Określa wersję programu obsługi skryptów. |