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=2025-04-01
Parametry URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter. |
|
subscription
|
path | True |
string minLength: 1 |
Identyfikator subskrypcji docelowej. |
|
vm
|
path | True |
string |
Nazwa rozszerzenia maszyny wirtualnej. |
|
vm
|
path | True |
string |
Nazwa maszyny wirtualnej. |
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
Ciało żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| location | True |
string |
Lokalizacja geograficzna, w której znajduje się zasób |
| 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 |
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 |
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 |
Operacja aktualizacji zasobu "VirtualMachineExtension" powiodła się |
|
| 201 Created |
Operacja tworzenia zasobu "VirtualMachineExtension" powiodła się Nagłówki
|
|
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
azure_auth
Przepływ protokołu OAuth2 usługi Azure Active Directory.
Typ:
oauth2
Flow:
implicit
URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresów
| Nazwa | Opis |
|---|---|
| user_impersonation | personifikacja konta użytkownika |
Przykłady
|
Virtual |
|
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
Przykładowa prośba
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"
}
}
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ładowa prośba
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 API. |
|
Api |
Baza błędów API. |
|
Cloud |
Odpowiedź na błąd z usługi obliczeniowej. |
|
created |
Typ tożsamości, która utworzyła zasób. |
|
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 |
|
|
system |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
|
Virtual |
Opisuje rozszerzenie maszyny wirtualnej. |
|
Virtual |
Widok wystąpienia rozszerzenia maszyny wirtualnej. |
ApiError
Błąd API.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu interfejsu API |
|
| innererror |
Wewnętrzny błąd interfejsu API |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Element docelowy określonego błędu. |
ApiErrorBase
Baza błędów 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 API. |
createdByType
Typ tożsamości, która utworzyła zasób.
| Wartość | Opis |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
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 (date-time) |
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.
| Wartość | Opis |
|---|---|
| Info | |
| Warning | |
| Error |
SubResource
| Nazwa | Typ | Opis |
|---|---|---|
| id |
string |
Identyfikator zasobu |
systemData
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
| Nazwa | Typ | Opis |
|---|---|---|
| createdAt |
string (date-time) |
Sygnatura czasowa tworzenia zasobu (UTC). |
| createdBy |
string |
Tożsamość, która utworzyła zasób. |
| createdByType |
Typ tożsamości, która utworzyła zasób. |
|
| lastModifiedAt |
string (date-time) |
Znacznik czasu ostatniej modyfikacji zasobu (UTC) |
| lastModifiedBy |
string |
Tożsamość, która ostatnio zmodyfikowała zasób. |
| lastModifiedByType |
Typ tożsamości, która ostatnio zmodyfikowała zasób. |
VirtualMachineExtension
Opisuje rozszerzenie maszyny wirtualnej.
| Nazwa | Typ | Opis |
|---|---|---|
| id |
string |
W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
Lokalizacja geograficzna, w której znajduje się zasób |
| 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 |
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 |
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. |
| systemData |
Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”. |
|
| tags |
object |
Tagi zasobów. |
| type |
string |
Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" |
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. |