Virtual Machine Extensions - Create Or Update
A bővítmény létrehozásához vagy frissítéséhez szükséges művelet.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2024-03-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Az erőforráscsoport neve. |
subscription
|
path | True |
string |
Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi. |
vm
|
path | True |
string |
A virtuálisgép-bővítmény neve. |
vm
|
path | True |
string |
Annak a virtuális gépnek a neve, ahol a bővítményt létre kell hozni vagy frissíteni kell. |
api-version
|
query | True |
string |
Ügyfél API-verziója. |
Kérelem törzse
Name | Típus | Description |
---|---|---|
location |
string |
Erőforrás helye |
properties.autoUpgradeMinorVersion |
boolean |
Azt jelzi, hogy a bővítménynek egy újabb alverziót kell-e használnia, ha az üzembe helyezéskor elérhető. Az üzembe helyezés után azonban a bővítmény csak akkor frissíti az alverziókat, ha újra üzembe helyezi, még akkor sem, ha ez a tulajdonság igaz értékre van állítva. |
properties.enableAutomaticUpgrade |
boolean |
Azt jelzi, hogy a bővítményt automatikusan frissítenie kell-e a platformnak, ha a bővítmény újabb verziója érhető el. |
properties.forceUpdateTag |
string |
Hogyan kell a bővítménykezelőt frissíteni, még akkor is, ha a bővítménykonfiguráció nem változott. |
properties.instanceView |
A virtuálisgép-bővítménypéldány nézete. |
|
properties.protectedSettings |
object |
A bővítmény tartalmazhat védettSettings vagy protectedSettingsFromKeyVault beállítást, vagy egyáltalán nem tartalmaz védett beállításokat. |
properties.protectedSettingsFromKeyVault |
A hivatkozás által átadott és a Key Vaultból felhasznált bővítmények védett beállításai |
|
properties.provisionAfterExtensions |
string[] |
Olyan bővítménynevek gyűjteménye, amelyek után ezt a bővítményt ki kell építeni. |
properties.publisher |
string |
A bővítménykezelő közzétevőjének neve. |
properties.settings |
object |
Json formátumú nyilvános beállítások a bővítményhez. |
properties.suppressFailures |
boolean |
Azt jelzi, hogy a bővítményből eredő hibák el lesznek-e tiltva (az olyan működési hibák, mint például a virtuális géphez való csatlakozás mellőzése, függetlenül attól, hogy ez az érték el lesz-e tiltva). Az alapértelmezett érték hamis. |
properties.type |
string |
Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension". |
properties.typeHandlerVersion |
string |
A szkriptkezelő verzióját adja meg. |
tags |
object |
Erőforráscímkék |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OKÉ |
|
201 Created |
Létrehozott |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy miért nem sikerült a művelet. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | a felhasználói fiók megszemélyesítése |
Példák
Virtual |
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
Mintakérelem
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"
}
}
Mintaválasz
{
"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
Mintakérelem
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension?api-version=2024-03-01
{
"location": "westus"
}
Mintaválasz
{
"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"
}
Definíciók
Name | Description |
---|---|
Api |
Api-hiba. |
Api |
Api-hibabázis. |
Cloud |
Hibaválasz a Compute szolgáltatástól. |
Inner |
Belső hiba részletei. |
Instance |
Példánynézet állapota. |
Key |
A Key Vault titkos kulcsára mutató hivatkozás leírása |
Status |
A szintkód. |
Sub |
|
Virtual |
Egy virtuálisgép-bővítményt ismertet. |
Virtual |
Egy virtuálisgép-bővítmény példánynézete. |
ApiError
Api-hiba.
Name | Típus | Description |
---|---|---|
code |
string |
A hibakód. |
details |
Az API-hiba részletei |
|
innererror |
Az Api belső hibája |
|
message |
string |
A hibaüzenet. |
target |
string |
Az adott hiba célja. |
ApiErrorBase
Api-hibabázis.
Name | Típus | Description |
---|---|---|
code |
string |
A hibakód. |
message |
string |
A hibaüzenet. |
target |
string |
Az adott hiba célja. |
CloudError
Hibaválasz a Compute szolgáltatástól.
Name | Típus | Description |
---|---|---|
error |
Api-hiba. |
InnerError
Belső hiba részletei.
Name | Típus | Description |
---|---|---|
errordetail |
string |
A belső hibaüzenet vagy kivételkép. |
exceptiontype |
string |
A kivétel típusa. |
InstanceViewStatus
Példánynézet állapota.
Name | Típus | Description |
---|---|---|
code |
string |
Az állapotkód. |
displayStatus |
string |
Az állapot rövid honosítható címkéje. |
level |
A szintkód. |
|
message |
string |
A részletes állapotüzenet, beleértve a riasztásokat és a hibaüzeneteket is. |
time |
string |
Az állapot időpontja. |
KeyVaultSecretReference
A Key Vault titkos kulcsára mutató hivatkozás leírása
Name | Típus | Description |
---|---|---|
secretUrl |
string |
Az URL-cím, amely egy titkos kulcsra hivatkozik egy Key Vaultban. |
sourceVault |
A titkos kulcsot tartalmazó Key Vault relatív URL-címe. |
StatusLevelTypes
A szintkód.
Name | Típus | Description |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
SubResource
Name | Típus | Description |
---|---|---|
id |
string |
Erőforrás-azonosító |
VirtualMachineExtension
Egy virtuálisgép-bővítményt ismertet.
Name | Típus | Description |
---|---|---|
id |
string |
Erőforrás-azonosító |
location |
string |
Erőforrás helye |
name |
string |
Erőforrás neve |
properties.autoUpgradeMinorVersion |
boolean |
Azt jelzi, hogy a bővítménynek egy újabb alverziót kell-e használnia, ha az üzembe helyezéskor elérhető. Az üzembe helyezés után azonban a bővítmény csak akkor frissíti az alverziókat, ha újra üzembe helyezi, még akkor sem, ha ez a tulajdonság igaz értékre van állítva. |
properties.enableAutomaticUpgrade |
boolean |
Azt jelzi, hogy a bővítményt automatikusan frissítenie kell-e a platformnak, ha a bővítmény újabb verziója érhető el. |
properties.forceUpdateTag |
string |
Hogyan kell a bővítménykezelőt frissíteni, még akkor is, ha a bővítménykonfiguráció nem változott. |
properties.instanceView |
A virtuálisgép-bővítménypéldány nézete. |
|
properties.protectedSettings |
object |
A bővítmény tartalmazhat védettSettings vagy protectedSettingsFromKeyVault beállítást, vagy egyáltalán nem tartalmaz védett beállításokat. |
properties.protectedSettingsFromKeyVault |
A hivatkozás által átadott és a Key Vaultból felhasznált bővítmények védett beállításai |
|
properties.provisionAfterExtensions |
string[] |
Olyan bővítménynevek gyűjteménye, amelyek után ezt a bővítményt ki kell építeni. |
properties.provisioningState |
string |
A kiépítési állapot, amely csak a válaszban jelenik meg. |
properties.publisher |
string |
A bővítménykezelő közzétevőjének neve. |
properties.settings |
object |
Json formátumú nyilvános beállítások a bővítményhez. |
properties.suppressFailures |
boolean |
Azt jelzi, hogy a bővítményből eredő hibák el lesznek-e tiltva (az olyan működési hibák, mint például a virtuális géphez való csatlakozás mellőzése, függetlenül attól, hogy ez az érték el lesz-e tiltva). Az alapértelmezett érték hamis. |
properties.type |
string |
Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension". |
properties.typeHandlerVersion |
string |
A szkriptkezelő verzióját adja meg. |
tags |
object |
Erőforráscímkék |
type |
string |
Erőforrás típusa |
VirtualMachineExtensionInstanceView
Egy virtuálisgép-bővítmény példánynézete.
Name | Típus | Description |
---|---|---|
name |
string |
A virtuális gép bővítményének neve. |
statuses |
Az erőforrás állapotadatai. |
|
substatuses |
Az erőforrás állapotadatai. |
|
type |
string |
Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension". |
typeHandlerVersion |
string |
A szkriptkezelő verzióját adja meg. |