Virtual Machine Extensions - Create Or Update
De bewerking voor het maken of bijwerken van de extensie.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2024-07-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De naam van de resourcegroep. |
subscription
|
path | True |
string |
Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep. |
vm
|
path | True |
string |
De naam van de extensie van de virtuele machine. |
vm
|
path | True |
string |
De naam van de virtuele machine waar de extensie moet worden gemaakt of bijgewerkt. |
api-version
|
query | True |
string |
Client-API-versie. |
Aanvraagbody
Name | Type | Description |
---|---|---|
location |
string |
Resourcelocatie |
properties.autoUpgradeMinorVersion |
boolean |
Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie eenmaal is geïmplementeerd, worden er echter geen secundaire versies bijgewerkt, tenzij deze opnieuw wordt geïmplementeerd, zelfs niet als deze eigenschap is ingesteld op true. |
properties.enableAutomaticUpgrade |
boolean |
Geeft aan of de extensie automatisch moet worden bijgewerkt door het platform als er een nieuwere versie van de extensie beschikbaar is. |
properties.forceUpdateTag |
string |
Hoe de extensie-handler moet worden gedwongen om bij te werken, zelfs als de extensieconfiguratie niet is gewijzigd. |
properties.instanceView |
De weergave exemplaar van de virtuele-machine-extensie. |
|
properties.protectedSettings |
object |
De extensie kan protectedSettings of protectedSettingsFromKeyVault of helemaal geen beveiligde instellingen bevatten. |
properties.protectedSettingsFromKeyVault |
De met extensies beveiligde instellingen die doorverwijzing worden doorgegeven en die worden gebruikt vanuit de sleutelkluis |
|
properties.provisionAfterExtensions |
string[] |
Verzameling extensienamen waarna deze extensie moet worden ingericht. |
properties.publisher |
string |
De naam van de uitgever van de extensie-handler. |
properties.settings |
object |
In Json opgemaakte openbare instellingen voor de extensie. |
properties.suppressFailures |
boolean |
Geeft aan of fouten die voortvloeien uit de extensie worden onderdrukt (operationele fouten, zoals het niet verbinden met de VIRTUELE machine, worden niet onderdrukt, ongeacht deze waarde). De standaardwaarde is onwaar. |
properties.type |
string |
Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension. |
properties.typeHandlerVersion |
string |
Hiermee geeft u de versie van de scripthandler. |
tags |
object |
Resourcetags |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
201 Created |
Geschapen |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
Virtual |
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
Voorbeeldaanvraag
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"
}
}
Voorbeeldrespons
{
"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
Voorbeeldaanvraag
Voorbeeldrespons
{
"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"
}
Definities
Name | Description |
---|---|
Api |
Api-fout. |
Api |
Api-foutbasis. |
Cloud |
Een foutreactie van de Compute-service. |
Inner |
Interne foutdetails. |
Instance |
Status van exemplaarweergave. |
Key |
Beschrijft een verwijzing naar Key Vault-geheim |
Status |
De niveaucode. |
Sub |
|
Virtual |
Beschrijft een virtuele-machineextensie. |
Virtual |
De exemplaarweergave van een virtuele-machineextensie. |
ApiError
Api-fout.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
details |
Details van de API-fout |
|
innererror |
De interne API-fout |
|
message |
string |
Het foutbericht. |
target |
string |
Het doel van de specifieke fout. |
ApiErrorBase
Api-foutbasis.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
message |
string |
Het foutbericht. |
target |
string |
Het doel van de specifieke fout. |
CloudError
Een foutreactie van de Compute-service.
Name | Type | Description |
---|---|---|
error |
Api-fout. |
InnerError
Interne foutdetails.
Name | Type | Description |
---|---|---|
errordetail |
string |
Het interne foutbericht of de uitzonderingsdump. |
exceptiontype |
string |
Het uitzonderingstype. |
InstanceViewStatus
Status van exemplaarweergave.
Name | Type | Description |
---|---|---|
code |
string |
De statuscode. |
displayStatus |
string |
Het korte lokaliseerbare label voor de status. |
level |
De niveaucode. |
|
message |
string |
Het gedetailleerde statusbericht, inclusief voor waarschuwingen en foutberichten. |
time |
string |
Het tijdstip van de status. |
KeyVaultSecretReference
Beschrijft een verwijzing naar Key Vault-geheim
Name | Type | Description |
---|---|---|
secretUrl |
string |
De URL die verwijst naar een geheim in een Sleutelkluis. |
sourceVault |
De relatieve URL van de sleutelkluis die het geheim bevat. |
StatusLevelTypes
De niveaucode.
Name | Type | Description |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
SubResource
Name | Type | Description |
---|---|---|
id |
string |
Resource-id |
VirtualMachineExtension
Beschrijft een virtuele-machineextensie.
Name | Type | Description |
---|---|---|
id |
string |
Resource-id |
location |
string |
Resourcelocatie |
name |
string |
Resourcenaam |
properties.autoUpgradeMinorVersion |
boolean |
Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie eenmaal is geïmplementeerd, worden er echter geen secundaire versies bijgewerkt, tenzij deze opnieuw wordt geïmplementeerd, zelfs niet als deze eigenschap is ingesteld op true. |
properties.enableAutomaticUpgrade |
boolean |
Geeft aan of de extensie automatisch moet worden bijgewerkt door het platform als er een nieuwere versie van de extensie beschikbaar is. |
properties.forceUpdateTag |
string |
Hoe de extensie-handler moet worden gedwongen om bij te werken, zelfs als de extensieconfiguratie niet is gewijzigd. |
properties.instanceView |
De weergave exemplaar van de virtuele-machine-extensie. |
|
properties.protectedSettings |
object |
De extensie kan protectedSettings of protectedSettingsFromKeyVault of helemaal geen beveiligde instellingen bevatten. |
properties.protectedSettingsFromKeyVault |
De met extensies beveiligde instellingen die doorverwijzing worden doorgegeven en die worden gebruikt vanuit de sleutelkluis |
|
properties.provisionAfterExtensions |
string[] |
Verzameling extensienamen waarna deze extensie moet worden ingericht. |
properties.provisioningState |
string |
De inrichtingsstatus, die alleen in het antwoord wordt weergegeven. |
properties.publisher |
string |
De naam van de uitgever van de extensie-handler. |
properties.settings |
object |
In Json opgemaakte openbare instellingen voor de extensie. |
properties.suppressFailures |
boolean |
Geeft aan of fouten die voortvloeien uit de extensie worden onderdrukt (operationele fouten, zoals het niet verbinden met de VIRTUELE machine, worden niet onderdrukt, ongeacht deze waarde). De standaardwaarde is onwaar. |
properties.type |
string |
Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension. |
properties.typeHandlerVersion |
string |
Hiermee geeft u de versie van de scripthandler. |
tags |
object |
Resourcetags |
type |
string |
Resourcetype |
VirtualMachineExtensionInstanceView
De exemplaarweergave van een virtuele-machineextensie.
Name | Type | Description |
---|---|---|
name |
string |
De naam van de extensie van de virtuele machine. |
statuses |
De informatie over de resourcestatus. |
|
substatuses |
De informatie over de resourcestatus. |
|
type |
string |
Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension. |
typeHandlerVersion |
string |
Hiermee geeft u de versie van de scripthandler. |